Skip to end of metadata
Go to start of metadata

Refresh page Aug 12, 2019 03:52

Supported 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.
String format Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.
String imageURL Gets/Sets the image displayed on a button or label; based on URL.
String mnemonic Gets or sets the specified character(s) - typically an underlined letter- used with/without the modifier key(s) for the label, button or image.
String rolloverImageURL Gets/Sets the image displayed on a button or label roll over; based on URL.
String text Gets or sets the text that is displayed on the label, button or image.
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.
Number getAbsoluteFormLocationY() Returns the absolute form (designed) Y location.
Object getClientProperty(key) Gets the specified client property for the element based on a key.
String getDataProviderID() Get the data provider this UI element (display) is showing.
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.
String getLabelForElementName() Gets the label for property of a label.
Number getLocationX() Returns the x location of the current element.
Number getLocationY() Returns the y location of the current element.
String getName() Returns the name of an element.
Array getThumbnailJPGImage() Returns the image data in .
Array getThumbnailJPGImage(width, height) Returns the image data in .
Number getWidth() Returns the width of the current element.
void hasStyleClass(styleName) Check if an element already have a style from the styleClass property.
void putClientProperty(key, value) Sets the value for the specified element client property key.
void removeStyleClass(styleName) Removes a style from the styleClass property.
void setLocation(x, y) Sets the location of an element.
void setSize(width, height) Sets the size of an element.

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.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

//sets the background color of the field
%%prefix%%%%elementName%%.bgcolor = "#FFFFFF";
//gets the background color of the field
var c = %%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

//gets the enabled state of the field
var currState = %%prefix%%%%elementName%%.enabled;

//sets the enabled state of the field
%%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

Sample

//sets the foreground color of the field
%%prefix%%%%elementName%%.fgcolor = "#000000";

//gets the foreground color of the field
var c = %%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

Sample

%%prefix%%%%elementName%%.font = 'Tahoma,1,11';

format

Gets or sets the display formatting of an element for number and text values; does not affect the actual value stored in the database column.

There are different options for the different dataprovider types that are assigned to this field.
For Integer fields, there is a display and an edit format, using http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html and the max (string) length can be set.
For Text/String fields, there are options to force uppercase,lowercase or only numbers. Or a mask can be set that restrict the input the pattern chars can be found here: http://docs.oracle.com/javase/7/docs/api/javax/swing/text/MaskFormatter.html
A mask can have a placehoder (what is shown when there is no data) and if the data must be stored raw (without literals of the mask). A max text length can also be set to force
the max text length input, this doesn't work on mask because that max length is controlled with the mask.
For Date fields a display and edit format can be set by using a pattern from here: http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html, you can also say this must behave like a mask (the edit format)
A mask only works with when the edit format is exactly that mask (1 char is 1 number/char), because for example MM then only 2 numbers are allowed MMM that displays the month as a string is not supported as a mask.
Some examples are "dd-MM-yyyy", "MM-dd-yyyy", etc.
The format property is also used to set the UI Converter, this means that you can convert the value object to something else before it gets set into the field, this can also result in a type change of the data. 
So a string in scripting/db is converted to a integer in the ui, then you have to set an integer format.
It only returns it's correct value if it was explicitly set, otherwise null.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

//sets the display formatting of the field
%%prefix%%%%elementName%%.format = '###';

//gets the display formatting of the field
var format = %%prefix%%%%elementName%%.format;

imageURL

Gets/Sets the image displayed on a button or label; based on URL.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

//dynamically sets an image displayed on a button or label
%%prefix%%%%elementName%%.imageURL = "http://www.servoy.com/images/test.gif";

//sets an image from your own image library
%%prefix%%%%elementName%%.imageURL = "media:///arrow.gif";

//loads an image (BLOB) from a field in a selected record into HTML
%%prefix%%%%elementName%%.imageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';

mnemonic

Gets or sets the specified character(s) - typically an underlined letter- used with/without the modifier key(s) for the label, button or image. 

Modifiers key values: 
1 SHIFT 
2 CTRL 
4 Meta/CMD (Macintosh)
8 ALT(Windows, Unix); OPTION (Macintosh) 

NOTE: A mnemonic is usually a single key used with/without the CTRL, CMD, SHIFT, ALT, or OPTION key(s) to activate a menu item or command - depending, in part on whether the menmonic applies in a command line or graphic interface. For one description, you can refer to this web page: http://msdn.microsoft.com/en-us/library/bb158536.aspx or perform a search in a web browser search engine using the criteria "mnemonic".
NOTE2: Mnemonic is only supported in Smart Client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

//gets the mnemonic of the element
var my_mnemoic = %%prefix%%%%elementName%%.mnemonic;

//sets the mnemonic of the element
%%prefix%%%%elementName%%.mnemonic = 'f';

rolloverImageURL

Gets/Sets the image displayed on a button or label roll over; based on URL.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

//dynamically sets a roll over image displayed on a button or label
%%prefix%%%%elementName%%.rolloverImageURL = "http://www.servoy.com/images/test.gif";

//sets an image from your own image library
%%prefix%%%%elementName%%.rolloverImageURL = "media:///arrow.gif";

//loads an image (BLOB) from a field in a selected record into HTML
%%prefix%%%%elementName%%.rolloverImageURL = 'media:///servoy_blobloader?datasource='+controller.getDataSource()+'&dataprovider=image_data&mimetype=image/jpeg&rowid1=2';

text

Gets or sets the text that is displayed on the label, button or image.

NOTE: The .text property applies to labels, buttons, or images ONLY.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

//gets the text of the element
var my_text = %%prefix%%%%elementName%%.text;

//sets the text of the element
%%prefix%%%%elementName%%.text = my_text + 'is cool';

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

//gets the tooltip text of the element
var toolTip = %%prefix%%%%elementName%%.toolTipText;

//sets the tooltip text of the element
%%prefix%%%%elementName%%.toolTipText = "New tip";
%%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

Sample

//gets the transparency of the element
var currentState = %%prefix%%%%elementName%%.transparent;

//sets the transparency of the element
%%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

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

Supported Clients

NGClient

Sample

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

getAbsoluteFormLocationY()

Returns the absolute form (designed) Y location.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var absolute_y = %%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getDataProviderID()

Get the data provider this UI element (display) is showing.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

%%prefix%%%%elementName%%.getDataProviderID();

getDesignTimeProperty(key)

Get a design-time property of an element.

Parameters

String key the name of the property

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getElementType()

Returns the type of a specified element.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getFormName()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var name = %%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

Sample

var ht = %%prefix%%%%elementName%%.getHeight();

getLabelForElementName()

Gets the label for property of a label. This property is used to link a label to a certain element (by default used for tableview header, form security, can be used for custom purposes ).

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var name = %%prefix%%%%elementName%%.getLabelForElementName();

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

var x = %%prefix%%%%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

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getName()

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

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

getThumbnailJPGImage()

Returns the image data in .jpg format from an icon; thumbnailing only works in record view.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var jpgData = %%prefix%%%%elementName%%.getThumbnailJPGImage();
plugins.file.writeFile("mypicture.jpg", jpgData);

getThumbnailJPGImage(width, height)

Returns the image data in .jpg format from an icon; thumbnailing only works in record view.

Parameters

Number width The target width, use -1 for original image width.
Number height The target height, use -1 for original image height.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var jpgData = %%prefix%%%%elementName%%.getThumbnailJPGImage(50, 50);
plugins.file.writeFile("mypicture.jpg", jpgData);

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

var w = %%prefix%%%%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

Supported Clients

NGClient

Sample

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

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

Supported Clients

NGClient

Sample

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

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

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.

Supported Clients

SmartClient,WebClient,NGClient

Sample

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

  • No labels