Child pages
  • Image

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Rev: 1381948887907

...

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onActiononAction
The method that is executed when the component is clicked.
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onDoubleClickonDoubleClick
The method that is executed when the component is double clicked.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRenderonRender
The method that is executed when the component is rendered.
Table Row (tr)
Table Cell (td)

Table Cell (td)
#onRightClickonRightClick
The method that is executed when the component is right clicked.

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

tbody
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#anchorsanchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#backgroundbackground
The background color of the component.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#borderTypeborderType
The type, color and style of border of the component.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#dataProviderdataProvider
The dataprovider of the component.
Table Row (tr)
Table Cell (td)
Object
Table Cell (td)
designTimeProperties
Property to get and add design-time properties for a component.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#displaysTagsdisplaysTags
Flag that enables or disables merging of data inside components using tags (placeholders).
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#enabledenabled
The enable state of the component, default true.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#fontTypefontType
The font type of the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#foregroundforeground
The foreground color of the component.
Table Body (tbody)tr
Table Cell (td)
Number
Table Cell (td)
formIndex
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#formatformat
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#horizontalAlignmenthorizontalAlignment
Horizontal alignment of the text inside the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#imageMediaimageMedia
The image Media object that should be displayed inside the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#labelForlabelFor
Some components can be set to be labels of other components.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#locationlocation
The x and y position of the component, in pixels, separated by a comma.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#marginmargin
The margins of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#mediaOptionsmediaOptions
Options to scale the image Media object that is displayed inside the component.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#mnemonicmnemonic
The keyboard shortcut that activates this component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#namename
The name of the component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#printSlidingprintSliding
Enables an element to resize based on its content and/or move when printing.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#printableprintable
Flag that tells if the component should be printed or not when the form is printed.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#rolloverCursorrolloverCursor
The cursor that is shown as the mouse is rolled over the component.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#rolloverImageMediarolloverImageMedia
The roll over image Media object used.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showClickshowClick
When set, the element will show the clicked state when selected.
tbody
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#showFocusshowFocus
When set the text of an element will showfocus when selected.
tbody
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#sizesize
The width and height (in pixels), separated by a comma.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#styleClassstyleClass
The name of the style class that should be applied to this component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#tabSeqtabSeq
An index that specifies the position of the component in the tab sequence.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#texttext
The text that is displayed inside the component.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#textRotationtextRotation
The rotation of the element.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#toolTipTexttoolTipText
The text displayed when hovering over the component with a mouse cursor.
tbody
Table Body (tbody)
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#transparenttransparent
Flag that tells if the component is transparent or not.
tbody
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
#verticalAlignmentverticalAlignment
The vertical alignment of the text inside the component.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
#visiblevisible
The visible property of the component, default true.

HTML Table
idevent
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Event Details
Table Body (tbody)
idonAction
Table Row (tr)
idname
Table Cell (td)
onAction
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is clicked.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonDoubleClick-JSEvent
Table Row (tr)
idname
Table Cell (td)
onDoubleClick
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is double clicked.
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRender
Table Row (tr)
idname
Table Cell (td)
onRender
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is rendered.
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idonRightClick
Table Row (tr)
idname
Table Cell (td)
onRightClick
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component is right clicked.
Table Row (tr)
classlastDetailRow
Table Cell (td)


HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Property Details
Table Body (tbody)
idanchors
Table Row (tr)
idname
Table Cell (td)
anchors
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.

If opposite anchors are activated then the component with grow or
shrink with the window. For example if Top and Bottom are activated,
then the component will grow/shrink when the window is vertically
resized. If Left and Right are activated then the component
will grow/shrink when the window is horizontally resized.

If opposite anchors are not activated, then the component will
keep a constant distance from the sides of the window which
correspond to the activated anchors.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idbackground
Table Row (tr)
idname
Table Cell (td)
background
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The background color of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idborderType
Table Row (tr)
idname
Table Cell (td)
borderType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The type, color and style of border of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddataProvider
Table Row (tr)
idname
Table Cell (td)
dataProvider
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The dataprovider of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddesignTimeProperties
Table Row (tr)
idname
Table Cell (td)
designTimeProperties
Table Row (tr)
iddes
Table Cell (td)
The dataprovider of the
Div
classsIndent
sIndent
Property to get and add design-time properties for a component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
StringObject - map of the design-time properties
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
iddisplaysTags
Table Row (tr)
idname
Table Cell (td)
displaysTags
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Flag that enables or disables merging of data inside components using tags (placeholders).
Tags (or placeholders) are words surrounded by %%on each side. There are data tags and
standard tags. Data tags consist in names of dataproviders surrounded by%%. Standard tags
are a set of predefined tags that are made available by the system.

See the "Merging data" section for more details about tags.

The default value of this flag is "false", that is merging of data is disabled by default.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idenabled
Table Row (tr)
idname
Table Cell (td)
enabled
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The enable state of the component, default true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean - enabled state
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idfontType
Table Row (tr)
idname
Table Cell (td)
fontType
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The font type of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idforeground
Table Row (tr)
idname
Table Cell (td)
foreground
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The foreground color of the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idformIndex
Table Row (tr)
idname
Table Cell (td)
formIndex
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idformat
Table Row (tr)
idname
Table Cell (td)
format
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The format that should be applied when displaying data(using dataProviderID) in the label/button.
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idhorizontalAlignment
Table Row (tr)
idname
Table Cell (td)
horizontalAlignment
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Horizontal alignment of the text inside the component. Can be one of
LEFT, CENTER or RIGHT.

Note that this property does not refer to the horizontal alignment
of the component inside the form.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idimageMedia
Table Row (tr)
idname
Table Cell (td)
imageMedia
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The image Media object that should be displayed inside the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idlabelFor
Table Row (tr)
idname
Table Cell (td)
labelFor
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Some components can be set to be labels of other components. This is useful in
two situations. In table view mode it is used for constructing the header of the
table. In record view mode, by setting mnemonics on the label, keyboard shortcuts
can be used to set the focus to fields.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idlocation
Table Row (tr)
idname
Table Cell (td)
location
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The x and y position of the component, in pixels, separated by a comma.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idmargin
Table Row (tr)
idname
Table Cell (td)
margin
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The margins of the component. They are specified in this order,
separated by commas: top, left, bottom, right.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idmediaOptions
Table Row (tr)
idname
Table Cell (td)
mediaOptions
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Options to scale the image Media object that is displayed inside the component.
Can be set to one or a combination of CROP, REDUCE, ENLARGE and KEEPASPECT.

REDUCE will scale down the image if the component is smaller than the image.
REDUCE combined with KEEPASPECT will reduce the image, but keep its aspect ratio.
This is useful when the component has other proportions than the image.

ENLARGE will scale up the image if the component is larger than the image.
ENLARGE combined with KEEPASPECT will scale up the image while keeping its aspect ratio.

CROP will leave the image at its original size. If the component is smaller than
the image this will result in only a part of the image showing up.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idmnemonic
Table Row (tr)
idname
Table Cell (td)
mnemonic
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

The keyboard shortcut that activates this component. A letter must be specified,
and the actual shortcut will be combination of ALT + the specified letter.

This property can be used in two ways. Normally the keyboard shortcut activates
the onClick event of the component. But if the "labelFor" property is set for the
component, then the keyboard shortcut will move the focus to the component whose
label this component is.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)
name
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The name of the component. Through this name it can also accessed in methods.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idprintSliding
Table Row (tr)
idname
Table Cell (td)
printSliding
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Enables an element to resize based on its content and/or move when printing.
The component can move horizontally or vertically and can grow or shrink in
height and width, based on its content and the content of neighboring
components.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idprintable
Table Row (tr)
idname
Table Cell (td)
printable
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Flag that tells if the component should be printed or not when the form is printed.

By default components are printable.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrolloverCursor
Table Row (tr)
idname
Table Cell (td)
rolloverCursor
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The cursor that is shown as the mouse is rolled over the component.
Possible options are DEFAULT and HAND. Note that roll over cursor is not supported in Smart client for list view and tableview forms.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idrolloverImageMedia
Table Row (tr)
idname
Table Cell (td)
rolloverImageMedia
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The roll over image Media object used. It will only work if a property image is also used.
When the mouse is moved over the component, this image Media will be displayed.
When the mouse is moved out of the component, whatever text or image was being initially
displayed will be restored. Note that roll over image is not supported in Smart client for list view and tableview forms.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowClick
Table Row (tr)
idname
Table Cell (td)
showClick
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
When set, the element will show the clicked state when selected.
Applies to labels and buttons and images only.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idshowFocus
Table Row (tr)
idname
Table Cell (td)
showFocus
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

When set the text of an element will showfocus when selected.
Applies to labels and buttons only.
The text property for the element MUST be filled in first.

NOTE: The TAB key may also be used to select the element, depending
on the operating system being used and the selected LAF.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idsize
Table Row (tr)
idname
Table Cell (td)
size
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The width and height (in pixels), separated by a comma.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)
styleClass
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

The name of the style class that should be applied to this component.

When defining style classes for specific component types, their names
must be prefixed according to the type of the component. For example
in order to define a class names 'fancy' for fields, in the style
definition the class must be named 'field.fancy'. If it would be
intended for labels, then it would be named 'label.fancy'. When specifying
the class name for a component, the prefix is dropped however. Thus the
field or the label will have its styleClass property set to 'fancy' only.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtabSeq
Table Row (tr)
idname
Table Cell (td)
tabSeq
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
An index that specifies the position of the component in the tab sequence. The components
are put into the tab sequence in increasing order of this property. A value of 0 means
to use the default mechanism of building the tab sequence (based on their location on the form).
A value of -2 means to remove the component from the tab sequence.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtext
Table Row (tr)
idname
Table Cell (td)
text
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The text that is displayed inside the component.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtextRotation
Table Row (tr)
idname
Table Cell (td)
textRotation
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The rotation of the element. You can choose 0, 90, 180, or 270 and the label is rotated accordingly.
This property also applies to buttons and images.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtoolTipText
Table Row (tr)
idname
Table Cell (td)
toolTipText
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

The text displayed when hovering over the component with a mouse cursor.

NOTE:
HTML should be used for multi-line tooltips; you can also use any
valid HTML tags to format tooltip text. For example:
<html>This includes<b>bolded text</b> and
<font color='blue'>BLUE</font> text as well.</html>

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idtransparent
Table Row (tr)
idname
Table Cell (td)
transparent
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

Flag that tells if the component is transparent or not.

The default value is "false", that is the components
are not transparent.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idverticalAlignment
Table Row (tr)
idname
Table Cell (td)
verticalAlignment
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

The vertical alignment of the text inside the component. Can be one of
TOP, CENTER or BOTTOM.

Note that this property does not refer to the vertical alignment of the
component inside the form.

Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idvisible
Table Row (tr)
idname
Table Cell (td)
visible
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The visible property of the component, default true.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
Boolean - visible property
Table Row (tr)
classlastDetailRow
Table Cell (td)