com.sapportals.htmlb.event

Class LinkClickEvent

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

public class LinkClickEvent

extends Event

Event that is fired when a Link is clicked

Copyright 2004 SAP AG

Constructor Summary

LinkClickEvent()

LinkClickEvent(String name)

Method Summary

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.
String	getRef()
static String	renderEventCall(IPageContext pc, Link link)
static String	renderJSFunction(IPageContext pc, Link theLink) INTERNAL USE ONLY.
protected void	setParams(String[] params) set the params from the HTML page.
void	setRef(String ref)
String	toString()

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

getAction, getComponentName, getModifierData, setAction

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkClickEvent

public LinkClickEvent()

LinkClickEvent

public LinkClickEvent(String name)

Method Detail

renderEventCall

public static String renderEventCall(IPageContext pc,
                                     Link link)

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

getParams

public String[] getParams()

Description copied from class: Event

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

Overrides:

getParams in class Event

getParams

public String[] getParams(Component c)

Description copied from class: Event

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

Overrides:

getParams in class Event

getRef

public String getRef()

setRef

public void setRef(String ref)

toString

public String toString()

Overrides:

toString in class Event

renderJSFunction

public static String renderJSFunction(IPageContext pc,
                                      Link theLink)

INTERNAL USE ONLY. This method is used by the rendering class to construct the JavaScript function wrapper for the client side JavaScript fragment.