Package | com.adobe.mosaic.core |
Interface | public interface IMosaicContainer |
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 |
IMosaicContainer
interface is implemented by most Mosaic 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 Mosaic container through the functions and properties here.
Property | Defined By | ||
---|---|---|---|
contentList : ISelectableList [read-only]
Returns the contents of the hostComponent as a selectable
list. | IMosaicContainer | ||
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 | ||
Returns the localized string associated with the given key. | IMosaicContainer | ||
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Returns the contents of the hostComponent
as a selectable
list. Each element must have a label
property.
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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.
|
getLocalizedString | () | method |
public function getLocalizedString(key:String, params:Array = null):String
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 localized string associated with the given key.
Parameters
key:String — The index of the string in the localized resource bundles.
| |
params:Array (default = null ) — Optional array of substitution values if the localized string contains {#}
placeholders.
|
String — The translated string in the current locale.
|
handleAddRequest | () | method |
public function handleAddRequest():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 |
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
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 9.5 |
Runtime Versions: | AIR 2.0.2, Flash Player 10.1 |
Instructs the hostComponent
to handle the Save request.
Parameters
index:int — The index of the child to save.
|
selectChildIndex | () | method |
public function selectChildIndex(index:int):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 |
Make the hostComponent
show the child at the given index.
Parameters
index:int — The index of the child being selected.
|
Wed Nov 21 2018, 06:34 AM -08:00