Typically used attributes
All attributes are
Binding to server side method that processes the events coming from this component.
#{methodBinding} | Method binding |
Special binding to componet adapter object instance on server side.
#{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 |
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.
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) |
Semicolon separated list of color values that is transferred into a color palette for the user.
Default color palette (default) | |
#000000;#FFFFFF | Black and white |
#FF0000;#00FF00;#0000FF | Ref green blue |
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 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 |
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. |
Binary data of image, converted into a hexadecimal string. User ValueManager.encodeHexstring(byte[]) in order to convert binary data into a string representation.
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 |
Defines is images keep their width/height ration or if they are stretched to fit. Only has effect when either width or height is defined in addition.
true | Keep ratio (default) |
false | Fit size, stretch |
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.
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 |
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.
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.
Vertical positioning of the content within the row.
top | Top |
middle | Middle (default) |
bottom | Bottom |
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 |