The CLIENTJSMETHODCALLER is an invisible component that executes JavaScript statements within the client when triggered. When defining the value of WITHCALLBACK with "true" then the result of the method it transferred to the server application.
It is used for interfacing on client side to other JavaScript programs which may be part of the client environment.
You can add additional own JavaScript libraries into the client processing (e.g. by using system.xml definitions) that provide JavaScript methods that are not bound to the CaptainCasa client processing.
Typically used attributes
All attributes are
General attributes are
Used inside: BEANPROCESSING
Binding to server side method that processes the events coming from this component.
#{methodBinding} | Method binding |
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 |
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.
Comment that can be asigned to any component. The comment is not operationally used.
Any text | Any text |
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.
Javascript method and parameters that are to be called on client side. String must be of format: COMMAND(PARAM1,PARAM2,...) - COMMAND being the name of the JS method, and PARAM1, ... being the parameters passed as method arguments.
show(aaa,bbb) | JS function show is called, aaa and bbb are passed as string parameters |
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.
ref | One reference |
ref1;ref2 | Two references |
ref1;ref2;ref3 | Three references |
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.
true | Component is rendered (default) |
false | Component is not rendered |
Trigger value: if the value changes then the component's activity is executed on client side. Use class Trigger on server side for implementations of this property.
When true then the component will do a callback to the server and invoke the actionListener after having successfully performed the client operation.
false | No callback to server (default) |
true | Callback to server |