Child pages
  • Image

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Divcache
HTML Table
idproperty
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
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)
Div
classsIndent
Property to get and add design-time properties for a component.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Object - 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
styleindexdisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div
iddescription
HTML Tableidclassservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Event Summary
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onAction
The method that is executed when the component is clicked.
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onDoubleClick
The method that is executed when the component is double clicked.
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onRender
The method that is executed when the component is rendered.
Table Row (tr)
Table Cell (td)
 
Table Cell (td)
onRightClick
The method that is executed when the component is right clicked.
HTML Tableidclassservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Property Summary
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
anchors
Enables a component to stick to a specific side of form and/or to
grow or shrink when a window is resized.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
background
The background color of the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
borderType
The type, color and style of border of the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
dataProvider
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.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
displaysTags
Flag that enables or disables merging of data inside components using tags (placeholders).
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
enabled
The enable state of the component, default true.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
fontType
The font type of the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
foreground
The foreground color of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
formIndex
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
format
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)
horizontalAlignment
Horizontal alignment of the text inside the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
imageMedia
The image Media object that should be displayed inside the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
labelFor
Some components can be set to be labels of other components.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
location
The x and y position of the component, in pixels, separated by a comma.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
margin
The margins of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
mediaOptions
Options to scale the image Media object that is displayed inside the component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
mnemonic
The keyboard shortcut that activates this component.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
name
The name of the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
printSliding
Enables an element to resize based on its content and/or move when printing.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
printable
Flag that tells if the component should be printed or not when the form is printed.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
rolloverCursor
The cursor that is shown as the mouse is rolled over the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
rolloverImageMedia
The roll over image Media object used.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showClick
When set, the element will show the clicked state when selected.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
showFocus
When set the text of an element will showfocus when selected.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
size
The width and height (in pixels), separated by a comma.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
styleClass
The name of the style class that should be applied to this component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
tabSeq
An index that specifies the position of the component in the tab sequence.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
text
The text that is displayed inside the component.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
textRotation
The rotation of the element.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
toolTipText
The text displayed when hovering over the component with a mouse cursor.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
transparent
Flag that tells if the component is transparent or not.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
verticalAlignment
The vertical alignment of the text inside the component.
Table Row (tr)
Table Cell (td)
Boolean
Table Cell (td)
visible
The visible property of the component, default true.
HTML Table
idevent
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
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)
 
Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.rettd

Returns

divsIndentclients

class

Supported Clients

sIndent
true
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Property SummaryEnables a component to stick to a specific side of form and/or to grow or shrink when a window is resized.The background color of the component.The type, color and style of border of the component.The dataprovider of the component.Property to get and add design-time properties for a component.Flag that enables or disables merging of data inside components using tags (placeholders).The enable state of the component, default true.The font type of the component.The foreground color of the component.Form index returns the z-index of the form element.The format that should be applied when displaying data(using dataProviderID) in the label/button.Horizontal alignment of the text inside the component.The image Media object that should be displayed inside the component.Some components can be set to be labels of other components.The x and y position of the component, in pixels, separated by a comma.The margins of the component.Options to scale the image Media object that is displayed inside the component.The keyboard shortcut that activates this component.The name of the component.Enables an element to resize based on its content and/or move when printing.Flag that tells if the component should be printed or not when the form is printed.The cursor that is shown as the mouse is rolled over the component.The roll over image Media object used.When set, the element will show the clicked state when selected.When set the text of an element will showfocus when selected.The width and height (in pixels), separated by a comma.The name of the style class that should be applied to this component.An index that specifies the position of the component in the tab sequence.The text that is displayed inside the component.The rotation of the element.The text displayed when hovering over the component with a mouse cursor.Flag that tells if the component is transparent or not.The vertical alignment of the text inside the component.The visible property of the component, default true.

servoy sSummary12%30%58%height: 30px;3Event SummaryThe method that is executed when the component is clicked.The method that is executed when the component is double clicked.The method that is executed when the component is rendered.The method that is executed when the component is right clicked.

propertyservoy sDetail2100%height:30px2Property Detailsanchorsname

anchors

dessIndentEnables 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.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow backgroundname

background

dessIndentThe background color of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
borderTypename

borderType

dessIndentThe type, color and style of border of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
dataProvidername

dataProvider

dessIndentThe dataprovider of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
designTimePropertiesname

designTimeProperties

dessIndentProperty to get and add design-time properties for a component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
displaysTagsname

displaysTags

dessIndentFlag 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.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
enabledname

enabled

dessIndentThe enable state of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
fontTypename

fontType

dessIndentThe font type of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
foregroundname

foreground

dessIndentThe foreground color of the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
formIndexname

formIndex

dessIndentForm index returns the z-index of the form element. If two elements overlap, then the element with higher Z index is displayed above the form element with lower Z index. In case of form inheritance, form index is evaluated in the context (form) where property is defined. Elements which have child form as context will always be on top of elements which have parent form. If element is overridden in child form but form index property is still inherited its context is still parent form.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow 
formatname

format

dessIndentThe format that should be applied when displaying data(using dataProviderID) in the label/button.

Table Row (tr)
id
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
horizontalAlignmentname

horizontalAlignment

dessIndentHorizontal 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
Table Row (tr)id of the component inside the form.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
Table Row (tr)idSmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
imageMedianame

imageMedia

dessIndentThe image Media object that should be displayed inside the component.
tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
labelForname

labelFor

dessIndentSome 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
Table Row (tr)id can be used to set the focus to fields.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
Table Row (tr)idSmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
locationname

location

dessIndentThe x and y position of the component, in pixels, separated by a comma.
tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
marginname

margin

dessIndentThe margins of the component. They are specified in this order,

Table Row (tr)id separated by commas: top, left, bottom, right.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
mediaOptionsname

mediaOptions

dessIndentOptions 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
Table Row (tr)id the image this will result in only a part of the image showing up.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
mnemonicname

mnemonic

dessIndentThe 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
Table Row (tr)id label this component is.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
Table Row (tr)idSmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
namename

name

dessIndentThe name of the component. Through this name it can also accessed in methods.
tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
printSlidingname

printSliding

dessIndentEnables 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
Table Row (tr)id components.tdret

Returns

divsIndentclients

class

Supported Clients

sIndentSmartClient,WebClient
sam

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

Sample

sIdentjavascript
lastDetailRow 
printablename

printable

dessIndentFlag that tells if the component should be printed or not when the form is printed.
Table Row (tr)id By default components are printable.tdret

Returns

divsIndentclients

class

Supported Clients

sIndentSmartClient,WebClient
sam

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

Sample

sIdentjavascript
lastDetailRow 
rolloverCursorname

rolloverCursor

dessIndentThe cursor that is shown as the mouse is rolled over the component.

Table Row (tr)id Possible options are DEFAULT and HAND. Note that roll over cursor is not supported in Smart client for list view and tableview forms.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
rolloverImageMedianame

rolloverImageMedia

dessIndentThe 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
Table Row (tr)id displayed will be restored. Note that roll over image is not supported in Smart client for list view and tableview forms.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
showClickname

showClick

dessIndentWhen set, the element will show the clicked state when selected.

Table Row (tr)id Applies to labels and buttons and images only.tdret

Returns

divsIndentclients

class

Supported Clients

sIndent
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
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow 
showFocusname

showFocus

dessIndentWhen 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
Table Row (tr)id on the operating system being used and the selected LAF.tdret

Returns

divsIndentclients

class

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) 

Supported Clients

sIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
SmartClient,WebClient,NGClientsam

Sample

sIdentjavascript
lastDetailRow&nbsp;
sizename

size

dessIndentThe width and height (in pixels), separated by a comma.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
styleClassname

styleClass

dessIndentThe 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.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
tabSeqname

tabSeq

dessIndentAn 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.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
textname

text

dessIndentThe text that is displayed inside the component.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
textRotationname

textRotation

dessIndentThe 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.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
toolTipTextname

toolTipText

dessIndentThe 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>ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
transparentname

transparent

dessIndentFlag that tells if the component is transparent or not. The default value is "false", that is the components are not transparent.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
verticalAlignmentname

verticalAlignment

dessIndentThe 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.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
visiblename

visible

dessIndentThe visible property of the component, default true.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;

eventservoy sDetail2100%height:30px2Event DetailsonActionname

onAction()

dessIndentThe method that is executed when the component is clicked.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
onDoubleClickname

onDoubleClick(event)

dessIndentThe method that is executed when the component is double clicked.prs

Parameters

sIndenteventthe event that triggered the action
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
onRendername

onRender()

dessIndentThe method that is executed when the component is rendered.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;
onRightClickname

onRightClick()

dessIndentThe method that is executed when the component is right clicked.ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow&nbsp;