TimedTrigger API
Definition
UI element TimedTrigger automatically and periodically triggers an event with a specified delay. UI element TimedTrigger is not displayed on the user interface. It therefore ignores the tooltip and property visibility. However, in specific layouts such as the matrix layout, it does take up space. To trigger an action, you must bind property onAction to an action. You use property delay to specify the delay in seconds.
To prevent events being triggered by UI element TimedTrigger, proceed as follows:
· Disable the action that is bound to the UI element’s onAction property.
· Set the value of the delay to 0 seconds
· Disable UI element TimedTrigger
Every user interaction is interrupted when the onAction event is triggered.
Use
In the Web Dynpro application, you can – with certain restrictions – use periodical server requests and UI element TimedTrigger to trigger push events – that is, the controlled triggering of events, for example, as a message for the user. When using UI element TimedTrigger, the client actively retrieves the data from the server. Due to the considerable server load, you should only use this option if the number of clients is small.
Description of UI Element Properties
· delay
Property delay 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 |
True |
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
The event is triggers when the delay has ended.