| Package | com.adobe.mosaic.om.interfaces | 
| Interface | public interface IShell extends IMosaicNode | 
| 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 | 
IShell interface provides access to the DOM that makes up a composite application. 
	 It contains methods to add and remove panels, tiles, and view managers.
	 
	  | Property | Defined By | ||
|---|---|---|---|
![]()  | childrenNodes : Array [read-only] 
		 Returns an array of child nodes (IMosaicNode objects) of the node.  | IMosaicNode | |
| layout : ILayout [read-only] 
         The layout of the shell.  | IShell | ||
![]()  | 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 | |
| panels : Array [read-only] 
         Returns an array of panels that exist within the current shell.  | IShell | ||
![]()  | parentNode : IMosaicNode [read-only] 
		 Returns the direct parent node of the current node within the application.  | IMosaicNode | |
| styleName : String 
         he name of the style for the shell.  | IShell | ||
| tiles : Array [read-only] 
         Returns an array of tiles that exist within the current shell.  | IShell | ||
![]()  | uniqueID : String [read-only] 
         Returns the generated unique ID of the node.  | IMosaicNode | |
| viewManagers : Array [read-only] 
         An array of viewManager objects that exist within the current shell.  | IShell | ||
| Method | Defined By | ||
|---|---|---|---|
         Adds a Panel to the shell.  | IShell | ||
		 Adds a service to this shell.  | IShell | ||
addTile(tile:com.adobe.mosaic.om.interfaces:ITile, onSuccess:Function = null, onFailure:Function = null):void 
         Adds a Tile to the Shell.  | IShell | ||
         Adds a viewManager to the shell.  | IShell | ||
![]()  | 
         Clones an IMosaicNode.  | IMosaicNode | |
         Removes the specified panel from the shell and returns the removed IPanel object, 
         which can optionally be added to another node in the DOM tree.  | IShell | ||
		 Removes the specified service from the shell and returns the removed IService object.  | IShell | ||
         Removes the specified tile from the shell and returns the removed ITile object, 
         which can optionally be added to another node in the DOM tree.  | IShell | ||
         Removes the specified viewManager from the shell and returns the removed IViewManager object, 
         which can optionally be added to another node in the DOM tree.  | IShell | ||
![]()  | 
         Resolves any reference elements that may be in the View, Panel, or Tile.  | IMosaicNode | |
layout | property | 
panels | property | 
panels:Array  [read-only] | Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
Returns an array of panels that exist within the current shell.
Implementation
    public function get panels():ArraystyleName | property | 
styleName: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 | 
he name of the style for the shell.
Implementation
    public function get styleName():String    public function set styleName(value:String):voidtiles | property | 
tiles:Array  [read-only] | Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
Returns an array of tiles that exist within the current shell.
Implementation
    public function get tiles():ArrayviewManagers | property | 
viewManagers:Array  [read-only] | Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         An array of viewManager objects that exist within the current shell.
         
          
Implementation
    public function get viewManagers():ArrayaddPanel | () | method | 
 public function addPanel(panel:IPanel, onSuccess:Function = null, onFailure:Function = null):void| Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         Adds a Panel to the shell.  The resulting AddPanelEvent indicating success or failure is returned 
         in the callback function and also dispatched to the MessageListeners. 
         
         
Parameters
panel:IPanel — The Panel to add.
          | |
onSuccess:Function (default = null) — a Function callback that takes in one parameter of type AddPanelEvent when the operation succeeded
          | |
onFailure:Function (default = null) — a Function callback that takes in one parameter of type AddPanelEvent when the operation failed
         
          | 
Related API Elements
Example
How to use this example
This example retrieves a panel named "samplePanel" from a catalog and adds the Panel to the shell:
         mosaicApp.addMessageListener(AddPanelEvent.NAMESPACE, AddPanelEvent.SUCCESS, onAddPanelEvent);
         mosaicApp.addMessageListener(AddPanelEvent.NAMESPACE, AddPanelEvent.FAILURE, onAddPanelEvent);
         
         var t:IPanel = sampleCatalog.getPanel("samplePanel");
         mosaicApp.shell.addPanel(t,onAddPanelSuccess,onAddPanelFailure);
         
         //functions to manage success or failure callbacks
         private function onAddPanelSuccess(evt:AddPanelEvent):void {} 
         private function onAddPanelFailure(evt:AddPanelEvent):void {}
         
         //functions to manage success or failure events
         private function onAddPanelEvent(message:Message):void {
             var addPanelEvent:AddPanelEvent = message.payload as AddPanelEvent;
             var addedPanel:IPanel = addPanelEvent.panelNode;
             //custom processing
         }
         
addService | () | method | 
 public function addService(service:IService, 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 service to this shell.
Parameters
service:IService — The new instance of a service, that implements IService.
		  | |
onSuccess:Function (default = null) — Specifies a function callback that takes in one parameter of type Event when the operation succeeded.
		  | |
onFailure:Function (default = null) — Specifies a function callback that takes in one parameter of type Event when the operation failed.
		 
		  | 
Related API Elements
addTile | () | method | 
 public function addTile(tile:com.adobe.mosaic.om.interfaces:ITile, onSuccess:Function = null, onFailure:Function = null):void| Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         Adds a Tile to the Shell.  The resulting AddTileEvent indicating success or failure is returned 
         in the callback function and also dispatched to the MessageListeners. 
         
         
Parameters
tile:com.adobe.mosaic.om.interfaces:ITile — The tile to add.
          | |
onSuccess:Function (default = null) — a Function callback that takes in one parameter of type AddTileEvent when the operation succeeded
          | |
onFailure:Function (default = null) — a Function callback that takes in one parameter of type AddTileEvent when the operation failed
         
          | 
Related API Elements
Example
How to use this example
This example retrieves a tile named "sampleTile" from a catalog and adds the tile to the shell:
         mosaicApp.addMessageListener(AddTileEvent.NAMESPACE, AddTileEvent.SUCCESS, onAddTileEvent);
         mosaicApp.addMessageListener(AddTileEvent.NAMESPACE, AddTileEvent.FAILURE, onAddTileEvent);
         
         var t:ITile = sampleCatalog.getTile("sampleTile");
         mosaicApp.shell.addTile(t,onAddTileSuccess,onAddTileFailure);
         
         //functions to manage success or failure callbacks
         private function onAddTileSuccess(evt:AddTileEvent):void {} 
         private function onAddTileFailure(evt:AddTileEvent):void {}
         
         //functions to manage success or failure events
         private function onAddTileEvent(message:Message):void {
             var addTileEvent:AddTileEvent = message.payload as AddTileEvent;
             var addedTile:ITile = addTileEvent.tileNode;
             //custom processing
         }
         
addViewManager | () | method | 
 public function addViewManager(viewManager:IViewManager, onSuccess:Function = null, onFailure:Function = null):void| Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         Adds a viewManager to the shell.  The Composite Application Framework only supports a single view manager in an application.
         The resulting AddViewManagerEvent indicating success or failure is returned 
         in the callback function and also dispatched to the message listeners. 
         
         
Parameters
viewManager:IViewManager — Specifies the viewManager to add.
          | |
onSuccess:Function (default = null) — Specifies a function callback that takes in one parameter of type AddViewManagerEvent when the operation succeeded
          | |
onFailure:Function (default = null) — Specifies a function callback that takes in one parameter of type AddViewManagerEvent when the operation failed
         
          | 
Related API Elements
Example
How to use this example
This example creates a new viewManager and adds the ViewManager to the shell:
         mosaicApp.addMessageListener(AddViewManagerEvent.NAMESPACE, AddViewManagerEvent.SUCCESS, onAddViewManagerEvent);
         mosaicApp.addMessageListener(AddViewManagerEvent.NAMESPACE, AddViewManagerEvent.FAILURE, onAddViewManagerEvent);
         
         var t:IViewManager =  mosaicApp.createBlankViewManager();
         mosaicApp.shell.addViewManager(t,onAddViewManagerSuccess,onAddViewManagerFailure);
         
         //functions to manage success or failure callbacks
         private function onAddViewManagerSuccess(evt:AddViewManagerEvent):void {} 
         private function onAddViewManagerFailure(evt:AddViewManagerEvent):void {}
         
         //functions to manage success or failure events
         private function onAddViewManagerEvent(message:Message):void {
             var addViewManagerEvent:AddViewManagerEvent = message.payload as AddViewManagerEvent;
             var addedViewManager:IViewManager = addViewManagerEvent.viewManagerNode;
             //custom processing
         }
         
removePanel | () | method | 
 public function removePanel(node:IPanel):IPanel| Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         Removes the specified panel from the shell and returns the removed IPanel object, 
         which can optionally be added to another node in the DOM tree.
         
         
Parameters
node:IPanel — The panel to be deleted.
         
          | 
IPanel — The IPanel object that was removed.
         
          | 
Related API Elements
removeService | () | method | 
 public function removeService(service:IService):IService| 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 service from the shell and returns the removed IService object.
		 
		 
Parameters
service:IService — The service to be deleted.
		 
		  | 
IService — The IService object that was removed.
		 
		  | 
Related API Elements
removeTile | () | method | 
 public function removeTile(node:com.adobe.mosaic.om.interfaces:ITile):com.adobe.mosaic.om.interfaces:ITile| Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         Removes the specified tile from the shell and returns the removed ITile object, 
         which can optionally be added to another node in the DOM tree.
         
         
Parameters
node:com.adobe.mosaic.om.interfaces:ITile — The tile to be deleted.
         
          | 
com.adobe.mosaic.om.interfaces:ITile — The ITile object that was removed.
         
          | 
Related API Elements
removeViewManager | () | method | 
 public function removeViewManager(node:IViewManager):IViewManager| Language Version: | ActionScript 3.0 | 
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 | 
| Runtime Versions: | AIR 2.6, Flash Player 10.2 | 
         Removes the specified viewManager from the shell and returns the removed IViewManager object, 
         which can optionally be added to another node in the DOM tree.
         
         
Parameters
node:IViewManager — The viewManager to be deleted.
         
          | 
IViewManager — The IViewManager object that was removed.
         
          | 
Related API Elements
Thu Dec 4 2014, 05:50 PM -08:00
