{column:padding=0px|width=80px}{column}{column}{column}
Property Summery
caretPosition
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
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:padding=0px|width=80px}{column}{column}{column}
Method Summery
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.
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 the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
getScrollY()
Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
getSelectedText()
Returns the currently selected text in the specified field.
void
putClientProperty(key, value)
Sets the value for the specified element client property key.
void
replaceSelectedText(s)
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
void
requestFocus([mustExecuteOnFocusGainedMethod])
Requests the focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).
void
selectAll()
Selects all the contents of a field.
void
setBorder(spec)
Sets the border attribute(s) of a specified element.
void
setFont(spec)
Sets the font name, style, and size of an element.
void
setLocation(x, y)
Sets the location of an element.
void
setScroll(x, y)
Sets the scroll location of a portal.
void
setSize(width, height)
Sets the size of the field.
{column:padding=0px|width=100%}{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.
Returns
String
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 number value (position) of the text caret (text "I" bar) in a field.
Returns
Number
Sample
//get the current caretposition var caretPos = forms.customer.elements.customer_id.caretPosition; //add one and set it forms.customer.elements.customer_id.caretPosition = caretPos+1;
Gets or sets the editable/read-only state of a field; true - editable; false - read-only.
NOTE the "!" operator can be used to invert the editable state.
Returns
Boolean
Sample
var currentState = forms.customer.elements.customer_id.editable; forms.customer.elements.customer_id.editable = !currentState;
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.
Returns
Boolean
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.
Returns
String
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 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.
Returns
Boolean
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 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.
Returns
String
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
Returns
Boolean
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.
Returns
Boolean
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:padding=0px|width=100%}{column}
Method Details
getAbsoluteFormLocationY
()
Returns the absolute form (designed) Y location.
Returns
Number – The y location of the form in pixels.
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.
Returns
String – The data provider as String.
Sample
forms.customer.elements.customer_id.getDataProviderID();
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);
Returns
Number – The height of the element in pixels.
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.
Returns
String[] – An array with element names.
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);
Returns
Number – The x location of the element in pixels.
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);
Returns
Number – The y location of the element in pixels.
Sample
var y = forms.customer.elements.customer_id.getLocationY();
getName
()
Returns the name of an element. (may be null as well)
Returns
String – The name of the element.
Sample
var name = forms.customer.elements.customer_id.getName();
getScrollX
()
Returns the x scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
NOTE: getScrollX() can be used with getScrollY() to set the scroll location of a portal 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);
Returns
Number – The x scroll location in pixels.
Sample
var x = forms.customer.elements.customer_id.getScrollX();
getScrollY
()
Returns the y scroll location of the current portal or specified portal - only for a portal where the height of the portal is greater than the height of the portal field(s).
NOTE: getScrollY() can be used with getScrollX() to set the scroll location of a portal 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);
Returns
Number – The y scroll location in pixels.
Sample
var y = forms.customer.elements.customer_id.getScrollY();
getSelectedText
()
Returns the currently selected text in the specified field.
NOTE: This function is for field elements only.
Returns
String – The selected text from the component.
Sample
var my_text = forms.customer.elements.customer_id.getSelectedText();
getTitleText
()
Get the title text.
Returns
String – The title text.
Sample
var titleText = forms.customer.elements.customer_id.getTitleText();
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);
Returns
Number – The width of the element in pixels.
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
replaceSelectedText
(s)
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA.
Parameters
{String} s – The replacement text.
Returns
void
Sample
//returns the current selected text var my_text = forms.customer.elements.customer_id.getSelectedText(); //replaces the current selected text forms.customer.elements.customer_id.replaceSelectedText('John');
void
requestFocus
([mustExecuteOnFocusGainedMethod])
Requests the focus for an element; can skip the onFocusGained event for an element by using requestFocus(false).
When focus is requested on a text field, a text cursor will be displayed in the specified field.
NOTE: This function is for field elements only; for more information about the optional parameter, see the onFocusGained design time property in the section on Fields.
Parameters
[mustExecuteOnFocusGainedMethod] – true - to execute the onFocusGained method; false - to prevent the onFocusGained method from executing, default is true (if not specified).
Returns
void
Sample
//requests the focus for the element //prevents the onFocusGained method from executing forms.customer.elements.customer_id.requestFocus(false);
void
selectAll
()
Selects all the contents of a field.
Returns
void
Sample
forms.customer.elements.customer_id.selectAll();
void
setBorder
(spec)
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).
NOTE: Use the same value(s) and order of attribute(s) from the element design time property "borderType".
Parameters
{String} spec – the border attributes
Returns
void
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" var b = forms.customer.elements.customer_id.setBorder('LineBorder,1,#ccffcc');
void
setFont
(spec)
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).
Parameters
{String} spec – the font name, style, size
Returns
void
Sample
forms.customer.elements.customer_id.setFont('Tahoma,1,11');
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.
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 a portal. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for a portal where the height of the portal is greater than the height of the portal filed(s).
NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of a portal; 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 the field. It takes as input the width and the height.
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);