com.sapportals.htmlb

Interface IEventValidationComponent

All Known Implementing Classes:
EventValidationComponent, EventValidationContainer

public interface IEventValidationComponent

Base interface for Javascript supporting Components (and Renderers)

Copyright 2004 SAP AG


Method Summary
 ArrayList getAllValidators()
           
 String getClientEvent(EventTrigger trigger)
          gets a client event handler (in Javascript) from the list of the events
 HashMap getClientEventMap()
           
 String getErrorText()
           
 Event getServerEvent(EventTrigger trigger)
          gets an event handler from the list of the events
 HashMap getServerEventMap()
           
 Validator getValidator()
          returns application specific validator to the component
 boolean isDisabled()
          Deprecated. return if this button is currently disabled
 boolean isEnabled()
          return if this button is currently disabled
 boolean isRequiresValidation()
          determines if the validation is required or not before submitting server event
 void setClientEvent(EventTrigger trigger, String javascript)
          adds a client event handler (in Javascript) to the list of the events null removes the event for the given trigger
 void setDisabled(boolean disabled)
          Deprecated. disable or enable this button
 void setEnabled(boolean enabled)
          disable or enable this button
 void setErrorText(String errortext)
           
 void setServerEvent(EventTrigger trigger, Event event)
          adds an event handler to the list of the events
 void setValidator(Validator validator)
          sets an application specific validator to the component null removes the validator
 

Method Detail

setValidator

public void setValidator(Validator validator)
sets an application specific validator to the component null removes the validator

Parameters:
validator - a validator to be assigned to the component
See Also:
Validator

getValidator

public Validator getValidator()
returns application specific validator to the component

Returns:
validator a validator to be assigned to the component
See Also:
Validator

setErrorText

public void setErrorText(String errortext)

getErrorText

public String getErrorText()

setClientEvent

public void setClientEvent(EventTrigger trigger,
                           String javascript)
adds a client event handler (in Javascript) to the list of the events null removes the event for the given trigger

Parameters:
trigger - triggering event, @see com.sapportals.htmlb.enum.EventTrigger
javascript - javascript to execute, be sure to specify return value

getClientEvent

public String getClientEvent(EventTrigger trigger)
gets a client event handler (in Javascript) from the list of the events

Parameters:
trigger - triggering event, @see com.sapportals.htmlb.enum.EventTrigger
Returns:
javascript javascript to execute, be sure to specify return value

setServerEvent

public void setServerEvent(EventTrigger trigger,
                           Event event)
adds an event handler to the list of the events

Parameters:
trigger - triggering event, @see com.sapportals.htmlb.enum.EventTrigger
event - object, @see com.sapportals.htmlb.event.Event

getServerEvent

public Event getServerEvent(EventTrigger trigger)
gets an event handler from the list of the events

Parameters:
trigger - triggering event, @see com.sapportals.htmlb.enum.EventTrigger
Returns:
event object, @see com.sapportals.htmlb.event.Event

getAllValidators

public ArrayList getAllValidators()

getClientEventMap

public HashMap getClientEventMap()

getServerEventMap

public HashMap getServerEventMap()

isDisabled

public boolean isDisabled()
Deprecated. return if this button is currently disabled

Returns:
true if the button is disabled

setDisabled

public void setDisabled(boolean disabled)
Deprecated. disable or enable this button

Parameters:
disabled - true if the button should be disabled

isEnabled

public boolean isEnabled()
return if this button is currently disabled

Returns:
true if the button is disabled

setEnabled

public void setEnabled(boolean enabled)
disable or enable this button


isRequiresValidation

public boolean isRequiresValidation()
determines if the validation is required or not before submitting server event



Copyright 2006 SAP AG Complete Copyright Notice