(Beta)
| Package | com.adobe.mosaic.om.interfaces |
| Interface | public interface IPanel extends IMosaicNode , IDisplayable |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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 | ||
|---|---|---|---|
 | childrenNodes : Array [read-only]
Returns an array of child nodes (IMosaicNode objects) of the node. | IMosaicNode | |
| displayed : Boolean [read-only]
Determines if the selected node is currently displayed. | IDisplayable | |
| 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 | |
| parentView : IView [read-only]
Returns the parent view, within an application, in which the panel is resident. | IPanel | ||
| tiles : Array [read-only]
Returns an array of tiles that exist within the current panel. | IPanel | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Adds a tile to this panel. | IPanel | ||
|
Navigates the application until the selected node is displayed. | IDisplayable | |
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 | ||
Property Detail
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.0.2, Flash Player 10.1 |
Returns the parent view, within an application, in which the panel is resident.
Implementation
public function get parentView():IViewRelated API Elements
tiles | 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.0.2, Flash Player 10.1 |
Returns an array of tiles that exist within the current panel.
Implementation
public function get tiles():ArrayMethod Detail
addTile | () | method |
public function addTile(tile:com.adobe.mosaic.om.interfaces:ITile):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
| Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Adds a tile to this panel.
Parameters
tile:com.adobe.mosaic.om.interfaces:ITile — The new instance of a tile, that implements ITile.
|
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.0.2, Flash Player 10.1 |
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
Examples How to use this example
IPanel_example.mxml
<?xml version="1.0" encoding="utf-8"?>
<mc:Tile xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx"
xmlns:mc="com.adobe.mosaic.core.*"
layout="absolute" height="23" width="100%">
<s:Button label="Add tile to panel" click="addTileToPanel()"/>
<fx:Script>
<![CDATA[
import com.adobe.mosaic.om.interfaces.ICatalog;
import com.adobe.mosaic.om.interfaces.ITile;
import com.adobe.mosaic.om.interfaces.IPanel;
import com.adobe.mosaic.om.interfaces.IView;
// Loads a tile from a catalog, then adds that tile to every displayed panel in the application
private function addTileToPanel():void
{
var catalog:ICatalog = mosaicApp.getCatalog("dashboard_catalog");
var tile:ITile = catalog.getTile("OpenCases");
for each (var view:IView in mosaicApp.views)
{
if (view.displayed)
{
for each (var panel:IPanel in view.panels)
{
if (panel.displayed)
{
panel.addTile(tile);
}
}
}
}
}
]]>
</fx:Script>
</mc:Tile>
Wed Nov 21 2018, 06:34 AM -08:00