RuntimePortal

Extends

RuntimeComponent

Property Summary

TypeNameSummary

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 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 Summary

TypeNameSummary

void

Adds a style to the styleClass property..

void

Deletes the currently selected portal row in the foundset of the specified portal..

void

Duplicates the currently selected portal row in the foundset of the specified portal..

void

Duplicates the currently selected portal row in the foundset of the specified portal..

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 name of an element..

Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content..

Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content..

Gets the selected record index in the current cached foundset in the specified portal..

Returns the sort columns names of the current portal (as comma separated string)..

Returns the width of the current element..

void

Check if an element already have a style from the styleClass property..

void

Creates a new portal row in the foundset of the specified portal..

void

Creates a new portal row in the foundset of the specified portal..

void

Sets the value for the specified element client property key..

void

Removes a style from the styleClass property..

void

Sets the location of an element..

void

Sets the scroll location of an element..

void

Sets the selected record index in the current cached foundset in the specified portal..

void

Sets the size of an element..

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

Returns String

Sample

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

Returns String

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

Returns Boolean

Sample

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

Returns String

Sample

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

Returns String

Sample

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

Returns Boolean

Sample

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

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.

Returns String

Sample

//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

Returns Boolean

Sample

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

Returns Boolean

Sample

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

Parameters String styleName the name of the style class to add

Returns void

Sample

%%elementName%%.addStyleClass('redbg');

deleteRecord()

Deletes the currently selected portal row in the foundset of the specified portal.

Returns void

Sample

%%elementName%%.deleteRecord();

duplicateRecord()

Duplicates the currently selected portal row in the foundset of the specified portal.

Returns void

Sample

// adds the duplicated record on top
%%elementName%%.duplicateRecord();

adds the duplicated record as the topmost record of the foundset

duplicateRecord(addOnTop)

Duplicates the currently selected portal row in the foundset of the specified portal.

Parameters Boolean addOnTop add on top (default true) adds the duplicated record to the foundset

Returns void

Sample

// adds the duplicated record on top
%%elementName%%.duplicateRecord(true);

getAbsoluteFormLocationY()

Returns the absolute form (designed) Y location.

Returns Number The y location of the form in pixels.

Sample

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.

Parameters Object key user interface key (depends on operating system)

Returns Object The value of the property for specified key.

Sample

var property = %%elementName%%.getClientProperty('ToolTipText');

getDesignProperties()

Get the design-time properties of an element.

Returns Object

Sample

var prop = forms.orders.elements.mylabel.getDesignProperties()

getDesignTimeProperty(key)

Get a design-time property of an element.

Parameters String key the name of the property

Returns Object

Sample

var prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop')

getElementType()

Returns the type of a specified element.

Returns String The display type of the element as String.

Sample

var et = %%elementName%%.getElementType();

getFormName()

Returns the name of the form. (may be empty string as well)

Returns String The name of the form.

Sample

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

Returns Number The height of the element in pixels.

Sample

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

Returns Number The x location of the element in pixels.

Sample

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

Returns Number The y location of the element in pixels.

Sample

var y =  %%elementName%%.getLocationY();

getName()

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

Returns String The name of the element.

Sample

var name = %%elementName%%.getName();

getScrollX()

Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content.

NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function. For Example:

//returns the X and Y scroll coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY();

//sets the new scroll location forms.company.elements.portal50.setScroll(x+10,y+10);

Returns Number The x scroll location in pixels.

Sample

var x = %%elementName%%.getScrollX();

getScrollY()

Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content.

NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function. For Example:

//returns the X and Y scroll coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY();

//sets the new scroll location forms.company.elements.portal50.setScroll(x+10,y+10);

Returns Number The y scroll location in pixels.

Sample

var y = %%elementName%%.getScrollY();

getSelectedIndex()

Gets the selected record index in the current cached foundset in the specified portal.

Returns Number The selected index (integer).

Sample

//gets the selected record index in the foundset
var current = %%elementName%%.getSelectedIndex();

//sets the next record index in the foundset
%%elementName%%.setSelectedIndex(current+1);

getSortColumns()

Returns the sort columns names of the current portal (as comma separated string).

Returns String array with column names

Sample

var w = %%elementName%%.getSortColumns();

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

var w = %%elementName%%.getWidth();

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

%%elementName%%.hasStyleClass('redbg');

newRecord()

Creates a new portal row in the foundset of the specified portal.

Returns void

Sample

// foreign key data is only filled in for equals (=) relation items 
%%elementName%%.newRecord();

newRecord(addOnTop)

Creates a new portal row in the foundset of the specified portal.

Parameters Boolean addOnTop adds the new portal record as the topmost row of the foundset, default value is true

Returns void

Sample

// foreign key data is only filled in for equals (=) relation items 
//adds the new record on top
%%elementName%%.newRecord(true);

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

%%elementName%%.putClientProperty('ToolTipText','some text');

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

%%elementName%%.removeStyleClass('redbg');

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

%%elementName%%.setLocation(200,200);

setScroll(x, y)

Sets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content

NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location. For Example:

//returns the X and Y coordinates var x = forms.company.elements.portal50.getScrollX(); var y = forms.company.elements.portal50.getScrollY();

//sets the new location forms.company.elements.portal50.setScroll(x+10,y+10);

Parameters Number x the X coordinate of the portal scroll location in pixels Number y the Y coordinate of the portal scroll location in pixels

Returns void

Sample

%%elementName%%.setScroll(200,200);

setSelectedIndex(index)

Sets the selected record index in the current cached foundset in the specified portal.

Parameters Number index the specified record index

Returns void

Sample

//gets the selected record index in the foundset
var current = %%elementName%%.getSelectedIndex();

//sets the next record index in the foundset
%%elementName%%.setSelectedIndex(current+1);

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

Parameters Number width the width of the element in pixels. Number height the height of the element in pixels.

Returns void

Sample

%%elementName%%.setSize(20,30);

Last updated