(form, [name], [tabText], [tooltip], [iconURL], [fg], [bg], [relatedfoundset/relationname], [index]) |
|
|
Adds a relationless or related form as a tab in a specified tabpanel. |
|
Parameters form – the specified form 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');
|
|
|
|
|
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 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');
|
|
|
|
|
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 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 maximum tab index for a specified tabpanel. |
|
Returns Number – maximum tab index (number) |
|
Sample
var max = forms.customer.elements.customer_id.getMaxTabIndex();
|
|
|
|
|
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 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);
|
|
|
|
|
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);
|
|
|
|
|
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. |
|
Sample
var tabName = forms.customer.elements.customer_id.getTabNameAt(3);
|
|
|
|
|
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);
|
|
|
|
|
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);
|
|
|
|
|
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();
|
|
|
|
|
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);
|
|
|
|
|
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');
|
|
|
|
|
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();
|
|
|
|
|
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);
|
|
|
|
|
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 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);
|
|
|
|
|
Sets the status of a specified tab in a tabpanel. |
|
Parameters {Number} i – the number of the specified tab.
{Boolean} b – true if enabled; or false if disabled. |
|
Sample
forms.customer.elements.customer_id.setTabEnabledAt(3,true);
|
|
|
|
|
Sets the foreground color for a specified tab in a tabpanel. |
|
Parameters {Number} i – the number of the specified tab
{String} s – the hexadecimal RGB color value to be set. |
|
Sample
forms.customer.elements.customer_id.setTabFGColorAt(3,'#000000');
|
|
|
|
|
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 |
|
Sample
forms.customer.elements.customer_id.setTabTextAt(3,'newTitle');
|
|
|
|
|
|