Page History

Divcache

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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)
Boolean

Table Cell (td)
onDataChange Method that is executed when the data in the component is successfully changed.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onFocusGained The method that is executed when the component gains focus.

Table Row (tr)

Table Cell (td)

Table Cell (td)
onFocusLost The method that is executed when the component looses focus.

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 Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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)
Number

Table Cell (td)
displayType The type of display used by the field.

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)editable

indexstyle	true	display: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.

refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

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.The type of display used by the field.Flag that enables or disables merging of data inside components using tags (placeholders).Flag that tells if the content of the field can be edited or not.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 the data in the component.Horizontal alignment of the text inside the component.The x and y position of the component, in pixels, separated by a comma.The margins of the component.The name of the component.The text that is displayed in field when the field doesn't have a text value.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.Scrollbar options for the vertical and horizontal scrollbars.Flag that tells if the content of the field can be edited or not.

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 the data in the component.

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)
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)
String

Table Cell (td)
name The name of the component.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
placeholderText The text that is displayed in field when the field doesn't have a text value.

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)
scrollbars Scrollbar options for the vertical and horizontal scrollbars.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
selectOnEnter Flag that tells if the content of the field should be automatically selected when the field receives focus.

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)
titleText Header text to component

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)
valuelist The valuelist that is used by this field when displaying data.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
visible The visible property of the component, default true.

HTML Table

id	event
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Details

Table Body (tbody)

id	onAction

Table Row (tr)

id	name

Table Cell (td)
onAction

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is clicked.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDataChange-__JSEvent

Table Row (tr)

id	name

Table Cell (td)
onDataChange

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Method that is executed when the data in the component is successfully changed.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

oldValue - old value
newValue - new value
{JSEvent} event - the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onFocusGained-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onFocusGained

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component gains focus.
NOTE: Do not call methods that will influence the focus itself.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onFocusLost-JSEvent

Table Row (tr)

id	name

Table Cell (td)
onFocusLost

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component looses focus.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSEvent} event - the event that triggered the action

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is rendered.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRightClick

Table Row (tr)

id	name

Table Cell (td)
onRightClick

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The method that is executed when the component is right clicked.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	property
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Details

Table Body (tbody)

id	anchors

Table Row (tr)

id	name

Table Cell (td)
anchors

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The background color of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	borderType

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type, color and style of border of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataProvider

Table Row (tr)

id	name

Table Cell (td)
dataProvider

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The dataprovider of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	designTimeProperties

Table Row (tr)

id	name

Table Cell (td)
designTimeProperties

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object - map of the design-time properties

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	displayType

Table Row (tr)

id	name

Table Cell (td)
displayType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The type of display used by the field. Can be one of CALENDAR, CHECKS,
COMBOBOX, HTML_AREA, IMAGE_MEDIA, PASSWORD, RADIOS, RTF_AREA, TEXT_AREA,
TEXT_FIELD, TYPE_AHEAD, LIST_BOX, MULTISELECT_LISTBOX or SPINNER.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	displaysTags

Table Row (tr)

id	name

Table Cell (td)
displaysTags

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	editable

Table Row (tr)

id	name

Table Cell (td)
editable

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the content of the field can be edited or not.
The default value of this flag is "true", that is the content can be edited.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The enable state of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - enabled state

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	fontType

Table Row (tr)

id	name

Table Cell (td)
fontType

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The font type of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	foreground

Table Row (tr)

id	name

Table Cell (td)
foreground

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The foreground color of the component.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	formIndex

Table Row (tr)

id	name

Table Cell (td)
formIndex

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	format

Table Row (tr)

id	name

Table Cell (td)
format

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

should be automatically selected when the field receives focus.

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.

Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).

Header text to component

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

Flag that tells if the component is transparent or not.

The valuelist that is used by this field when displaying data.

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.Method that is executed when the data in the component is successfully changed.The method that is executed when the component gains focus.The method that is executed when the component looses focus.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

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

background

name

background

des

sIndent

The background color of the component.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

borderType

name

borderType

des

sIndent

The type, color and style of border of the component.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

dataProvider

name

dataProvider

des

sIndent

The dataprovider of the component.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

designTimeProperties

name

designTimeProperties

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

displayType

name

displayType

des

sIndent

The type of display used by the field. Can be one of CALENDAR, CHECKS, COMBOBOX, HTML_AREA, IMAGE_MEDIA, PASSWORD, RADIOS, RTF_AREA, TEXT_AREA, TEXT_FIELD, TYPE_AHEAD, LIST_BOX, MULTISELECT_LISTBOX or SPINNER.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

displaysTags

name

displaysTags

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

editable

name

editable

des

sIndent

Flag that tells if the content of the field can be edited or not. The default value of this flag is "true", that is the content can be edited.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

enabled

name

enabled

des

sIndent

The enable state of the component, default true.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

fontType

name

fontType

des

sIndent

The font type of the component.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

foreground

name

foreground

des

sIndent

The foreground color of the component.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

formIndex

name

formIndex

des

sIndent

Form 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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

format

name

format

des

sIndent

The format that should be applied when displaying the data in the component.

There are different options for the different dataprovider types that are assigned to this field.

For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html and the max (string) length can be set.

For Text/String fields, there are options to force uppercase,lowercase or only numbers. Or a mask can be set that restrict the input the pattern chars can be found here: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html

A mask can have a placehoder (what is shown when there is no data) and if the data must be stored raw (without literals of the mask). A max text length can also be set to force

the max text length input, this doesn't work on mask because that max length is controlled with the mask.

For Date fields a display and edit format can be set by using a pattern from here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html, you can also say this must behave like a mask (the edit format)

A mask only works with when the edit format is exactly that mask (1 char is 1 number/char), because for example MM then only 2 numbers are allowed MMM that displays the month as a string is not supported as a mask.

Some examples are "dd-MM-yyyy", "MM-dd-yyyy", etc.

The format property is also used to set the UI Converter, this means that you can convert the value object to something else before it gets set into the field, this can also result in a type change of the data.

So a string in scripting/db is converted to a integer in the ui, then you have to set an integer format.

Table Row (tr)id

This property is applicable only for types: TEXT_FIELD, COMBOBOX, TYPE_AHEAD, CALENDAR and SPINNER.

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	horizontalAlignment

Table Row (tr)

id	name

Table Cell (td)
horizontalAlignment

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

horizontalAlignment

name

horizontalAlignment

des

sIndent

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

Table Row (tr)id

of the component inside the form.

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	location

Table Row (tr)

id	name

Table Cell (td)
location

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

location

name

location

des

sIndent

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

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	margin

Table Row (tr)

id	name

Table Cell (td)
margin

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

margin

name

margin

des

sIndent

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

Table Row (tr)id

separated by commas: top, left, bottom, right.

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

name

des

sIndent

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

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	placeholderText

Table Row (tr)

id	name

Table Cell (td)
placeholderText

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Table Row (tr)id

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

placeholderText

name

placeholderText

des

sIndent

The text that is displayed in field when the field doesn't have a text value.

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printSliding

Table Row (tr)

id	name

Table Cell (td)
printSliding

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

printSliding

name

printSliding

des

sIndent

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

Table Row (tr)id

components.

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

SmartClient,WebClient

sam

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printable

Table Row (tr)

id	name

Table Cell (td)
printable

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Sample

sIdent

javascript

lastDetailRow

printable

name

printable

des

sIndent

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

Table Row (tr)id

By default components are printable.

td

ret

Returns

div

sIndent

clients

class

Supported Clients

sIndent

SmartClient,WebClient

sam

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	scrollbars

Table Row (tr)

id	name

Table Cell (td)
scrollbars

Table Row (tr)

id	des

Table Cell (td) Div

class	sIndent

Sample

sIdent

javascript

lastDetailRow

scrollbars

name

scrollbars

des

sIndent

Scrollbar options for the vertical and horizontal scrollbars. Each of the

vertical and horizontal scrollbars can be configured to display all the time,

to display only when needed or to never display

. Table Row (tr)

id	ret

td

.

ret

Returns

div

sIndent

clients

class

Table Body (tbody)

id	selectOnEnter

Table Row (tr)

id	name

Table Cell (td)
selectOnEnter

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Flag that tells if the content of the field should be automatically selected
when the field receives focus. The default value of this field is "false".

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tabSeq

Table Row (tr)

id	name

Table Cell (td)
tabSeq

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	titleText

Table Row (tr)

id	name

Table Cell (td)
titleText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Header text to component

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toolTipText

Table Row (tr)

id	name

Table Cell (td)
toolTipText

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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 includesbolded text and
BLUE text as well.</html>

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	valuelist

Table Row (tr)

id	name

Table Cell (td)
valuelist

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The valuelist that is used by this field when displaying data. Can be used
with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

The visible property of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean - visible property

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Supported Clients

sIndent

Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

selectOnEnter

name

selectOnEnter

des

sIndent

Flag that tells if the content of the field should be automatically selected when the field receives focus. The default value of this field is "false".

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

size

name

size

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

styleClass

name

styleClass

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

tabSeq

name

tabSeq

des

sIndent

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

titleDisplaysTags

name

titleDisplaysTags

des

sIndent

Flag for header text to field component 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

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

titleText

name

titleText

des

sIndent

Header text to component

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

toolTipText

name

toolTipText

des

sIndent

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 includesbolded text and BLUE text as well.</html>

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

transparent

name

transparent

des

sIndent

Flag 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

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

valuelist

name

valuelist

des

sIndent

The valuelist that is used by this field when displaying data. Can be used with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

visible

name

visible

des

sIndent

The visible property of the component, default true.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

eventservoy sDetail2100%height:30px2Event DetailsonActionname

onAction()

des

sIndent

The method that is executed when the component is clicked.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

onDataChange

name

onDataChange(oldValue, newValue, event)

des

sIndent

Method that is executed when the data in the component is successfully changed.

prs

Parameters

sIndent

oldValue

old value

newValue

new value

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient,MobileClient

sam

Sample

sIdent

javascript

lastDetailRow

onFocusGained

name

onFocusGained(event)

des

sIndent

The method that is executed when the component gains focus. NOTE: Do not call methods that will influence the focus itself.

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onFocusLost

name

onFocusLost(event)

des

sIndent

The method that is executed when the component looses focus.

prs

Parameters

sIndent

event

the event that triggered the action

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

onRender

name

onRender()

des

sIndent

The method that is executed when the component is rendered.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient

sam

Sample

sIdent

javascript

lastDetailRow

onRightClick

name

onRightClick()

des

sIndent

The method that is executed when the component is right clicked.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Page History

Versions Compared

Old Version 12

New Version 13

Key

onAction

onDataChange

onFocusGained

onFocusLost

onRender

onRightClick

anchors

background

borderType

dataProvider

designTimeProperties

displayType

displaysTags

editable

enabled

fontType

foreground

formIndex

format

anchors

background

borderType

dataProvider

designTimeProperties

displayType

displaysTags

editable

enabled

fontType

foreground

formIndex

format

horizontalAlignment

horizontalAlignment

location

location

margin

margin

name

name

placeholderText

placeholderText

printSliding

printSliding

printable

printable

scrollbars

scrollbars

selectOnEnter

size

styleClass

tabSeq

titleText

toolTipText

transparent

valuelist

visible

selectOnEnter

size

styleClass

tabSeq

titleDisplaysTags

titleText

toolTipText

transparent

valuelist

visible

onAction()

onDataChange(oldValue, newValue, event)

onFocusGained(event)

onFocusLost(event)

onRender()

onRightClick()