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 |
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. |
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) |
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.
When including a sub-page definition then it is possible to udpate attribute values according to this definition. The definition is a complex value and lists the plain rules which content to replace with which other content. Please note: the replacement is done once when including the page, there is no permanent check for updates of the contentreplace attribute with every roundtrip!
| $i$:1 | All occurances of $i$ are replaced with 1 |
| $i$:1;$value$:xyz | Two replacements: $i$ with 1, $value$ with xyz |
Similar to contentreplace attribute - but now the replace statement is drilled down to all page levels. This means the replace statement is valid for the included page and all pages below the included page.
| $i$:1 | All occurances of $i$ are replaced with 1 |
| $i$:1;$value$:xyz | Two replacements: $i$ with 1, $value$ with xyz |
Color of animated curtain that is shown for a short time and then is fading out.
| #FFFFFF | White |
| #000000 | Black |
| #FF0000 | Red |
| #00FF00 | Green |
| #0000FF | Blue |
| #0000FF30 | Blue with a transparency of x30. |
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. |
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. |
Background color of the inner part of the component.
| #FFFFFF | White |
| #000000 | Black |
| #FF0000 | Red |
| #00FF00 | Green |
| #0000FF | Blue |
| #0000FF30 | Blue with a transparency of x30. |
Background painting of the inner part of the component.
| 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. |
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 |
Background color of the inner part of the component.
| #FFFFFF | White |
| #000000 | Black |
| #FF0000 | Red |
| #00FF00 | Green |
| #0000FF | Blue |
| #0000FF30 | Blue with a transparency of x30. |
Background painting of the inner part of the component.
| 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. |
Defines the initial rendering status of the component.
| true | Opened (default) |
| false | Closed |
Definition of padding on top level of container. This is the pixel distance between the outer shape of the container and its content. The definition either is a straight integer value or is an explicit per-side definition.
| 1 | One pixel distance on all sides (left, top, right, bottom) |
| 5 | 5 pixels distance on all sides (left, top, right, bottom) |
| left:1;right:1 | Only padding on the left and on the right - no padding on top and bottom. |
Link to page.
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 |
Defininition if popup is opened as dialog (default) or as frame. A frame is shown in the task bar and provides minimize/maximize icons.
| false | (default) poup is opened as dialog |
| true | popup is openes as frame) |
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 |
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 |
Distance that is left between tow rows. Only integer (pixel) values are allowed, no percentage values.
| 0 | No distance (default) |
| 2 | 2 pixels |
| 5 | 5 pixels |
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.
Number of pixels that are put in front of the title - in addition to the normal padding definition.
| 5 | 5 pixels |
| 10 | 10 pixels |
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 |
The popup that is opened by the component can be put into the administration of a workpage. In this case you need to define the expression pointing to the workpage. Typically the workpage is kept as property of the dispatcher.
| #{..} | Expression binding to workpage |