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 format
The format that should be applied when displaying the data in the component.
String location
The x and y position of the component, in pixels, separated by a comma.
String name
The name of the component.
String placeholderText
The text that is displayed in field when the field doesn't have a text value.
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
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
 

format

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.

Returns

 

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

 

placeholderText

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

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

 

visible

The visible property of the component, default true.

Returns

Boolean - visible property
 



  • No labels