com.sapportals.htmlb.event

Class TrayHeaderClickEvent

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

public class TrayHeaderClickEvent

extends Event

Enter description here

Copyright 2004 SAP AG

Field Summary

static String	COLLAPSE
static String	EDIT
static String	EXPAND
static String	REMOVE

Constructor Summary

TrayHeaderClickEvent()

TrayHeaderClickEvent(String name)

Method Summary

static String	renderEventCall(IPageContext pc, Tray tray, String eventType, String action) INTERNAL USE ONLY.
protected void	setParams(String[] params) set the params from the HTML page.

Methods inherited from class com.sapportals.htmlb.event.Event

getAction, getComponentName, getModifierData, getParams, getParams, setAction, toString

Methods inherited from class java.lang.Object

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

Field Detail

EDIT

public static final String EDIT

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

COLLAPSE

public static final String COLLAPSE

See Also:

Constant Field Values

EXPAND

public static final String EXPAND

See Also:

Constant Field Values

Constructor Detail

TrayHeaderClickEvent

public TrayHeaderClickEvent()

TrayHeaderClickEvent

public TrayHeaderClickEvent(String name)

Method Detail

setParams

protected void setParams(String[] params)

Description copied from class: Event

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

Specified by:

setParams in class Event

Parameters:

params - the event parameters

renderEventCall

public static String renderEventCall(IPageContext pc,
                                     Tray tray,
                                     String eventType,
                                     String action)

INTERNAL USE ONLY. This method is used by the rendering class to construct the JavaScript function call for this event.