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.
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.
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.
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
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.
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)
true
refresh
100d
showRefresh
true
id
doc
title
Refresh page
showDate
true
retry
Enable
servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClientsWordListMobileClientservoy 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.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.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 componentThe 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
dessIndentEnables a component to stick to a specific side of form and/or to grow or shrink when a window is resized. If opposite anchors are activated then the component with grow or shrink with the window. For example if Top and Bottom are activated, then the component will grow/shrink when the window is vertically resized. If Left and Right are activated then the component will grow/shrink when the window is horizontally resized. If opposite anchors are not activated, then the component will keep a constant distance from the sides of the window which correspond to the activated anchors.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow backgroundname
background
dessIndentThe background color of the component.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow borderTypename
borderType
dessIndentThe type, color and style of border of the component.ret
dessIndentThe 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
dessIndentFlag that enables or disables merging of data inside components using tags (placeholders). Tags (or placeholders) are words surrounded by %% on each side. There are data tags and standard tags. Data tags consist in names of dataproviders surrounded by %%. Standard tags are a set of predefined tags that are made available by the system. See the "Merging data" section for more details about tags. The default value of this flag is "false", that is merging of data is disabled by default.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow editablename
editable
dessIndentFlag 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
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow enabledname
enabled
dessIndentThe enable state of the component, default true.ret
dessIndentThe foreground color of the component.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow formIndexname
formIndex
dessIndentForm index returns the z-index of the form element. If two elements overlap, then the element with higher Z index is displayed above the form element with lower Z index. In case of form inheritance, form index is evaluated in the context (form) where property is defined. Elements which have child form as context will always be on top of elements which have parent form. If element is overridden in child form but form index property is still inherited its context is still parent form.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow formatname
format
dessIndentThe 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.rettd
dessIndentHorizontal alignment of the text inside the component. Can be one of LEFT, CENTER or RIGHT. Note that this property does not refer to the horizontal alignment
dessIndentEnables an element to resize based on its content and/or move when printing. The component can move horizontally or vertically and can grow or shrink in height and width, based on its content and the content of neighboring
dessIndentScrollbar 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
tddisplay.ret
Returns
divsIndentclientsclass
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.
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.
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.
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>
dessIndentThe width and height (in pixels), separated by a comma.ret
Returns
sIndentclients
Supported Clients
sIndentSmartClient,WebClient,NGClientsam
Sample
sIdentjavascriptlastDetailRow styleClassname
styleClass
dessIndentThe name of the style class that should be applied to this component. When defining style classes for specific component types, their names must be prefixed according to the type of the component. For example in order to define a class names 'fancy' for fields, in the style definition the class must be named 'field.fancy'. If it would be intended for labels, then it would be named 'label.fancy'. When specifying the class name for a component, the prefix is dropped however. Thus the field or the label will have its styleClass property set to 'fancy' only.ret
dessIndentAn index that specifies the position of the component in the tab sequence. The components are put into the tab sequence in increasing order of this property. A value of 0 means to use the default mechanism of building the tab sequence (based on their location on the form). A value of -2 means to remove the component from the tab sequence.ret
dessIndentFlag 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
dessIndentThe text displayed when hovering over the component with a mouse cursor. NOTE: HTML should be used for multi-line tooltips; you can also use any valid HTML tags to format tooltip text. For example: <html>This includes<b>bolded text</b> and <font color='blue'>BLUE</font> text as well.</html>ret