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!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Field Summary

static int

DEFAULT_DELAY Default value of the delay property is 0.

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

DEFAULT_ENABLED, DEFAULT_TOOLTIP, DEFAULT_VISIBLE

Method Summary

void	bindDelay(IWDAttributeInfo attributeInfo) Binds the delay property to the context attribute specified by the given attribute info.
void	bindDelay(String path) Binds the delay property to the context attribute specified by the given path.
String	bindingOfDelay() Returns the binding path of the delay property.
int	getDelay() Returns the value of the delay property.
IWDAction	getOnAction() Returns the action assigned to event onAction.
IWDParameterMapping	mappingOfOnAction() Returns the parameter mapping for event onAction.
void	setDelay(int value) Sets the delay property to the given value.
void	setOnAction(IWDAction action) Assigns the given action to event onAction.

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

destroy, getId, getView, requestFocus

Field Detail

DEFAULT_DELAY

public static final int DEFAULT_DELAY

Default value of the delay property is 0.

See Also:

Constant Field Values

Method Detail

getOnAction

public IWDAction getOnAction()

Returns the action assigned to event onAction. The action to be triggered when the specified delay has passed.

Returns:

the action assigned to event onAction

See Also:

mappingOfOnAction()

setOnAction

public void setOnAction(IWDAction action)

Assigns the given action to event onAction.

Parameters:

action - the action assigned to the event

See Also:

getOnAction()

mappingOfOnAction

public IWDParameterMapping mappingOfOnAction()

Returns the parameter mapping for event onAction.

This event has no parameters.

Returns:

the parameter mapping for event onAction

See Also:

getOnAction()

bindDelay

public void bindDelay(String path)

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

Parameters:

path - the context path of the attribute to which the delay property will be bound

bindDelay

public void bindDelay(IWDAttributeInfo attributeInfo)

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

Parameters:

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

bindingOfDelay

public String bindingOfDelay()

Returns the binding path of the delay property.

Returns:

the path of the context attribute to which the delay property 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 the delay property to the given value.

Parameters:

value - the new value of the delay property

See Also:

getDelay()