The CODEEDITOR is a component that allows to edit structured text content according to various format descriptions.
The component internally uses the ACE editor framework. Please check more details at https://ace.c9.io.
Typically used attributes
All attributes are
Used inside: ADAPTIVETILECONTAINER, ADAPTIVETOOLBAR, AREASELECTOR, BLOCKABLEAREA, COLSYNCHEDROW, DRAWAREA, FOLDABLEPANEHEADERROW, GRIDCOL, GRIDFOOTER, GRIDHEADER, GRIDHEADERLABEL, GRIDLAYOUTROW, LABELCONTAINER, LABELFLIP, LAYEREDPANE, OVERLAYAREABASEITEM, OVERLAYAREAITEM, PAGEBEANROOT, PAINTAREAITEM, PILE, REPEAT, ROW, ROWADAPTIVELINE, ROWFLEXCOLUMNCONTAINER, ROWFLEXLINECONTAINER, ROWFOOTER, ROWHEADER, ROWMATRIXAREA, ROWSPANMATRIXAREA, ROWTITLEBAR, SCHEDULEITEM, SCHEDULEITEMAREA, SIZEANIMATIONAREA, SPANGRIDCOL, STABLEAREA, TABBEDAREABEGIN, TABBEDAREAEND, TEXTWITHCONTROLS, TEXTWITHCONTROLSOIS, TREENODE
Binding to server side method that processes the events coming from this component.
The attribute value must be an expression.
| #{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).
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) |
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.
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) |
Name of the page that is the bridge to the extenal framework. By default the page name is determined automatically, you may explicitly control if e.g. you want to use some older/newer version of the bridged framework.
| newest version (default) | |
| /xxx/yyy.html | Bridge page name, starting with slash, relative to webcontent-directory. |
| /eclnt/risc/ext_quill/quillbridge.html | SIMPLEHTMLEDITOR: bridge page to quill editor |
| /eclnt/risc/ext_ckeditor/v4171/ext_ckeditor.html | CKEDITOR: version 4.17.0 |
| /eclnt/risc/ext_ckeditor/v54020/ext_ckeditor.html | CKEDITOR: version 5.40.2.0, classic |
| /eclnt/risc/ext_chartjs/ext_chartjs.html | CHARTJS: default bridge page to chart.js |
| /eclnt/risc/ext_chartjs/ext_chartjs_datalabels.html | CHARTJS: bridge page to chart.js with datalabels plugin |
Type of code that is edited in this component.
| xml | XML text |
| java | Java code |
| javascript | Javascript code |
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.
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. |
Used in addition to FLUSH attribute. Defines the number of milliseconds after which the component automatically flushs to the server. You need to set FLUSH=true in addition. Do not define too short - user input is not possible during server-roundtrips by default.
| No flush timer (default) | |
| 1000 | 1000 milliseconds |
| 2000 | 2000 milliseconds |
| 5000 | 5000 milliseconds |
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 |
| byContent | No explicit height defined, height is defined by content |
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 |
Rounding radius of edges of border/background. This is optical rounding - so has nothing to do with mathematical rounding... The definition is either made for all corners - or as semicolon separated variant for each corner.
| 0 | Straight edges |
| 5 | Rounding with radius 5 |
| 10 | Rounding with radius 10 |
| 0;5;5;0 | indiviual per corner: left top, right top, right bottom, left bottom |
| 0;50%;5;2 | indiviual per corner: any mixing is allowed.. |
Spanning of rows if used inside a GRIDLAYOUTPANE.
| 1 | Control spans one row (default) |
| 2 | 2 rows |
| 3 | 3 rows |
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.
Text that is shown and (dependent from the component type) edited inside the component. The terminator is a decimal byte value.
2 dimensional transformation that is applied to the component.
| no transformation (default) | |
| rotate(10deg) | Rotation by 10 degrees |
| rotate(-10deg) | Rotation by -10 degrees |
| skewX(-10deg) | Skew in horizontal direction by -10 degrees |
| skewY(10deg) | Skew in vertical direction by 10 degrees |
| skew(10deg,20deg) | Skew in both horizontal (10 degrees) and vertical (20 degrees) direction |
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 |
| byContent | No explicit width defined, width is defined by content |
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!