Mar 29, 2024 02:16 Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
Extends
RuntimeComponent
Property Summary
String
bgcolor
Gets or sets the background color of a field.
String
border
Gets or sets the border attribute(s) of a specified element.
Boolean
enabled
Gets or sets the enabled state of a specified field, also known as "grayed".
String
fgcolor
Gets or sets the foreground color of a field.
String
font
Gets or sets the font name, style, and size of an element.
Boolean
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).
Object
tabIndex
Gets or sets the selected tab index for the specified tabpanel.
String
toolTipText
Gets or sets the tool tip text of an element; text displays when the mouse cursor hovers over an element.
Boolean
transparent
Gets or sets the transparency of an element; true - transparent; false - not transparent.
Boolean
visible
Gets or sets the visibility of an element; true - visible; false - not visible; ! - the visibility state is inverted (the opposite).
Methods Summary
void
addStyleClass(styleName)
Adds a style to the styleClass property.
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.
Number
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Object
getClientProperty(key)
Gets the specified client property for the element based on a key.
Object
getDesignProperties()
Get the design-time properties of an element.
Object
getDesignTimeProperty(key)
Get a design-time property of an element.
String
getElementType()
Returns the type of a specified element.
String
getFormName()
Returns the name of the form.
Number
getHeight()
Returns the height of the current element.
Number
getLocationX()
Returns the x location of the current element.
Number
getLocationY()
Returns the y location of the current element.
Number
getMaxTabIndex()
Returns the maximum tab index for a specified tabpanel.
String
getMnemonicAt(i)
Returns the mnemonic for a specified tab of a tabpanel.
String
getName()
Returns the name of an element.
String
getTabFGColorAt(i)
Returns the foreground color for a specified tab of a tabpanel.
String
getTabFormNameAt(i)
Returns the form name for a specified tab of a tabpanel.
String
getTabNameAt(i)
Returns the name - the "name" design time property value - for a specified tab of a tabpanel.
String
getTabRelationNameAt(i)
Returns the relation name for a specified tab of a tabpanel.
String
getTabTextAt(i)
Returns the text for a specified tab of a tabpanel.
Number
getWidth()
Returns the width of the current element.
void
hasStyleClass(styleName)
Check if an element already have a style from the styleClass property.
Boolean
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.
Boolean
removeAllTabs()
Removes all tabs for a specified tabpanel.
void
removeStyleClass(styleName)
Removes a style from the styleClass property.
Boolean
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
setMnemonicAt(index, text)
Sets the mnemonic for a specified tab in a tabpanel.
void
setSize(width, height)
Sets the size of an element.
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.
Property Details
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.
//sets the background color of the field
%%elementName%%.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = %%elementName%%.bgcolor;
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".
//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"
%%elementName%%.border = 'LineBorder,1,#ccffcc';
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.
//gets the enabled state of the field
var currState = %%elementName%%.enabled;
//sets the enabled state of the field
%%elementName%%.enabled = !currentState;
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.
//sets the foreground color of the field
%%elementName%%.fgcolor = "#000000";
//gets the foreground color of the field
var c = %%elementName%%.fgcolor;
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.
%%elementName%%.font = 'Tahoma,1,11';
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.
//gets the editable/read-only state of the field
var currentState = %%elementName%%.readOnly;
//sets the editable/read-only state of the field
%%elementName%%.readOnly = !currentState;
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)
//gets the selected tab index of the tabpanel
var current = %%elementName%%.tabIndex;
//sets (goes to) the selected tabIndex of the tabpanel
%%elementName%%.tabIndex = current + 1;
//or sets (goes to) the tab with the specified name
%%elementName%%.tabIndex = 'tab_name';
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.
//gets the tooltip text of the element
var toolTip = %%elementName%%.toolTipText;
//sets the tooltip text of the element
%%elementName%%.toolTipText = "New tip";
%%elementName%%.toolTipText = "<html>This includes <b>bolded text</b> and <font color='blue'>BLUE</font> text as well.";
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
//gets the transparency of the element
var currentState = %%elementName%%.transparent;
//sets the transparency of the element
%%elementName%%.transparent = !currentState;
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.
//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;
Methods Details
addStyleClass(styleName)
Adds a style to the styleClass property. This works only for NGClient where multiple styles are supported.
String
styleName
the name of the style class to add
%%elementName%%.addStyleClass('redbg');
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.
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
%%elementName%%.addTab(forms.orders,'ordersTab','Orders',null,null,'#000000','#BBCCEE');
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
var absolute_y = %%elementName%%.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.
Object
key
user interface key (depends on operating system)
var property = %%elementName%%.getClientProperty('ToolTipText');
getDesignProperties()
Get the design-time properties of an element.
var prop = forms.orders.elements.mylabel.getDesignProperties()
getDesignTimeProperty(key)
Get a design-time property of an element.
String
key
the name of the property
var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')
getElementType()
Returns the type of a specified element.
var et = %%elementName%%.getElementType();
getFormName()
Returns the name of the form. (may be empty string as well)
var name = %%elementName%%.getFormName();
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);
var ht = %%elementName%%.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);
var x = %%elementName%%.getLocationX();
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);
var y = %%elementName%%.getLocationY();
getMaxTabIndex()
Returns the maximum tab index for a specified tabpanel.
var max = %%elementName%%.getMaxTabIndex();
getMnemonicAt(i)
Returns the mnemonic for a specified tab of a tabpanel.
Number
i
The number of the specified tab.
var mnemonic = %%elementName%%.getMnemonicAt(3);
getName()
Returns the name of an element. (may be null as well)
var name = %%elementName%%.getName();
getTabFGColorAt(i)
Returns the foreground color for a specified tab of a tabpanel.
Number
i
the number of the specified tab
var color = %%elementName%%.getTabFGColorAt(3);
getTabFormNameAt(i)
Returns the form name for a specified tab of a tabpanel.
Number
i
index of the tab
var formName = %%elementName%%.getSelectedTabFormName(3);
getTabNameAt(i)
Returns the name - the "name" design time property value - for a specified tab of a tabpanel.
Number
i
The number of the specified tab.
var tabName = %%elementName%%.getTabNameAt(3);
getTabRelationNameAt(i)
Returns the relation name for a specified tab of a tabpanel.
Number
i
index of the tab
var relName = %%elementName%%.getTabRelationNameAt(3);
getTabTextAt(i)
Returns the text for a specified tab of a tabpanel.
Number
i
The number of the specified tab.
var tabText = %%elementName%%.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);
var w = %%elementName%%.getWidth();
hasStyleClass(styleName)
Check if an element already have a style from the styleClass property.
String
styleName
the name of the style class to be checked
%%elementName%%.hasStyleClass('redbg');
isTabEnabledAt(i)
Returns the enabled status of a specified tab in a tabpanel.
Number
i
the number of the specified tab.
var status = %%elementName%%.isTabEnabledAt(3);
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.
Object
key
user interface key (depends on operating system)
Object
value
a predefined value for the key
%%elementName%%.putClientProperty('ToolTipText','some text');
removeAllTabs()
Removes all tabs for a specified tabpanel.
%%elementName%%.removeAllTabs();
removeStyleClass(styleName)
Removes a style from the styleClass property. This works only for NGClient where multiple styles are supported.
String
styleName
the name of the style class to remove
%%elementName%%.removeStyleClass('redbg');
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.
Object
index
The index of the tab to remove.
%%elementName%%.removeTabAt(3);
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);
Number
x
the X coordinate of the element in pixels.
Number
y
the Y coordinate of the element in pixels.
%%elementName%%.setLocation(200,200);
setMnemonicAt(index, text)
Sets the mnemonic for a specified tab in a tabpanel.
Object
index
the number of the specified tab
Object
text
the text to be set for the specified tab
%%elementName%%.setMnemonicAt(3,'a');
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);
Number
width
the width of the element in pixels.
Number
height
the height of the element in pixels.
%%elementName%%.setSize(20,30);
setTabEnabledAt(i, b)
Sets the status of a specified tab in a tabpanel.
Number
i
the number of the specified tab.
Boolean
b
true if enabled; or false if disabled.
%%elementName%%.setTabEnabledAt(3,true);
setTabFGColorAt(i, s)
Sets the foreground color for a specified tab in a tabpanel.
Number
i
the number of the specified tab
String
s
the hexadecimal RGB color value to be set.
%%elementName%%.setTabFGColorAt(3,'#000000');
setTabTextAt(index, text)
Sets the text for a specified tab in a tabpanel.
Object
index
the number of the specified tab
Object
text
the text to be set for the specified tab
%%elementName%%.setTabTextAt(3,'newTitle');