RuntimeTabPanel
Last updated
Was this helpful?
Last updated
Was this helpful?
The IScriptTabPanelMethods
is a scripting interface for RuntimeTabPanel. Combines (deprecated) script methods and java api (IRuntimeTabPanel).
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).
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.
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.
Sample
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".
Sample
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.
Sample
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.
Sample
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.
Sample
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.
Sample
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)
Sample
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.
Sample
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
Sample
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.
Sample
Adds a style to the styleClass property. This works only for NGClient where multiple styles are supported.
Parameters
Returns: void
Sample
Adds a relationless or related form as a tab in a specified tabpanel.
Parameters
Sample
Returns the absolute form (designed) Y location.
Sample
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
Sample
Get the design-time properties of an element.
Sample
Get a design-time property of an element.
Parameters
Sample
Returns the type of a specified element.
Sample
Returns the name of the form. (may be empty string as well)
Sample
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);
Sample
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);
Sample
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);
Sample
Returns the maximum tab index for a specified tabpanel.
Sample
Returns the mnemonic for a specified tab of a tabpanel.
Parameters
Sample
Returns the name of an element. (may be null as well)
Sample
Returns the foreground color for a specified tab of a tabpanel.
Parameters
Sample
Returns the form name for a specified tab of a tabpanel.
Parameters
Sample
Returns the name - the "name" design time property value - for a specified tab of a tabpanel.
Parameters
Sample
Returns the relation name for a specified tab of a tabpanel.
Parameters
Sample
Returns the text for a specified tab of a tabpanel.
Parameters
Sample
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);
Sample
Check if an element already have a style from the styleClass property.
Parameters
Returns: void
Sample
Returns the enabled status of a specified tab in a tabpanel.
Parameters
Sample
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
Removes all tabs for a specified tabpanel.
Sample
Removes a style from the styleClass property. This works only for NGClient where multiple styles are supported.
Parameters
Returns: void
Sample
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
Sample
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
Returns: void
Sample
Sets the mnemonic for a specified tab in a tabpanel.
Parameters
Returns: void
Sample
Sets the size of an element. It takes as input the width and the height. Please note that size should not be altered at runtime when an element is anchored. Use the solutionModel in such a situation.
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
Returns: void
Sample
Sets the status of a specified tab in a tabpanel.
Parameters
Returns: void
Sample
Sets the foreground color for a specified tab in a tabpanel.
Parameters
Returns: void
Sample
Sets the text for a specified tab in a tabpanel.
Parameters
Returns: void
Sample
Type
Type
Type
Type
Type
Type
Type
Type
Type
Type
styleName the name of the style class to add
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: a boolean value indicating if tab was successfully added
Returns: The y location of the form in pixels.
key user interface key (depends on operating system)
Returns: The value of the property for specified key.
Returns: The value of the specified design-time property.
key the name of the property
Returns: A map of all design-time properties for the element.
Returns: The display type of the element as String.
Returns: The name of the form.
Returns: The height of the element in pixels.
Returns: The x location of the element in pixels.
Returns: The y location of the element in pixels.
Returns: maximum tab index (number)
i The number of the specified tab.
Returns: The mnemonic.
Returns: The name of the element.
i the number of the specified tab
Returns: color as hexadecimal RGB string
i index of the tab
Returns: the name of the form
i The number of the specified tab.
Returns: The tab name
i index of the tab
Returns: relation name
i The number of the specified tab.
Returns: The tab text.
Returns: The width of the element in pixels.
styleName the name of the style class to be checked
i the number of the specified tab.
Returns: True if tab is enabled, false otherwise.
key user interface key (depends on operating system)
value a predefined value for the key
Returns: a boolean value indicating if tabs were successfully removed
styleName the name of the style class to remove
index The index of the tab to remove.
Returns: a boolean value indicating if tab was successfully removed
x the X coordinate of the element in pixels.
y the Y coordinate of the element in pixels.
index the number of the specified tab
text the text to be set for the specified tab
width the width of the element in pixels.
height the height of the element in pixels.
i the number of the specified tab.
b true if enabled; or false if disabled.
i the number of the specified tab
s the hexadecimal RGB color value to be set.
index the number of the specified tab
text the text to be set for the specified tab