| Package | ardisia.components.expandingContainer |
| Class | public class ExpandingContainer |
| Inheritance | ExpandingContainer  spark.components.SkinnableContainer |
| Implements | IExpandingContainer |
| Subclasses | AccordionContainer, FieldSet |
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
| duration : Number = 150
The duration of the expand/collapse animations. | ExpandingContainer | ||
| easer : IEaser
The easer to use for expand/collapse animations. | ExpandingContainer | ||
| icon : Object
The icon to display in the header button part. | ExpandingContainer | ||
| label : String
The string to display in the header button part. | ExpandingContainer | ||
| open : Boolean
True if the component is open. | ExpandingContainer | ||
| Method | Defined By | ||
|---|---|---|---|
closeContainer():void
Immediately close the component (if open). | ExpandingContainer | ||
openContainer():void
Immediately open the component (if closed). | ExpandingContainer | ||
| Method | Defined By | ||
|---|---|---|---|
eventHandler(event:Event):void
Handles events on the component. | ExpandingContainer | ||
getEaser():IEaser
Return the easer to use. | ExpandingContainer | ||
headerBtnPartHandler(event:Event):void
Handles events for the headerBtnPart. | ExpandingContainer | ||
updateContentGroup():void
Updates the header button skin part. | ExpandingContainer | ||
updateHeaderBtnPart():void
Updates the header button skin part. | ExpandingContainer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the component's "open" property changes. | ExpandingContainer | |||
| Dispatched when the component contracts, or closes, via user interaction. | ExpandingContainer | |||
| Dispatched when the component expands, or opens, via user interaction. | ExpandingContainer | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| Skin Part | Description | Defined By | ||
|---|---|---|---|---|
headerBtnPart:spark.components.supportClasses.ToggleButtonBase | Required: false Part Type: Static Header button that expands/contracts the control. | ExpandingContainer | ||
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
| Skin State | Description | Defined By | ||
|---|---|---|---|---|
open | Skin state when the panel is expanded. | ExpandingContainer | ||
| duration | property |
public var duration:Number = 150The duration of the expand/collapse animations. Set to 0 to skip the animation.
The default value is 150.
| easer | property |
public var easer:IEaserThe easer to use for expand/collapse animations.
The default value is Sine.
| icon | property |
icon:ObjectThe icon to display in the header button part. See the "icon" property for a spark button for supported formats.
The default value is null.
public function get icon():Object public function set icon(value:Object):void| label | property |
label:StringThe string to display in the header button part.
Property is bindable.
The default value is "".
This property can be used as the source for data binding.
public function get label():String public function set label(value:String):void| open | property |
open:BooleanTrue if the component is open. False if closed. Set to true or false to open and close the container. Will open or close immediately without any animations.
To close or open via animations, use the openContainer() / closeContainer() functions.
Property is bindable.
The default value is true.
This property can be used as the source for data binding.
public function get open():Boolean public function set open(value:Boolean):void| closeContainer | () | method |
public function closeContainer():voidImmediately close the component (if open).
| eventHandler | () | method |
protected function eventHandler(event:Event):voidHandles events on the component.
Parameters
event:Event — the Event that triggered the handler
|
| getEaser | () | method |
protected function getEaser():IEaserReturn the easer to use.
ReturnsIEaser |
| headerBtnPartHandler | () | method |
protected function headerBtnPartHandler(event:Event):voidHandles events for the headerBtnPart.
Parameters
event:Event — the Event that triggered the handler
|
| openContainer | () | method |
public function openContainer():voidImmediately open the component (if closed).
| updateContentGroup | () | method |
protected function updateContentGroup():voidUpdates the header button skin part.
| updateHeaderBtnPart | () | method |
protected function updateHeaderBtnPart():voidUpdates the header button skin part.
| change | Event |
ardisia.components.expandingContainer.events.ExpandingContainerEventardisia.components.expandingContainer.events.ExpandingContainerEventDispatched when the component's "open" property changes. Dispatched before any animations finish running.
| collapsed | Event |
ardisia.components.expandingContainer.events.ExpandingContainerEventardisia.components.expandingContainer.events.ExpandingContainerEventDispatched when the component contracts, or closes, via user interaction. Dispatched at the end of any animations.
| expanded | Event |
ardisia.components.expandingContainer.events.ExpandingContainerEventardisia.components.expandingContainer.events.ExpandingContainerEventDispatched when the component expands, or opens, via user interaction. Dispatched at the end of any animations.