| Package | ardisia.components.compassContainer |
| Class | public class CompassRegionContainer |
| Inheritance | CompassRegionContainer  spark.components.SkinnableContainer |
Default MXML PropertymxmlContentFactory
| Property | Defined By | ||
|---|---|---|---|
| canBeClosed : Boolean
True to allow this region to be closed via mouse interaction. | CompassRegionContainer | ||
| canBeMinimized : Boolean
True to allow the container to be minimized via mouse interaction. | CompassRegionContainer | ||
| compassRegion : String
String description of the region's cardinal location in the
CompassContainer. | CompassRegionContainer | ||
| floating : Boolean
True to display the region as a float outside the minimize region. | CompassRegionContainer | ||
| minimized : Boolean
Controlled by the host CompassContainer. | CompassRegionContainer | ||
| regionID : String
A unique string used to track this region. | CompassRegionContainer | ||
| showChrome : Boolean
True to display region chrome in a header for the container. | CompassRegionContainer | ||
| title : String
The region title. | CompassRegionContainer | ||
| Method | Defined By | ||
|---|---|---|---|
| CompassRegionContainer | |||
dispose():void
Remove the container from the display list and remove listeners. | CompassRegionContainer | ||
| Method | Defined By | ||
|---|---|---|---|
closeButtonPartHandler(event:Event):void
Handles events on the close button part. | CompassRegionContainer | ||
minimizeButtonPartHandler(event:Event):void | CompassRegionContainer | ||
skinHandler(event:Event):void
Handles events on the skin. | CompassRegionContainer | ||
updateCloseButtonPart():void
Update the close button part. | CompassRegionContainer | ||
updateMinimizeButtonPart():void
Update the minimize button part. | CompassRegionContainer | ||
updateTitleLabelPart():void
Update the title label part. | CompassRegionContainer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the minimize button is clicked. | CompassRegionContainer | |||
| Dispatched when a region's close button part is clicked. | CompassRegionContainer | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
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.
| canBeClosed | property |
canBeClosed:BooleanTrue to allow this region to be closed via mouse interaction.
The default value is false.
public function get canBeClosed():Boolean public function set canBeClosed(value:Boolean):void| canBeMinimized | property |
canBeMinimized:BooleanTrue to allow the container to be minimized via mouse interaction.
Can still be minimized programmatically even if this property is false.
The default value is true.
public function get canBeMinimized():Boolean public function set canBeMinimized(value:Boolean):void| compassRegion | property |
public var compassRegion:StringString description of the region's cardinal location in the CompassContainer.
Possible values are defined by the CompassQuadrant class.
The default value is null.
| floating | property |
floating:BooleanTrue to display the region as a float outside the minimize region.
The default value is null.
public function get floating():Boolean public function set floating(value:Boolean):void| minimized | property |
public var minimized:BooleanControlled by the host CompassContainer.
The default value is false.
| regionID | property |
public var regionID:StringA unique string used to track this region. Useful to identify the region after begin docked to new quadrants.
The default value is randomized string.
| showChrome | property |
showChrome:BooleanTrue to display region chrome in a header for the container.
False to hide all the chrome and improve performance in the skin.
The default value is true.
public function get showChrome():Boolean public function set showChrome(value:Boolean):void| title | property |
title:StringThe region title.
The default value is null.
public function get title():String public function set title(value:String):void| CompassRegionContainer | () | Constructor |
public function CompassRegionContainer()| closeButtonPartHandler | () | method |
protected function closeButtonPartHandler(event:Event):voidHandles events on the close button part.
Parameters
event:Event — the Event that triggered the handler
|
| dispose | () | method |
public function dispose():voidRemove the container from the display list and remove listeners.
| minimizeButtonPartHandler | () | method |
protected function minimizeButtonPartHandler(event:Event):voidParameters
event:Event |
| skinHandler | () | method |
protected function skinHandler(event:Event):voidHandles events on the skin.
Parameters
event:Event — the Event that triggered the handler
|
| updateCloseButtonPart | () | method |
protected function updateCloseButtonPart():voidUpdate the close button part.
| updateMinimizeButtonPart | () | method |
protected function updateMinimizeButtonPart():voidUpdate the minimize button part.
| updateTitleLabelPart | () | method |
protected function updateTitleLabelPart():voidUpdate the title label part.
| minimizeRegionRequest | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when the minimize button is clicked.
| regionCloseRequest | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a region's close button part is clicked.