Extends | |
---|---|
RuntimeComponent |
Property Summary | |
---|---|
String | bgcolor Gets or sets the background color of a field. |
String | border Gets or sets the border attribute(s) of a specified element. |
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). |
Object | tabIndex Gets or sets the selected tab index for the specified tabpanel. |
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 | |
---|---|
Boolean | addTab(form/formname, [name], [tabText], [tooltip], [iconURL], [fg], [bg], [relatedfoundset/relationname], [index]) Adds a relationless or related form as a tab in a specified tabpanel. |
Number | getAbsoluteFormLocationY() Returns the absolute form (designed) Y location. |
Object | getClientProperty(key) Gets the specified client property for the element based on a key. |
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. |
Number | getLocationX() Returns the x location of the current element. |
Number | getLocationY() Returns the y location of the current element. |
Number | getMaxTabIndex() Returns the maximum tab index for a specified tabpanel. |
String | getMnemonicAt(i) Returns the mnemonic for a specified tab of a tabpanel. |
String | getName() Returns the name of an element. |
String | getTabFGColorAt(i) Returns the foreground color for a specified tab of a tabpanel. |
String | getTabFormNameAt(i) Returns the form name for a specified tab of a tabpanel. |
String | getTabNameAt(i) Returns the name - the "name" design time property value - for a specified tab of a tabpanel. |
String | getTabRelationNameAt(i) Returns the relation name for a specified tab of a tabpanel. |
String | getTabTextAt(i) Returns the text for a specified tab of a tabpanel. |
Number | getWidth() Returns the width of the current element. |
Boolean | isTabEnabledAt(i) Returns the enabled status of a specified tab in a tabpanel. |
void | putClientProperty(key, value) Sets the value for the specified element client property key. |
Boolean | removeAllTabs() Removes all tabs for a specified tabpanel. |
Boolean | removeTabAt(index) Removes a specified tab in a tabpanel; can be based on a relation or relationless. |
void | setLocation(x, y) Sets the location of an element. |
void | setMnemonicAt(index, text) Sets the mnemonic for a specified tab in a tabpanel. |
void | setSize(width, height) Sets the size of an element. |
void | setTabEnabledAt(i, b) Sets the status of a specified tab in a tabpanel. |
void | setTabFGColorAt(i, s) Sets the foreground color for a specified tab in a tabpanel. |
void | setTabTextAt(index, text) Sets the text for a specified tab in a tabpanel. |
Property Details | |
---|---|
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'; |
|
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; |
|
tabIndex |
|
Gets or sets the selected tab index for the specified tabpanel.
When setting the value either the tab index or the tab name can be used. When getting the value, the tab index (not the name) will be returned all the time. |
|
Returns |
|
Sample //gets the selected tab index of the tabpanel var current = forms.customer.elements.customer_id.tabIndex; //sets (goes to) the selected tabIndex of the tabpanel forms.customer.elements.customer_id.tabIndex = current + 1; //or sets (goes to) the tab with the specified name forms.customer.elements.customer_id.tabIndex = 'tab_name'; |
|
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 | |
---|---|
addTab |
|
Boolean addTab (form/formname, [name], [tabText], [tooltip], [iconURL], [fg], [bg], [relatedfoundset/relationname], [index]) | |
Adds a relationless or related form as a tab in a specified tabpanel.
|
|
Parameters form/formname - the specified form/form name you wish to add as a tab
[name] - the specified name for the tab or NULL (default is null) [tabText] - the specified text for the tab (default is null) [tooltip] - a specified tooltip for the tab (default is null) [iconURL] - a specified icon image or icon URL for the tab (default is null) [fg] - the HTML RGB Hexadecimal foreground color for the tab (default is null) [bg] - the HTML RGB Hexadecimal background color for the tab (default is null) [relatedfoundset/relationname] - the specified name of the related foundset (default is null) [index] - the specified index of a tab, default is -1, will add tab to the end, this index is 0 based |
|
Returns Boolean - a boolean value indicating if tab was successfully added
|
|
Sample forms.customer.elements.customer_id.addTab(forms.orders,'ordersTab','Orders',null,null,'#000000','#BBCCEE'); |
|
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(); |
|
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'); |
|
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(); |
|
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(); |
|
getMaxTabIndex |
|
Number getMaxTabIndex () | |
Returns the maximum tab index for a specified tabpanel.
|
|
Returns Number - maximum tab index (number)
|
|
Sample var max = forms.customer.elements.customer_id.getMaxTabIndex(); |
|
getMnemonicAt |
|
String getMnemonicAt (i) | |
Returns the mnemonic for a specified tab of a tabpanel.
|
|
Parameters {Number} i - The number of the specified tab.
|
|
Returns String - The mnemonic.
|
|
Sample var mnemonic = forms.customer.elements.customer_id.getMnemonicAt(3); |
|
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(); |
|
getTabFGColorAt |
|
String getTabFGColorAt (i) | |
Returns the foreground color for a specified tab of a tabpanel.
|
|
Parameters {Number} i - the number of the specified tab
|
|
Returns String - color as hexadecimal RGB string
|
|
Sample var color = forms.customer.elements.customer_id.getTabFGColorAt(3); |
|
getTabFormNameAt |
|
String getTabFormNameAt (i) | |
Returns the form name for a specified tab of a tabpanel.
|
|
Parameters {Number} i - index of the tab
|
|
Returns String - the name of the form
|
|
Sample var formName = forms.customer.elements.customer_id.getSelectedTabFormName(3); |
|
getTabNameAt |
|
String getTabNameAt (i) | |
Returns the name - the "name" design time property value - for a specified tab of a tabpanel.
|
|
Parameters {Number} i - The number of the specified tab.
|
|
Returns String - The tab name
|
|
Sample var tabName = forms.customer.elements.customer_id.getTabNameAt(3); |
|
getTabRelationNameAt |
|
String getTabRelationNameAt (i) | |
Returns the relation name for a specified tab of a tabpanel.
|
|
Parameters {Number} i - index of the tab
|
|
Returns String - relation name
|
|
Sample var relName = forms.customer.elements.customer_id.getTabRelationNameAt(3); |
|
getTabTextAt |
|
String getTabTextAt (i) | |
Returns the text for a specified tab of a tabpanel.
|
|
Parameters {Number} i - The number of the specified tab.
|
|
Returns String - The tab text.
|
|
Sample var tabText = forms.customer.elements.customer_id.getTabTextAt(3); |
|
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(); |
|
isTabEnabledAt |
|
Boolean isTabEnabledAt (i) | |
Returns the enabled status of a specified tab in a tabpanel.
|
|
Parameters {Number} i - the number of the specified tab.
|
|
Returns Boolean - True if tab is enabled, false otherwise.
|
|
Sample var status = forms.customer.elements.customer_id.isTabEnabledAt(3); |
|
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'); |
|
removeAllTabs |
|
Boolean removeAllTabs () | |
Removes all tabs for a specified tabpanel.
|
|
Returns Boolean - a boolean value indicating if tabs were successfully removed
|
|
Sample forms.customer.elements.customer_id.removeAllTabs(); |
|
removeTabAt |
|
Boolean removeTabAt (index) | |
Removes a specified tab in a tabpanel; can be based on a relation or relationless. NOTE: In Servoy 4.x (and higher), the addTab function applies to relationless or related tabs in a tabpanel. |
|
Parameters index - The index of the tab to remove.
|
|
Returns Boolean - a boolean value indicating if tab was successfully removed
|
|
Sample forms.customer.elements.customer_id.removeTabAt(3); |
|
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); |
|
setMnemonicAt |
|
void setMnemonicAt (index, text) | |
Sets the mnemonic for a specified tab in a tabpanel.
|
|
Parameters index - the number of the specified tab
text - the text to be set for the specified tab |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setMnemonicAt(3,'a'); |
|
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); |
|
setTabEnabledAt |
|
void setTabEnabledAt (i, b) | |
Sets the status of a specified tab in a tabpanel.
|
|
Parameters |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setTabEnabledAt(3,true); |
|
setTabFGColorAt |
|
void setTabFGColorAt (i, s) | |
Sets the foreground color for a specified tab in a tabpanel.
|
|
Parameters |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setTabFGColorAt(3,'#000000'); |
|
setTabTextAt |
|
void setTabTextAt (index, text) | |
Sets the text for a specified tab in a tabpanel.
|
|
Parameters index - the number of the specified tab
text - the text to be set for the specified tab |
|
Returns void
|
|
Sample forms.customer.elements.customer_id.setTabTextAt(3,'newTitle'); |
|