com.sap.tc.webdynpro.clientserver.uielib.standard.api
Interface IWDTimedTrigger

All Superinterfaces:

IWDUIElement, IWDViewElement

public interface IWDTimedTrigger

extends IWDUIElement

Web Dynpro TimedTrigger API. UI element that automatically and periodically triggers a UI element event with a defined delay. TimedTrigger is currently invisible like InvisibleElement, thus it ignores both its tooltip and its visibility. Nevertheless it occupies a cell in certain layouts like MatrixLayout. To use a timed trigger you have to bind its "onAction" event to an action and set its "delay" property to the desired delay in seconds. There are several ways to turn off a timed trigger. The most convenient way is to disable the action this trigger is bound to (like you would do with a button). Other possibilities are setting the delay to 0 or disabling the timed trigger like any other UI element. Caution: Triggering the action rudely interrupts user interactions!

This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Field Summary

static int

DEFAULT_DELAY Default value of property delay.

Fields inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindDelay(IWDAttributeInfo attributeInfo) Binds property delay to the context attribute specified by the given attribute info.
void	bindDelay(java.lang.String path) Binds property delay to the context attribute specified by path.
java.lang.String	bindingOfDelay() Binding path of property delay.
int	getDelay() Returns the value of the delay property.
IWDAction	getOnAction() Returns the action to which the event onAction is mapped.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping of event onAction.
void	setDelay(int value) Sets property delay to the new value.
void	setOnAction(IWDAction action) Maps the event onAction to the given action.

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDUIElement

bindEnabled, bindEnabled, bindingOfEnabled, bindingOfTooltip, bindingOfVisible, bindTooltip, bindTooltip, bindVisible, bindVisible, createLayoutData, getContainer, getEnabled, getLayoutData, getTooltip, getVisible, setEnabled, setTooltip, setVisible

Methods inherited from interface com.sap.tc.webdynpro.progmodel.api.IWDViewElement

getId, getView, requestFocus

Field Detail

DEFAULT_DELAY

public static final int DEFAULT_DELAY

Default value of property delay.

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action to which the event onAction is mapped. The action to be triggered when the specified delay has passed.

Returns:

the action to which the event is mapped

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Maps the event onAction to the given action.

Parameters:

action - the action for the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping of event onAction.

To be accessible in a view controller, a UI element event parameter has to be mapped to a controller event handler parameter. This is done by defining a parameter mapping.

Event parameters:

• none

Returns:

parameter mapping list.

See Also:

getOnAction()

bindDelay

public void bindDelay(java.lang.String path)

Binds property delay to the context attribute specified by path.

Parameters:

path - the path of the context attribute to which the delay property is bound

bindDelay

public void bindDelay(IWDAttributeInfo attributeInfo)

Binds property delay to the context attribute specified by the given attribute info.

Parameters:

attributeInfo - the info of the context attribute to which the delay property is bound

bindingOfDelay

public java.lang.String bindingOfDelay()

Binding path of property delay.

Returns:

the path of the context attribute to which the delay is currently bound

getDelay

public int getDelay()

Returns the value of the delay property. The initial value is 0. The delay in seconds before the specified action is fired; must not be negative. A delay of 0 means that the timer is off and no action is triggered. The delay counts from the moment the response is received by the client. Thus the timer is restarted on every roundtrip to the server, e.g. due to a user interaction. Very short delays (e.g. below 5 seconds) must be handled with extreme care and might be deprecated in the future.

Returns:

the current value of the delay property

See Also:

setDelay(int)

setDelay

public void setDelay(int value)

Sets property delay to the new value.

Parameters:

value - the new value of the delay property

See Also:

getDelay()