Typically used attributes
All attributes are
General attributes are
Hotkey definition that is used to activat the function that the component provides. The acitivation hotkey is only applied if the user does focus the component. Example: you many define an own hot key within a COMBOFIELD so that the COMBOFIELD activates its value help.
| No keyboard association (default) | |
| ctrl-83 | Control key + s |
| alt-83 | Alt key + s |
| shift-83 | Shift key + s |
| ctrl-shift-83 | Control key + Shift key + s |
| 10 | return |
| 32 | space |
| 37 | cursor left |
| 38 | cursor up |
| 39 | cursor right |
| 40 | cursor down |
| 33 | page up |
| 34 | page down |
| 36 | Begin |
| 35 | End |
| 27 | escape |
| 127 | Del |
| 65 | a |
| 66 | b |
| 67 | c |
| 68 | d |
| 69 | e |
| 70 | f |
| 71 | g |
| 72 | h |
| 73 | i |
| 74 | j |
| 75 | k |
| 76 | l |
| 77 | m |
| 78 | n |
| 79 | o |
| 80 | p |
| 81 | q |
| 82 | r |
| 83 | s |
| 84 | t |
| 85 | u |
| 86 | v |
| 87 | w |
| 88 | x |
| 89 | y |
| 90 | z |
| 48 | 0 |
| 49 | 1 |
| 50 | 2 |
| 51 | 3 |
| 52 | 4 |
| 53 | 5 |
| 54 | 6 |
| 55 | 7 |
| 56 | 8 |
| 57 | 9 |
| 112 | F1 |
| 113 | F2 |
| 114 | F3 |
| 115 | F4 |
| 116 | F5 |
| 117 | F6 |
| 118 | F7 |
| 119 | F8 |
| 120 | F9 |
| 121 | F10 |
| 122 | F11 |
| 123 | F12 |
Special binding to componet adapter object instance on server side.
The attribute value must be an expression.
| #{tobedefined} | Binding to IComponentAdapter instance |
Horizontal alignment of content.
| left | left (transferred into right when starting client in right to left mode) |
| left! | left (still is left when starting client in right to left mode) |
| center | center |
| right | right (transferred into left when starting client in right to left mode) |
| right! | right! (still is right when starting client in right to left mode) |
| leading | leading |
| trailing | trailing |
If set to true then changes of the width/height of the component are animated.
| true | With animation |
| false | Without animation (default) |
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.
Background 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. |
Defintion of border of control. Either defined as straight color value, with then having a border of 1 pixel. Or: an explicit per-side definition as comma separated list of border definition values.
| #808080 | 1 pixel border in color dark gray. |
| top:1;color:#808080 | top:1;color:#808080 : border only on top, 1 pixel height, color #808080 |
| top:1;bottom:1;left:1;right:1;color:#FF0000 | top:1;bottom:1;left:1;right:1;color:#FF0000 : red border of 1 pixel size |
| top:1;bottom:1;left:1;right:1;color:#FF0000;dashing:5,2 | top:1;bottom:1;left:1;right:1;color:#FF0000 : red border of 1 pixel size, dashed with segments of 5 pixesl and 2 pixels; dashing only supported with FX Client! |
| noborder | Defines that no border is painted - esp. in cases when empty borders are normally added (e.g. in grid cells) |
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.
Description of object that can be dragged from this component. The description consists out of a type and and id. A component may have multiple objects that can be associated.
| article:4711 | Example: article |
| file:harry.txt;content:Hello world! | Example: Multiple object descriptions |
Semicolon separated list of object types that can be dropped onto this component.
| article | Example: articles can be dropped |
| article;customer | Example: articles and customers can be dropped |
Indicator if component is enabled or not.
| true | Component is enabled. |
| false | Component is not enabled. |
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. |
Semicolon separated sequence of style class names that are applied to this component.
Height of the control. Either defined as absolute value or as percentage value. Pay attention when using percentage sizing: the size refers to what is given from the components above. - When using components within a grid (FIXGRID) then the sizing of the component is completely managed by the grid, you do not need to specify any height in this case.
| 100 | 100 Pixels |
| 120 | 120 Pixels |
| 200 | 200 Pixels |
| 50% | 50 percents |
| 100% | Full available height |
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 |
Pressed image.
| /images/abc.png | Image /images/abc.png |
| abc.png | Image abc.png |
| ../images/abc.png | Image ../images/abc.png |
Rollover image.
| /images/abc.png | Image /images/abc.png |
| abc.png | Image abc.png |
| ../images/abc.png | Image ../images/abc.png |
Client side event that triggers a server invoke.
| click | Mouse click (both mouse buttons) |
| leftclick | Mouse click (left mouse button) |
| rightclick | Mouse click (right mouse button) |
| doubleclick | Mouse double click |
| leftanyclick | Both click and double click are transferred, check event BaseActionEventInvoke on server side for click count |
If set to true then all data input will be transferred into lowercase.
| true | lowercase only |
| false | lower and uppercase (default) |
Maximum number of characters that a user can input.
| Unlimited (default) | |
| 10 | 10 characters |
| 20 | 20 characters |
Defines the click-sensitive area that triggers the value help event.
| icon | The user clicks the icon in order to open the value help (default) |
| fieldandicon | The user may click onto the whole control in order to open the value help |
Binding to server side object property that represents the component on server side. The type of the property needs to fit to the component type. Example: for FIXGRID components the server side property needs to be of type FIXGRIDListBinding or FIXGRIDTreeBinding.
| #{xyz.xyz} | Binding definition |
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 |
Regular expression that is used for checking the input while the user updates the content.
| [01]+ | Only 0 and 1, any number |
| [01]{5} | Exactly 5 occurances of 0 or 1 |
Mode that controls how the field content is treated in case the user inputs wrong values.
| 0 | Component shows error, input value is kept |
| 1 | Component shows error, input value is reset to previous valid value |
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. |
Limit the input to certain keys only.
| All keys allowed | |
| 0123456789 | Only numbers can be input |
| aAbBcC | Only a,A,b,B,c,C can be input |
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.
If enabled then the return-key will switch the focus to the next component.
| true | Switch focus on return-key |
| false | Switch focus on tab-key only (default) |
By default a flushing of a component is only executed if there was a value change of the user. If setting this property to true then a flush event is sent when the user presses the return key, regardless if the value has changed ord not.
| true | Always send flush event on return key |
| false | Only send flush event on changes (default) |
Text that is shown as hint when the user stays with the mouse on top of the control for a while.
| ...anytext... | Text that is displayed as tooltip. |
| server:true | Indicator that tooltip for the component is managed on server side. The actionListener will be invokde with events BaseActionEventTooltipStarted and BaseActionEventTooltipEnde. On server side you may implement some modeless popup in order to show some more complex tooltip |
| server:true;closedelay:1000 | Duration in milliseconds (in this case: 1000ms) that the client waits before sending a close event to the server side |
| server:true;opendelay:1000 | Duration in milliseconds after which a tooltip event is triggered when the user moves the mouse on top of this component |
| server:true;keeppopup:true | If the server side processing opens up a modeless popup then this popup is NOT closed when the user moves the mouse into the popup |
If set to true then all data input will be transferred into uppercase.
| true | uppercase only |
| false | lower and uppercase (default) |
Text that is shown as hint below the component. The text appears when the user steps into the component, i.e. when the component is focussed. It automatically disappears when the user steps into the next component. - Please note: the user hint is only activiated by the user if the component is focusable!
Trigger for showing the user hint. The user hint is shown in the same way as if the user focused the component.
Width of the control. Either defined as absolute value or as percentage value. Pay attention when using percentage sizing: the size refers to what is given from the components above. - When using components within a grid (FIXGRID) then the sizing of the component is completely managed by the grid, you do not need to specify any width in this case.
| 100 | 100 Pixels |
| 120 | 120 Pixels |
| 200 | 200 Pixels |
| 50% | 50 percents |
| 100% | Full available width |