Component SIMPLEHTMLEDITOR

Overview

The component SIMPLEHTMLEDITOR is a simple wysiwyg-editor for editing HTML texts.

The component binds to some framework that is embedded from outside. Currently there are two options: either you may use the Squill-Editor or you may use the CK-Editor. Please check and respect terms of licens for each embedded framework.

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.

avoidsanitizing

By default any HTML that is directly passed into the client processing is sanitized on client side. This means it is checked to not contain JavaScript and/or other injection. There are some situations in which you need to embed HTML without sanitizing - so in these situations you may switch off the sanizing by setting this attribute to true. Of course: PAY ATTENTION! Do not pass any untrusted content into client! You are now responsible for avoding e.g. JavaScript injection!

falseWith sanitzing (default)
trueNo sanititzing - HTML is processed as is.

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)

bridgepage

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.htmlBridge page name, starting with slash, relative to webcontent-directory.

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.

flush

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.

flushtimer

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.

 No flush timer (default)
10001000 milliseconds
20002000 milliseconds

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

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

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

rowspan

Spanning of rows if used inside a GRIDLAYOUTPANE.

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

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

styleseq

Style class names that are applied to this component.

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.

text

Text that is shown and (dependent from the component type) edited inside the component. The terminator is a decimal byte value.

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!