Component SUBPAGE

Overview

The component SUBPAGE includes a CC-page from another CC-application. It internally uses an HTML-iframe element to do this.

Please make sure that the setup of your CORS-policy allows the integration on browser side.

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

Attribute details

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.

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.

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

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.

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

highlightid

iframeattributes

Attribute values that are directly passed into attribtues of the IFRAME instance. Format: ATTNAME1:ATTVALUE1;ATTNAME2:ATTNAMEVALUE2. In the value: use \x3B for semicolons.

sandbox:allow-popupsExample using sandbox attribute
sandbox:allow-popups;allow:camera\x3BmicrophoneExample using sandbox and allow attribute, allow attribute with inner semicolon

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

previewmode

Defines if the contained page runs in a preview of a layout editor. In this case clicks within the component are transferred in order to notify the editing environment.

falseIn normal mode (default)
trueIn preview mode

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

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

rowspan

Spanning of rows if used inside a GRIDLAYOUTPANE.

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

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.

subpagesessionid

The sessionid that should be applied to the subpage. This attribute is bi-directional: the actuall subpage is written into the attribute at runtime. Vice versa: the subpage is taken over when the subpage is loaded into the client.

synchronous

Defines if the component talks to the server and a synchronous or asynchronous way. Only when running in asynchronous mode then the component will run independently from its environment: in this case the user interface around the component will be released while the communication is going on.

trueSynchronous (default)
falseAsynchronous

takeoversessionid

If set to true then the contained pages is opened with the same session id as the surrounding page.

falseOpen content in own session (default)
trueOpen content with same session id as surrounding page

url

URL that is loaded. Either an absolute address, or relative to the jsp starting page.

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

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!