| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IViewManager extends IMosaicNode , IUIAttributes |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
IViewManager interface provides access to the views and includes
add/remove/get of views.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| allowContentAdd : Boolean
Returns the allowContentAdd value
| IViewManager | ||
 | bottom : Number
Returns the node's bottom value which is the vertical distance, in pixels, from the lower edge
of the component to the lower edge of the content region. | IUIAttributes | |
| childrenNodes : Array [read-only]
Returns an array of child nodes (IMosaicNode objects) of the node. | IMosaicNode | |
| height : String
The maximum height for the nodes. | IUIAttributes | |
| layout : ILayout [read-only]
The layout of the viewManager. | IViewManager | ||
| left : Number
Returns the node's left value which is horizontal distance, in pixels,
from the left edge of the component to the left edge of the content region. | IUIAttributes | |
| maxHeight : Number
The node's maximum width. | IUIAttributes | |
| maxWidth : Number
The node's maximum width. | IUIAttributes | |
| minHeight : Number
The node's minimum height. | IUIAttributes | |
| minWidth : Number
The the node's minimum width. | IUIAttributes | |
| nodeID : String [read-only]
Returns the ID of the node. | IMosaicNode | |
| nodeLabel : String
Returns the label of the tile. | IMosaicNode | |
| nodeName : String [read-only]
Returns the name of the node. | IMosaicNode | |
| nodeType : String [read-only]
Returns the type value of the node. | IMosaicNode | |
| parentNode : IMosaicNode [read-only]
Returns the direct parent node of the current node within the application. | IMosaicNode | |
| right : Number
Returns the node's right value which is the horizontal distance, in pixels, from the right edge
of the component to the right edge of the content region. | IUIAttributes | |
| saveMode : String
Returns the saveMode that controls the ability to save and close views managed by the ViewManager. | IViewManager | ||
| styleName : String
The style name for the node. | IUIAttributes | |
| top : Number
Returns the node's top value which is the vertical distance, in pixels, from the upper
edge of the component to the upper edge of the content region. | IUIAttributes | |
| uniqueID : String [read-only]
Returns the generated unique ID of the node. | IMosaicNode | |
| views : Array [read-only]
Returns an array of views that are available within the application. | IViewManager | ||
| visible : Boolean
Returns the node's visible setting. | IUIAttributes | |
| width : String
Returns the node's width. | IUIAttributes | |
| x : Number
Returns the node's x coordinate, relative to its container. | IUIAttributes | |
| y : Number
Returns the node's y coordinate, relative to its container. | IUIAttributes | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Adds a view to the ViewManager. | IViewManager | ||
|
Clones an IMosaicNode. | IMosaicNode | |
Removes the specified view from the application. | IViewManager | ||
|
Resolves any reference elements that may be in the View, Panel, or Tile. | IMosaicNode | |
Property Detail
allowContentAdd | property |
allowContentAdd:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns the allowContentAdd value
Implementation
public function get allowContentAdd():Boolean public function set allowContentAdd(value:Boolean):voidlayout | property |
saveMode | property |
saveMode:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns the saveMode that controls the ability to save and close views managed by the ViewManager. The default allows views to be saved and closed ("saveAndClose"). Other options are to save without closing ("saveOnly"), close without saving ("closeOnly"), or to do nothing ("none"). If the saveMode is set to a value not supported by the chosen Layout, then it will be treated as if no saveMode were specified and default to "saveAndClose".
Implementation
public function get saveMode():String public function set saveMode(value:String):voidviews | property |
views:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Returns an array of views that are available within the application.
Implementation
public function get views():ArrayMethod Detail
addView | () | method |
public function addView(view:IView, onSuccess:Function = null, onFailure:Function = null):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Adds a view to the ViewManager. The resulting AddViewEvent indicating success or failure is returned
in the callback function and also dispatched to the MessageListeners.
Parameters
view:IView — The view to add.
| |
onSuccess:Function (default = null)AddViewEvent when the operation succeeded
| |
onFailure:Function (default = null)AddViewEvent when the operation failed
|
Example
How to use this example
This example retrieves a view named "sampleView" from a catalog and adds the view to the viewManager:
mosaicApp.addMessageListener(AddViewEvent.NAMESPACE, AddViewEvent.SUCCESS, onAddViewEvent);
mosaicApp.addMessageListener(AddViewEvent.NAMESPACE, AddViewEvent.FAILURE, onAddViewEvent);
var v:IView = sampleCatalog.getView("sampleView");
(thisTile.parentView.parentNode as IViewManager).addView(v,onAddViewSuccess,onAddViewFailure);
//functions to manage success or failure callbacks
private function onAddViewSuccess(evt:AddViewEvent):void {}
private function onAddViewFailure(evt:AddViewEvent):void {}
//functions to manage success or failure events
private function onAddViewEvent(message:Message):void {
var addViewEvent:AddViewEvent = message.payload as AddViewEvent;
var addedView:IView = addViewEvent.viewNode;
//custom processing
}
removeView | () | method |
public function removeView(node:IView):IView| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
| Runtime Versions: | AIR 2.6, Flash Player 10.2 |
Removes the specified view from the application.
Parameters
node:IView — The view to be deleted.
|
IView — The view that was removed.
|
Related API Elements
Mon Apr 10 2017, 12:28 PM -07:00