Paket | com.adobe.mosaic.om.interfaces |
Schnittstelle | public interface IView extends IMosaicNode , IDisplayable , IMetadataAvailable , IUIAttributes , IContextProvider |
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
IView
interface defines methods for adding panels, saving views, and retrieving
view context and a list of panels.
Eigenschaft | Definiert von | ||
---|---|---|---|
allowContentAdd : Boolean
Returns the allowContentAdd value
| IView | ||
allowContentDelete : Boolean
Returns the allowContentDelete value
| IView | ||
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 [schreibgeschützt]
Returns an array of child nodes (IMosaicNode objects) of the node. | IMosaicNode | ||
context : IContext [schreibgeschützt]
Returns the context interface for the application. | IContextProvider | ||
displayed : Boolean [schreibgeschützt]
Determines if the selected node is currently displayed. | IDisplayable | ||
height : String
The maximum height for the nodes. | IUIAttributes | ||
layout : ILayout [schreibgeschützt]
The layout of the view. | IView | ||
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 [schreibgeschützt]
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 [schreibgeschützt]
Returns the ID of the node. | IMosaicNode | ||
nodeLabel : String
Returns the label of the tile. | IMosaicNode | ||
nodeName : String [schreibgeschützt]
Returns the name of the node. | IMosaicNode | ||
nodeType : String [schreibgeschützt]
Returns the type value of the node. | IMosaicNode | ||
panels : Array [schreibgeschützt]
Returns an array of panels that exist within a view. | IView | ||
parentNode : IMosaicNode [schreibgeschützt]
Returns the direct parent node of the current node within the application. | IMosaicNode | ||
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 | ||
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 [schreibgeschützt]
Returns the generated unique ID of the node. | IMosaicNode | ||
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 |
Methode | Definiert von | ||
---|---|---|---|
Adds a Panel to the View. | IView | ||
Clones an IMosaicNode. | IMosaicNode | ||
Navigates the application until the selected node is displayed. | IDisplayable | ||
Removes the specified panel from the view and returns the removed IPanel object,
which can optionally be added to another node in the DOM tree. | IView | ||
Resolves any reference elements that may be in the View, Panel, or Tile. | IMosaicNode | ||
save(label:String, description:String = null, onSuccess:Function = null, onFailure:Function = null):void
Programmatically saves the view with a label and description. | IView |
allowContentAdd | Eigenschaft |
allowContentAdd:Boolean
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
Returns the allowContentAdd value
Implementierung
public function get allowContentAdd():Boolean
public function set allowContentAdd(value:Boolean):void
allowContentDelete | Eigenschaft |
allowContentDelete:Boolean
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
Returns the allowContentDelete value
Implementierung
public function get allowContentDelete():Boolean
public function set allowContentDelete(value:Boolean):void
layout | Eigenschaft |
panels | Eigenschaft |
panels:Array
[schreibgeschützt] Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
Returns an array of panels that exist within a view.
Implementierung
public function get panels():Array
addPanel | () | Methode |
public function addPanel(panel:IPanel, onSuccess:Function = null, onFailure:Function = null):void
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
Adds a Panel to the View. The resulting AddPanelEvent
indicating success or failure is returned
in the callback function and also dispatched to the MessageListeners.
Parameter
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
|
Verwandte API-Elemente
Beispiel
Verwendung dieses Beispiels
This example retrieves a panel named "samplePanel" from a catalog and adds the Panel to the view:
mosaicApp.addMessageListener(AddPanelEvent.NAMESPACE, AddPanelEvent.SUCCESS, onAddPanelEvent); mosaicApp.addMessageListener(AddPanelEvent.NAMESPACE, AddPanelEvent.FAILURE, onAddPanelEvent); var t:IPanel = sampleCatalog.getPanel("samplePanel"); thisTile.parentView.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 }
removePanel | () | Methode |
public function removePanel(panel:IPanel):IPanel
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
Removes the specified panel from the view and returns the removed IPanel
object,
which can optionally be added to another node in the DOM tree.
Parameter
panel:IPanel — The panel to be deleted.
|
IPanel — The IPanel object that was removed.
|
Verwandte API-Elemente
save | () | Methode |
public function save(label:String, description:String = null, onSuccess:Function = null, onFailure:Function = null):void
Sprachversion: | ActionScript 3.0 |
Produktversion: | Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 9.5 |
Laufzeitversionen: | AIR 2.6, Flash Player 10.2 |
Programmatically saves the view with a label and description. Users are not presented with a user interface to input view details.
The resulting SaveViewEvent
indicating success or failure is returned in the callback function and also dispatched to the MessageListeners.
Parameter
label:String — The label to use for the view.
| |
description:String (default = null ) — The text description for this view.
| |
onSuccess:Function (default = null ) — A function that takes in one parameter of type SaveViewEvent that is called when the view is saved successfully.
| |
onFailure:Function (default = null ) — A function that takes in one parameter of type SaveViewEvent that is called when the view save fails.
|
Tue Jun 12 2018, 10:04 AM Z