Page History

{div:style=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.\\		\\		Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div}
{div:id=description}{div}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Event Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#onDataChange]
Method that is executed when the data in the component is successfully changed.{td}{tr}{tbody}{table}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Property Summary{th}{tr}{tbody}{tr}{td}[String]{td}{td}[#dataProvider]
The dataprovider of the component.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#displayType]
The type of display used by the field.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#enabled]
The enable state of the component, default true.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#horizontal]
Show the radios as horizontal or vertical set.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#location]
The x and y position of the component, in pixels, separated by a comma.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#name]
The name of the component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#styleClass]
The name of the style class that should be applied to this component.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#titleDataProvider]
Dataprovider for header text to field component{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#titleDisplaysTags]
Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#titleText]
Header text to component{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#valuelist]
The valuelist that is used by this field when displaying data.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]{td}{td}[#visible]
The visible property of the component, default true.{td}{tr}{tbody}{table}\\ 

{table:id=event|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Event Details{th}{tr}{tbody:id=onDataChange-__JSEvent}{tr:id=name}{td}h6.onDataChange{td}{tr}{tr:id=des}{td}{div:class=sIndent}Method that is executed when the data in the component is successfully changed.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}oldValue -- old value
newValue -- new value
\{[JSEvent]} event -- the event that triggered the action
{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}\\ 

{table:id=property|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Property Details{th}{tr}{tbody:id=dataProvider}{tr:id=name}{td}h6.dataProvider{td}{tr}{tr:id=des}{td}{div:class=sIndent}The dataprovider of the component.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=displayType}{tr:id=name}{td}h6.displayType{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=enabled}{tr:id=name}{td}h6.enabled{td}{tr}{tr:id=des}{td}{div:class=sIndent}The enable state of the component, default true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- enabled state{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=horizontal}{tr:id=name}{td}h6.horizontal{td}{tr}{tr:id=des}{td}{div:class=sIndent}Show the radios as horizontal or vertical set.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=location}{tr:id=name}{td}h6.location{td}{tr}{tr:id=des}{td}{div:class=sIndent}The x and y position of the component, in pixels, separated by a comma.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=name}{tr:id=name}{td}h6.name{td}{tr}{tr:id=des}{td}{div:class=sIndent}The name of the component. Through this name it can also accessed in methods.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=styleClass}{tr:id=name}{td}h6.styleClass{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleDataProvider}{tr:id=name}{td}h6.titleDataProvider{td}{tr}{tr:id=des}{td}{div:class=sIndent}Dataprovider for header text to field component{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleDisplaysTags}{tr:id=name}{td}h6.titleDisplaysTags{td}{tr}{tr:id=des}{td}{div:class=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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=titleText}{tr:id=name}{td}h6.titleText{td}{tr}{tr:id=des}{td}{div:class=sIndent}Header text to component{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=valuelist}{tr:id=name}{td}h6.valuelist{td}{tr}{tr:id=des}{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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number]{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=visible}{tr:id=name}{td}h6.visible{td}{tr}{tr:id=des}{td}{div:class=sIndent}The visible property of the component, default true.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Boolean] -- visible property{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}