Component FIXGRID

Overview

The FIXGRID component is the default grid within the CaptainCasa framework. There is some own documentation within the Developer's Guide that shows how to use this component.

The FIXGRID is both used for rendering/editing lists of data and for rendering/editing tree data structures.

Attribute summary

Typically used attributes

All attributes are

General attributes are

Positioning

Used inside: ADAPTIVETILECONTAINER, ADAPTIVETOOLBAR, AREASELECTOR, BLOCKABLEAREA, COLSYNCHEDROW, DRAWAREA, FOLDABLEPANEHEADERROW, GRIDCOL, GRIDFOOTER, GRIDHEADER, GRIDHEADERLABEL, GRIDLAYOUTROW, LABELCONTAINER, OVERLAYAREABASEITEM, OVERLAYAREAITEM, PAGEBEANROOT, PAINTAREAITEM, REPEAT, ROW, ROWADAPTIVELINE, ROWFLEXCOLUMNCONTAINER, ROWFLEXLINECONTAINER, ROWFOOTER, ROWHEADER, ROWTITLEBAR, SCHEDULEITEM, SPANGRIDCOL, STABLEAREA, TEXTWITHCONTROLS, TREENODE

Using inside: GRIDCOL, GRIDFOOTER, GRIDHEADER

Attribute details

accessiblename

Text that is passed as control content to the accessible support devices (e.g. screen readers).

actionListener

Binding to server side method that processes the events coming from this component.

#{methodBinding}Method binding

adapterbinding

Special binding to component adapter object instance on server side. The component adapter must be an instance of IComponentAdapterBinding. For some components (e.g. FIXGRID) there is an extended interface (e.g. IFIXGRIDComponentAdapterBinding).

#{tobedefined}Binding to IComponentAdapter instance

animatechangeofsize

If set to true then changes of the width/height of the component are animated.

trueWith animation
falseWithout animation (default)

attributemacro

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.

autoexecute

Triggers an execution event on a grid item after selection and after passing some time, in which the selection is not removed. This is very useful for lists in which you quickly navigate through the grid (e.g. with keyboard) but in which you want to make sure that the item is executed after some time, in order to show some detail data.

falseNo auto execution (default)
trueWith auto execution

autoexecuteduration

Number of milliseconds after which an auto-execute is triggered when selecting an item.

10001000ms (default)
500500ms

avoidroundtrips

By default a roundtrip to the server is triggered with every item selection. When specifying false then selections are managed locally within the client, without server roundtrip.

0Roundtrips with every selection (default)
1Avoid roundtrips with selection, only send roundtrip if data changed within row
2Avoid roundtrips with selection, never send rountrip with selection
falseRoundtrips with every selection (default), same as 0-value
trueAvoid roundtrips with selection, only send roundtrip if data changed within row, same as 1-value

background

Background color of the component. Any RGB value can be chosen using format #rrggbb.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

bgpaint

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).

---------- bgpaint commands for all clients -----
error()Component indicates error.
mandatory()Component indicates mandatory input. Only is shown if component does not have any content yet.
bgbackground(#FF0000)Background with one color
bgbackground(#FF0000,#0000FF,vertical)Background as gradient of two colors
bgimage(left,/images/xyz.png)Image at certain position
bgwrite(left,...text...)Text at certain position
bgwrite(left,...text...,#800000,12)Text at certain position with defined color and size
---------- bgpaint commands for Java clients -----
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...)
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.

border

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.

#8080801 pixel border in color dark gray.
top:1;color:#808080top:1;color:#808080 : border only on top, 1 pixel height, color #808080
top:1;bottom:1;left:1;right:1;color:#FF0000top: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,2top: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!
noborderDefines that no border is painted - esp. in cases when empty borders are normally added (e.g. in grid cells)

bordercolor

The color of the border that is rendered between the controls of the grid. When no border color is defined then the background will shine through.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

borderdashing

FX only: dashing of border lines between the cells. Any sequence of integer values epxressing the sequence of dots of the line and empty dots

 (default) No dashing, solid line
1 11 dot line, 1 dot empty, repeated for the whole line
5 2 2 25 dots line, 2 dots empty, 2 dots line, 2 dots empty, repeated for the whole line

borderheight

Height of the border between the cells of the grid.

0No border between cells.
1Border of 1 pixel height

borderwidth

Width of the border between the cells of the grid.

0No border between cells.
1Border of 1 pixel height

clientname

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.

colalignmentx

In case the space provided by the container (e.g. gridlayoutcontainer) for the component is wider than the component itself: definition where to place the component

leftLeft (default)
centerCenter
rightRight

colspan

Spanning of columns if used inside a COLSYNCHEDROW or inside a GRIDLAYOUTPANE.

1Control spans one column (default)
22 columns
33 columns

columndragdropenabled

Allows the user to change the sequence of columns by drag and drop.

trueEnabled (default)
falseNo column drag and drop

columnresizerbackground

columnresizingenabled

Allows the user to change the size of the columns.

trueEnabled (default)
falseNo sizing of columns by the user

comment

Comment that can be asigned to any component. The comment is not operationally used.

Any textAny text

configinfo

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.

dragroundtrip

If set to true then an event is triggered on server side when the user starts a drag operation. The event is of type BaseActionEventDragStarted.

falseNo event triggered (default)
trueEvent triggered

dragsend

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:4711Example: article
file:harry.txt;content:Hello world!Example: Multiple object descriptions

drawoddevenbackgroundeven

Background of even rows - if DRAWODDEVENROWS is set to true. Use a transparent color (e.g. #xxxxxx20) in order to avoid that the row coloring of the application is overpainted.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

drawoddevenbackgroundodd

Background of odd rows - if DRAWODDEVENROWS is set to true. Use a transparent color (e.g. #xxxxxx20) in order to avoid that the row coloring of the application is overpainted.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

drawoddevenrows

Odd rows and even rows are differenciated by color.

trueDifferent coloring of odd and even rows
falseNo odd/even row coloring (default)

droprastertext

Text that is shown when dragging over the component. The text is only shown if a drop is possible (DROPRECEIVE definition).

 (default) No text shown
 pixel(5) Current drop pixel position - in steps of 5 (or any other value)
 pixelX(5) Current drop pixel position - only the x-position
 pixelY(5) Current drop pixel position - only the y-position
 percentage(5) Current drop pixel position as percentage number - in steps of 5 (or any other value)
 percentageX(5) Current drop pixel position as percentage number - only the x-position
 percentageY(5) Current drop pixel position as percentage number - only the y-position
 textX(0,left,25,middle,75,right) Text that is shown depending from percentage x-position

dropreceive

Semicolon separated list of object types that can be dropped onto this component.

articleExample: articles can be dropped
article;customerExample: articles and customers can be dropped

dropshape

dynamicheightsizing

When switching to true, then the width of the rows is dynamically measured at runtime.

falsesizing of lines according to rowheight definitions (default)
truedynamic height sizing enabled

enabled

Indicator if component is enabled or not.

trueComponent is enabled.
falseComponent is not enabled.

flusharea

If set to true then data changes within this area will cause a flush-rountrip to the server as soon as the user leaves the area.

trueFlush is done on data change + leaving the area.
falseNo flush. Data is transferred to server with next round trip. (Default)

flushcolumnupdates

Indicator if data changed in the component are transferred immediately to the server, causing a normal round trip processing from client to server.

trueFlush is done on data change.
falseNo flush. Data is transferred to server with next round trip.

focusable

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.

trueFocusable
falseNot focusable

focusnexthotkey

Hotkey definition that is used als alternative to the tab-key for moving the focus into the next component.

 No keyboard association (default)
ctrl-83Control key + s
alt-83Alt key + s
shift-83Shift key + s
ctrl-shift-83Control key + Shift key + s
10return
32space
37cursor left
38cursor up
39cursor right
40cursor down
33page up
34page down
36Begin
35End
27escape
127Del
65a
66b
67c
68d
69e
70f
71g
72h
73i
74j
75k
76l
77m
78n
79o
80p
81q
82r
83s
84t
85u
86v
87w
88x
89y
90z
480
491
502
513
524
535
546
557
568
579
112F1
113F2
114F3
115F4
116F5
117F6
118F7
119F8
120F9
121F10
122F11
123F12

focusprevioushotkey

Hotkey definition that is used als alternative to the tab-key for moving the focus into the previous component.

 No keyboard association (default)
ctrl-83Control key + s
alt-83Alt key + s
shift-83Shift key + s
ctrl-shift-83Control key + Shift key + s
10return
32space
37cursor left
38cursor up
39cursor right
40cursor down
33page up
34page down
36Begin
35End
27escape
127Del
65a
66b
67c
68d
69e
70f
71g
72h
73i
74j
75k
76l
77m
78n
79o
80p
81q
82r
83s
84t
85u
86v
87w
88x
89y
90z
480
491
502
513
524
535
546
557
568
579
112F1
113F2
114F3
115F4
116F5
117F6
118F7
119F8
120F9
121F10
122F11
123F12

focussequence

Explicit definition of tab sequence. The format of the definition is GROUP/SEQUENCENUMBER. You can define any number of tab-groups within one page. If the user tabs into a component with a FOCUSSEQUENCE definition then the next tab will focus the next component belonging to the same GROUP and holding the next SEQUENCENUMBER. - By default the FOCUSSEQUENCE value is prefixed with some page-id before being sent to the client so that definitions of one page do not affect definitions of another page. You can explicitly avoid this prefixing by using the naming convention ccfix_GROUP/SEQUENCENUMBER.

---------- Examples -----
A/1Example: group A, sequence 1
A/2Example: group A, sequence 2

gridcolbgpaint

BGPAINT definition that is used as for all contained GRIDCOL elements of this grid. Overrides any local GRIDCOL-BGPAINT definintion.

---------- bgpaint commands for all clients -----
error()Component indicates error.
mandatory()Component indicates mandatory input. Only is shown if component does not have any content yet.
bgbackground(#FF0000)Background with one color
bgbackground(#FF0000,#0000FF,vertical)Background as gradient of two colors
bgimage(left,/images/xyz.png)Image at certain position
bgwrite(left,...text...)Text at certain position
bgwrite(left,...text...,#800000,12)Text at certain position with defined color and size
---------- bgpaint commands for Java clients -----
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...)
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.

gridcolfont

FONT definition that is used for all contained GRIDLCOL elements. Overrids any local GRIDCOL-FONT definition.

family:Arialfamily:Arial
family:Courierfamily:Courier
size:12size:12
weight:boldweight:bold
size:12;weight:boldsize:12;weight:bold
size:12;posture:italicsize:12;posture:italic

gridcolforeground

FOREGROUND definition that is used for all contained GRIDLCOL elements. Overrids any local GRIDCOL-FOREGROUND definition.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

headlinerowheight

The height of the headline row. If not set then the headline is as high as the content lines.

1616 pixels
2020 pixels (default)

height

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 percentage sizing then you may define a minimum size in addition, by appending it with a semicolon: "100%;100" means: use 100%, but always keep a minimum size of 100. If using absolute sizes you may append a "+" to define, that the size is extended if required by the component. - Please note: the sizing may be completely taken over by the parent component (e.g. if a component is used in a grid cell), in this case the size definintions on this component level are obsolete.

100100 Pixels
120120 Pixels
200200 Pixels
50%50 percents
100%Full available height

helpid

Help id that is part of the online help management.

helpidId pointing to a server side online help file.
ccnof1helpExplicitly switching off default F1 help. This is sometimes required in case you want to explicitly react on F1-key as hotkey.

horizontalscrollmode

Scroll mode for the horizontal scrollbar.

autoShow scrollbar if required (default)
autowithresizeShow scrollbar if required, do not implicitly calculate scrollbar height into grid height
alwaysShow scrollbar always
hiddenNever show scrollbar

keysensitive

If set to true then the component registers key strokes within its content - after a certain short duration a corresponding KeySequence event is sent to the server side, telling about the sequence of characters that was input.

false(default) No key sensitivity
trueKey sensitive - listening to key events.

mousewheeldelta

Number of grid rows that is scrolled by mouse wheel movement.

1(default) 1 row
22 rows
33 rows

multicolumnsort

Defines if sorting via multiple columns is supported.

true(default) Multiple column sorting is active
falseMultiple column sorting is disabled

multiselect

Selection mode: by default exactly one item can be selected. You can allow multiple item selection by using this attribute. Multiple selections are done by the user using the ctrl- and shift-key of the keyboard while selecting with the mouse.

falseSingle item selection (default)
trueMultiple item selection

multiselectmode

If multiselect is switched to true: the mode how the user can pick multiple items with the mouse

0Default: multi-selection by keeping ctrl-key pressed
1Click by click selection/deselection

noscrollmode

Special flag that controls the inner content of the grid on client side. If switched to true then no scroll pane is used for the content, but just a normal pane. Consequence: the grid can be put into a SCROLLAREA and the grid is moved as a whole when navigating. - This is a quite special attribute, and should not normally not be touched...

falseNormal mode (default)
trueNo scrolling mode (only for very specific use cases)

objectbinding

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

persistid

popupmenu

Reference to the id of a POPUPMENU definition that is available either in this page or in a page that includes this page.

popupmenuloadroundtrip

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.

falseMenu is already defined in layout, no roundtrip (default)
trueMenu is dynamically created, roundtrip is triggered

reference

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.

refOne reference
ref1;ref2Two references
ref1;ref2;ref3Three references

rendered

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.

trueComponent is rendered (default)
falseComponent is not rendered

requestfocus

Indicator, by which you can control the focus to be moved into this component.

creationComponent requests focus when created.
...int value...Counter coming from server side. Please check Developers Guide.

requestfocushotkey

Hotkey definition that is used request the focus for this component. The hotkey is globally available within the corresponding dialog.

 No keyboard association (default)
ctrl-83Control key + s
alt-83Alt key + s
shift-83Shift key + s
ctrl-shift-83Control key + Shift key + s
10return
32space
37cursor left
38cursor up
39cursor right
40cursor down
33page up
34page down
36Begin
35End
27escape
127Del
65a
66b
67c
68d
69e
70f
71g
72h
73i
74j
75k
76l
77m
78n
79o
80p
81q
82r
83s
84t
85u
86v
87w
88x
89y
90z
480
491
502
513
524
535
546
557
568
579
112F1
113F2
114F3
115F4
116F5
117F6
118F7
119F8
120F9
121F10
122F11
123F12

reselectable

Decides what happens when the user clicks a line which is already selected. By default no further selection event is sent to the server side processing. You can override by specifying true.

trueReselection is enabled
falseNo reselection (default)

rolloverbgpaint

rounding

Rounding radius of edges of border/background. This is optical rounding - so has nothing to do with mathematical rounding...

0Straight edges
5Rounding with radius 5
10Rounding with radius 10

rowalignmenty

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.

topTop
centerCenter (default)
bottomBottom

rowbgpaint

This is the BGPAINT definition for each row of the grid.

---------- bgpaint commands for all clients -----
error()Component indicates error.
mandatory()Component indicates mandatory input. Only is shown if component does not have any content yet.
bgbackground(#FF0000)Background with one color
bgbackground(#FF0000,#0000FF,vertical)Background as gradient of two colors
bgimage(left,/images/xyz.png)Image at certain position
bgwrite(left,...text...)Text at certain position
bgwrite(left,...text...,#800000,12)Text at certain position with defined color and size
---------- bgpaint commands for Java clients -----
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...)
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.

rowdragsend

This is the DRAGSEND definition for each row of the grid. Either input a straight value or a binding to some row information: .{...}

article:4711Example: article
file:harry.txt;content:Hello world!Example: Multiple object descriptions

rowdropreceive

This is the DROPRECEOVE definition for each row of the grid. Either input a straight value or a binding to some row information: .{...}

articleExample: articles can be dropped
article;customerExample: articles and customers can be dropped

rowflusharea

rowheight

The height of one row of the grid.

1616 pixels
2020 pixels (default)

rowpopupmenu

This is the POPUPMENU definition for each row of the grid. The POPUPMENU is a reference to the POPUPMENU component id that is used with this component.

rowpopupmenuloadroundtrip

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.

falseMenu is already defined in layout, no roundtrip (default)
trueMenu is dynamically created, roundtrip is triggered

rowspan

Spanning of rows if used inside a GRIDLAYOUTPANE.

1Control spans one row (default)
22 rows
33 rows

sbvisibleamount

Visible amount of rows within the grid. Dependent on the actual size of the grid, the grid may show less than defined grid items. - Please remember: the number or rows in the client has nothing to do with the number of rows on server side! This definition only tells how many items should fit into the client grid for display reasons.

2020 rows as maximum
3030 rows as maximum

scrollanimationtype

Animation that is executed when the user scrolls the grid content

foglightLight fog that disappears
fogdarkDark fog that disappears
fog(#000000,10)Fox that starts with the color/transparency that are passed as parameters
noanimation...finally: no animation at all

scrollbydragdrop

If set to true then scrolling can be invoked by dragging and dropping with the mouse.

trueScrolling enabled via drag and drop
falseNormal scrolling by scroll bars (default)

scrollingenabled

The grid can be scrolled by using the scroll bar - or by using some implicit srcoll functions (e.g. mouse wheel, keyboard navigation). If you do not want the grid to be vertically scrollable, then you can remove the scroll bar by using attribute VERTICALSCROLLMODE. By setting SCROLLINGENABLED to false you in addition disable the implicit scrolling functions. - Area of usage: you may want to control the scrolling completely on your own, e.g. using explicit scroll icons.

true(default) scrolling enabled
falseMouse wheel scrolling disabled

scrollreferencehorizontal

A scrollpane/grid can synchronize with another scrollpane/grid: if this one scrolls then the scollpane/grid follows. The reference contains the id that links to the master scrollpane/grid.

selectioncolor1

Top color of color shading that is applied when a grid row is selected.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

selectioncolor2

Bottom color of color shading that is applied when a grid row is selected.

#FFFFFFWhite
#000000Black
#FF0000Red
#00FF00Green
#0000FFBlue
#0000FF30Blue with a transparency of x30.

selectorcolumn

If set to 1 or 2 then a selector is rendered as first columns automatically.

0No selector column (default)
1Arrow-icon selector
2Index-of-row selector

selectorcolumnimagefalse

Image that is drawn inside the selector cell when unselected.

/images/abc.pngImage /images/abc.png
/images/svg/def.svgImage /images/svg/def.svg

selectorcolumnimagetrue

Image that is dran into the selector cell when selected.

/images/abc.pngImage /images/abc.png
/images/svg/def.svgImage /images/svg/def.svg

selectorcolumntitleimage

Image that is drawn inside the title column.

/images/abc.pngImage /images/abc.png
/images/svg/def.svgImage /images/svg/def.svg

selectorcolumnwidth

shadow

Shadow of component. The definition is done by several inner values: hoffset, voffset, blur and color.

hoffset:5;voffset:5;blur:5;color:#C0C0C0full shadow definition
color:#C0C0C0Definition only via color, rest of values is set to default values

showemptyrows

By default a grid has a certain size that is calculated from its SBVISIBLEAMOUNT value (and if height is not explicitly set). If only a few rows of the grid are filled with data, then there is remaining space at the bottom. With SHOWEMPTYROWS you can define, to not see this empty space, if setting the value to false. The setting only shows effect if no explicit height is defined with the grid.

trueEmpty rows are shown (default)
falseEmpty rows are hidden, grid is shrinked

singleclickexecute

By default an execute event is triggered by double-click. By setting SINGLECLICKEXECUTE to ture you can define that a simple click already triggers an execute on server side.

falseDouble click execute (default)
trueSingle click execute

styleseq

Style class names that are applied to this component.

styleseqselector

stylevariant

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.

suppressheadline

Controls if the grid is rendered with a headline or without. The headline contains the column titles and allows the user to exchange and resize columns.

falseWith headline, no suppressig of headline (default)
trueWithout headline, suppressing of headline

verticalscrollmode

Scroll mode for the horizontal scrollbar.

autoShow scrollbar if required (default)
alwaysShow scrollbar always
hiddenNever show scrollbar

width

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 percentage sizing then you may define a minimum size in addition, by appending it with a semicolon: "100%;100" means: use 100%, but always keep a minimum size of 100. If using absolute sizes you may append a "+" to define, that the size is extended if required by the component. - Please note: the sizing may be completely taken over by the parent component (e.g. if a component is used in a grid cell), in this case the size definintions on this component level are obsolete.

100100 Pixels
120120 Pixels
200200 Pixels
50%50 percents
100%Full available width

withfocusevent

If set then corresponding focus events are triggered if the component gains/looses the focus.

false(default) no focus events
truewith focus events
focusgainedwith focus events but only for gaining the focus
focuslostwith focus events but only for loosing the focus

withrollover

Defines if rollover effects are enabled with this component.

trueRollover enabled (default)
falseRollover disabled

x

x-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!

y

y-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!