com.sapportals.htmlb.event

Class Event

java.lang.Object
  com.sapportals.htmlb.event.Event

Direct Known Subclasses:

BreadCrumbClickEvent, ButtonClickEvent, CheckboxClickEvent, DateNavigatorDayClickEvent, DateNavigatorMonthClickEvent, DateNavigatorNavigationEvent, DateNavigatorWeekClickEvent, LinkClickEvent, ListSelectEvent, RadioButtonClickEvent, TableCellClickEvent, TableHeaderClickEvent, TableNavigationEvent, TableRowSelectionEvent, TabSelectEvent, TrayHeaderClickEvent, TreeNodeExpandEvent, TreeNodeSelectEvent

public abstract class Event

extends Object

Base class for Events

Copyright 2004 SAP AG

Constructor Summary

Event()
create an Event for a component

Event(String name)
create an Event for a component

Method Summary

String	getAction() gets the action associated with the event, i.e.
String	getComponentName() get the name/id of the component which caused this event.
com.sapportals.htmlb.event.EventModifierData	getModifierData() gets additional data about the event modification.
String[]	getParams() gets parameters of the event the default implementation returns null, needs to be overriden by events that require parameters (e.g.
String[]	getParams(Component c) gets parameters of the event the default implementation returns null, needs to be overriden by events that require parameters (e.g.
void	setAction(String action) set the action string that was set for the event
protected abstract void	setParams(String[] params) set the params from the HTML page.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Event

public Event()

create an Event for a component

Event

public Event(String name)

create an Event for a component

Parameters:

name - the Id of the component

Method Detail

getComponentName

public String getComponentName()

get the name/id of the component which caused this event.

Returns:

the name of the component

getAction

public String getAction()

gets the action associated with the event, i.e. the string that was passed to a 'setOnXXX' method

Returns:

the action string

setAction

public void setAction(String action)

set the action string that was set for the event

Parameters:

action - the action String set by a setOn* method

getModifierData

public com.sapportals.htmlb.event.EventModifierData getModifierData()

gets additional data about the event modification. E.g. the visible row when the modifier is a TableView

Returns:

additional data about the event

toString

public String toString()

getParams

public String[] getParams()

gets parameters of the event the default implementation returns null, needs to be overriden by events that require parameters (e.g. RadioButtonClickEvent)

getParams

public String[] getParams(Component c)

gets parameters of the event the default implementation returns null, needs to be overriden by events that require parameters (e.g. RadioButtonClickEvent)

setParams

protected abstract void setParams(String[] params)

set the params from the HTML page. The actual content of these parameters depends on the exact nature of the event. Table related events might include row and column id. Thus each event class should be able to set its parameters using this generic method. This is the last method that is called by the EventManager to create an event object. If you use custom Events you must make sure this method is accessible for the EventManager. Additionally, Event classes should provide a method public static String renderEventCall(Component component); so that the rendering of the JavaScript call is in the same scope

Parameters:

params - the event parameters