Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Event Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)

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

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)

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

Table Body (tbody)

Table Row (tr)

Table Cell (td)

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

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Property Summary

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#background The background color of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#borderType The type, color and style of border of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#dataProvider The dataprovider of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

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

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#editable Flag that tells if the content of the field can be edited or not.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#enabled The enable state of the component, default true.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#fontType The font type of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#foreground The foreground color of the component.

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#horizontalAlignment Horizontal alignment of the text inside the component.

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#margin The margins of the component.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

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

Table Body (tbody)

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 Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#scrollbars Scrollbar options for the vertical and horizontal scrollbars.

Table Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#size The width and height (in pixels), separated by a comma.

Table Body (tbody)

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 Body (tbody)

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 Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#text The text that is displayed in the column header associated with the component when the form is in table view.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#toolTipText The text displayed when hovering over the component with a mouse cursor.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#transparent Flag that tells if the component is transparent or not.

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
#valuelist The valuelist that is used by this field when displaying data.

Table Body (tbody)

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

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Event Details

Table Body (tbody)

id	onAction
class	node

Table Row (tr)

id	name

Table Cell (td)
onAction

Table Row (tr)

id	des

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

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onDataChange
class	node

Table Row (tr)

id	name

Table Cell (td)
onDataChange

Table Row (tr)

id	des

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

Table Row (tr)

id	prs

Table Cell (td)
Parameters {JSEvent} event – the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onFocusGained
class	node

Table Row (tr)

id	name

Table Cell (td)
onFocusGained

Table Row (tr)

id	des

Table Cell (td)
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 {JSEvent} event – the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onFocusLost
class	node

Table Row (tr)

id	name

Table Cell (td)
onFocusLost

Table Row (tr)

id	des

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

Table Row (tr)

id	prs

Table Cell (td)
Parameters {JSEvent} event – the event that triggered the action

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRender
class	node

Table Row (tr)

id	name

Table Cell (td)
onRender

Table Row (tr)

id	des

Table Cell (td)
The method that is executed when the component is rendered.

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	onRightClick
class	node

Table Row (tr)

id	name

Table Cell (td)
onRightClick

Table Row (tr)

id	des

Table Cell (td)
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

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Property Details

Table Body (tbody)

id	anchors
class	node

Table Row (tr)

id	name

Table Cell (td)
anchors

Table Row (tr)

id	des

Table Cell (td)

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 Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	background
class	node

Table Row (tr)

id	name

Table Cell (td)
background

Table Row (tr)

id	des

Table Cell (td)
The background color of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	borderType
class	node

Table Row (tr)

id	name

Table Cell (td)
borderType

Table Row (tr)

id	des

Table Cell (td)
The type, color and style of border of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	dataProvider
class	node

Table Row (tr)

id	name

Table Cell (td)
dataProvider

Table Row (tr)

id	des

Table Cell (td)
The dataprovider of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	displayType
class	node

Table Row (tr)

id	name

Table Cell (td)
displayType

Table Row (tr)

id	des

Table Cell (td)
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 or TYPE_AHEAD.

Table Row (tr)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	displaysTags
class	node

Table Row (tr)

id	name

Table Cell (td)
displaysTags

Table Row (tr)

id	des

Table Cell (td)

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 Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	editable
class	node

Table Row (tr)

id	name

Table Cell (td)
editable

Table Row (tr)

id	des

Table Cell (td)
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 Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	enabled
class	node

Table Row (tr)

id	name

Table Cell (td)
enabled

Table Row (tr)

id	des

Table Cell (td)
The enable state of the component, default true.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	fontType
class	node

Table Row (tr)

id	name

Table Cell (td)
fontType

Table Row (tr)

id	des

Table Cell (td)
The font type of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	foreground
class	node

Table Row (tr)

id	name

Table Cell (td)
foreground

Table Row (tr)

id	des

Table Cell (td)
The foreground color of the component.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	format
class	node

Table Row (tr)

id	name

Table Cell (td)
format

Table Row (tr)

id	des

Table Cell (td)
The format that should be applied when displaying the data in the component. Some examples are "#%", "dd-MM-yyyy", "MM-dd-yyyy", etc.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	horizontalAlignment
class	node

Table Row (tr)

id	name

Table Cell (td)
horizontalAlignment

Table Row (tr)

id	des

Table Cell (td)

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)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	location
class	node

Table Row (tr)

id	name

Table Cell (td)
location

Table Row (tr)

id	des

Table Cell (td)
The x and y position of the component, in pixels, separated by a comma.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	margin
class	node

Table Row (tr)

id	name

Table Cell (td)
margin

Table Row (tr)

id	des

Table Cell (td)
The margins of the component. They are specified in this order, separated by commas: top, right, bottom, left.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	name
class	node

Table Row (tr)

id	name

Table Cell (td)
name

Table Row (tr)

id	des

Table Cell (td)
The name of the component. Through this name it can also accessed in methods.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printSliding
class	node

Table Row (tr)

id	name

Table Cell (td)
printSliding

Table Row (tr)

id	des

Table Cell (td)
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)

id	ret

Table Cell (td)
Returns Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	printable
class	node

Table Row (tr)

id	name

Table Cell (td)
printable

Table Row (tr)

id	des

Table Cell (td)

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

By default components are printable.

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	scrollbars
class	node

Table Row (tr)

id	name

Table Cell (td)
scrollbars

Table Row (tr)

id	des

Table Cell (td)
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

Table Cell (td)
Returns Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	selectOnEnter
class	node

Table Row (tr)

id	name

Table Cell (td)
selectOnEnter

Table Row (tr)

id	des

Table Cell (td)
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 Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	size
class	node

Table Row (tr)

id	name

Table Cell (td)
size

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	styleClass
class	node

Table Row (tr)

id	name

Table Cell (td)
styleClass

Table Row (tr)

id	des

Table Cell (td)

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 String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	tabSeq
class	node

Table Row (tr)

id	name

Table Cell (td)
tabSeq

Table Row (tr)

id	des

Table Cell (td)
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 Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	text
class	node

Table Row (tr)

id	name

Table Cell (td)
text

Table Row (tr)

id	des

Table Cell (td)
The text that is displayed in the column header associated with the component when the form is in table view.

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	toolTipText
class	node

Table Row (tr)

id	name

Table Cell (td)
toolTipText

Table Row (tr)

id	des

Table Cell (td)

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)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	transparent
class	node

Table Row (tr)

id	name

Table Cell (td)
transparent

Table Row (tr)

id	des

Table Cell (td)

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 Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	valuelist
class	node

Table Row (tr)

id	name

Table Cell (td)
valuelist

Table Row (tr)

id	des

Table Cell (td)
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 Number

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	visible
class	node

Table Row (tr)

id	name

Table Cell (td)
visible

Table Row (tr)

id	des

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

Table Row (tr)

id	ret

Table Cell (td)
Returns Boolean

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 16

New Version Current

Key

onAction

onDataChange

onFocusGained

onFocusLost

onRender

onRightClick

anchors

background

borderType

dataProvider

displayType

displaysTags

editable

enabled

fontType

foreground

format

horizontalAlignment

location

margin

name

printSliding

printable

scrollbars

selectOnEnter

size

styleClass

tabSeq

text

toolTipText

transparent

valuelist

visible