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'
Extends
{column:width=80px|padding=0px}{column}{column}{column}
Property Summary
toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
{column:width=80px|padding=0px}{column}{column}{column}
Method Summary
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
getClientProperty(key)
Gets the specified client property for the element based on a key.
getDataProviderID()
Get the data provider this UI element (display) is showing.
getDesignTimeProperty()
Get a design-time property of an element.
getElementType()
Returns the type of a specified element.
String[]
getLabelForElementNames()
Returns an Array of label element names that has this field filled in as the labelFor.
getLocationX()
Returns the x location of the current element.
getLocationY()
Returns the y location of the current element.
getScrollX()
Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.
getScrollY()
Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.
Object[]
getSelectedElements()
Gets the selected values (real values from valuelist) as array.
getValueListName()
Returns the current valuelist name for the specified field; returns NULL if no valuelist.
void
putClientProperty(key, value)
Sets the value for the specified element client property key.
void
requestFocus()
Request the focus in this element.
void
requestFocus(mustExecuteOnFocusGainedMethod)
Request the focus in this element.
void
setLocation(x, y)
Sets the location of an element.
void
setScroll(x, y)
Sets the scroll location of an element.
void
setSize(width, height)
Sets the size of an element.
void
setValueListItems(value)
Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).
{column:width=100%|padding=0px}{column}
Property Details
Gets or sets the background color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.
Sample
//sets the background color of the field forms.customer.elements.customer_id.bgcolor = "#FFFFFF"; //gets the background color of the field var c = forms.customer.elements.customer_id.bgcolor;
Gets or sets the border attribute(s) of a specified element.
The border attributes:
borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder.
size - (numeric value) for: bottom, left, right, top.
color - (hexadecimal value) for: bottom, left, right, top.
dash pattern - (numeric value) for selected side(s).
rounding radius - (numeric value) for selected side(s).
It only returns it's correct value if it was explicitly set.
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".
Sample
//sets the border type to "LineBorder" //sets a 1 px line width for the bottom and left side of the border //sets the hexadecimal color of the border to "#ccffcc" forms.customer.elements.customer_id.border = 'LineBorder,1,#ccffcc';
Gets or sets the enabled state of a specified field, also known as "grayed".
true - enabled; false - not enabled; ! - the enabled state is inverted (the opposite).
NOTE: A disabled element cannot be selected by clicking the element (or by pressing the TAB key even if this option is supported by the operating system).
NOTE: A label or button element will not disable if the "displayType" design time property for a field is set to HTML_AREA.
NOTE: The disabled "grayed" color is dependent on the LAF set in the Servoy Client Application Preferences. For more information see Preferences: Look And Feel in the Servoy Developer User's Guide.
Sample
//gets the enabled state of the field var currState = forms.customer.elements.customer_id.enabled; //sets the enabled state of the field forms.customer.elements.customer_id.enabled = !currentState;
Gets or sets the foreground color of a field. The color has to be set using the hexadecimal RGB value as used in HTML.
It only returns it's correct value if it was explicitly set.
Sample
//sets the foreground color of the field forms.customer.elements.customer_id.fgcolor = "#000000"; //gets the foreground color of the field var c = forms.customer.elements.customer_id.fgcolor;
Gets or sets the font name, style, and size of an element.
font name - the name of the font family.
style - the type of the font. (plain = 0; bold = 1; italic = 2; bold-italic = 3).
size - the size of the font (in points).
It only returns it's correct value if it was explicitly set.
Sample
forms.customer.elements.customer_id.font = 'Tahoma,1,11';
Gets or sets the editable/read-only state of a field; true - read-only; false - editable; ! - the editable/read-only state is inverted (the opposite).
NOTE: A field set as read-only can be selected by clicking (or pressing the TAB key if this option is supported by the operating system) and the field data can be copied.
Sample
//gets the editable/read-only state of the field var currentState = forms.customer.elements.customer_id.readOnly; //sets the editable/read-only state of the field forms.customer.elements.customer_id.readOnly = !currentState;
Gets or sets the title text.
Sample
var titleText = forms.customer.elements.customer_id.titleText;
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
NOTE: HTML should be used for multi-line tooltips; you can also use any valid HTML tags to format tooltip text.
Sample
//gets the tooltip text of the element var toolTip = forms.customer.elements.customer_id.toolTipText; //sets the tooltip text of the element forms.customer.elements.customer_id.toolTipText = "New tip"; forms.customer.elements.customer_id.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
Gets or sets the transparency of an element; true - transparent; false - not transparent.
NOTE: transparency can be inverted using ! operator: elements.elementName.transparent = !elements.elementName.transparent;
NOTE: transparency will be mostly used for background color, a transparent element will receive the background of the element "beneath" it, a non transparent one will use its own background color
Sample
//gets the transparency of the element var currentState = forms.customer.elements.customer_id.transparent; //sets the transparency of the element forms.customer.elements.customer_id.transparent = !currentState;
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
NOTE: The visibility of an element is not persistent; the state of visibility only applies to the current user in his/her current session.
Sample
//sets the element as visible forms.company.elements.faxBtn.visible = true; //gets the visibility of the element var currentState = forms.company.elements.faxBtn.visible; //sets the element as not visible when the current state is visible forms.company.elements.faxBtn.visible = !currentState;
{column:width=100%|padding=0px}{column}
Method Details
getAbsoluteFormLocationY
()
Returns the absolute form (designed) Y location.
Sample
var absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY();
getClientProperty
(key)
Gets the specified client property for the element based on a key.
NOTE: Depending on the operating system, a user interface property name may be available.
Parameters
{Object} key – user interface key (depends on operating system)
Returns
Object – The value of the property for specified key.
Sample
var property = forms.customer.elements.customer_id.getClientProperty('ToolTipText');
getDataProviderID
()
Get the data provider this UI element (display) is showing.
Sample
forms.customer.elements.customer_id.getDataProviderID();
getDesignTimeProperty
()
Get a design-time property of an element.
Sample
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
getElementType
()
Returns the type of a specified element.
Returns
String – The display type of the element as String.
Sample
var et = forms.customer.elements.customer_id.getElementType();
getHeight
()
Returns the height of the current element.
NOTE: getHeight() can be used with getWidth() to set the size of an element using the setSize function. For example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);
Sample
var ht = forms.customer.elements.customer_id.getHeight();
String[]
getLabelForElementNames
()
Returns an Array of label element names that has this field filled in as the labelFor.
Sample
var array = elements.name_first.getLabelForElementNames(); for (var i = 0; i<array.length; i++) { elements[array[i]].fgcolor = "#ff00ff"; }
getLocationX
()
Returns the x location of the current element.
NOTE: getLocationX() can be used with getLocationY() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);
Sample
var x = forms.customer.elements.customer_id.getLocationX();
getLocationY
()
Returns the y location of the current element.
NOTE: getLocationY() can be used with getLocationX() to set the location of an element using the setLocation function. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);
Sample
var y = forms.customer.elements.customer_id.getLocationY();
getName
()
Returns the name of an element. (may be null as well)
Sample
var name = forms.customer.elements.customer_id.getName();
getScrollX
()
Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.
NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);
Sample
var x = forms.customer.elements.customer_id.getScrollX();
getScrollY
()
Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.
NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function. For Example:
//returns the X and Y scroll coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new scroll location
forms.company.elements.portal50.setScroll(x+10,y+10);
Sample
var y = forms.customer.elements.customer_id.getScrollY();
Object[]
getSelectedElements
()
Gets the selected values (real values from valuelist) as array.
Sample
var values = forms.customer.elements.customer_id.getSelectedElements();
getValueListName
()
Returns the current valuelist name for the specified field; returns NULL if no valuelist.
Sample
var name = forms.customer.elements.customer_id.getValueListName();
getWidth
()
Returns the width of the current element.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);
Sample
var w = forms.customer.elements.customer_id.getWidth();
void
putClientProperty
(key, value)
Sets the value for the specified element client property key.
NOTE: Depending on the operating system, a user interface property name may be available.
Returns
void
Sample
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
void
requestFocus
()
Request the focus in this element. (Focus is also a text cursor on text components).
Returns
void
Sample
//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components) forms.customer.elements.customer_id.requestFocus();
void
requestFocus
(mustExecuteOnFocusGainedMethod)
Request the focus in this element. (Focus is also a text cursor on text components).
Parameters
{Boolean} mustExecuteOnFocusGainedMethod – If true will execute onFocusGained method, else will not; default value is true.
Returns
void
Sample
//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components), skip on focus gained method call forms.customer.elements.customer_id.requestFocus(false);
void
setLocation
(x, y)
Sets the location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen.
Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getLocationX() can be used with getLocationY() to return the current location of an element; then use the X and Y coordinates with the setLocation function to set a new location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.faxBtn.getLocationX();
var y = forms.company.elements.faxBtn.getLocationY();
//sets the new location 10 px to the right; 10 px down from the current location
forms.company.elements.faxBtn.setLocation(x+10,y+10);
Returns
void
Sample
forms.customer.elements.customer_id.setLocation(200,200);
void
setScroll
(x, y)
Sets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content
NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:
//returns the X and Y coordinates
var x = forms.company.elements.portal50.getScrollX();
var y = forms.company.elements.portal50.getScrollY();
//sets the new location
forms.company.elements.portal50.setScroll(x+10,y+10);
Returns
void
Sample
forms.customer.elements.customer_id.setScroll(200,200);
void
setSize
(width, height)
Sets the size of an element. It takes as input the width and the height.
Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
NOTE: getWidth() can be used with getHeight() to set the size of an element using the setSize function. For Example:
//returns the width (w) and height (h)
var w = forms.company.elements.faxBtn.getWidth();
var h = forms.company.elements.faxBtn.getHeight();
//sets the new size
forms.company.elements.faxBtn.setSize(w,h);
//sets the new size and adds 1 px to both the width and height
forms.company.elements.faxBtn.setSize(w+1,h+1);
Returns
void
Sample
forms.customer.elements.customer_id.setSize(20,30);
void
setValueListItems
(value)
Sets the display/real values to the custom valuelist of the element (if element has custom valuelist).
This does not effect the value list with same name list on other elements or value lists at application level.
Should receive a dataset parameter, first column is for display values, second column (optional) is for real values.
NOTE: if you modify values for checkbox/radio field, note that having one value in valuelist is a special case, so switching between one value and 0/multiple values after form is created may have side effects
Parameters
{Object} value – first column is display value, second column is real value
Returns
void
Sample
var dataset = databaseManager.createEmptyDataSet(0,new Array('display_values','optional_real_values')); dataset.addRow(['aa',1]); dataset.addRow(['bb',2]); dataset.addRow(['cc',3]); // forms.customer.elements.customer_id should have a valuelist attached forms.customer.elements.customer_id.setValueListItems(dataset);