Page History
Cache | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
anchorsEnables 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. Returns Supported Clients Sample backgroundThe background color of the component. Returns Supported Clients Sample borderTypeThe type, color and style of border of the component. Returns Supported Clients Sample dataProviderIDThe dataprovider of the component. Returns Supported Clients Sample displayTypeThe 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 Supported Clients Sample displaysTagsFlag 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 Supported Clients Sample editableFlag 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. Returns Supported Clients Sample enabledReturns Supported Clients Sample fontTypeThe font type of the component. Returns Supported Clients Sample foregroundThe foreground color of the component. Returns Supported Clients Sample formIndexThe 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. Returns Supported Clients Sample formatThe 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 Supported Clients Sample groupIDA 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. Returns Supported Clients Sample heightThe height in pixels of the component. Returns Supported Clients Sample horizontalAlignmentHorizontal 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. Returns Supported Clients Sample marginThe margins of the component. They are specified in this order,
separated by commas: top, left, bottom, right. Returns Supported Clients Sample nameReturns Supported Clients Sample onActionThe method that is executed when the component is clicked. Returns Supported Clients Sample onDataChangeMethod that is executed when the data in the component is successfully changed. Returns Supported Clients Sample onFocusGainedThe method that is executed when the component gains focus.
NOTE: Do not call methods that will influence the focus itself. Returns Supported Clients Sample onFocusLostThe method that is executed when the component looses focus. Returns Supported Clients Sample onRenderThe method that is executed when the component is rendered. Returns Supported Clients Sample onRightClickThe method that is executed when the component is right clicked. Returns Supported Clients Sample placeholderTextThe text that is displayed in field when the field doesn't have a text value. Returns Supported Clients Sample printSlidingEnables 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
components. Returns Supported Clients Sample printableFlag that tells if the component should be printed or not when the form is printed.
By default components are printable. Returns Supported Clients Sample scrollbarsScrollbar 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. Returns Supported Clients Sample selectOnEnterFlag that tells if the content of the field should be automatically selected
when the field receives focus. The default value of this field is "false". Returns Supported Clients Sample styleClassThe 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 Supported Clients Sample tabSeqAn 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. Returns Supported Clients Sample titleTextThe text that is displayed in the column header associated with the component when the form
is in table view. Returns Supported Clients Sample toolTipTextThe 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> Returns Supported Clients Sample transparentFlag that tells if the component is transparent or not.
The default value is "false", that is the components
are not transparent. Returns Supported Clients Sample valuelistThe valuelist that is used by this field when displaying data. Can be used
with fields of type CHECKS, COMBOBOX, RADIOS and TYPE_AHEAD. Returns Supported Clients Sample visibleReturns Supported Clients Sample widthThe width in pixels of the component. Returns Supported Clients Sample xThe x coordinate of the component on the form. Returns Supported Clients Sample yThe y coordinate of the component on the form. Returns Supported Clients Sample getAttribute(name)Get the value of an attribute of the element. Parameters Returns Supported Clients Sample getAttributes()Returns the attribute names of an element. Returns Supported Clients Sample getDesignTimeProperty(key)Get a design-time property of an element. Parameters Returns Supported Clients Sample getDesignTimePropertyNames()Get the design-time properties of an element. Returns Supported Clients Sample getFormName()Returns the name of the form. (may be empty string as well) Returns Supported Clients Sample getTitle()Returns Supported Clients Sample getUUID()Returns the UUID of this component. Returns Supported Clients Sample putDesignTimeProperty(key, value)Set a design-time property of an element. Parameters Returns Supported Clients Sample removeAttribute(name)Remove the attribute of an element. Parameters Returns Supported Clients Sample removeDesignTimeProperty(key)Clear a design-time property of an element. Parameters Returns Supported Clients Sample setAttribute(name, value)Set the attribute value of an element. Parameters Supported Clients Sample |