Properties
| | Property | Type | Access | Description |
|---|
| active | Boolean |
r/w | Always false. This element cannot have input focus. |
| alignment | String |
r/w |
The alignment style for this element. If defined, this value overrides the alignChildren setting for the parent container.
|
| bounds | Bounds |
r/w | The boundaries of the element, in parent-relative coordinates. |
| characters | Number (min: 0) |
r/w | A number of characters for which to reserve space when calculating the preferred size of the element. |
| children | Array of Object |
readonly | An array of child elements. |
| enabled | Boolean |
r/w | True if this element is enabled. |
| graphics | ScriptUIGraphics |
readonly |
The graphics object that can be used to customize the element's appearance, in response to the onDraw() event.
|
| helpTip | String |
r/w | The help text that is displayed when the mouse hovers over the element. |
| indent | Number (min: 0) |
r/w | The number of pixels to indent the element during automatic layout. |
| justify | String |
r/w | The text justification style. (default: left)
One of left, center, or right. Justification only works if this value is set on creation of the element.
|
| location | Point |
r/w | The upper left corner of this element relative to its parent. |
| maximumSize | Dimension |
r/w | The maximum height and width to which the element can be resized. |
| minimumSize | Dimension |
r/w | The minimum height and width to which the element can be resized. |
| parent | Object |
readonly | The parent element. |
| preferredSize | Dimension |
r/w | The preferred size, used by layout managers to determine the best size for each element. |
| properties | Object |
r/w | An object that contains one or more creation properties of the container (properties used only when the element is created). |
| shortcutKey | String |
r/w |
The key sequence that invokes the onShortcutKey() callback for this element (in Windows only).
|
| size | Dimension |
r/w | The current dimensions of this element. |
| text | String |
r/w | The text to display, a localizable string. |
| type | String |
readonly | The element type, "statictext". |
| visible | Boolean |
r/w | True if this element is shown, false if it is hidden. |
| window | Window (SUI) |
readonly | The window that this element belongs to. |
| windowBounds | Bounds |
readonly | The bounds of this element relative to the top-level parent window. |
|
Methods
| Eventsvoid onDraw ()
An event-handler callback function, called when the window is about to be drawn.
Allows the script to modify or control the appearance, using the controlís associated ScriptUIGraphics object. Handler takes one argument, a DrawState object.
void onShortcutKey ()
An event-handler callback function, called when the element's shortcutKey sequence is typed in the active window.
In Windows only.
InstancesBoolean addEventListener (eventName:
String, handler:
Function[, capturePhase:
Boolean=false])
Registers an event handler for a particular type of event occuring in this element.
| Parameter | Type | Description |
|---|
| eventName | String | The name of the event.
Event names are listed in the JavaScript Tools Guide.
|
| handler | Function | The function that handles the event.
This can be the name of a function defined in the extension, or a locally defined handler function to be executed when the event occurs. A handler function takes one argument, the UIEvent object.
|
| capturePhase | Boolean | When true, the handler is called only in the capturing phase of the event propagation. (default: false)
Default is false, meaning that the handler is called in the bubbling phase if this object is an ancestor of the target, or in the at-target phase if this object is itself the target. |
Event dispatchEvent ()
Simulates the occurrence of an event in this target.
A script can create a UIEvent object for a specific event and pass it to this method to start the event propagation for the event.
void hide ()
Hides this element.
void notify ([eventName:
String])
Sends a notification message, simulating the specified user interaction event.
| Parameter | Type | Description |
|---|
| eventName | String | The name of the control event handler to call.
One of: onClick, onChange, onChanging. By default, simulates the onChange event for an edittext control, an onClick event for controls that support that event.
(Optional) |
Boolean removeEventListener (eventName:
String, handler:
Function[, capturePhase:
Boolean=false])
Unregisters an event handler for a particular type of event occuring in this element.
All arguments must be identical to those that were used to register the event handler.
| Parameter | Type | Description |
|---|
| eventName | String | The name of the event. |
| handler | Function | The function that handles the event. |
| capturePhase | Boolean | Whether to call the handler only in the capturing phase of the event propagation. (default: false) |
void show ()
Shows this element.
When a window or container is hidden, its children are also hidden, but when it is shown again, the children retain their own visibility states.
|