RuntimeHtmlArea
Overview
Interface for RuntimeHtmlArea component.
Extends
Properties Summarized
Type | Name | Summary |
---|---|---|
Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only. | ||
Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only. | ||
Gets or sets the background color of a field. | ||
Gets or sets the border attribute(s) of a specified element. | ||
Gets or sets the number value (position) of the text caret (text "I" bar) in a field. | ||
Gets or sets the editable/read-only state of a field; true - editable; false - read-only. | ||
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 title text. | ||
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 Summarized
Type | Name | Summary |
---|---|---|
void | Adds a style to the styleClass property. | |
Returns the absolute form (designed) Y location. | ||
Gets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only. | ||
Gets the specified client property for the element based on a key. | ||
Get the data provider this UI element (display) is showing. | ||
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 an Array of label element names that has this field filled in as the labelFor. | ||
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. | ||
Returns the currently selected text in the specified text field or text area. | ||
Returns the width of the current element. | ||
void | Check if an element already have a style from the styleClass property. | |
void | Sets the value for the specified element client property key. | |
void | Removes a style from the styleClass property. | |
void | Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position. | |
void | Request the focus in this element. | |
void | Request the focus in this element. | |
void | Selects all the contents of a field. | |
void | Sets the location of an element. | |
void | Sets the scroll location of an element. | |
void | Sets the size of an element. |
Properties Detailed
URL
Gets or sets the relative URL string contained in a field with a design time display property of HTML_AREA only.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.
Type String
Sample
baseURL
Gets or sets the absolute base URL for the URL string contained in a field with a design time display property of HTML_AREA only.
Type String
Sample
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
caretPosition
Gets or sets the number value (position) of the text caret (text "I" bar) in a field. NOTE: This does not work in Web Client.
Type Number
Sample
editable
Gets or sets the editable/read-only state of a field; true - editable; false - read-only.
NOTE the "!" operator can be used to invert the editable state.
Type Boolean
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
titleText
Gets or sets the title text.
Type String
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
Sample
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.
Type Boolean
Sample
Methods Detailed
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
getAbsoluteFormLocationY()
Returns the absolute form (designed) Y location.
Returns: Number The y location of the form in pixels.
Sample
getAsPlainText()
Gets the plain text for the formatted HTML/RTF text of a specified field element with a design time display property of HTML_AREA/RTF only.
NOTE: This does not work in Web Client.
NOTE: As of Servoy 4.x (and higher) you can also get/set the relative or absolute URL for an HTML_AREA field element. For more detail, see the .URL and .baseURL field element runtime properties earlier in this section.
NOTE: For information about field element design time properties, see the section on Field elements in the Forms chapter of the Servoy Developer User's Guide.
Returns: String the plain text
Sample
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
getDataProviderID()
Get the data provider this UI element (display) is showing.
Returns: String The data provider as String.
Sample
getDesignProperties()
Get the design-time properties of an element.
Returns: Object
Sample
getDesignTimeProperty(key)
Get a design-time property of an element.
Parameters
String key the name of the property
Returns: Object
Sample
getElementType()
Returns the type of a specified element.
Returns: String The display type of the element as String.
Sample
getFormName()
Returns the name of the form. (may be empty string as well)
Returns: String The name of the form.
Sample
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
getLabelForElementNames()
Returns an Array of label element names that has this field filled in as the labelFor.
Returns: Array An array with element names.
Sample
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
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
getName()
Returns the name of an element. (may be null as well)
Returns: String The name of the element.
Sample
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
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
getSelectedText()
Returns the currently selected text in the specified text field or text area.
NOTE: This does not work for text fields in the Web Client.
Returns: String The selected text from the component.
Sample
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
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
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
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
replaceSelectedText(s)
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA.
Parameters
String s The replacement text.
Returns: void
Sample
requestFocus()
Request the focus in this element. (Focus is also a text cursor on text components).
Returns: void
Sample
requestFocus(mustExecuteOnFocusGainedMethod)
Request the focus in this element. (Focus is also a text cursor on text components).
Parameters
Boolean mustExecuteOnFocusGainedMethod If true will execute onFocusGained method, else will not; default value is true.
Returns: void
Sample
selectAll()
Selects all the contents of a field.
Returns: void
Sample
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
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
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
Returns: void
Sample
Last updated