new UI()
Provides UI interaction in action scripts
Methods
(static) alert(message, windowTitleopt)
Show a notification dialog
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
windowTitle | string | <optional> |
(static) choose(objects, message, windowTitleopt, stringFunctionopt) → {object}
Let the user choose an object from a list
| Name | Type | Attributes | Description |
|---|---|---|---|
objects | Array.<object> | ||
message | string | ||
windowTitle | string | <optional> | |
stringFunction | function | <optional> | Function that returns a string that should be displayed for an element |
Returns undefined if no UI is available
- Type:
- object
(static) chooseExpanded(objects, messageopt) → {objects}
Let the user choose some objects from a list. Shows details of the objects.
| Name | Type | Attributes | Description |
|---|---|---|---|
objects | Array.<object> | ||
message | string | <optional> |
Returns undefined if no UI is available
- Type:
- objects
(static) chooseMultiple(objects, message, windowTitleopt, stringFunctionopt) → {objects}
Let the user choose some objects from a list.
| Name | Type | Attributes | Description |
|---|---|---|---|
objects | Array.<object> | ||
message | string | ||
windowTitle | string | <optional> | |
stringFunction | function | <optional> | Function that returns a string that should be displayed for an element |
Returns undefined if no UI is available
- Type:
- objects
(static) confirm(message, windowTitleopt) → {boolean}
Show a confirmation dialog
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
windowTitle | string | <optional> |
True if confirmed, false if not. Returns undefined if no UI is available.
- Type:
- boolean
(static) hasUI() → {boolean}
True if UI interaction is possible
- Since
- 5.2.1
- Type:
- boolean
(static) notificationDialog(notificationFunction, parametersopt, windowTitleopt)
Open a notification dialog that stays open while the notification function is evaluated
| Name | Type | Attributes | Description |
|---|---|---|---|
notificationFunction | function | Notification function | |
parameters | Array.<boolean> | <optional> | |
windowTitle | string | <optional> |
- Since
- 4.1.0
- See
- UIObject#raiseNotification
(static) openEditor(element, contextopt, optionsopt)
Opens an editor on the element
| Name | Type | Attributes | Description |
|---|---|---|---|
element | $k.SemanticElement | ||
context | <optional> | Context that should be used to detect the view configuration, or a view configuration | |
options | <optional> | Possible key in option object: #isNew |
(static) openGraph(elements, graphConfigopt)
Opens a graph on the elements
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | Graph elements or hits | |
graphConfig | <optional> | Graph configuration |
- Since
- 5.3.2
(static) openTable(elements, domainopt, contextopt)
Opens a table on the elements
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | Table elements or hits | |
domain | $k.Domain | <optional> | Domain or internal name of a type of the table |
context | <optional> | Context that should be used to detect the table configuration, or a table configuration |
- Since
- 4.2.1
(static) openURL(url)
Opens the URL with the associated application
| Name | Type | Description |
|---|---|---|
url | string |
- Since
- 5.2.2
(static) raiseNotification(jseString)
Raise message notification (to use in function #notificationDialog)
| Name | Type | Description |
|---|---|---|
jseString | string |
- Since
- 4.1.0
- See
- UIObject#notificationDialog
(static) requestString(message, windowTitleopt, initialAnsweropt) → {string}
Let the user enter a string in a single-line input field
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
windowTitle | string | <optional> | |
initialAnswer | string | <optional> |
Returns undefined if no UI is available
- Type:
- string
(static) saveFile(blobOrNetEntity, windowTitleopt)
Requests a filename and writes the given blob or net entity to the file.
| Name | Type | Attributes | Description |
|---|---|---|---|
blobOrNetEntity | $k.NetEntity | ||
windowTitle | string | <optional> |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.3.2
alert(message, windowTitleopt)
Show a notification dialog
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
windowTitle | string | <optional> |
choose(objects, message, windowTitleopt, stringFunctionopt) → {object}
Let the user choose an object from a list
| Name | Type | Attributes | Description |
|---|---|---|---|
objects | Array.<object> | ||
message | string | ||
windowTitle | string | <optional> | |
stringFunction | function | <optional> | Function that returns a string that should be displayed for an element |
Returns undefined if no UI is available
- Type:
- object
chooseExpanded(objects, messageopt) → {objects}
Let the user choose some objects from a list. Shows details of the objects.
| Name | Type | Attributes | Description |
|---|---|---|---|
objects | Array.<object> | ||
message | string | <optional> |
Returns undefined if no UI is available
- Type:
- objects
chooseMultiple(objects, message, windowTitleopt, stringFunctionopt) → {objects}
Let the user choose some objects from a list.
| Name | Type | Attributes | Description |
|---|---|---|---|
objects | Array.<object> | ||
message | string | ||
windowTitle | string | <optional> | |
stringFunction | function | <optional> | Function that returns a string that should be displayed for an element |
Returns undefined if no UI is available
- Type:
- objects
confirm(message, windowTitleopt) → {boolean}
Show a confirmation dialog
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
windowTitle | string | <optional> |
True if confirmed, false if not. Returns undefined if no UI is available.
- Type:
- boolean
hasUI() → {boolean}
True if UI interaction is possible
- Since
- 5.2.1
- Type:
- boolean
notificationDialog(notificationFunction, parametersopt, windowTitleopt)
Open a notification dialog that stays open while the notification function is evaluated
| Name | Type | Attributes | Description |
|---|---|---|---|
notificationFunction | function | Notification function | |
parameters | Array.<boolean> | <optional> | |
windowTitle | string | <optional> |
- Since
- 4.1.0
- See
- UIObject#raiseNotification
openEditor(element, contextopt, optionsopt)
Opens an editor on the element
| Name | Type | Attributes | Description |
|---|---|---|---|
element | $k.SemanticElement | ||
context | <optional> | Context that should be used to detect the view configuration, or a view configuration | |
options | <optional> | Possible key in option object: #isNew |
openGraph(elements, graphConfigopt)
Opens a graph on the elements
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | Graph elements or hits | |
graphConfig | <optional> | Graph configuration |
- Since
- 5.3.2
openTable(elements, domainopt, contextopt)
Opens a table on the elements
| Name | Type | Attributes | Description |
|---|---|---|---|
elements | Array.<$k.SemanticElement> | Table elements or hits | |
domain | $k.Domain | <optional> | Domain or internal name of a type of the table |
context | <optional> | Context that should be used to detect the table configuration, or a table configuration |
- Since
- 4.2.1
openURL(url)
Opens the URL with the associated application
| Name | Type | Description |
|---|---|---|
url | string |
- Since
- 5.2.2
raiseNotification(jseString)
Raise message notification (to use in function #notificationDialog)
| Name | Type | Description |
|---|---|---|
jseString | string |
- Since
- 4.1.0
- See
- UIObject#notificationDialog
requestString(message, windowTitleopt, initialAnsweropt) → {string}
Let the user enter a string in a single-line input field
| Name | Type | Attributes | Description |
|---|---|---|---|
message | string | ||
windowTitle | string | <optional> | |
initialAnswer | string | <optional> |
Returns undefined if no UI is available
- Type:
- string
saveFile(blobOrNetEntity, windowTitleopt)
Requests a filename and writes the given blob or net entity to the file.
| Name | Type | Attributes | Description |
|---|---|---|---|
blobOrNetEntity | $k.NetEntity | ||
windowTitle | string | <optional> |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.3.2