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). |
Method Summary | |
---|---|
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() Get a design-time property of an element. |
String | #getElementType() Returns the type of a specified element. |
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. |
String | #getName() Returns the name of an element. |
byte[] | #getThumbnailJPGImage() Returns the image data in . |
byte[] | #getThumbnailJPGImage(width, height) Returns the image data in . |
Number | #getWidth() Returns the width of the current element. |
void | #putClientProperty(key, value) Sets the value for the specified element client property key. |
void | #requestFocus() Request the focus in this element. |
void | #requestFocus(mustExecuteOnFocusGainedMethod) Request the focus in this element. |
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 |
Sample//sets the background color of the field forms.customer.elements.customer_id.bgcolor = "#FFFFFF"; //gets the background color of the field var c = forms.customer.elements.customer_id.bgcolor; |
border |
Gets or sets the border attribute(s) of a specified element. The border attributes: borderType - EmptyBorder, EtchedBorder, BevelBorder, LineBorder, TitleBorder, MatteBorder, SpecialMatteBorder. 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 |
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" forms.customer.elements.customer_id.border = 'LineBorder,1,#ccffcc'; |
enabled |
Gets or sets the enabled state of a specified field, also known as "grayed". 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 |
Sample//gets the enabled state of the field var currState = forms.customer.elements.customer_id.enabled; //sets the enabled state of the field forms.customer.elements.customer_id.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 |
Sample//sets the foreground color of the field forms.customer.elements.customer_id.fgcolor = "#000000"; //gets the foreground color of the field var c = forms.customer.elements.customer_id.fgcolor; |
font |
Gets or sets the font name, style, and size of an element. font name - the name of the font family. It only returns it's correct value if it was explicitly set. |
Returns |
Sampleforms.customer.elements.customer_id.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. |
Returns |
Sample//sets the display formatting of the field forms.customer.elements.customer_id.format = '###'; //gets the display formatting of the field var format = forms.customer.elements.customer_id.format; |
imageURL |
Gets/Sets the image displayed on a button or label; based on URL.
|
Returns |
Sample//dynamically sets an image displayed on a button or label forms.customer.elements.customer_id.imageURL = "http://www.servoy.com/images/test.gif"; //sets an image from your own image library forms.customer.elements.customer_id.imageURL = "media:///arrow.gif"; //loads an image (BLOB) from a field in a selected record into HTML forms.customer.elements.customer_id.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: 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". |
Returns |
Sample//gets the mnemonic of the element var my_mnemoic = forms.customer.elements.customer_id.mnemonic; //sets the mnemonic of the element forms.customer.elements.customer_id.mnemonic = 'f'; |
rolloverImageURL |
Gets/Sets the image displayed on a button or label roll over; based on URL.
|
Returns |
Sample//dynamically sets a roll over image displayed on a button or label forms.customer.elements.customer_id.rolloverImageURL = "http://www.servoy.com/images/test.gif"; //sets an image from your own image library forms.customer.elements.customer_id.rolloverImageURL = "media:///arrow.gif"; //loads an image (BLOB) from a field in a selected record into HTML forms.customer.elements.customer_id.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 |
Sample//gets the text of the element var my_text = forms.customer.elements.customer_id.text; //sets the text of the element forms.customer.elements.customer_id.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 |
Sample//gets the tooltip text of the element var toolTip = forms.customer.elements.customer_id.toolTipText; //sets the tooltip text of the element forms.customer.elements.customer_id.toolTipText = "New tip"; forms.customer.elements.customer_id.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 |
Sample//gets the transparency of the element var currentState = forms.customer.elements.customer_id.transparent; //sets the transparency of the element forms.customer.elements.customer_id.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 |
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; |
Method Details |
---|
getAbsoluteFormLocationY |
Number getAbsoluteFormLocationY () |
Returns the absolute form (designed) Y location.
|
Returns Number – The y location of the form in pixels.
|
Samplevar absolute_y = forms.customer.elements.customer_id.getAbsoluteFormLocationY(); |
getClientProperty |
Object 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.
|
Samplevar property = forms.customer.elements.customer_id.getClientProperty('ToolTipText'); |
getDataProviderID |
String getDataProviderID () |
Get the data provider this UI element (display) is showing.
|
Returns String – The data provider as String.
|
Sampleforms.customer.elements.customer_id.getDataProviderID(); |
getDesignTimeProperty |
Object getDesignTimeProperty () |
Get a design-time property of an element.
|
Returns |
Samplevar prop = forms.orders.elements.mylabel.getDesignTimeProperty('myprop') |
getElementType |
String getElementType () |
Returns the type of a specified element.
|
Returns String – The display type of the element as String.
|
Samplevar et = forms.customer.elements.customer_id.getElementType(); |
getHeight |
Number getHeight () |
Returns the height of the current element. //returns the width (w) and height (h) //sets the new size //sets the new size and adds 1 px to both the width and height |
Returns Number – The height of the element in pixels.
|
Samplevar ht = forms.customer.elements.customer_id.getHeight(); |
getLocationX |
Number 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 //sets the new location 10 px to the right; 10 px down from the current location |
Returns Number – The x location of the element in pixels.
|
Samplevar x = forms.customer.elements.customer_id.getLocationX(); |
getLocationY |
Number getLocationY () |
Returns the y location of the current element. 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 //sets the new location 10 px to the right; 10 px down from the current location |
Returns Number – The y location of the element in pixels.
|
Samplevar y = forms.customer.elements.customer_id.getLocationY(); |
getName |
String getName () |
Returns the name of an element. (may be null as well)
|
Returns String – The name of the element.
|
Samplevar name = forms.customer.elements.customer_id.getName(); |
getThumbnailJPGImage |
byte[] getThumbnailJPGImage () |
Returns the image data in .jpg format from an icon; thumbnailing only works in record view.
|
Returns byte[] – An array of bytes.
|
Samplevar jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage(); plugins.file.writeFile("mypicture.jpg", jpgData); |
getThumbnailJPGImage |
byte[] getThumbnailJPGImage (width, height) |
Returns the image data in .jpg format from an icon; thumbnailing only works in record view.
|
Parameters |
Returns byte[] – An array of bytes.
|
Samplevar jpgData = forms.customer.elements.customer_id.getThumbnailJPGImage(50, 50); plugins.file.writeFile("mypicture.jpg", jpgData); |
getWidth |
Number 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) //sets the new size //sets the new size and adds 1 px to both the width and height |
Returns Number – The width of the element in pixels.
|
Samplevar w = forms.customer.elements.customer_id.getWidth(); |
putClientProperty |
void 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 |
Returns void
|
Sampleforms.customer.elements.customer_id.putClientProperty('ToolTipText','some text'); |
requestFocus |
void requestFocus () |
Request the focus in this element. (Focus is also a text cursor on text components).
|
Returns void
|
Sample//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components) forms.customer.elements.customer_id.requestFocus(); |
requestFocus |
void 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//request the focus in this forms.customer.elements.customer_id (focus is also a text cursor on text components), skip on focus gained method call forms.customer.elements.customer_id.requestFocus(false); |
setLocation |
void 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. 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 //sets the new location 10 px to the right; 10 px down from the current location |
Parameters |
Returns void
|
Sampleforms.customer.elements.customer_id.setLocation(200,200); |
setSize |
void setSize (width, height) |
Sets the size of an element. It takes as input the width and the height. 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) //sets the new size //sets the new size and adds 1 px to both the width and height |
Parameters |
Returns void
|
Sampleforms.customer.elements.customer_id.setSize(20,30); |