Package | com.adobe.mosaic.skinning |
Interface | public interface IMosaicContainer extends IMosaicComponent , ILayoutChild |
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 |
IMosaicContainer
interface is implemented by most composite application container, such as View
,
ViewManager
, Panel
, and Shell
. Skins for these containers can declare
their hostComponent
to be of this interface type, gaining access to the
underlying composite application container through the functions and properties here.
Property | Defined By | ||
---|---|---|---|
allowDelete : Boolean [read-only]
Indicates if this component may be deleted or not. | IMosaicComponent | ||
columnIndex : int
The column index of the component. | ILayoutChild | ||
contentList : ISelectableList [read-only]
The list of components managed by this container as a SelectableList. | IMosaicContainer | ||
enableDrag : Boolean
Indicates if the item may be dragged. | ILayoutChild | ||
label : String
The title of the component. | IMosaicComponent | ||
mosaicNode : IMosaicNode [read-only]
Do Not Use. | IMosaicComponent | ||
rowIndex : int
The row index of the component
| ILayoutChild | ||
selectedChild : DisplayObject [read-only]
Returns the selectedChild of the hostComponent or null if no
child is currently selected. | IMosaicContainer |
Method | Defined By | ||
---|---|---|---|
The skin should present a control to allow the user to request a new
child element. | IMosaicContainer | ||
The skin should present a control to allow the user to close
a child element. | IMosaicContainer | ||
The skin should present a control to allow the user to save
a child element. | IMosaicContainer | ||
Records the new size of the component in the DOM structure representing
the component. | IMosaicComponent | ||
Creates an displayable object (eg, Image) of the
child suitable for use in a drag/drop operation as the
drag proxy. | ILayoutChild | ||
Returns the localized string associated with the given key. | IMosaicComponent | ||
Instructs the hostComponent to handle the Add request. | IMosaicContainer | ||
Instructs the hostComponent to handle the Close request. | IMosaicContainer | ||
Instructs the hostComponent to give one of its children a new name. | IMosaicContainer | ||
Instructs the hostComponent to handle the Save request. | IMosaicContainer | ||
Make the hostComponent show the child at the given index. | IMosaicContainer |
contentList | property |
contentList:ISelectableList
[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 list of components managed by this container as a SelectableList.
Implementation
public function get contentList():ISelectableList
selectedChild | property |
selectedChild:DisplayObject
[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 |
Returns the selectedChild
of the hostComponent
or null if no
child is currently selected.
Implementation
public function get selectedChild():DisplayObject
allowsAdd | () | method |
public function allowsAdd():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 skin should present a control to allow the user to request a new
child element. Pressing the control should invoke the handleAddRequest()
function.
Boolean — A value of true if the hostComponent allows new children.
|
allowsClose | () | method |
public function allowsClose():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 skin should present a control to allow the user to close a child element. Pressing the control should invoke the handleCloseRequest() function.
ReturnsBoolean — true if the hostComponent allows its children to be closed.
|
allowsSave | () | method |
public function allowsSave():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 skin should present a control to allow the user to save a child element. Pressing the control should invoke the handleSaveRequest() function.
ReturnsBoolean — true if the hostComponent allows its children to be saved.
|
handleAddRequest | () | method |
public function handleAddRequest():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 |
Instructs the hostComponent
to handle the Add request.
handleCloseRequest | () | method |
public function handleCloseRequest(index:int):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 |
Instructs the hostComponent
to handle the Close request.
Parameters
index:int — The index of the child to close.
|
handleRenameRequest | () | method |
public function handleRenameRequest(index:int, newName:String):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 |
Instructs the hostComponent
to give one of its children a new name.
Parameters
index:int — The index of the child to give a new name to.
| |
newName:String — The new name to give.
|
handleSaveRequest | () | method |
public function handleSaveRequest(index:int):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 |
Instructs the hostComponent
to handle the Save request.
Parameters
index:int — The index of the child to save.
|
selectChildIndex | () | method |
public function selectChildIndex(newIndex:int, oldIndex:int):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 |
Make the hostComponent
show the child at the given index.
Parameters
newIndex:int — The index of the child being selected.
| |
oldIndex:int — The index of the child that was selected.
|
Mon Nov 28 2011, 06:48 AM -08:00