The HIDEABLE is a container that can be hidden on client side. The hiding is a client side operation - so the container is still available as DOM-object internally.
There are two modes for hiding that are controlled by attribute TYPEOFHIDING:
1. the container is temporarily removed from the DOM tree in the browser
2. the container is resized to "0,0" and is internally deactivated
The type of hiding was especially introduced to support scenarios in which some IFRAME is/maybe part of the content of the container. IFRAME instances are not keeping their current state when being removed from the DOM tree and later on re-positioned into the DOM tree. Resizing the container does not remove the content from the DOM tree and as consequence prserves the current state of the contained IFRAME.
Typically used attributes
All attributes are
Used inside: ADAPTIVETILECONTAINER, ADAPTIVETOOLBAR, AREASELECTOR, BLOCKABLEAREA, COLSYNCHEDROW, DRAWAREA, FOLDABLEPANEHEADERROW, GRIDCOL, GRIDFOOTER, GRIDHEADER, GRIDHEADERLABEL, GRIDLAYOUTROW, LABELCONTAINER, LAYEREDPANE, OVERLAYAREABASEITEM, OVERLAYAREAITEM, PAGEBEANROOT, PAINTAREAITEM, REPEAT, ROW, ROWADAPTIVELINE, ROWFLEXCOLUMNCONTAINER, ROWFLEXLINECONTAINER, ROWFOOTER, ROWHEADER, ROWTITLEBAR, SCHEDULEITEM, SCHEDULEITEMAREA, SIZEANIMATIONAREA, SPANGRIDCOL, STABLEAREA, TABBEDAREABEGIN, TABBEDAREAEND, TEXTWITHCONTROLS, TREENODE
Using inside: ADAPTIVEGRIDLAYOUTPANE, ADAPTIVESPLITAREA, ANIMATEDPANE, AREASELECTOR, BLOCKABLEAREA, BOX, COLSYNCHEDPANE, CUBEROTATOR, FLYINCONTENTAREA, FOLDABLEPANE, FOLDABLEPOPUPINCLUDE, FOLDABLEVERTICALPANE, GRIDLAYOUTPANE, LAYEREDPANE, OVERLAYAREA, PAINTAREA, PANE, PARENTEXIT, REPEAT, ROLLINGCONTAINERAREA, ROTATECONTENTAREA, SCALEPANE, SCROLLPANE, SIZEABLEPANE, SIZEABLEPANEHORIZONTAL, SIZEANIMATIONAREA, SPLITPANE, STABLEAREAMANAGER, STABLEAREAPLACEHOLDER, TABBEDLINECONTAINER, TABBEDPANE, TEXTWITHCONTROLS, TILEDAREA
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).
The attribute value must be an expression.
| #{tobedefined} | Binding to IComponentAdapter instance |
If set to true then changes of the width/height of the component are animated.
| true | With animation |
| false | Without animation (default) |
If set to true then the component will switch its own RENDERED status to false if all child components are not rendered.
| false | No cascading of rendered false (default) |
| true | With cascading of rendered false |
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.
In case the content of the component exceeds the available height and in case the height is defined as percentage value then the content by default will expand the height correspondingly. But, if defined as true, then the content will be cut.
| true | Cut content to fit into available height |
| false | Expand surrounding layout (default) |
In case the content of the component exceeds the available width and in case the width is defined as percentage value then the content by default will expand the width correspondingly. But, if defined as true, then the content will be cut.
| true | Cut content to fit into available width |
| false | Expand surrounding layout (default) |
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 use an extended syntax: "xxx%;<min>;<max>": in this case the minimum and maximum definitions are respected. 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.
| 100 | 100 pixels |
| 120 | 120 pixels |
| 200 | 200 pixels |
| 50% | 50 percents |
| 100% | Full available height |
| 100%;100 | Full available height, minimum 100 pixels |
| 100%;100;500 | Full available height, minimum 100 pixels, maximum 500 pixels |
| 100%;;500 | Full available height, maximum 500 pixels |
If set to true then the component is hidden on client side.
The attribute value must be an expression.
| true | Hidden |
| false | Shown (default) |
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 |
Shadow of component. The definition is done by several inner values: hoffset, voffset, blur and color.
| hoffset:5;voffset:5;blur:5;color:#C0C0C0 | full shadow definition |
| color:#C0C0C0 | Definition only via color, rest of values is set to default values |
Style class names that are applied to this component.
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.
Definition how the hiding is internally executed. When selecting value 'resize' then the content internally remains unchanged - which is importatn if e.g. wanting to keep some client state within the contained components (esp. if using an IFRAME based component inside, e.g. BROWSER, SUBPAGE, IFRAMEINCLUDE)
| remove | (default) The content of the area is removed from the component tree when hidden and moved back in when shown |
| resize | The content is sized to width 0 and height 0. |
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 use an extended syntax: "xxx%;<min>;<max>": in this case the minimum and maximum definitions are respected. - 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.
| 100 | 100 Pixels |
| 120 | 120 Pixels |
| 200 | 200 Pixels |
| 50% | 50 percents |
| 100% | Full available width |
| 100%;100 | Full available width, minimum 100 pixels |
| 100%;100;500 | Full available width, minimum 100 pixels, maximum 500 pixels |
| 100%;;500 | Full available width, maximum 500 pixels |
x-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!
y-pixel-position: this attribute is only used if the component is directly placed into a PAINTAREA!