Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
com.adobe.mosaic.om.interfaces 

IPanel  - AS3 ADEP Composite Application

パッケージcom.adobe.mosaic.om.interfaces
インターフェイスpublic interface IPanel extends IMosaicNode , IDisplayable , IMetadataAvailable , IUIAttributes , IContextProvider

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: AIR 2.6, Flash Player 10.2

The 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.



パブリックプロパティ
 プロパティ定義元
  allowContentDelete : Boolean
Returns the allowContentDelete value
IPanel
 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
[読み取り専用] Returns an array of child nodes (IMosaicNode objects) of the node.
IMosaicNode
 Inheritedcontext : IContext
[読み取り専用] Returns the context interface for the application.
IContextProvider
 Inheriteddisplayed : Boolean
[読み取り専用] Determines if the selected node is currently displayed.
IDisplayable
 Inheritedheight : String
The maximum height for the nodes.
IUIAttributes
  layout : ILayout
[読み取り専用] Returns an layout of the views.
IPanel
 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
 Inheritedmetadata : IMetadata
[読み取り専用] Returns the metadata if any of the node.
IMetadataAvailable
 InheritedminHeight : Number
The node's minimum height.
IUIAttributes
 InheritedminWidth : Number
The the node's minimum width.
IUIAttributes
 InheritednodeID : String
[読み取り専用] Returns the ID of the node.
IMosaicNode
 InheritednodeLabel : String
Returns the label of the tile.
IMosaicNode
 InheritednodeName : String
[読み取り専用] Returns the name of the node.
IMosaicNode
 InheritednodeType : String
[読み取り専用] Returns the type value of the node.
IMosaicNode
  panels : Array
[読み取り専用] Returns an array of panels that exist within the current panel.
IPanel
 InheritedparentNode : IMosaicNode
[読み取り専用] Returns the direct parent node of the current node within the application.
IMosaicNode
  parentPanel : IPanel
[読み取り専用] Returns the parent panel, within the application, in which this panel is resident.
IPanel
  parentView : IView
[読み取り専用] Returns the parent view, within an application, in which the panel is resident.
IPanel
 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
 InheritedstyleName : String
The style name for the node.
IUIAttributes
  tileChrome : String
Returns the panel's tileChrome setting.
IPanel
  tiles : Array
[読み取り専用] Returns an array of tiles that exist within the current panel.
IPanel
 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
[読み取り専用] Returns the generated unique ID of the node.
IMosaicNode
  viewManagers : Array
[読み取り専用] Returns an array of viewManagers that exist within the current panel.
IPanel
 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
パブリックメソッド
 メソッド定義元
  
addPanel(panel:IPanel, onSuccess:Function = null, onFailure:Function = null):void
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
  
addViewManager(viewManager:IViewManager, onSuccess:Function = null, onFailure:Function = null):void
Adds a viewManager to this panel.
IPanel
 Inherited
Clones an IMosaicNode.
IMosaicNode
 Inherited
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
 Inherited
resolveReferences(onSuccess:Function = null, onFailure:Function = null):void
Resolves any reference elements that may be in the View, Panel, or Tile.
IMosaicNode
プロパティの詳細

allowContentDelete

プロパティ
allowContentDelete:Boolean

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
ランタイムバージョン: AIR 2.6, Flash Player 10.2

Returns the allowContentDelete value



実装
    public function get allowContentDelete():Boolean
    public function set allowContentDelete(value:Boolean):void

layout

プロパティ 
layout:ILayout  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10
ランタイムバージョン: AIR 2.6, Flash Player 10.2

Returns an layout of the views.



実装
    public function get layout():ILayout

panels

プロパティ 
panels:Array  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: AIR 2.6, Flash Player 10.2

Returns an array of panels that exist within the current panel.



実装
    public function get panels():Array

parentPanel

プロパティ 
parentPanel:IPanel  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.



実装
    public function get parentPanel():IPanel

関連する API エレメント

parentView

プロパティ 
parentView:IView  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.



実装
    public function get parentView():IView

関連する API エレメント

tileChrome

プロパティ 
tileChrome:String

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: AIR 2.6, Flash Player 10.2

Returns the panel's tileChrome setting.



実装
    public function get tileChrome():String
    public function set tileChrome(value:String):void

tiles

プロパティ 
tiles:Array  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: AIR 2.6, Flash Player 10.2

Returns an array of tiles that exist within the current panel.



実装
    public function get tiles():Array

viewManagers

プロパティ 
viewManagers:Array  [読み取り専用]

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: AIR 2.6, Flash Player 10.2

Returns an array of viewManagers that exist within the current panel.



実装
    public function get viewManagers():Array
メソッドの詳細

addPanel

()メソッド
public function addPanel(panel:IPanel, onSuccess:Function = null, onFailure:Function = null):void

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.

パラメーター

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

関連する API エレメント



この例の使用方法
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

()メソッド 
public function addTile(tile:com.adobe.mosaic.om.interfaces:ITile, onSuccess:Function = null, onFailure:Function = null):void

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.

パラメーター

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

関連する API エレメント



この例の使用方法
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

()メソッド 
public function addViewManager(viewManager:IViewManager, onSuccess:Function = null, onFailure:Function = null):void

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.

パラメーター

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

関連する API エレメント



この例の使用方法
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

()メソッド 
public function removePanel(node:IPanel):IPanel

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.

パラメーター

node:IPanel — The panel to be deleted.

戻り値
IPanel — The IPanel object that was removed.

関連する API エレメント

removeTile

()メソッド 
public function removeTile(node:com.adobe.mosaic.om.interfaces:ITile):com.adobe.mosaic.om.interfaces:ITile

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.

パラメーター

node:com.adobe.mosaic.om.interfaces:ITile — The tile to be deleted.

戻り値
com.adobe.mosaic.om.interfaces:ITile — The ITile object that was removed.

関連する API エレメント

removeViewManager

()メソッド 
public function removeViewManager(node:IViewManager):IViewManager

言語バージョン: ActionScript 3.0
製品バージョン: Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5
ランタイムバージョン: 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.

パラメーター

node:IViewManager — The viewManager to be deleted.

戻り値
IViewManager — The IViewManager object that was removed.

関連する API エレメント





[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。