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.
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. |
Background paint commands. There is a sequence of paint commands which can be executed one after the other by listing them as semicolon separated list. - By appending certain suffixes to a command you can define that the command is only executed in a certain situation. Available suffixes are: _empty (content of component is empty), _focus, _nofocus, _enabled, _disabled, _mouseover. Multiple suffixes can be used in parallel (e.g. write_empty_focus).
| rectangle(0,0,100%,100%,#FF0000) | Red rectangle |
| rectangle(20,20,100,100,#FF0000) | Red rectangle from 20,20 to 120,120 |
| rectangle(20,20,100%-40,100%-40,#FF0000) | Minus absolute values is allowed after percentage definitions |
| rectangle(0,0,100%,100%,#FF0000,#00FF00,vertical) | Rectangle with color changing from red to green in vertical direction |
| roundedrectangle(0,0,100%,100%,10,10,#FF0000,#00FF00,vertical) | Rectangle with color changing from red to green in vertical direction |
| line(0,0,100%,100%,1,#00FF00) | Green line crossing the whole rectangle, from coordinate 0,0 to coordinat 100%,100%, thickness of line is 1 |
| image(0,0,/images/xyz.png,lefttop) | Image output x,y,image,position (lefttop/centermiddle/rightbottom...) |
| image(0,0,200,100,/images/xyz.png,lefttop) | Image output x,y,width,heigh,image,position (lefttop/centermiddle/rightbottom...) |
| scaledimage(0,0,200,100,/images/xyz.png,lefttop) | Scaled image output, the width/height ration is kept while scaling : x,y,width,heigh,image,position (lefttop/centermiddle/rightbottom...) |
| heximage(0,0,08FF40324672849CDFE...,lefttop) | Image output x,y,hexadecimal image,position (lefttop/centermiddle/rightbottom...) |
| heximage(0,0,200,100,08FF40324672849CDFE...,lefttop) | Image output x,y,width,height,hexadecimal image,position (lefttop/centermiddle/rightbottom...) |
| scaledheximage(0,0,200,100,08FF40324672849CDFE...,lefttop) | Scaled image output x,y,width,height,hexadecimal image,position (lefttop/centermiddle/rightbottom...) |
| error() | Component indicates error. |
| mandatory() | Component indicates mandatory input. Only is shown if component does not have any content yet. |
| border(0,0,100%,100%,#C0C0C0,2) | Rectangular border with thickness 2 |
| roundedborder(0,0,100%,100%,10,10,#C0C0C0,2) | Rounded border with thickness 2 |
| write(0,0,Some text,lefttop) | Some text in the left top corner |
| write(50%,50%,Some text,20,#00FF00,centermiddle) | Some text in the left center, font size 20, font color green |
| write(50%,50%,Some text,20,#00FF00,bold,centermiddle) | Some text in the left center, font size 20, font color green,bold |
| write(50%,50%,Some text,20,#00FF00,italic,centermiddle) | Some text in the left center, font size 20, font color green,italic |
| write(50%,50%,Some text,20,#00FF00,normal,centermiddle) | Some text in the left center, font size 20, font color green,normal |
| write(0,100%,Some text,20,#00FF00,default,lefttop,90) | Some text in the left bottom corner, font size 20, font color green, 90 degrees rotated |
| write(20,100%,Some text,20,#00FF00,default,lefttop,90,-1,1) | Some text in the left bottom corner, font size 20, font color green, 90 degrees rotated. x scaling -1, y scaling 1 |
| write(20,100%,Some text,20,#00FF00,bold,lefttop,90,-1,1) | Some text in the left bottom corner, font size 20, font color green, 90 degrees rotated. x scaling -1, y scaling 1 |
| writeifempty(0,0,Some text,lefttop) | Same as write-command, but now only visible if component contains data |
| writeifempty(50%,50%,Some text,20,#00FF00,centermiddle) | Same as write-command, but now only visible if component contains data |
| writemultiline(0,0,100%,100%,Some text) | Some text into the defined rectangle. Only fully supported with FX client, in Swing client the text will be output as one line. |
| writemultiline(0,0,100%,100%,Some text,20,#FF0000,bold) | Some text into the defined rectangle. In additional font size, text color and text style (normal,bold,italic) are passed. Only fully supported with FX client, in Swing client the text will be output as one line. |
| oval(0,0,100%,100%,#FF0000) | Red ellipse |
| oval(0,0,100%,100%,#FF0000,#00FF00,vertical) | Red ellipse with color changing from red to green |
| ovalborder(0,0,100%,100%,#FF0000,2) | Red ellipse border, red, 2 pixels thick |
| grid(100,#00000020) | Grid with line distance 100, black line color - with transparency |
| nodisabled() | Switches off the automated shading of disabled input components |
| background(#FF0000) | Sets the background of the painted area. |
| backgroundnofocus(#FF0000) | Sets the background of the painted area - which is only drawn if the component does not hold the focus. |
| repeatimage(/images/xyz.png) | The image is repeated and drawn all over the available space. |
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.
Type of text content that is output.
| text/plain | Unformatted text (default + fastest) |
| text/html | Simple HTML |
| text/rtf | Simple RTF |
Defines if the component interprets a double-click as a second click. By default the component only sends one invoke event to the server, even if the user double-clicks the component. AS consequence, accidental double-processing on server side is avoiding. But: there may be situations in which you want to allow the user to press a button multiple times: in this case switch the value to true.
| true | Double click leads to two server side events. |
| false | (default) Double click leads to one server side event. |
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. |
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. |
Definition of keyboard key that is associated with this menu item.
| 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 |
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 |
Distance in pixels that is kept left and right from the image.
| 10 | 10 Pixels |
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 |
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 |
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. |
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.
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 |