ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.mosaic.om.interfaces 

IViewManager  - AS3 ADEP Composite Application
Packagecom.adobe.mosaic.om.interfaces
Interfacepublic 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

The IViewManager interface provides access to the views and includes add/remove/get of views.


Public Properties
 PropertyDefined By
  allowContentAdd : Boolean
Returns the allowContentAdd value
IViewManager
 Inheritedbottom : 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
 InheritedchildrenNodes : Array
[read-only] Returns an array of child nodes (IMosaicNode objects) of the node.
IMosaicNode
 Inheritedheight : String
The maximum height for the nodes.
IUIAttributes
  layout : ILayout
[read-only] The layout of the viewManager.
IViewManager
 Inheritedleft : 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
 InheritedmaxHeight : Number
The node's maximum width.
IUIAttributes
 InheritedmaxWidth : Number
The node's maximum width.
IUIAttributes
 InheritedminHeight : Number
The node's minimum height.
IUIAttributes
 InheritedminWidth : Number
The the node's minimum width.
IUIAttributes
 InheritednodeID : String
[read-only] Returns the ID of the node.
IMosaicNode
 InheritednodeLabel : String
Returns the label of the tile.
IMosaicNode
 InheritednodeName : String
[read-only] Returns the name of the node.
IMosaicNode
 InheritednodeType : String
[read-only] Returns the type value of the node.
IMosaicNode
 InheritedparentNode : IMosaicNode
[read-only] Returns the direct parent node of the current node within the application.
IMosaicNode
 Inheritedright : 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
 InheritedstyleName : String
The style name for the node.
IUIAttributes
 Inheritedtop : 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
 InheriteduniqueID : 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
 Inheritedvisible : Boolean
Returns the node's visible setting.
IUIAttributes
 Inheritedwidth : String
Returns the node's width.
IUIAttributes
 Inheritedx : Number
Returns the node's x coordinate, relative to its container.
IUIAttributes
 Inheritedy : Number
Returns the node's y coordinate, relative to its container.
IUIAttributes
Public Methods
 MethodDefined By
  
addView(view:IView, onSuccess:Function = null, onFailure:Function = null):void
Adds a view to the ViewManager.
IViewManager
 Inherited
clone():IMosaicNode
Clones an IMosaicNode.
IMosaicNode
  
removeView(node:IView):IView
Removes the specified view from the application.
IViewManager
 Inherited
resolveReferences(onSuccess:Function = null, onFailure:Function = null):void
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):void

layout

property 
layout:ILayout  [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

The layout of the viewManager.



Implementation
    public function get layout():ILayout

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):void

views

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():Array
Method 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) — a Function callback that takes in one parameter of type AddViewEvent when the operation succeeded
 
onFailure:Function (default = null) — a Function callback that takes in one parameter of type 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.

Returns
IView — The view that was removed.

Related API Elements

com.adobe.mosaic.om.interfaces.IView



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy