| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IPanel extends IMosaicNode , IDisplayable , IMetadataAvailable , IUIAttributes , IContextProvider |
| 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 |
IPanel interface defines the methods for adding tiles to a panel. It also
retrieves a list of tiles and the view in which the panel resides.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| allowContentDelete : Boolean
Returns the allowContentDelete value
| IPanel | ||
 | 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 | |
| context : IContext [read-only]
Returns the context interface for the application. | IContextProvider | |
| displayed : Boolean [read-only]
Determines if the selected node is currently displayed. | IDisplayable | |
| height : String
The maximum height for the nodes. | IUIAttributes | |
| layout : ILayout [read-only]
Returns an layout of the views. | IPanel | ||
| 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 | |
| metadata : IMetadata [read-only]
Returns the metadata if any of the node. | IMetadataAvailable | |
| 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 | |
| panels : Array [read-only]
Returns an array of panels that exist within the current panel. | IPanel | ||
| parentNode : IMosaicNode [read-only]
Returns the direct parent node of the current node within the application. | IMosaicNode | |
| parentPanel : IPanel [read-only]
Returns the parent panel, within the application, in which this panel is resident. | IPanel | ||
| parentView : IView [read-only]
Returns the parent view, within an application, in which the panel is resident. | IPanel | ||
| 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 | |
| styleName : String
The style name for the node. | IUIAttributes | |
| tileChrome : String
Returns the panel's tileChrome setting. | IPanel | ||
| tiles : Array [read-only]
Returns an array of tiles that exist within the current panel. | IPanel | ||
| 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 | |
| viewManagers : Array [read-only]
Returns an array of viewManagers that exist within the current panel. | IPanel | ||
| 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 Panel to the Panel. | IPanel | ||
addTile(tile:com.adobe.mosaic.om.interfaces:ITile, onSuccess:Function = null, onFailure:Function = null):void
Adds a Tile to the Panel. | IPanel | ||
Adds a viewManager to this panel. | IPanel | ||
|
Clones an IMosaicNode. | IMosaicNode | |
|
Navigates the application until the selected node is displayed. | IDisplayable | |
Removes the IPanel object from the panel and returns the removed ITile object,
which can optionally be added to another node in the DOM tree. | IPanel | ||
Removes the specified tile from the panel and returns the removed ITile object,
which can optionally be added to another node in the DOM tree. | IPanel | ||
Removes the specified viewManager from the panel and returns the removed IViewManager object,
which can optionally be added to another node in the DOM tree. | IPanel | ||
|
Resolves any reference elements that may be in the View, Panel, or Tile. | IMosaicNode | |
Property Detail
allowContentDelete | property |
allowContentDelete: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 allowContentDelete value
Implementation
public function get allowContentDelete():Boolean public function set allowContentDelete(value:Boolean):voidlayout | 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 panel.
Implementation
public function get panels():ArrayparentPanel | property |
parentPanel:IPanel [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 the parent panel, within the application, in which this panel is resident.
When the panel is not resident in a panel, a value of null is returned.
Implementation
public function get parentPanel():IPanelRelated API Elements
parentView | property |
parentView:IView [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 the parent view, within an application, in which the panel is resident. When the panel is not resident in a view, a value of null is returned.
Implementation
public function get parentView():IViewRelated API Elements
tileChrome | property |
tileChrome:String| 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 the panel's tileChrome setting.
Implementation
public function get tileChrome():String public function set tileChrome(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 panel.
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 |
Returns an array of viewManagers that exist within the current panel.
Implementation
public function get viewManagers():ArrayMethod Detail
addPanel | () | 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 Panel. 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)AddPanelEvent when the operation succeeded
| |
onFailure:Function (default = null)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 same panel as thisTile:
mosaicApp.addMessageListener(AddPanelEvent.NAMESPACE, AddPanelEvent.SUCCESS, onAddPanelEvent);
mosaicApp.addMessageListener(AddPanelEvent.NAMESPACE, AddPanelEvent.FAILURE, onAddPanelEvent);
var t:IPanel = sampleCatalog.getPanel("samplePanel");
thisTile.parentPanel.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
}
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 Panel. 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)AddTileEvent when the operation succeeded
| |
onFailure:Function (default = null)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 same panel as thisTile:
mosaicApp.addMessageListener(AddTileEvent.NAMESPACE, AddTileEvent.SUCCESS, onAddTileEvent);
mosaicApp.addMessageListener(AddTileEvent.NAMESPACE, AddTileEvent.FAILURE, onAddTileEvent);
var t:ITile = sampleCatalog.getTile("sampleTile");
thisTile.parentPanel.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 this panel. 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 MessageListeners.
Parameters
viewManager:IViewManager — Specifies the viewManager to add.
| |
onSuccess:Function (default = null)AddViewManagerEvent when the operation succeeded
| |
onFailure:Function (default = null)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 same panel as thisTile:
mosaicApp.addMessageListener(AddViewManagerEvent.NAMESPACE, AddViewManagerEvent.SUCCESS, onAddViewManagerEvent);
mosaicApp.addMessageListener(AddViewManagerEvent.NAMESPACE, AddViewManagerEvent.FAILURE, onAddViewManagerEvent);
var t:IViewManager = mosaicApp.createBlankViewManager();
thisTile.parentPanel.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 IPanel object from the panel and returns the removed ITile 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
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 panel 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 panel 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
Mon Nov 28 2011, 06:48 AM -08:00