com.sapportals.htmlb.event

Class BreadCrumbClickEvent

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

public class BreadCrumbClickEvent

extends Event

Event fired by a BreadCrumb

Copyright 2004 SAP AG

Constructor Summary

BreadCrumbClickEvent()

Method Summary

String	getKey() get the key of the BreadCrumb element that was clicked
static String	renderEventCall(IPageContext pc, BreadCrumb bc, String key) INTERNAL USE ONLY.
protected void	setParams(String[] params) set the params from the HTML page.
String	toString()

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

getAction, getComponentName, getModifierData, getParams, getParams, setAction

Methods inherited from class java.lang.Object

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

Constructor Detail

BreadCrumbClickEvent

public BreadCrumbClickEvent()

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

getKey

public String getKey()

get the key of the BreadCrumb element that was clicked

Returns:

the key of the clicked element

toString

public String toString()

Overrides:

toString in class Event

renderEventCall

public static String renderEventCall(IPageContext pc,
                                     BreadCrumb bc,
                                     String key)

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