Component TIMER

Overview

The TIMER component is an invisible component which calls a server side method (attribute ACTIONLISTNER) every x milliseconds. The duration is defined via attribute DURATION.

There is a DURATIONTYPE which may be defined in addition, e.g. if you want the timer to be only called if there is no user interaction for a certain while.

Attribute summary

Typically used attributes

All attributes are

General attributes are

Positioning

Used inside: BEANPROCESSING

Attribute details

actionListener

Binding to server side method that processes the events coming from this component.

#{methodBinding}Method binding

adapterbinding

Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).

#{tobedefined}Binding to IComponentAdapter instance

attributemacro

Name of macro that is used for generating certain attributes of this component. Please pay attention: the value of this attribute is read one time for each control and cannot be changed afterwards.

avoidvalidations

When a roundtrip is triggered then by default the curren user input is validated. This may lead to some change within the current user input field (e.g. is user just defines a date then the user might not yet have specified a correct date).

falseValidations are executed (default)
trueValidations are not executed

comment

Comment that can be asigned to any component. The comment is not operationally used.

Any textAny text

configinfo

Configuration information that is attached to this component. This information is not functionally used by CaptainCasa, but may be used for any application specific purpose.

duration

Duration in milliseconds after which a request to the client is triggered. In case of TIMER components this is the actual polling duration (every xxx milliseconds), in case of LONGPOLLING components this is the duration after which the new polling request is sent to the server (in order to avoid, that there are too many requests).

0Deactivated
10001000 milliseconds
20002000 milliseconds

durationtype

Information how to interepret the duration.

 (default) regular timer execution
regularRegular timer execution, the timer is executed every xxx ms
lastroundtripThe timer is executed xxx ms after the last roundtrip.
lastactivityThe timer is executed xxx ms after the last user activity (e.g. mouse click / keyboard input)
onetimelastactivityThe timer is executed xxx ms after the last user activity (e.g. mouse click / keyboard input). Then there is no further calling to the server.

reference

Reference to an outside object that is the content behind the component. E.g. a field is representing a certain field of a database table: in this case you could define the value table;column. The reference plays a siginficant role within the attributemacro management.

refOne reference
ref1;ref2Two references
ref1;ref2;ref3Three references

rendered

Flag that indicated if this component is rendered at all. If set to false then the component is not rendered - there is no component data sent to the client.

trueComponent is rendered (default)
falseComponent is not rendered

statusbarneutral

If set to true, then the roundtrip that is caused by the component does NOT clear the current statusbar content.

falseStatusbar content is cleared. (default)
trueStatusbar content is kept.

waitcursor

Cursor that appears during round trip to the server.

 Hourglass (default)
nocursorNo cursor is shown
corsshairCrosshair