| Package | ardisia.components.compassContainer |
| Class | public class CompassContainer |
| Inheritance | CompassContainer  CompassContainerBase spark.components.supportClasses.SkinnableComponent |
View the technical documentation on the Ardisia Labs website for more information.
Default MXML PropertycenterContent
| Property | Defined By | ||
|---|---|---|---|
 | animationDuration : Number
The duration of animations for the minimize/maximize animations. | CompassContainerBase | |
| centerContent : Array [write-only]
Array of MXML content to add to the center region. | CompassContainerBase | |
| centerRegionInstance : CompassRegionContainer | CompassContainerBase | |
| centerRegionTitle : String
The title to display in the header for the center region if the header
is displayed. | CompassContainerBase | |
| easer : IEaser
The easer to use for the minimize/maximize fade animation. | CompassContainerBase | |
| eastCanBeClosed : Boolean
True if the east region can be closed via mouse interaction. | CompassContainerBase | |
| eastCanBeMinimized : Boolean
True if the east region can be minimized via mouse interaction. | CompassContainerBase | |
| eastContent : Array [write-only]
Array of MXML content to add to the east region. | CompassContainerBase | |
| eastDividerInstance : ButtonBase | CompassContainer | ||
| eastRegionInstance : CompassRegionContainer | CompassContainerBase | |
| eastRegionTitle : String
The title to display in the header for the east region if the header
is displayed. | CompassContainerBase | |
| eastResizeLocked : Boolean
True to prevent the region from being resized via user interaction. | CompassContainerBase | |
| eastWidth : Number
Explicit width of the east region. | CompassContainerBase | |
| maxEastWidth : Number
The maximum allowed size of the east region. | CompassContainerBase | |
| maxNorthHeight : Number
The maximum allowed size of the north region. | CompassContainerBase | |
| maxSouthHeight : Number
The maximum allowed size of the south region. | CompassContainerBase | |
| maxWestWidth : Number
The maximum allowed size of the west region. | CompassContainerBase | |
| minEastWidth : Number
The minimum allowed size of the east region. | CompassContainerBase | |
| minimizedRegionEastInstance : CompassMinimizedRegion | CompassContainer | ||
| minimizedRegionNorthInstance : CompassMinimizedRegion | CompassContainer | ||
| minimizedRegionSouthInstance : CompassMinimizedRegion | CompassContainer | ||
| minimizedRegionWestInstance : CompassMinimizedRegion | CompassContainer | ||
| minNorthHeight : Number
The minimum allowed size of the north region. | CompassContainerBase | |
| minSouthHeight : Number
The minimum allowed size of the south region. | CompassContainerBase | |
| minWestWidth : Number
The minimum allowed size of the west region. | CompassContainerBase | |
| northCanBeClosed : Boolean
True if the north region can be closed via mouse interaction. | CompassContainerBase | |
| northCanBeMinimized : Boolean
True if the north region can be minimized via mouse interaction. | CompassContainerBase | |
| northContent : Array [write-only]
Array of MXML content to add to the north region. | CompassContainerBase | |
| northDividerInstance : ButtonBase | CompassContainer | ||
| northHeight : Number
Explicit height of the north region. | CompassContainerBase | |
| northRegionInstance : CompassRegionContainer | CompassContainerBase | |
| northRegionTitle : String
The title to display in the header for the north region if the header
is displayed. | CompassContainerBase | |
| northResizeLocked : Boolean
True to prevent the region from being resized via user interaction. | CompassContainerBase | |
| showCenterChrome : Boolean
True to display the chrome for the center region. | CompassContainerBase | |
| showEastChrome : Boolean
True to display the chrome for the east region. | CompassContainerBase | |
| showNorthChrome : Boolean
True to display the chrome for the north region. | CompassContainerBase | |
| showSouthChrome : Boolean
True to display the chrome for the south region. | CompassContainerBase | |
| showWestChrome : Boolean
True to display the chrome for the west region. | CompassContainerBase | |
| southCanBeClosed : Boolean
True if the east region can be closed via mouse interaction. | CompassContainerBase | |
| southCanBeMinimized : Boolean
True if the south region can be minimized via mouse interaction. | CompassContainerBase | |
| southContent : Array [write-only]
Array of MXML content to add to the south region. | CompassContainerBase | |
| southDividerInstance : ButtonBase | CompassContainer | ||
| southHeight : Number
Explicit height of the south region. | CompassContainerBase | |
| southRegionInstance : CompassRegionContainer | CompassContainerBase | |
| southRegionTitle : String
The title to display in the header for the south region if the header
is displayed. | CompassContainerBase | |
| southResizeLocked : Boolean
True to prevent the region from being resized via user interaction. | CompassContainerBase | |
| westCanBeClosed : Boolean
True if the west region can be closed via mouse interaction. | CompassContainerBase | |
| westCanBeMinimized : Boolean
True if the west region can be minimized via mouse interaction. | CompassContainerBase | |
| westContent : Array [write-only]
Array of MXML content to add to the west region. | CompassContainerBase | |
| westDividerInstance : ButtonBase | CompassContainer | ||
| westRegionInstance : CompassRegionContainer | CompassContainerBase | |
| westRegionTitle : String
The title to display in the header for the west region if the header
is displayed. | CompassContainerBase | |
| westResizeLocked : Boolean
True to prevent the region from being resized via user interaction. | CompassContainerBase | |
| westWidth : Number
Explicit width of the west region. | CompassContainerBase | |
| Method | Defined By | ||
|---|---|---|---|
addRegion(region:String):CompassRegionContainer
A non-mxml way to add a region. | CompassContainer | ||
dispose():void
Remove the container from the display list and remove listeners. | CompassContainer | ||
Return the region container based on the mouse position. | CompassContainer | ||
removeRegion(region:String):CompassRegionContainer
Remove the passed region. | CompassContainer | ||
setMinimizeState(compassQuadrant:String, minimize:Boolean, skipAnimation:Boolean = true):void
Set whether a region is minimized or not. | CompassContainer | ||
| Method | Defined By | ||
|---|---|---|---|
closeFloatRegion():void
Close a floated region. | CompassContainer | ||
dividerHandler(event:Event):void
Handles events of the dividers. | CompassContainer | ||
effectHandler(event:EffectEvent):void
Handles effect events. | CompassContainer | ||
floatingRegionHandler(event:Event):void
Handles events on floated regions. | CompassContainer | ||
floatMinimizedRegionContent(region:CompassRegionContainer):void
Displays the region for a minimized region by displaying it above
the CompassContainer. | CompassContainer | ||
initializeRegion(region:String):void
Setup the passed region. | CompassContainer | ||
minimizedRegionHandler(event:Event):void
Handles events on the minimized regions. | CompassContainer | ||
regionEventHandler(event:Event):void
Handles events. | CompassContainer | ||
regionHandler(event:Event):void
Handles events on the region. | CompassContainer | ||
removeMinimizedGroup(minimizedRegion:CompassMinimizedRegion):void
Remove the minimized region display element. | CompassContainer | ||
resizeHandler(event:MouseEvent):void
Handles the MouseEvents dispatched by resizing drags. | CompassContainer | ||
updateRegionProperties():void
Update region properties. | CompassContainer | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when a "divider" is dragged. | CompassContainer | |||
| Dispatched when a "divider" is moused down. | CompassContainer | |||
| Dispatched when a "divider" is moused up or released. | CompassContainer | |||
| Dispatched when a region is closed. | CompassContainer | |||
| Dispatched when a region is initialized and added to the CompassContainer. | CompassContainer | |||
| Dispatched when a region's minimization state changes. | CompassContainer | |||
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.
| eastDividerInstance | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var eastDividerInstance:ButtonBase| minimizedRegionEastInstance | property |
public var minimizedRegionEastInstance:CompassMinimizedRegion| minimizedRegionNorthInstance | property |
public var minimizedRegionNorthInstance:CompassMinimizedRegion| minimizedRegionSouthInstance | property |
public var minimizedRegionSouthInstance:CompassMinimizedRegion| minimizedRegionWestInstance | property |
public var minimizedRegionWestInstance:CompassMinimizedRegion| northDividerInstance | property |
public var northDividerInstance:ButtonBase| southDividerInstance | property |
public var southDividerInstance:ButtonBase| westDividerInstance | property |
public var westDividerInstance:ButtonBase| addRegion | () | method |
public function addRegion(region:String):CompassRegionContainerA non-mxml way to add a region. Add content to the returned Group or access the specific region instance container.
Parameters
region:String — the string description of the region to add
|
CompassRegionContainer — the initialized region container
|
| closeFloatRegion | () | method |
protected function closeFloatRegion():voidClose a floated region.
| dispose | () | method |
public function dispose():voidRemove the container from the display list and remove listeners.
| dividerHandler | () | method |
protected function dividerHandler(event:Event):voidHandles events of the dividers.
Parameters
event:Event — the Event that triggered the handler
|
| effectHandler | () | method |
protected function effectHandler(event:EffectEvent):voidHandles effect events.
Parameters
event:EffectEvent — the EffectEvent that triggered the handler
|
| floatingRegionHandler | () | method |
protected function floatingRegionHandler(event:Event):voidHandles events on floated regions.
Parameters
event:Event — the Event that triggered the handler
|
| floatMinimizedRegionContent | () | method |
protected function floatMinimizedRegionContent(region:CompassRegionContainer):voidDisplays the region for a minimized region by displaying it above the CompassContainer.
Parameters
region:CompassRegionContainer — the CompassRegionContainer to display the content for
|
| getHoveredRegion | () | method |
public function getHoveredRegion():CompassRegionContainerReturn the region container based on the mouse position. If the hovered region is east/west/north/south the returned element is a CompassRegionContainer. If the region is a center region, the centerRegionInstance is returned.
ReturnsCompassRegionContainer — the container
|
| initializeRegion | () | method |
protected function initializeRegion(region:String):voidSetup the passed region.
Parameters
region:String — the string representation of the region to initialize
|
| minimizedRegionHandler | () | method |
protected function minimizedRegionHandler(event:Event):voidHandles events on the minimized regions.
Parameters
event:Event — the Event that triggered the handler
|
| regionEventHandler | () | method |
protected function regionEventHandler(event:Event):voidHandles events.
Parameters
event:Event — the Event that triggered the handler
|
| regionHandler | () | method |
protected function regionHandler(event:Event):voidHandles events on the region.
Parameters
event:Event — the Event that triggered the handler
|
| removeMinimizedGroup | () | method |
protected function removeMinimizedGroup(minimizedRegion:CompassMinimizedRegion):voidRemove the minimized region display element.
Parameters
minimizedRegion:CompassMinimizedRegion — the minimized region element
|
| removeRegion | () | method |
public function removeRegion(region:String):CompassRegionContainerRemove the passed region.
Parameters
region:String |
CompassRegionContainer — the removed region container
|
| resizeHandler | () | method |
protected function resizeHandler(event:MouseEvent):voidHandles the MouseEvents dispatched by resizing drags.
Parameters
event:MouseEvent — the MouseEvent that triggered the handler
|
| setMinimizeState | () | method |
public function setMinimizeState(compassQuadrant:String, minimize:Boolean, skipAnimation:Boolean = true):voidSet whether a region is minimized or not.
Will skip any animations.
Parameters
compassQuadrant:String — the CompassQuadrant string for the region to
change its minimized state
| |
minimize:Boolean — Boolean whether to set as minimized or not
| |
skipAnimation:Boolean (default = true) |
| updateRegionProperties | () | method |
protected function updateRegionProperties():voidUpdate region properties.
| dividerDrag | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a "divider" is dragged.
| dividerPress | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a "divider" is moused down.
| dividerRelease | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a "divider" is moused up or released.
| regionClose | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a region is closed.
| regionInitialized | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a region is initialized and added to the CompassContainer.
| regionMinimizeChange | Event |
ardisia.components.compassContainer.events.CompassContainerEventardisia.components.compassContainer.events.CompassContainerEventDispatched when a region's minimization state changes.