Web Dynpro TimedTrigger API - IWDTimedTrigger 

Definition

The TimedTrigger UI element automatically and periodically triggers an event with a specified delay. The TimedTrigger UI element is not displayed on the user interface. Therefore, it ignores the tooltip and the visibilty property. However, in specific layouts such as the matrix layout it takes up space. To trigger an action, you must bind the onAction property to an action. You use the delay property to specify the delay in seconds.

If events are not to be triggered by the TimedTrigger UI element, you do the following:

·        Disable the action that is bound to the onAction property of the UI element

·        Set the value of the delay to 0 seconds

·        Disable the TimedTrigger UI element

Every user interaction is interrupted when the onAction is triggered.

Use

In the Web Dynpro application, you can use, with restrictions, periodical server requests and the TimedTrigger UI element to trigger push events – that is, the controlled triggering of events, for example, as a message for the user. When using the TimedTrigger UI element, the client actively retrieves the data from the server. Due to the considerable server load, you should only use this option if a small number of clients exists.

Description of UI Element Properties

·        delay
The delay property describes the delay in seconds before a specific action is triggered. The value of this property cannot be negative. A delay of 0 seconds means that the timer is turned off and no action is executed. The delay starts at the point of the time at which the client receives the response. After each round trip to the server – that is, after each user action, the timer is restarted.

Note that in case of very short delays (delays of less than 5 seconds), it might be impossible to operate user interfaces.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
delay	IWDTimedTrigger	int	0	bindable	No
enabled	IWDUIElement	boolean	true	bindable	No
tooltip	IWDUIElement	String (Translatable Text)		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No

 

Events

·        onAction
This property contains the action that is executed when a specific delay terminated.

Data Binding

You can use the onAction property to specify the action that is to be triggered after a specific delay.

Methods in the Web Dynpro IWDTimedTrigger API

Method Name	Parameter	Return Value	Description
bindDelay	(String path)		Binds the delay property to the context node specified by a path.
bindingOfDelay		String	Returns the path of the context element to which the delay property is bound. Returns NULL if no binding exists.
getDelay		int	Returns the value of the delay property.
getOnAction		IWDAction	Returns the action that is executed when the onAction event is triggered.
mappingOfOnAction		IWDParameterMapping	Returns the parameter mapping for the onAction action.
setDelay	(int delay)		Sets the value of the delay property.
setOnAction	(IWDAction action)		Sets the action that is executed if the onAction event is raised.

Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.