RuntimePortal
Overview
The IScriptPortalComponentMethods
interface supports scripting for runtime portals in Servoy, combining (deprecated) script methods and java api (IRuntimePortal).
Extends
Properties Summarized
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.
Methods Summarized
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 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).
void
Sets the selected record index in the current cached foundset in the specified portal.
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
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