{column:padding=0px|width=80px}{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:padding=0px|width=80px}{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.
getElementType()
Returns the type of a specified element.
getLocationX()
Returns the x location of the current element.
getLocationY()
Returns the y location of the current element.
getMaxTabIndex()
Returns the maximum tab index for a specified tabpanel.
getTabFGColorAt(i)
Returns the foreground color for a specified tab of a tabpanel.
getTabFormNameAt(i)
Returns the form name for a specified tab of a tabpanel.
getTabNameAt(i)
Returns the name - the "name" design time property value - for a specified tab of a tabpanel.
getTabRelationNameAt(i)
Returns the relation name for a specified tab of a tabpanel.
getTabTextAt(i)
Returns the text for a specified tab of a tabpanel.
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.
removeAllTabs()
Removes all tabs for a specified tabpanel.
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
setSize(width, height)
Sets the size of the field.
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.
{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 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
spec – the border attributes
Returns
String
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');
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;
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
spec – the font name, style, size
Returns
String
Sample
forms.customer.elements.customer_id.setFont('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.
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 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
Object
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';
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
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
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
()
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');
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();
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();
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();
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
(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
(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
(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
(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
(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
()
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();
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);
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');
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
(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);
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
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);
void
setTabEnabledAt
(i, b)
Sets the status of a specified tab in a tabpanel.
Returns
void
Sample
forms.customer.elements.customer_id.setTabEnabledAt(3,true);
void
setTabFGColorAt
(i, s)
Sets the foreground color for a specified tab in a tabpanel.
Returns
void
Sample
forms.customer.elements.customer_id.setTabFGColorAt(3,'#000000');
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');