Skip to end of metadata
Go to start of metadata



Event Summary
  onAction
The method that is executed when the component is clicked.
Boolean onDataChange
Method that is executed when the data in the component is successfully changed.



Property Summary
String dataProvider
The dataprovider of the component.
Number displayType
The type of display used by the field.
Boolean enabled
The enable state of the component, default true.
String location
The x and y position of the component, in pixels, separated by a comma.
String name
The name of the component.
String styleClass
The name of the style class that should be applied to this component.
String titleDataProvider
Dataprovider for header text to field component
Boolean titleDisplaysTags
Flag for header text to field component that enables or disables merging of data inside components using tags (placeholders).
String titleText
Header text to component
Number valuelist
The valuelist that is used by this field when displaying data.
Boolean visible
The visible property of the component, default true.



Event Details

onAction

The method that is executed when the component is clicked.
 

onDataChange

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

Parameters

oldValue - old value
newValue - new value
{JSEvent} event - the event that triggered the action

Returns

 



Property Details

dataProvider

The dataprovider of the component.

Returns

 

displayType

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.

Returns

 

enabled

The enable state of the component, default true.

Returns

Boolean - enabled state
 

location

The x and y position of the component, in pixels, separated by a comma.

Returns

 

name

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

Returns

 

styleClass

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.

Returns

 

titleDataProvider

Dataprovider for header text to field component

Returns

 

titleDisplaysTags

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.

Returns

 

titleText

Header text to component

Returns

 

valuelist

The valuelist that is used by this field when displaying data. Can be used
with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD.

Returns

 

visible

The visible property of the component, default true.

Returns

Boolean - visible property
 



  • No labels