RuntimeTabPanel
Overview
Scripting interface for RuntimeTabPanel. Combines (deprecated) script methods and java api (IRuntimeTabPanel).
Extends
Properties Summarized
Type | Name | Summary |
---|---|---|
Gets or sets the background color of a field. | ||
Gets or sets the border attribute(s) of a specified element. | ||
Gets or sets the enabled state of a specified field, also known as "grayed". | ||
Gets or sets the foreground color of a field. | ||
Gets or sets the font name, style, and size of an element. | ||
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). | ||
Gets or sets the selected tab index for the specified tabpanel. | ||
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element. | ||
Gets or sets the transparency of an element; true - transparent; false - not transparent. | ||
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite). |
Methods Summarized
Type | Name | Summary |
---|---|---|
void | Adds a style to the styleClass property. | |
Adds a relationless or related form as a tab in a specified tabpanel. | ||
Returns the absolute form (designed) Y location. | ||
Gets the specified client property for the element based on a key. | ||
Get the design-time properties of an element. | ||
Get a design-time property of an element. | ||
Returns the type of a specified element. | ||
Returns the name of the form. | ||
Returns the height of the current element. | ||
Returns the x location of the current element. | ||
Returns the y location of the current element. | ||
Returns the maximum tab index for a specified tabpanel. | ||
Returns the mnemonic for a specified tab of a tabpanel. | ||
Returns the name of an element. | ||
Returns the foreground color for a specified tab of a tabpanel. | ||
Returns the form name for a specified tab of a tabpanel. | ||
Returns the name - the "name" design time property value - for a specified tab of a tabpanel. | ||
Returns the relation name for a specified tab of a tabpanel. | ||
Returns the text for a specified tab of a tabpanel. | ||
Returns the width of the current element. | ||
void | Check if an element already have a style from the styleClass property. | |
Returns the enabled status of a specified tab in a tabpanel. | ||
void | Sets the value for the specified element client property key. | |
Removes all tabs for a specified tabpanel. | ||
void | Removes a style from the styleClass property. | |
Removes a specified tab in a tabpanel; can be based on a relation or relationless. | ||
void | Sets the location of an element. | |
void | Sets the mnemonic for a specified tab in a tabpanel. | |
void | Sets the size of an element. | |
void | Sets the status of a specified tab in a tabpanel. | |
void | Sets the foreground color for a specified tab in a tabpanel. | |
void | Sets the text for a specified tab in a tabpanel. |
Properties Detailed
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.
Type String
Sample
border
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).
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".
Type String
Sample
enabled
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.
Type Boolean
Sample
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.
Type String
Sample
font
Gets or 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).
It only returns it's correct value if it was explicitly set.
Type String
Sample
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.
Type Boolean
Sample
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.
NOTE: In NGClient tabIndex is updated after form is shown (so onShow of form will have the old index)
Type Object
Sample
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.
Type String
Sample
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
Type Boolean
Sample
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.
Type Boolean
Sample
Methods Detailed
addStyleClass(styleName)
Adds a style to the styleClass property. This works only for NGClient where multiple styles are supported.
Parameters
String styleName the name of the style class to add
Returns: void
Sample
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
Object form/formname the specified form/form name you wish to add as a tab
Object name the specified name for the tab or NULL (default is null)
Object tabText the specified text for the tab (default is null)
Object tooltip a specified tooltip for the tab (default is null)
Object iconURL a specified icon image or icon URL for the tab (default is null)
Object fg the HTML RGB Hexadecimal foreground color for the tab (default is null)
Object bg the HTML RGB Hexadecimal background color for the tab (default is null)
Object relatedfoundset/relationname the specified name of the related foundset (default is null)
Object 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
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Returns: Number The y location of the form in pixels.
Sample
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
getDesignProperties()
Get the design-time properties of an element.
Returns: Object
Sample
getDesignTimeProperty(key)
Get a design-time property of an element.
Parameters
String key the name of the property
Returns: Object
Sample
getElementType()
Returns the type of a specified element.
Returns: String The display type of the element as String.
Sample
getFormName()
Returns the name of the form. (may be empty string as well)
Returns: String The name of the form.
Sample
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
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
getLocationY()
Returns the y location of the current element. The method can only be used in Record view.
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
getMaxTabIndex()
Returns the maximum tab index for a specified tabpanel.
Returns: Number maximum tab index (number)
Sample
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
getName()
Returns the name of an element. (may be null as well)
Returns: String The name of the element.
Sample
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
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
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
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
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
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
hasStyleClass(styleName)
Check if an element already have a style from the styleClass property.
Parameters
String styleName the name of the style class to be checked
Returns: void
Sample
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
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
Object key user interface key (depends on operating system)
Object value a predefined value for the key
Returns: void
Sample
removeAllTabs()
Removes all tabs for a specified tabpanel.
Returns: Boolean a boolean value indicating if tabs were successfully removed
Sample
removeStyleClass(styleName)
Removes a style from the styleClass property. This works only for NGClient where multiple styles are supported.
Parameters
String styleName the name of the style class to remove
Returns: void
Sample
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
Object index The index of the tab to remove.
Returns: Boolean a boolean value indicating if tab was successfully removed
Sample
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. Please note that location should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
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.
Returns: void
Sample
setMnemonicAt(index, text)
Sets the mnemonic for a specified tab in a tabpanel.