ardisia.components.dockingCompassContainer.DockingCompassContainer

Public Properties

	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
		eastTopLevelDropTarget : TopLevelDropTarget	DockingCompassContainer
		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
		northTopLevelDropTarget : TopLevelDropTarget	DockingCompassContainer
		regionDropTargetInstance : RegionDropTarget	DockingCompassContainer
		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
		southTopLevelDropTarget : TopLevelDropTarget	DockingCompassContainer
		topLevelCompassContainer : CompassContainer [read-only] Top level compass container.	DockingCompassContainer
		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
		westTopLevelDropTarget : TopLevelDropTarget	DockingCompassContainer
		westWidth : Number Explicit width of the west region.	CompassContainerBase

	Method	Defined By
		dragDrop(draggedRegion:CompassRegionContainer, hoveredRegion:CompassRegionContainer, regionDropQuadrant:String = null, topLevelQuadrant:String = null):void Called when a region drag is dropped.	DockingCompassContainer
		dragEnd():void Called when a drag operation ends.	DockingCompassContainer
		dragEnter(event:DockingCompassContainerEvent):void Called when a drag operation enters the entire DockingCompassContainer.	DockingCompassContainer
		dragExit():void Called when a drag operation exits the entire DockingCompassContainer.	DockingCompassContainer
		dragMove(hoveredRegion:CompassRegionContainer, originatingDockingCompassContainer:DockingCompassContainer):void Called when a drag operation moves over the DockingCompassContainer.	DockingCompassContainer
		dragRegionEnter(hoveredRegion:CompassRegionContainer, event:DockingCompassContainerEvent):void Called when a region drag enters a docking container region.	DockingCompassContainer
		dragRegionExit():void Called when a drag operations exits a docking region.	DockingCompassContainer

	Method	Defined By
		compassContainerHandler(event:Event):void Handles events on the CompassContainer.	DockingCompassContainer
		dockingHandler(event:MouseEvent):void Handles docking operations for the dragged region.	DockingCompassContainer
		drawDropIndicator(location:String, region:UIComponent, originatingDockingCompassContainer:DockingCompassContainer):void Draw an indicator when hovering over a top level drop target or a region drop target.	DockingCompassContainer
		getHoveredRegionDropTarget():String Return the region drop target hovered (if any).	DockingCompassContainer
		getHoveredTopLevelRegionDropTarget():String Check if any top level drop targets are hovered over.	DockingCompassContainer
		removeRegionDropTargets():void Remove the region drop target instance.	DockingCompassContainer
		removeTopLevelDropTargets():void Remove the top level drop targets.	DockingCompassContainer

Summary	Defined By
dragDropComplete	Dispatched when a drop is completed and after the dragged region has been added to the drop region.	DockingCompassContainer
dragDropStarting	Dispatched when a drop is initiated, assuming it was not cancelled in the "dragEnter" event.	DockingCompassContainer
dragEnd	Dispatched when a drag ends, regardless if a drop occurred or not.	DockingCompassContainer
dragEnter	Dispatched when a drag enters a DockingCompassContainer.	DockingCompassContainer
dragExit	Dispatched when a drag leaves a DockingCompassContainer.	DockingCompassContainer
dragRegionEnter	Dispatched when a drag enters another region of a DockingCompassContainer.	DockingCompassContainer
dragRegionExit	Dispatched when a drag leaves a region of the CompassRegionContainer.	DockingCompassContainer
dragStart	Dispatched when a region begins dragging.	DockingCompassContainer
dragStarting	Dispatched when a region is about to begin dragging.	DockingCompassContainer

Description	Defined By
centerBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the center region.	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.	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.	CompassContainerBase
gapAlpha	Type: Number CSS Inheritance: no Alpha of the gap.	CompassContainerBase
gapColor	Type: Number CSS Inheritance: no Color of the gap between regions.	CompassContainerBase
northBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the north region.	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.	CompassContainerBase
resizeRegionWidth	Type: Number CSS Inheritance: no Width of the divider button for vertical dividers.	CompassContainerBase
southBackgroundColor	Type: uint Format: Color CSS Inheritance: no Color of the background for the south region.	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.	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

Description	Defined By
compassContainerFactoryPart:mx.core.IFactory	Required: true Part Type: Dynamic Factory that creates the CompassContainers. At least one top level CompassContainer will be created. The IFactory must return an object of type CompassContainer	DockingCompassContainer
dragProxyFactoryPart:mx.core.IFactory	Required: true Part Type: Dynamic Factory to create the region drag proxy. The IFactory must return an object of type DataRenderer	DockingCompassContainer
regionDropTargetFactoryPart:mx.core.IFactory	Required: true Part Type: Dynamic Creates elements that function as drop targets for a CompassRegionContainer. The IFactory must return an object of type UIComponent	DockingCompassContainer
topLevelDropTargetFactoryPart:mx.core.IFactory	Required: true Part Type: Dynamic Creates elements that function as drop targets for the top level DockingCompassContainer. Will create 4, 1 for each cardinal direction if the docking quadrant is enabled. The IFactory must return an object of type UIComponent	DockingCompassContainer

Property Detail

eastTopLevelDropTarget

property

public var eastTopLevelDropTarget:TopLevelDropTarget

northTopLevelDropTarget

property

public var northTopLevelDropTarget:TopLevelDropTarget

regionDropTargetInstance

property

public var regionDropTargetInstance:RegionDropTarget

southTopLevelDropTarget

property

public var southTopLevelDropTarget:TopLevelDropTarget

topLevelCompassContainer

property

topLevelCompassContainer:CompassContainer [read-only]

Top level compass container. Should be available after creationComplete fires.

The default value is null.

Implementation
public function get topLevelCompassContainer():CompassContainer

westTopLevelDropTarget

property

public var westTopLevelDropTarget:TopLevelDropTarget

Method Detail

compassContainerHandler

()

method

protected function compassContainerHandler(event:Event):void

Handles events on the CompassContainer.

Parameters

event:Event — the Event that triggered the handler

dockingHandler

()

method

protected function dockingHandler(event:MouseEvent):void

Handles docking operations for the dragged region.

Fired continously while a region that is a child of this DockingCompassContainer is being dragged.

Parameters

event:MouseEvent — the MouseEvent associated with the check

dragDrop

()

method

 public function dragDrop(draggedRegion:CompassRegionContainer, hoveredRegion:CompassRegionContainer, regionDropQuadrant:String = null, topLevelQuadrant:String = null):void

Called when a region drag is dropped.

Parameters

	`draggedRegion:CompassRegionContainer` — the CompassRegionContainer being dragged

	`hoveredRegion:CompassRegionContainer` — the docking CompassRegionContainer region currently hovered

	`regionDropQuadrant:String` (default = `null`) — the region quadrant to dock too

	`topLevelQuadrant:String` (default = `null`) — the top level quadrant to dock too

dragEnd

()

method

public function dragEnd():void

Called when a drag operation ends.

dragEnter

()

method

public function dragEnter(event:DockingCompassContainerEvent):void

Called when a drag operation enters the entire DockingCompassContainer.

See the dragRegionEnter method for the handler when a drag operation enters a particular region of the DockingCompassContainer.

Change the docking properties of the event to change allowed region docking.

Parameters

event:DockingCompassContainerEvent — the DockingCompassContainerEvent

dragExit

()

method

public function dragExit():void

Called when a drag operation exits the entire DockingCompassContainer.

dragMove

()

method

 public function dragMove(hoveredRegion:CompassRegionContainer, originatingDockingCompassContainer:DockingCompassContainer):void

Called when a drag operation moves over the DockingCompassContainer.

Parameters

	`hoveredRegion:CompassRegionContainer` — the CompassRegionContainer region currently hovered

	`originatingDockingCompassContainer:DockingCompassContainer` — the DockingCompassContainer that originated the drag

dragRegionEnter

()

method

public function dragRegionEnter(hoveredRegion:CompassRegionContainer, event:DockingCompassContainerEvent):void

Called when a region drag enters a docking container region.

See the dragEnter method for the handler when a drag operation enters the entire DockingCompassContainer.

Change the docking properties of the event to change allowed region docking.

Parameters

	`hoveredRegion:CompassRegionContainer` — the docking UIComponent region currently hovered

	`event:DockingCompassContainerEvent` — the DockingCompassContainerEvent

dragRegionExit

()

method

public function dragRegionExit():void

Called when a drag operations exits a docking region.

See the dragExit method for the handler when a drag operation exits the entire DockingCompassContainer.

drawDropIndicator

()

method

 protected function drawDropIndicator(location:String, region:UIComponent, originatingDockingCompassContainer:DockingCompassContainer):void

Draw an indicator when hovering over a top level drop target or a region drop target.

Parameters

	`location:String` — the quadrant hovered

	`region:UIComponent` — the UIComponent region hovered

	`originatingDockingCompassContainer:DockingCompassContainer` — the DockingCompassContainer that originated the drag

getHoveredRegionDropTarget

()

method

protected function getHoveredRegionDropTarget():String

Return the region drop target hovered (if any).

Returns

String — the CompassQuadrant string describing the hovered region (if any)

getHoveredTopLevelRegionDropTarget

()

method

protected function getHoveredTopLevelRegionDropTarget():String

Check if any top level drop targets are hovered over.

Returns

String — the CompassQuadrant string describing the hovered region (if any)

removeRegionDropTargets

()

method

protected function removeRegionDropTargets():void

Remove the region drop target instance.

removeTopLevelDropTargets

()

method

protected function removeTopLevelDropTargets():void

Remove the top level drop targets.

Event Detail

dragDropComplete

Event

Event Object Type: ardisia.components.dockingCompassContainer.events.DockingCompassContainerEvent
DockingCompassContainerEvent.type property = ardisia.components.dockingCompassContainer.events.DockingCompassContainerEvent

Dispatched when a drop is completed and after the dragged region has been added to the drop region.

Applies to drops to the top level and regions of the top level container. See the "dropType" property of the event.

dragDropStarting

Event

Dispatched when a drop is initiated, assuming it was not cancelled in the "dragEnter" event.

Cancel to prevent the drop.

dragEnd

Event

Dispatched when a drag ends, regardless if a drop occurred or not.

dragEnter

Event

Dispatched when a drag enters a DockingCompassContainer.

Cancel to prevent the user from dropping on the entered container. When the event is cancelled, the drag will not end, only the entered target DockingCompassContainer cannot be dropped on. When cancelled, not only will the drop not be allowed, but no drop indicators will be displayed.

This event only applies when dragging over an entire DockingCompassContainer. For enter events for regions of the container, see the "dragRegionEnter" event.

dragExit

Event

Dispatched when a drag leaves a DockingCompassContainer.

This event only applies when dragging out of an entire DockingCompassContainer. For exit events for regions of the container, see the "dragRegionExit" event.

dragRegionEnter

Event

Dispatched when a drag enters another region of a DockingCompassContainer.

Cancel to prevent the user from dropping on the entered container. When the event is cancelled, the drag will not end, only the entered target region cannot be dropped unto. When cancelled, not only will the drop not be allowed, but no drop indicators will be displayed.

This event only applies when dragging over an regions elements. For enter events for the top level, entire DockingCompassContainer, see the "dragEnter" event.

dragRegionExit

Event

Dispatched when a drag leaves a region of the CompassRegionContainer.

This event only applies when exiting a region element. For exit events for the entire DockingCompassContainer, see the "dragRegionExit" event.

dragStart

Event

Dispatched when a region begins dragging.

dragStarting

Event

Dispatched when a region is about to begin dragging.

Cancel to prevent the drag.

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

Ardisia Component Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
DockingCompassContainer	Properties \| Methods \| Events \| Styles \| Skin Parts \| Skin States

Package	ardisia.components.dockingCompassContainer
Class	public class DockingCompassContainer
Inheritance	DockingCompassContainer CompassContainerBase spark.components.supportClasses.SkinnableComponent