Application
Extends
Node.
The Application class provides access to the DOM for an application, and provides methods for adding views, panels, and tiles, as well as querying aspects of the application's environment.
Defined in: mosaicDOM.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Application(o)
Constructor.
|
| Method Attributes | Method Name and Description |
|---|---|
|
addMessageListener(ns, name, listener)
Adds a message listener assigned to a namespace-name combination.
|
|
|
addView(v)
Adds a view to the application.
|
|
|
createLayout(name)
Creates a
Layout node of the specified type. |
|
|
createNode(type, layout)
Creates a blank node of the specified type.
|
|
|
getCatalog(name)
Returns a catalog available on the server, specifically the assets available as part of the catalog.
|
|
|
Returns the information for the application context, specifically tile attributes stored in name-value pairings.
|
|
|
getUser()
Returns the information for the current user, including: username, full name, and SAMLAssertion.
|
|
|
getViews()
Returns the
View elements that are children of the application. |
|
|
removeMessageListener(ns, name, listener)
Removes a message listener assigned to a namespace-name combination.
|
|
|
removeView(view)
Deletes the specified view.
|
|
|
sendMessage(message)
Broadcasts a message across the application level that will reach all listeners, regardless of the panel or view.
|
- Methods borrowed from class Node:
- display, getChildrenNodes, getDisplayed, getNodeId, getNodeLabel, getNodeName, getNodeType, getParentNode, setNodeLabel
Detail
Application(o)
Constructor. Note: This constructor is for internal use only. Do not use.
- Parameters:
- o
- DOM object being wrapped from Flex
Method Detail
addMessageListener(ns, name, listener)
Adds a message listener assigned to a namespace-name combination. Triggers the listener with a PropertyChange Event from Flex
- Parameters:
- ns
- The namespace of the message.
- name
- The name of the message.
- listener
- A function that triggers when a message matching the namespace-name combination is broadcast.
addView(v)
Adds a view to the application.
- Parameters:
- v
- A view to add.
createLayout(name)
Creates a
Layout node of the specified type.
- Parameters:
- name
- One of: "AbsoluteLayout", "ColumnLayout", "DynamicColumnLayout", "DynamicRowLayout", "FlowLayout", "HDividedBoxLayout", "HorizontalLayout", "RowLayout", "StackLayout", "TileLayout", "VDividedBoxLayout", or "VerticalLayout".
- Returns:
- A blank layout of the specified type.
createNode(type, layout)
Creates a blank node of the specified type.
- Parameters:
- type
- One of: "view", "panel", or "tile".
- layout
- Returns:
- A blank object of the specified type.
getCatalog(name)
Returns a catalog available on the server, specifically the assets available as part of the catalog.
- Parameters:
- name
- The URI of the catalog to retrieve.
- Returns:
- A new instance of
Catalog.
getContext()
Returns the information for the application context, specifically tile attributes stored in name-value pairings.
- Returns:
- A new instance of
Context.
getUser()
Returns the information for the current user, including: username, full name, and SAMLAssertion.
- Returns:
- A new instance of
Userwith the user's information.
getViews()
Returns the
View elements that are children of the application.
- Returns:
- An array of objects of type
View.
removeMessageListener(ns, name, listener)
Removes a message listener assigned to a namespace-name combination.
- Parameters:
- ns
- The namespace of the message.
- name
- The name of the message.
- listener
- A function will be removed from the message watching trigger.
removeView(view)
Deletes the specified view.
- Parameters:
- view
- the view to delete from the application.
- Returns:
- The view that was deleted.
sendMessage(message)
Broadcasts a message across the application level that will reach all listeners, regardless of the panel or view.
- Parameters:
- message
- Any object that is allowed to be serialized.
