Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClient

servoy sReturnTypes2100%height: 30px;2ExtendssWordListBLOCK

servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.Constant for specifying the display type of a JSField.

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.CSS position is a replacement for anchoring system making it more intuitive to place a component.The dataprovider of the 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.The Z index of this component.The format that should be applied when displaying the data in the component.A String representing a group ID for this component.The height in pixels of the component.Horizontal alignment of the text inside the component.The margins of the component.The name of the component.The 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.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 should be automatically selected when the field receives focus.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 in the column header associated with the component when the form is in table view.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.The width in pixels of the component.The x coordinate of the component on the form.The y coordinate of the component on the form.

servoy sSummary12%30%58%height: 30px;3Methods SummaryGet the value of an attribute of the element.Returns the attribute names of an element.Get a design-time property of an element.Get the design-time properties of an element.Returns the name of the form.Returns the UUID of this component.Set a design-time property of an element.Remove the attribute of an element.Clear a design-time property of an element.voidSet the attribute value of an element.

constantservoy sDetail2100%height:30px2Constants DetailsCALENDARname

CALENDAR

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the 
field to calendar. The field will show a formatted date and will have a button which
pops up a calendar for date selection.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRowCHECKSname

CHECKS

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to checkbox. The field will show a checkbox, or a list of checkboxes if the valuelist
property is also set.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
COMBOBOXname

COMBOBOX

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to combobox.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
HTML_AREAname

HTML_AREA

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to HTML area. The field will display formatted HTML content.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
IMAGE_MEDIAname

IMAGE_MEDIA

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to image. The field will display images.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
LISTBOXname

LISTBOX

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to list box. The field will show a selection list with single choice selection.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
MULTISELECT_LISTBOXname

MULTISELECT_LISTBOX

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to list box. The field will show a selection list with multiple choice selection.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
PASSWORDname

PASSWORD

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
fiels to password. The field will allow the user to enter passwords, masking the typed
characters.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
RADIOSname

RADIOS

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to radio buttons. The field will show a radio button, or a list of them if 
the valuelist property is also set.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
RTF_AREAname

RTF_AREA

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the 
field to RTF area. The field will display formatted RTF content.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
SPINNERname

SPINNER

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to spinner. The field will show a spinner.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
TEXT_AREAname

TEXT_AREA

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to text area. The field will show text on multiple lines.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
TEXT_FIELDname

TEXT_FIELD

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to text field. The field will show regular text on a single line.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
TYPE_AHEADname

TYPE_AHEAD

dessIndent
Constant for specifying the display type of a JSField. Sets the display type of the
field to type ahead. The field will show regular text, but will have type ahead 
capabilities.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow

propertyservoy sDetail2100%height:30px2Property Detailsanchorsname

anchors

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowbackgroundname

background

dessIndent
The background color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
borderTypename

borderType

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
cssPositionname

cssPosition

dessIndent
CSS position is a replacement for anchoring system making it more intuitive to place a component.
CSS position should be set on form, an absolute position form can either work with anchoring or with css position.
This is only working in NGClient.
ret

Returns

sIndent
clients

Supported Clients

sIndentNGClient
sam

Sample

sIdentjavascript
lastDetailRow
dataProviderIDname

dataProviderID

dessIndent
The dataprovider of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
displayTypename

displayType

dessIndent
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

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
displaysTagsname

displaysTags

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
editablename

editable

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
enabledname

enabled

dessIndent
The enable state of the component, default true.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
fontTypename

fontType

dessIndent
The font type of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
foregroundname

foreground

dessIndent
The foreground color of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formIndexname

formIndex

dessIndent
The Z index of this component. If two components overlap,
then the component with higher Z index is displayed above
the component with lower Z index.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
formatname

format

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
groupIDname

groupID

dessIndent
A String representing a group ID for this component. If several
components have the same group ID then they belong to the same
group of components. Using the group itself, all components can
be disabled/enabled or made invisible/visible.
The group id should be a javascript compatible identifier to allow access of the group in scripting.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
heightname

height

dessIndent
The height in pixels of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
horizontalAlignmentname

horizontalAlignment

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
marginname

margin

dessIndent
The margins of the component. They are specified in this order, 
separated by commas: top, left, bottom, right.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
namename

name

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onActionname

onAction

dessIndent
The method that is executed when the component is clicked.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onDataChangename

onDataChange

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
onFocusGainedname

onFocusGained

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onFocusLostname

onFocusLost

dessIndent
The method that is executed when the component looses focus.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
onRendername

onRender

dessIndent
The method that is executed when the component is rendered.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
onRightClickname

onRightClick

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
placeholderTextname

placeholderText

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
printSlidingname

printSliding

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
printablename

printable

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

By default components are printable.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient
sam

Sample

sIdentjavascript
lastDetailRow
scrollbarsname

scrollbars

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
selectOnEntername

selectOnEnter

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
styleClassname

styleClass

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
tabSeqname

tabSeq

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
titleTextname

titleText

dessIndent
The text that is displayed in the column header associated with the component when the form
is in table view.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
toolTipTextname

toolTipText

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

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
transparentname

transparent

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
valuelistname

valuelist

dessIndent
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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
visiblename

visible

dessIndent
The visible property of the component, default true.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
widthname

width

dessIndent
The width in pixels of the component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
xname

x

dessIndent
The x coordinate of the component on the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow
yname

y

dessIndent
The y coordinate of the component on the form.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient,MobileClient
sam

Sample

sIdentjavascript
lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetAttributename

getAttribute(name)

dessIndent
Get the value of an attribute of the element.
prs

Parameters

sIndentnamethe name of the attribute
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowgetAttributesname

getAttributes()

dessIndent
Returns the attribute names of an element.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyname

getDesignTimeProperty(key)

dessIndent
Get a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getDesignTimePropertyNamesname

getDesignTimePropertyNames()

dessIndent
Get the design-time properties of an element.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getFormNamename

getFormName()

dessIndent
Returns the name of the form. (may be empty string as well)
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getUUIDname

getUUID()

dessIndent
Returns the UUID of this component.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
putDesignTimePropertyname

putDesignTimeProperty(key, value)

dessIndent
Set a design-time property of an element.
prs

Parameters

sIndentkeythe name of the propertyvaluethe value to store
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeAttributename

removeAttribute(name)

dessIndent
Remove the attribute of an element.
prs

Parameters

sIndentnamethe name of the attribute
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
removeDesignTimePropertyname

removeDesignTimeProperty(key)

dessIndent
Clear a design-time property of an element.
prs

Parameters

sIndentkeythe name of the property
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setAttributename

setAttribute(name, value)

dessIndent
Set the attribute value of an element.
prs

Parameters

sIndentnamethe name of the attributevaluethe value of the attribute
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow