Child pages
  • RadioButtons

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay: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 Table
id
classservoy 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)
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
classservoy 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)
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
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)
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)
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
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)
idonDataChange-__JSEvent
Table Row (tr)
idname
Table Cell (td)

onDataChange

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Method that is executed when the data in the component is successfully changed.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
oldValue - old value
newValue - new value
{JSEvent} event - the event that triggered the action
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonFocusGained-JSEvent
Table Row (tr)
idname
Table Cell (td)

onFocusGained

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component gains focus.
NOTE: Do not call methods that will influence the focus itself.
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)
idonFocusLost-JSEvent
Table Row (tr)
idname
Table Cell (td)

onFocusLost

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The method that is executed when the component looses focus.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{JSEvent} event - the event that triggered the action
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idonRender
Table Row (tr)
idname
Table Cell (td)

onRender

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

onRightClick

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



HTML Table
idproperty
classservoy sDetail
Colgroup Tag
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)
iddisplayType
Table Row (tr)
idname
Table Cell (td)

displayType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
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)
ideditable
Table Row (tr)
idname
Table Cell (td)

editable

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idenabled
Table Row (tr)
idname
Table Cell (td)

enabled

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The enable state of the component, default true.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean - enabled state
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idfontType
Table Row (tr)
idname
Table Cell (td)

fontType

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The font type of the component.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idforeground
Table Row (tr)
idname
Table Cell (td)

foreground

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The foreground color of the component.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idformIndex
Table Row (tr)
idname
Table Cell (td)

formIndex

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idformat
Table Row (tr)
idname
Table Cell (td)

format

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The format that should be applied when displaying 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.
This property is applicable only for types: TEXT_FIELD, COMBOBOX, TYPE_AHEAD, CALENDAR and SPINNER.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idhorizontalAlignment
Table Row (tr)
idname
Table Cell (td)

horizontalAlignment

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idlocation
Table Row (tr)
idname
Table Cell (td)

location

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The x and y position of the component, in pixels, separated by a comma.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idmargin
Table Row (tr)
idname
Table Cell (td)

margin

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

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idname
Table Row (tr)
idname
Table Cell (td)

name

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

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprintSliding
Table Row (tr)
idname
Table Cell (td)

printSliding

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

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idprintable
Table Row (tr)
idname
Table Cell (td)

printable

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

By default components are printable.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Boolean
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idscrollbars
Table Row (tr)
idname
Table Cell (td)

scrollbars

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
idret
Table Cell (td)

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsize
Table Row (tr)
idname
Table Cell (td)

size

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
The width and height (in pixels), separated by a comma.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idstyleClass
Table Row (tr)
idname
Table Cell (td)

styleClass

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtabSeq
Table Row (tr)
idname
Table Cell (td)

tabSeq

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

Returns

Div
classsIndent
Number
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idtitleText
Table Row (tr)
idname
Table Cell (td)

titleText

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Header text to component
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String
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)
idvaluelist
Table Row (tr)
idname
Table Cell (td)

valuelist

Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
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)