The component SVGVIEWER renders SVG (scalable vector graphics) content. The content is passed by setting the attribute SVG on server side.
For JavaFX client: you may help the component if you pass the SVGWIDTH and SVGWIDTH together with the SVG. If doing so, then the component is able to fit the component into the available space and it will allow the user to zoom in/out using the mouse wheel.
You may add a certain type of interactivity into the SVG - which is a proprietary extension: by assigning an attribute "cc_id" to a certain SVG-element (e.g. "<text ... cc_id='NORTH' ...>"), clicks on this element are recognized on client side and are passed back to the server by corresponding the assigned ACTIONLISTENER (event BaseActionEventSvgElementSelection). The id of the clicked element is passed as part of the event data. - Please pay attention: there is an attribute WITHELEMENTSELECTION that you have to set to "true" in addition, in order to activate the possibility to click on elements.
Typically used attributes
All attributes are
General attributes are
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
Binding to server side method that processes the events coming from this component.
| #{methodBinding} | Method binding |
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 |
If set to true then changes of the width/height of the component are animated.
| true | With animation |
| false | Without animation (default) |
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.
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 or inside a GRIDLAYOUTPANE.
| 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.
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.
| 100 | 100 Pixels |
| 120 | 120 Pixels |
| 200 | 200 Pixels |
| 50% | 50 percents |
| 100% | Full available height |
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.
| 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.
| true | Component is rendered (default) |
| false | Component is not rendered |
Spanning of rows if used inside a GRIDLAYOUTPANE.
| 1 | Control spans one row (default) |
| 2 | 2 rows |
| 3 | 3 rows |
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 |
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.
String containing the SVG-XML.
Explicit size of the SVG graphics. - The SVGVIEWER needs to know the size of the SVG graphics in order to properly scale it. If this size is not defined then the size definition of the SVG document is used, if this size is not defined then a default size is selected.
Explicit size of the SVG graphics. - The SVGVIEWER needs to know the size of the SVG graphics in order to properly scale it. If this size is not defined then the size definition of the SVG document is used, if this size is not defined then a default size is selected.
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.
| 100 | 100 Pixels |
| 120 | 120 Pixels |
| 200 | 200 Pixels |
| 50% | 50 percents |
| 100% | Full available width |
When true then a close icon is rendered into the tab.
| false | (default) |
| true | With close icon inside the tab |
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!