Extends | |
---|---|
RuntimeComponent |
Property Summary | |
---|---|
String | URL Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only. |
String | baseURL Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only. |
String | bgcolor Gets or sets the background color of a field. |
String | border Gets or sets the border attribute(s) of a specified element. |
Number | caretPosition Gets or sets the number value (position) of the text caret (text "I" bar) in a field. |
Boolean | editable Gets or sets the editable/read-only state of a field; true - editable; false - read-only. |
Boolean | enabled Gets or sets the enabled state of a specified field, also known as "grayed". |
String | fgcolor Gets or sets the foreground color of a field. |
String | font Gets or sets the font name, style, and size of an element. |
Boolean | readOnly 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). |
String | titleText Gets or sets the title text. |
String | toolTipText Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element. |
Boolean | transparent Gets or sets the transparency of an element; true - transparent; false - not transparent. |
Boolean | visible Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite). |
Method Summary | |
---|---|
Number | getAbsoluteFormLocationY() Returns the absolute form (designed) Y location. |
String | getAsPlainText() 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. |
Object | getClientProperty(key) Gets the specified client property for the element based on a key. |
String | getDataProviderID() Get the data provider this UI element (display) is showing. |
Object | getDesignTimeProperty() Get a design-time property of an element. |
String | getElementType() Returns the type of a specified element. |
Number | getHeight() Returns the height of the current element. |
String[] | getLabelForElementNames() Returns an Array of label element names that has this field filled in as the labelFor. |
Number | getLocationX() Returns the x location of the current element. |
Number | getLocationY() Returns the y location of the current element. |
String | getName() Returns the name of an element. |
Number | 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. |
Number | 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. |
String | getSelectedText() Returns the currently selected text in the specified text field or text area. |
Number | getWidth() Returns the width of the current element. |
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() Request the focus in this element. |
void | requestFocus(mustExecuteOnFocusGainedMethod) Request the focus in this element. |
void | selectAll() Selects all the contents of a field. |
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. |
Property Details | |
---|---|
URL |
|
Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only. 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 |
|
Sample //sets the relative URL of the HTML_AREA field forms.customer.elements.customer_id.URL = "http://www.examples.com/icon.gif"; //gets the relative URL of the HTML_AREA field var theURL = forms.customer.elements.customer_id.URL; |
|
baseURL |
|
Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.
|
|
Returns |
|
Sample //gets the base URL of theField when display is HTML_AREA var baseURL = forms.customer.elements.customer_id.baseURL; //sets the base URL of theField when display is HTML_AREA forms.customer.elements.customer_id.baseURL = "http://www.examples.com"; |
|
bgcolor |
|
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. |
|
Returns |
|
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; |
|
border |
|
Gets or sets the border attribute(s) of a specified element. The border attributes: borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder. 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". |
|
Returns |
|
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'; |
|
caretPosition |
|
Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
|
|
Returns |
|
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; |
|
editable |
|
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 |
|
Sample var currentState = forms.customer.elements.customer_id.editable; forms.customer.elements.customer_id.editable = !currentState; |
|
enabled |
|
Gets or sets the enabled state of a specified field, also known as "grayed". 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 |
|
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; |
|
fgcolor |
|
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. |
|
Returns |
|
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; |
|
font |
|
Gets or sets the font name, style, and size of an element. font name - the name of the font family. It only returns it's correct value if it was explicitly set. |
|
Returns |
|
Sample forms.customer.elements.customer_id.font = 'Tahoma,1,11'; |
|
readOnly |
|
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 |
|
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; |
|
titleText |
|
Gets or sets the title text.
|
|
Returns |
|
Sample var titleText = forms.customer.elements.customer_id.titleText; |
|
toolTipText |
|
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 |
|
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."; |
|
transparent |
|
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 |
|
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; |
|
visible |
|
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 |
|
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; |
|
Method Details | |
---|---|
getAbsoluteFormLocationY |
|
Number 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(); |
|
getAsPlainText |
|
String getAsPlainText () | |
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(); |
|
getClientProperty |
|
Object 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 |
|
String 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(); |
|
getDesignTimeProperty |
|
Object getDesignTimeProperty () | |
Get a design-time property of an element.
|
|
Returns |
|
Sample var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop') |
|
getElementType |
|
String 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 |
|
Number getHeight () | |
Returns the height of the current element. //returns the width (w) and height (h) //sets the new size //sets the new size and adds 1 px to both the width and height |
|
Returns Number - The height of the element in pixels.
|
|
Sample var ht = forms.customer.elements.customer_id.getHeight(); |
|
getLabelForElementNames |
|
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 |
|
Number 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 //sets the new location 10 px to the right; 10 px down from the current location |
|
Returns Number - The x location of the element in pixels.
|
|
Sample var x = forms.customer.elements.customer_id.getLocationX(); |
|
getLocationY |
|
Number 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 //sets the new location 10 px to the right; 10 px down from the current location |
|
Returns Number - The y location of the element in pixels.
|
|
Sample var y = forms.customer.elements.customer_id.getLocationY(); |
|
getName |
|
String 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 |
|
Number 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 //sets the new scroll location |
|
Returns Number - The x scroll location in pixels.
|
|
Sample var x = forms.customer.elements.customer_id.getScrollX(); |
|
getScrollY |
|
Number 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 //sets the new scroll location |
|
Returns Number - The y scroll location in pixels.
|
|
Sample var y = forms.customer.elements.customer_id.getScrollY(); |
|
getSelectedText |
|
String getSelectedText () | |
Returns the currently selected text in the specified text field or text area. NOTE: This does not work for text fields in the Web Client. |
|
Returns String - The selected text from the component.
|
|
Sample var my_text = forms.customer.elements.customer_id.getSelectedText(); |
|
getWidth |
|
Number 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) //sets the new size //sets the new size and adds 1 px to both the width and height |
|
Returns Number - The width of the element in pixels.
|
|
Sample var w = forms.customer.elements.customer_id.getWidth(); |
|
putClientProperty |
|
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. |
|
Parameters |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.putClientProperty('ToolTipText','some text'); |
|
replaceSelectedText |
|
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'); |
|
requestFocus |
|
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(); |
|
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); |
|
selectAll |
|
void selectAll () | |
Selects all the contents of a field.
|
|
Returns void
|
|
Sample forms.customer.elements.customer_id.selectAll(); |
|
setLocation |
|
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 //sets the new location 10 px to the right; 10 px down from the current location |
|
Parameters |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setLocation(200,200); |
|
setScroll |
|
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 //sets the new location |
|
Parameters |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setScroll(200,200); |
|
setSize |
|
void setSize (width, height) | |
Sets the size of an element. 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) //sets the new size //sets the new size and adds 1 px to both the width and height |
|
Parameters |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setSize(20,30); |
|