JSField
Extends
Constants Summarized
Properties Summarized
Methods Summarized
Constants Detailed
CALENDAR
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.
Type Number
Sample
CHECKS
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.
Type Number
Sample
COMBOBOX
Constant for specifying the display type of a JSField. Sets the display type of the field to combobox.
Type Number
Sample
HTML_AREA
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.
Type Number
Sample
IMAGE_MEDIA
Constant for specifying the display type of a JSField. Sets the display type of the field to image. The field will display images.
Type Number
Sample
LISTBOX
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.
Type Number
Sample
MULTISELECT_LISTBOX
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.
Type Number
Sample
PASSWORD
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.
Type Number
Sample
RADIOS
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.
Type Number
Sample
RTF_AREA
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.
Type Number
Sample
SPINNER
Constant for specifying the display type of a JSField. Sets the display type of the field to spinner. The field will show a spinner.
Type Number
Sample
TEXT_AREA
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.
Type Number
Sample
TEXT_FIELD
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.
Type Number
Sample
TYPE_AHEAD
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.
Type Number
Sample
Properties Detailed
anchors
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.
Type Number
Sample
background
The background color of the component.
Type String
Sample
borderType
The type, color and style of border of the component.
Type String
Sample
cssPosition
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.
Type CSSPosition
Sample
dataProviderID
The dataprovider of the component.
Type String
Sample
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.
Type Number
Sample
displaysTags
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.
Type Boolean
Sample
editable
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.
Type Boolean
Sample
enabled
The enable state of the component, default true.
Type Boolean
Sample
fontType
The font type of the component.
Type String
Sample
foreground
The foreground color of the component.
Type String
Sample
formIndex
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.
Type Number
Sample
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.
Type String
Sample
groupID
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.
Type String
Sample
height
The height in pixels of the component.
Type Number
Sample
horizontalAlignment
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.
Type Number
Sample
margin
The margins of the component. They are specified in this order, separated by commas: top, left, bottom, right.
Type String
Sample
name
The name of the component. Through this name it can also accessed in methods. Must be a valid javascript name. (no - in the name or start with number)
Type String
Sample
onAction
The method that is executed when the component is clicked.
Type JSMethod
Sample
onDataChange
Method that is executed when the data in the component is successfully changed.
Type JSMethod
Sample