Packageardisia.components.dockingCompassContainer
Classpublic class RegionDropTarget
InheritanceRegionDropTarget Inheritance spark.components.supportClasses.SkinnableComponent

Drop target indicator for the docking regions. Each instance handles the display for each indicator for each quadrant of the region.

Use the getHoveredDropTargetQuadrant() method to return which drop target is hovered (if any).


Public Properties
 PropertyDefined By
  dockingEastEnabled : Boolean
True if regions can be dragged and docked to the east quadrant of this region.
RegionDropTarget
  dockingNorthEnabled : Boolean
True if regions can be dragged and docked to the north quadrant of this region.
RegionDropTarget
  dockingSouthEnabled : Boolean
True if regions can be dragged and docked to the south quadrant of this region.
RegionDropTarget
  dockingWestEnabled : Boolean
True if regions can be dragged and docked to the west quadrant of this region.
RegionDropTarget
Public Methods
 MethodDefined By
  
getHoveredDropTargetQuadrant():String
Return the hovered drop target compass direction string description.
RegionDropTarget
  
update():void
Check if a drop target is hovered and update the skin state.
RegionDropTarget
Skin Parts

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
  
eastDropTargetPart:mx.core.IVisualElement
Required: true Part Type: Dynamic
East quadrant drop target.
RegionDropTarget
  
northDropTargetPart:mx.core.IVisualElement
Required: true Part Type: Dynamic
North quadrant drop target.
RegionDropTarget
  
southDropTargetPart:mx.core.IVisualElement
Required: true Part Type: Dynamic
South quadrant drop target.
RegionDropTarget
  
westDropTargetPart:mx.core.IVisualElement
Required: true Part Type: Dynamic
West quadrant drop target.
RegionDropTarget
Skin States

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
  
eastOver
RegionDropTarget
  
normal
RegionDropTarget
  
northOver
RegionDropTarget
  
southOver
RegionDropTarget
  
westOver
RegionDropTarget
Property Detail
dockingEastEnabledproperty
dockingEastEnabled:Boolean

True if regions can be dragged and docked to the east quadrant of this region.

Value only affects future docks, not past ones.

The default value is true.


Implementation
    public function get dockingEastEnabled():Boolean
    public function set dockingEastEnabled(value:Boolean):void
dockingNorthEnabledproperty 
dockingNorthEnabled:Boolean

True if regions can be dragged and docked to the north quadrant of this region.

Value only affects future docks, not past ones.

The default value is true.


Implementation
    public function get dockingNorthEnabled():Boolean
    public function set dockingNorthEnabled(value:Boolean):void
dockingSouthEnabledproperty 
dockingSouthEnabled:Boolean

True if regions can be dragged and docked to the south quadrant of this region.

Value only affects future docks, not past ones.

The default value is true.


Implementation
    public function get dockingSouthEnabled():Boolean
    public function set dockingSouthEnabled(value:Boolean):void
dockingWestEnabledproperty 
dockingWestEnabled:Boolean

True if regions can be dragged and docked to the west quadrant of this region.

Value only affects future docks, not past ones.

The default value is true.


Implementation
    public function get dockingWestEnabled():Boolean
    public function set dockingWestEnabled(value:Boolean):void
Method Detail
getHoveredDropTargetQuadrant()method
public function getHoveredDropTargetQuadrant():String

Return the hovered drop target compass direction string description.

Returns
String — the Compass direction hovered (if any)
update()method 
public function update():void

Check if a drop target is hovered and update the skin state.





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