ITile

Package	com.adobe.mosaic.om.interfaces
Interface	public interface ITile 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

The ITile interface provides methods for retrieving information about composite application tile's details.

Public Properties

	Property		Defined By
		allowDelete : Boolean The tile's allowDelete setting.	ITile
		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
		chrome : String The tile's chrome setting.	ITile
		columnIndex : Number The tile's column index.	ITile
		confirmDelete : Boolean The tile's confirmDelete setting.	ITile
		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
		fitContent : Boolean The tile's fitContent.	ITile
		hasPlugin : String The tile's hasPlugin setting.	ITile
		height : String The maximum height for the nodes.	IUIAttributes
		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
		parentNode : IMosaicNode [read-only] Returns the direct parent node of the current node within the application.	IMosaicNode
		parentPanel : IPanel [read-only] The parent panel, within the application, in which the tile is resident.	ITile
		parentView : IView [read-only] The parent view, within the application, in which the tile is resident.	ITile
		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
		rowIndex : Number The tile's row index.	ITile
		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 [read-only] Returns the generated unique ID of the node.	IMosaicNode
		url : String [read-only] The fully resolved URI for this tile.	ITile
		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
		clone():IMosaicNode Clones an IMosaicNode.	IMosaicNode
		display():void Navigates the application until the selected node is displayed.	IDisplayable
		getCatalog(onSuccess:Function = null, onFailure:Function = null):void Returns the catalog that contains this tile.	ITile
		resolveReferences(onSuccess:Function = null, onFailure:Function = null):void Resolves any reference elements that may be in the View, Panel, or Tile.	IMosaicNode
		setInjectionProperty(name:String, value:IInjectableValue):void Sets an property of a tile for injection, this is analgous to using the Property tag on the Experience Server.	ITile

Property Detail

allowDelete

property

allowDelete: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

The tile's allowDelete setting.

Implementation
public function get allowDelete():Boolean
public function set allowDelete(value:Boolean):void

chrome

property

chrome: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

The tile's chrome setting.

Implementation
public function get chrome():String
public function set chrome(value:String):void

columnIndex

property

columnIndex:Number

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

The tile's column index.

Implementation
public function get columnIndex():Number
public function set columnIndex(value:Number):void

confirmDelete

property

confirmDelete: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

The tile's confirmDelete setting.

Implementation
public function get confirmDelete():Boolean
public function set confirmDelete(value:Boolean):void

fitContent

property

fitContent: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

The tile's fitContent.

Implementation
public function get fitContent():Boolean
public function set fitContent(value:Boolean):void

hasPlugin

property

hasPlugin: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

The tile's hasPlugin setting.

Implementation
public function get hasPlugin():String
public function set hasPlugin(value:String):void

parentPanel

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

The parent panel, within the application, in which the tile is resident.

Implementation
public function get parentPanel():IPanel

Related API Elements

com.adobe.mosaic.om.interfaces.IPanel

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

The parent view, within the application, in which the tile is resident.

Implementation
public function get parentView():IView

Related API Elements

com.adobe.mosaic.om.interfaces.IView

rowIndex

property

rowIndex:Number

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

The tile's row index.

Implementation
public function get rowIndex():Number
public function set rowIndex(value:Number):void

url

property

url:String [read-only]

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

The fully resolved URI for this tile.

Implementation
public function get url():String

Method Detail

getCatalog

()

method

public function getCatalog(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

Returns the catalog that contains this tile.

This allows you to access tiles, views, etc. from the catalog to add to the application.

Parameters

	`onSuccess:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `CatalogLoadEvent` when the operation succeeded.

	`onFailure:Function` (default = `null`) — Specifies a function callback that takes in one parameter of type `CatalogLoadEvent` when the operation failed. The onSuccess callback will be called if the loadCatalog call is successful. If the catalog was not already loaded, the catalog will be loaded into the client cache. The cached copy is returned in the `CatalogLoadEvent`. The onFailure callback with occur if the catalog was not available.

Related API Elements

com.adobe.mosaic.om.interfaces.ICatalog

Example
How to use this example
This example retrieves a catalog named "sample_catalog":

         mosaicApp.addMessageListener(CatalogLoadEvent.NAMESPACE, CatalogLoadEvent.SUCCESS, onCatLoadEvent);
         mosaicApp.addMessageListener(CatalogLoadEvent.NAMESPACE, CatalogLoadEvent.FAILURE, onCatLoadEvent);
         
         thisTile.getCatalog(onLoadSuccess, onLoadFailure);                
         
         
         //functions to manage success or failure callbacks
         private function onLoadSuccess(evt:CatalogLoadEvent):void {} 
         private function onLoadFailure(evt:CatalogLoadEvent):void {}
         
         //functions to manage success or failure events
         private function onCatLoadEvent(message:Message):void {
             var  catalogLoadEvent:CatalogLoadEvent = message.payload as CatalogLoadEvent;
             var catalog:ICatalog = catalogLoadEvent.catalog;
             //custom processing
         }

setInjectionProperty

()

method

public function setInjectionProperty(name:String, value:IInjectableValue):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

Sets an property of a tile for injection, this is analgous to using the Property tag on the Experience Server. This will inject the value into the tile at name when the tile is started up.

Parameters

	`name:String` — Specifies the public attribute or public setter where you want to inject the value.

	`value:IInjectableValue` — Specifies the value to be injected.

Legal Notices | Online Privacy Policy

ITile - AS3 ADEP Composite Application

Classes x

allowDelete

chrome

columnIndex

confirmDelete

fitContent

hasPlugin

parentPanel

parentView

rowIndex

url

getCatalog

setInjectionProperty