The ANIMATEICON component is a quite special component. Please do not get confused: the component does NOT start any graphical animation!
What the component does: it refers to an other component, running in parallel and changes a certain attribute of this component from one value to another value (and back) when clicked. The other component is referenced by attribute REFERREDID, the attribute is referred by REFERREDATTRIBUTE and the values are defined in the attributes FROM and TO.
A usage example for the component is the FOLDABLEPANE component, which internally uses ANIMATEICON: when the user presses the icon, then the height of an other area (the content area of the FOLABLEPANE) is set either to "0" (not visible) or to a certain height value (visible).
Typically used attributes
All attributes are
Binding to server side method that processes the events coming from this component.
The attribute value must be an expression.
| #{methodBinding} | Method binding |
Special binding to componet adapter object instance on server side.
The attribute value must be an expression.
| #{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.
The attribute value must not be changed once the component is created.
Name that is assigned to the component at client side: there is no specific function associated with the name - but it can be used on client side to describe the component in a clearer way. The name is e.g. used by UI test tools that replay certain user interaction sequences - and that reference components via their name.
Spanning of columns if used inside a COLSYNCHEDROW.
| 1 | Control spans one column (default) |
| 2 | 2 columns |
| 3 | 3 columns |
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.
Indicator if component is enabled or not.
| true | Component is enabled. |
| false | Component is not enabled. |
Indicator if data changed in the component are transferred immediately to the server, causing a normal round trip processing from client to server.
| true | Flush is done on data change. |
| false | No flush. Data is transferred to server with next round trip. |
Defines if the component is focusable. The default depends on the component: typical input components (field, check box, ...) are focusable by default, while typical structure components (pane, label, ...) are not focusable by default.
| true | Focusable |
| false | Not focusable |
By default a border is drawn aroudn a focussed element. This can be switched off by setting this attribute to false.
| true | Draw border when focussed (default) |
| false | No border when focussed |
Semicolon separated list of font attributes. Valid attributes are: faces (font family), size (integer number), weight (bold), posture (italic)
| family:Arial | family:Arial |
| family:Courier | family:Courier |
| size:12 | size:12 |
| weight:bold | weight:bold |
| size:12;weight:bold | size:12;weight:bold |
| size:12;posture:italic | size:12;posture:italic |
Foreground color of the component. Any RGB value can be chosen using format #rrggbb.
| #FFFFFF | White |
| #000000 | Black |
| #FF0000 | Red |
| #00FF00 | Green |
| #0000FF | Blue |
| #0000FF30 | Blue with a transparency of x30. |
Foreground color that is applied when the component is not enabled
| #FFFFFF | White |
| #000000 | Black |
| #FF0000 | Red |
| #00FF00 | Green |
| #0000FF | Blue |
| #0000FF30 | Blue with a transparency of x30. |
The from-vaue that is used.
Semicolon separated sequence of style class names that are applied to this component.
Help id that is part of the online help management.
| helpid | Id pointing to a server side online help file. |
| ccnof1help | Explicitly switching off default F1 help. This is sometimes required in case you want to explicitly react on F1-key as hotkey. |
Reference to image within your web application. The image either needs to be defined relative to the current page (e.g. ../images/abc.png) or needs to be defined in an absolute way (e.g. /images/abc.png). The root directory for absolute addressing is the directory of the web application.
| /images/abc.png | Image /images/abc.png |
| abc.png | Image abc.png |
| ../images/abc.png | Image ../images/abc.png |
Image that is shown in the animated/second state of the component.
| /images/abc.png | Image /images/abc.png |
| abc.png | Image abc.png |
| ../images/abc.png | Image ../images/abc.png |
Reference to the id of a POPUPMENU definition that is available either in this page or in a page that includes this page.
If set to true, then an explicit roundtrip is triggered when the user presses the right mouse button in order to open a popup menu. As result you can define the popup menu dynamically (using DYNAMICCONTENT) and prepare the popup menu at this point of time when the user want to open it.
| false | Menu is already defined in layout, no roundtrip (default) |
| true | Menu is dynamically created, roundtrip is triggered |
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.
The attribute value must not be changed once the component is created.
| ref | One reference |
| ref1;ref2 | Two references |
| ref1;ref2;ref3 | Three references |
Attribute of the other component that is updated by this component.
Id of the other component that is updated by this component.
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.
The attribute value must be an expression.
| true | Component is rendered (default) |
| false | Component is not rendered |
Indicator, by which you can control the focus to be moved into this component.
| creation | Component requests focus when created. |
| ...int value... | Counter coming from server side. Please check Developers Guide. |
Rounding radius of edges of border/background. This is optical rounding - so has nothing to do with mathematical rounding...
| 0 | Straight edges |
| 5 | Rounding with radius 5 |
| 10 | Rounding with radius 10 |
If more than one component is arranged within one row, then components need to decide how they want to be aligned vertically inside the row - in case the height of the row exceeds the height of the component itself.
| top | Top |
| center | Center (default) |
| bottom | Bottom |
In CaptainCasa you can define styles definitions for components. A style definition is a definition of a set of default attribute values that are applied to the component. In case you want to differenciate between different usage types of the component you can apply multiple styles - and use the stylevariant attribute to select between.
Text that is shown and (dependent from the component type) edited inside the component. The terminator is a decimal byte value.
The to-vaue that is used.
Data value that is shown and (dependent from the component type) edited inside the component.