ardisia.components.compassContainer.CompassContainerBase

	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
		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
		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
		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
		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
		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

Description	Defined By
centerBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the center region. The default value is `#FFFFFF`.	CompassContainerBase
centerBorderAlpha	Type: Number CSS Inheritance: no Alpha of the border for the center region.	CompassContainerBase
centerBorderColor	Type: uint Format: Color CSS Inheritance: no Color of the border for the center region.	CompassContainerBase
centerBorderVisible	Type: Boolean CSS Inheritance: no True to display a border around the center region.	CompassContainerBase
eastBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the east region. The default value is `#FFFFFF`.	CompassContainerBase
eastBorderAlpha	Type: Number CSS Inheritance: no Alpha of the border for the east region.	CompassContainerBase
eastBorderColor	Type: uint Format: Color CSS Inheritance: no Color of the border for the east region.	CompassContainerBase
eastBorderVisible	Type: Boolean CSS Inheritance: no True to display a border around the east region.	CompassContainerBase
gap	Type: Number CSS Inheritance: no The gap between regions. If the resizeRegion width/height styles are not explicitly set, the resize region divider buttons will be sized to the same dimensions as the gap. The default value is `6`.	CompassContainerBase
gapAlpha	Type: Number CSS Inheritance: no Alpha of the gap.	CompassContainerBase
gapColor	Type: Number CSS Inheritance: no Color of the gap between regions. Only applicable if there is a gap.	CompassContainerBase
northBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the north region. The default value is `#FFFFFF`.	CompassContainerBase
northBorderAlpha	Type: Number CSS Inheritance: no Alpha of the border for the north region.	CompassContainerBase
northBorderColor	Type: uint Format: Color CSS Inheritance: no Color of the border for the north region.	CompassContainerBase
northBorderVisible	Type: Boolean CSS Inheritance: no True to display a border around the north region.	CompassContainerBase
resizeRegionHeight	Type: Number CSS Inheritance: no Height of the divider button for horizontal dividers. If NaN, will be set to the height of the gap. The default value is `NaN`.	CompassContainerBase
resizeRegionWidth	Type: Number CSS Inheritance: no Width of the divider button for vertical dividers. If NaN, will be set to the width of the gap. The default value is `NaN`.	CompassContainerBase
southBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the south region. The default value is `#FFFFFF`.	CompassContainerBase
southBorderAlpha	Type: Number CSS Inheritance: no Alpha of the border for the south region.	CompassContainerBase
southBorderColor	Type: uint Format: Color CSS Inheritance: no Color of the border for the south region.	CompassContainerBase
southBorderVisible	Type: Boolean CSS Inheritance: no True to display a border around the south region.	CompassContainerBase
westBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the west region. The default value is `#FFFFFF`.	CompassContainerBase
westBorderAlpha	Type: Number CSS Inheritance: no Alpha of the border for the west region.	CompassContainerBase
westBorderColor	Type: uint Format: Color CSS Inheritance: no Color of the border for the west region.	CompassContainerBase
westBorderVisible	Type: Boolean CSS Inheritance: no True to display a border around the west region.	CompassContainerBase

Property Detail

animationDuration

property

animationDuration:Number

The duration of animations for the minimize/maximize animations.

Set to 0 to skip animation.

The default value is 250.

Implementation
public function get animationDuration():Number
public function set animationDuration(value:Number):void

centerContent

property

centerContent:Array [write-only]

Array of MXML content to add to the center region. Typically declared in MXML.

Retrieve the content via the centerRegionInstance instance.

The default value is null.

Implementation
public function set centerContent(value:Array):void

centerRegionInstance

property

public var centerRegionInstance:CompassRegionContainer

centerRegionTitle

property

centerRegionTitle:String

The title to display in the header for the center region if the header is displayed.

The default value is null.

Implementation
public function get centerRegionTitle():String
public function set centerRegionTitle(value:String):void

easer

property

easer:IEaser

The easer to use for the minimize/maximize fade animation.

The default value is Power easer.

Implementation
public function get easer():IEaser
public function set easer(value:IEaser):void

eastCanBeClosed

property

eastCanBeClosed:Boolean

True if the east region can be closed via mouse interaction.

Only relevant if "showEastChrome" is true.

The default value is false.

Implementation
public function get eastCanBeClosed():Boolean
public function set eastCanBeClosed(value:Boolean):void

eastCanBeMinimized

property

eastCanBeMinimized:Boolean

True if the east region can be minimized via mouse interaction.

Only relevant if "showEastChrome" is true.

The default value is true.

Implementation
public function get eastCanBeMinimized():Boolean
public function set eastCanBeMinimized(value:Boolean):void

eastContent

property

eastContent:Array [write-only]

Array of MXML content to add to the east region. Typically declared in MXML.

Retrieve the content via the eastRegionInstance instance.

The default value is null.

Implementation
public function set eastContent(value:Array):void

eastRegionInstance

property

public var eastRegionInstance:CompassRegionContainer

eastRegionTitle

property

eastRegionTitle:String

The title to display in the header for the east region if the header is displayed.

The default value is null.

Implementation
public function get eastRegionTitle():String
public function set eastRegionTitle(value:String):void

eastResizeLocked

property

eastResizeLocked:Boolean

True to prevent the region from being resized via user interaction.

The default value is false.

Implementation
public function get eastResizeLocked():Boolean
public function set eastResizeLocked(value:Boolean):void

eastWidth

property

eastWidth:Number

Explicit width of the east region.

The default value is 200.

Implementation
public function get eastWidth():Number
public function set eastWidth(value:Number):void

maxEastWidth

property

maxEastWidth:Number

The maximum allowed size of the east region.

Users will not be able to resize larger than this value.

The default value is 1000.

Implementation
public function get maxEastWidth():Number
public function set maxEastWidth(value:Number):void

maxNorthHeight

property

maxNorthHeight:Number

The maximum allowed size of the north region.

Users will not be able to resize larger than this value.

The default value is 1000.

Implementation
public function get maxNorthHeight():Number
public function set maxNorthHeight(value:Number):void

maxSouthHeight

property

maxSouthHeight:Number

The maximum allowed size of the south region.

Users will not be able to resize larger than this value.

The default value is 1000.

Implementation
public function get maxSouthHeight():Number
public function set maxSouthHeight(value:Number):void

maxWestWidth

property

maxWestWidth:Number

The maximum allowed size of the west region.

Users will not be able to resize larger than this value.

The default value is 1000.

Implementation
public function get maxWestWidth():Number
public function set maxWestWidth(value:Number):void

minEastWidth

property

minEastWidth:Number

The minimum allowed size of the east region.

Users will not be able to resize smaller than this value.

The default value is 50.

Implementation
public function get minEastWidth():Number
public function set minEastWidth(value:Number):void

minNorthHeight

property

minNorthHeight:Number

The minimum allowed size of the north region.

Users will not be able to resize smaller than this value.

The default value is 50.

Implementation
public function get minNorthHeight():Number
public function set minNorthHeight(value:Number):void

minSouthHeight

property

minSouthHeight:Number

The minimum allowed size of the south region.

Users will not be able to resize smaller than this value.

The default value is 50.

Implementation
public function get minSouthHeight():Number
public function set minSouthHeight(value:Number):void

minWestWidth

property

minWestWidth:Number

The minimum allowed size of the west region.

Users will not be able to resize smaller than this value.

The default value is 50.

Implementation
public function get minWestWidth():Number
public function set minWestWidth(value:Number):void

northCanBeClosed

property

northCanBeClosed:Boolean

True if the north region can be closed via mouse interaction.

Only relevant if "showNorthChrome" is true.

The default value is false.

Implementation
public function get northCanBeClosed():Boolean
public function set northCanBeClosed(value:Boolean):void

northCanBeMinimized

property

northCanBeMinimized:Boolean

True if the north region can be minimized via mouse interaction.

Only relevant if "showNorthChrome" is true.

The default value is true.

Implementation
public function get northCanBeMinimized():Boolean
public function set northCanBeMinimized(value:Boolean):void

northContent

property

northContent:Array [write-only]

Array of MXML content to add to the north region. Typically declared in MXML.

Retrieve the content via the northRegionInstance instance.

The default value is null.

Implementation
public function set northContent(value:Array):void

northHeight

property

northHeight:Number

Explicit height of the north region.

The default value is 200.

Implementation
public function get northHeight():Number
public function set northHeight(value:Number):void

northRegionInstance

property

public var northRegionInstance:CompassRegionContainer

northRegionTitle

property

northRegionTitle:String

The title to display in the header for the north region if the header is displayed.

The default value is null.

Implementation
public function get northRegionTitle():String
public function set northRegionTitle(value:String):void

northResizeLocked

property

northResizeLocked:Boolean

True to prevent the region from being resized via user interaction.

The default value is false.

Implementation
public function get northResizeLocked():Boolean
public function set northResizeLocked(value:Boolean):void

showCenterChrome

property

showCenterChrome:Boolean

True to display the chrome for the center region.

The default value is true.

Implementation
public function get showCenterChrome():Boolean
public function set showCenterChrome(value:Boolean):void

showEastChrome

property

showEastChrome:Boolean

True to display the chrome for the east region.

The default value is true.

Implementation
public function get showEastChrome():Boolean
public function set showEastChrome(value:Boolean):void

showNorthChrome

property

showNorthChrome:Boolean

True to display the chrome for the north region.

The default value is true.

Implementation
public function get showNorthChrome():Boolean
public function set showNorthChrome(value:Boolean):void

showSouthChrome

property

showSouthChrome:Boolean

True to display the chrome for the south region.

The default value is true.

Implementation
public function get showSouthChrome():Boolean
public function set showSouthChrome(value:Boolean):void

showWestChrome

property

showWestChrome:Boolean

True to display the chrome for the west region.

The default value is true.

Implementation
public function get showWestChrome():Boolean
public function set showWestChrome(value:Boolean):void

southCanBeClosed

property

southCanBeClosed:Boolean

True if the east region can be closed via mouse interaction.

Only relevant if "showSouthChrome" is true.

The default value is false.

Implementation
public function get southCanBeClosed():Boolean
public function set southCanBeClosed(value:Boolean):void

southCanBeMinimized

property

southCanBeMinimized:Boolean

True if the south region can be minimized via mouse interaction.

Only relevant if "showSouthChrome" is true.

The default value is true.

Implementation
public function get southCanBeMinimized():Boolean
public function set southCanBeMinimized(value:Boolean):void

southContent

property

southContent:Array [write-only]

Array of MXML content to add to the south region. Typically declared in MXML.

Retrieve the content via the southRegionInstance instance.

The default value is null.

Implementation
public function set southContent(value:Array):void

southHeight

property

southHeight:Number

Explicit height of the south region.

The default value is 200.

Implementation
public function get southHeight():Number
public function set southHeight(value:Number):void

southRegionInstance

property

public var southRegionInstance:CompassRegionContainer

southRegionTitle

property

southRegionTitle:String

The title to display in the header for the south region if the header is displayed.

The default value is null.

Implementation
public function get southRegionTitle():String
public function set southRegionTitle(value:String):void

southResizeLocked

property

southResizeLocked:Boolean

True to prevent the region from being resized via user interaction.

The default value is false.

Implementation
public function get southResizeLocked():Boolean
public function set southResizeLocked(value:Boolean):void

westCanBeClosed

property

westCanBeClosed:Boolean

True if the west region can be closed via mouse interaction.

Only relevant if "showWestChrome" is true.

The default value is false.

Implementation
public function get westCanBeClosed():Boolean
public function set westCanBeClosed(value:Boolean):void

westCanBeMinimized

property

westCanBeMinimized:Boolean

True if the west region can be minimized via mouse interaction.

Only relevant if "showWestChrome" is true.

The default value is true.

Implementation
public function get westCanBeMinimized():Boolean
public function set westCanBeMinimized(value:Boolean):void

westContent

property

westContent:Array [write-only]

Array of MXML content to add to the west region. Typically declared in MXML.

Retrieve the content via the westRegionInstance instance.

The default value is null.

Implementation
public function set westContent(value:Array):void

westRegionInstance

property

public var westRegionInstance:CompassRegionContainer

westRegionTitle

property

westRegionTitle:String

The title to display in the header for the west region if the header is displayed.

The default value is null.

Implementation
public function get westRegionTitle():String
public function set westRegionTitle(value:String):void

westResizeLocked

property

westResizeLocked:Boolean

True to prevent the region from being resized via user interaction.

The default value is false.

Implementation
public function get westResizeLocked():Boolean
public function set westResizeLocked(value:Boolean):void

westWidth

property

westWidth:Number

Explicit width of the west region.

The default value is 200.

Implementation
public function get westWidth():Number
public function set westWidth(value:Number):void

Mon Sep 15 2014, 01:55 AM -06:00

Ardisia Component Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
CompassContainerBase	Properties \| Styles \| Skin States

Package	ardisia.components.compassContainer
Class	public class CompassContainerBase
Inheritance	CompassContainerBase spark.components.supportClasses.SkinnableComponent
Subclasses	CompassContainer, DockingCompassContainer