RuntimeAccordionPanel

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.

Since

Parameters

String

Also see

External links

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".

Since

spec – the border attributes

String

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

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.

Since

Parameters

String

Also see

External links

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.

Since

Parameters

String

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

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.

Since

Parameters

Object

Also see

External links

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.

Since

Parameters

String

Also see

External links

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

Since

Parameters

Boolean

Also see

External links

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.

Since

Parameters

Boolean

Also see

External links

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.

Since

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

Boolean – a boolean value indicating if tab was successfully added

Also see

External links

Number

getAbsoluteFormLocationY

()

Returns the absolute form (designed) Y location.

Since

Parameters

Number – The y location of the form in pixels.

Also see

External links

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.

Since

{Object} key – user interface key (depends on operating system)

Object – The value of the property for specified key.

Also see

External links

Object

getDesignTimeProperty

()

Get a design-time property of an element.

Since

Parameters

Object

Also see

External links

String

getElementType

()

Returns the type of a specified element.

Since

Parameters

String – The display type of the element as String.

Also see

External links

Number

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);

Since

Parameters

Number – The height of the element in pixels.

Also see

External links

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
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);

Since

Parameters

Number – The x location of the element in pixels.

Also see

External links

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
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);

Since

Parameters

Number – The y location of the element in pixels.

Also see

External links

Number

getMaxTabIndex

()

Returns the maximum tab index for a specified tabpanel.

Since

Parameters

Number – maximum tab index (number)

Also see

External links

String

getMnemonicAt

(i)

Returns the mnemonic for a specified tab of a tabpanel.

Since

{Number} i – The number of the specified tab.

String – The mnemonic.

Also see

External links

String

getName

()

Returns the name of an element. (may be null as well)

Since

Parameters

String – The name of the element.

Also see

External links

String

getTabFGColorAt

(i)

Returns the foreground color for a specified tab of a tabpanel.

Since

{Number} i – the number of the specified tab

String – color as hexadecimal RGB string

Also see

External links

String

getTabFormNameAt

(i)

Returns the form name for a specified tab of a tabpanel.

Since

{Number} i – index of the tab

String – the name of the form

Also see

External links

String

getTabNameAt

(i)

Returns the name - the "name" design time property value - for a specified tab of a tabpanel.

Since

{Number} i – The number of the specified tab.

String – The tab name

Also see

External links

String

getTabRelationNameAt

(i)

Returns the relation name for a specified tab of a tabpanel.

Since

{Number} i – index of the tab

String – relation name

Also see

External links

String

getTabTextAt

(i)

Returns the text for a specified tab of a tabpanel.

Since

{Number} i – The number of the specified tab.

String – The tab text.

Also see

External links

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)
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);

Since

Parameters

Number – The width of the element in pixels.

Also see

External links

Boolean

isTabEnabledAt

(i)

Returns the enabled status of a specified tab in a tabpanel.

Since

{Number} i – the number of the specified tab.

Boolean – True if tab is enabled, false otherwise.

Also see

External links

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.

Since

{Object} key – user interface key (depends on operating system)
{Object} value – a predefined value for the key

void

Also see

External links

Boolean

removeAllTabs

()

Removes all tabs for a specified tabpanel.

Since

Parameters

Boolean – a boolean value indicating if tabs were successfully removed

Also see

External links

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.

Since

index – The index of the tab to remove.

Boolean – a boolean value indicating if tab was successfully removed

Also see

External links

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.
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);

Since

{Number} x – the X coordinate of the element in pixels.
{Number} y – the Y coordinate of the element in pixels.

void

Also see

External links

void

setMnemonicAt

(index, text)

Sets the mnemonic for a specified tab in a tabpanel.

Since

index – the number of the specified tab
text – the text to be set for the specified tab

void

Also see

External links

void

setSize

(width, height)

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);

Since

{Number} width – the width of the element in pixels.
{Number} height – the height of the element in pixels.

void

Also see

External links

void

setTabEnabledAt

(i, b)

Sets the status of a specified tab in a tabpanel.

Since

{Number} i – the number of the specified tab.
{Boolean} b – true if enabled; or false if disabled.

void

Also see

External links

void

setTabFGColorAt

(i, s)

Sets the foreground color for a specified tab in a tabpanel.

Since

{Number} i – the number of the specified tab
{String} s – the hexadecimal RGB color value to be set.

void

Also see

External links

void

setTabTextAt

(index, text)

Sets the text for a specified tab in a tabpanel.

Since

index – the number of the specified tab
text – the text to be set for the specified tab

void

Also see

External links