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();
|
|
|
|
|
Gets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only.
NOTE: As of Servoy 4.x (and higher) you can also get/set the relative or absolute URL for an HTML_AREA field element. For more detail, see the .URL and .baseURL field element runtime properties earlier in this section.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide. |
|
Returns String – the plain text |
|
Sample
var my_text = forms.customer.elements.customer_id.getAsPlainText();
|
|
|
|
|
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');
|
|
|
|
|
Get the data provider this UI element (display) is showing. |
|
Returns String – The data provider as String. |
|
Sample
forms.customer.elements.customer_id.getDataProviderID();
|
|
|
|
|
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();
|
|
|
|
|
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();
|
|
|
|
|
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";
}
|
|
|
|
|
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();
|
|
|
|
|
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();
|
|
|
|
|
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();
|
|
|
|
|
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();
|
|
|
|
|
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();
|
|
|
|
|
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();
|
|
|
|
|
Returns String – The title text. |
|
Sample
var titleText = forms.customer.elements.customer_id.getTitleText();
|
|
|
|
|
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();
|
|
|
|
|
Sets the value for the specified element client property 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)
{Object} value – a predefined value for the key |
|
Sample
forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text');
|
|
|
|
|
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. |
|
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');
|
|
|
|
|
([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). |
|
Sample
//requests the focus for the element
//prevents the onFocusGained method from executing
forms.customer.elements.customer_id.requestFocus(false);
|
|
|
|
|
Selects all the contents of a field. |
|
Sample
forms.customer.elements.customer_id.selectAll();
|
|
|
|
|
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 |
|
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');
|
|
|
|
|
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 |
|
Sample
forms.customer.elements.customer_id.setFont('Tahoma,1,11');
|
|
|
|
|
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); |
|
Parameters {Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels. |
|
Sample
forms.customer.elements.customer_id.setLocation(200,200);
|
|
|
|
|
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); |
|
Parameters {Number} x – the X coordinate of the portal scroll location in pixels
{Number} y – the Y coordinate of the portal scroll location in pixels |
|
Sample
forms.customer.elements.customer_id.setScroll(200,200);
|
|
|
|
|
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); |
|
Parameters {Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels. |
|
Sample
forms.customer.elements.customer_id.setSize(20,30);
|
|
|
|
|
|