com.sapportals.portal.prt.service.epcftoolbox
Interface IClientEventSender

All Superinterfaces:

IScriptGenerator

public interface IClientEventSender

extends IScriptGenerator

interface for sender object in the eventing pattern. The sender object allows you to register a multiple parameters for one outcoming clientside event and generate corresponding client script code.

See Also:

IClientEventReceiver

Method Summary

void	setParameter(java.lang.String key, java.lang.String value) register a string value with given key.
void	setRawParameter(java.lang.String key, java.lang.String variableName) register a variable which carries a string value with the given key

Methods inherited from interface com.sapportals.portal.prt.service.epcftoolbox.IScriptGenerator

getScript, getWrappedScript

Method Detail

setParameter

public void setParameter(java.lang.String key,
                         java.lang.String value)

register a string value with given key.

Parameters:

key - identification of the parameter in the event container. Only the characters from the following set are allowed [A-Z0-9_-]

value - may not contain single or double quotes or escaped characters, Empty string is allowed.

setRawParameter

public void setRawParameter(java.lang.String key,
                            java.lang.String variableName)

register a variable which carries a string value with the given key

Parameters:

key - identification of the parameter in the event container. Only the characters from the following set are allowed [A-Z0-9_-]

variableName - any JavaScript / DOM reference (i.e. document.form.textfield.value). It may not be empty or contain escaped characters. When using single or double quotes (i.e. document.getElementById('theId').value), always make sure, that they are used in pairs and not collide with the surrounding characters of the whole generated script.