| Package | ardisia.components.dockingCompassContainer.events |
| Class | public class DockingCompassContainerEvent |
| Inheritance | DockingCompassContainerEvent  flash.events.Event |
| Property | Defined By | ||
|---|---|---|---|
| draggedRegion : CompassRegionContainer
Region being dragged. | DockingCompassContainerEvent | ||
| dropType : String = region
For a drop, the type of drop. | DockingCompassContainerEvent | ||
| eastDockAllowed : Boolean = true
On "enter" events, property indicates if the drop can occur over the
east region within the hovered region. | DockingCompassContainerEvent | ||
| newRegion : CompassRegionContainer
Only applicable to DRAG_DROP_COMPLETE events. | DockingCompassContainerEvent | ||
| northDockAllowed : Boolean = true
On "enter" events, property indicates if the drop can occur over the
north region within the hovered region. | DockingCompassContainerEvent | ||
| overRegion : UIComponent
Region hovered over while dragging or the drop region on a drop. | DockingCompassContainerEvent | ||
| southDockAllowed : Boolean = true
On "enter" events, property indicates if the drop can occur over the
south region within the hovered region. | DockingCompassContainerEvent | ||
| westDockAllowed : Boolean = true
On "enter" events, property indicates if the drop can occur over the
west region within the hovered region. | DockingCompassContainerEvent | ||
| Method | Defined By | ||
|---|---|---|---|
DockingCompassContainerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, draggedRegion:CompassRegionContainer = null, overRegion:UIComponent = null) | DockingCompassContainerEvent | ||
clone():Event [override]
Necessary for re-dispatching to work. | DockingCompassContainerEvent | ||
| Constant | Defined By | ||
|---|---|---|---|
| DRAG_DROP_COMPLETE : String = dragDropComplete [static] | DockingCompassContainerEvent | ||
| DRAG_DROP_STARTING : String = dragDropStarting [static] | DockingCompassContainerEvent | ||
| DRAG_END : String = dragEnd [static] | DockingCompassContainerEvent | ||
| DRAG_ENTER : String = dragEnter [static] | DockingCompassContainerEvent | ||
| DRAG_EXIT : String = dragExit [static] | DockingCompassContainerEvent | ||
| DRAG_REGION_ENTER : String = dragRegionEnter [static] | DockingCompassContainerEvent | ||
| DRAG_REGION_EXIT : String = dragRegionExit [static] | DockingCompassContainerEvent | ||
| DRAG_START : String = dragStart [static] | DockingCompassContainerEvent | ||
| DRAG_STARTING : String = dragStarting [static] | DockingCompassContainerEvent | ||
| draggedRegion | property |
| dropType | property |
public var dropType:String = regionFor a drop, the type of drop.
Either a "region" drop, meaning dropped inside of a region or a "topLevel" meaning the drop will add a region to the top level container, A.K.A. the DockingCompassContainer.
The default value is null.
| eastDockAllowed | property |
public var eastDockAllowed:Boolean = trueOn "enter" events, property indicates if the drop can occur over the east region within the hovered region.
Set in the event listener.
The default value is true.
| newRegion | property |
public var newRegion:CompassRegionContainerOnly applicable to DRAG_DROP_COMPLETE events.
This is the new region created after the drop. Useful to make changes to the new region.
The default value is null.
| northDockAllowed | property |
public var northDockAllowed:Boolean = trueOn "enter" events, property indicates if the drop can occur over the north region within the hovered region.
Set in the event listener.
The default value is true.
| overRegion | property |
public var overRegion:UIComponentRegion hovered over while dragging or the drop region on a drop.
The default value is null.
| southDockAllowed | property |
public var southDockAllowed:Boolean = trueOn "enter" events, property indicates if the drop can occur over the south region within the hovered region.
Set in the event listener.
The default value is true.
| westDockAllowed | property |
public var westDockAllowed:Boolean = trueOn "enter" events, property indicates if the drop can occur over the west region within the hovered region.
Set in the event listener.
The default value is true.
| DockingCompassContainerEvent | () | Constructor |
public function DockingCompassContainerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, draggedRegion:CompassRegionContainer = null, overRegion:UIComponent = null)type:String | |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
draggedRegion:CompassRegionContainer (default = null) | |
overRegion:UIComponent (default = null) |
| clone | () | method |
override public function clone():EventNecessary for re-dispatching to work.
ReturnsEvent — DockingCompassContainer
|
| DRAG_DROP_COMPLETE | Constant |
public static const DRAG_DROP_COMPLETE:String = dragDropComplete| DRAG_DROP_STARTING | Constant |
public static const DRAG_DROP_STARTING:String = dragDropStarting| DRAG_END | Constant |
public static const DRAG_END:String = dragEnd| DRAG_ENTER | Constant |
public static const DRAG_ENTER:String = dragEnter| DRAG_EXIT | Constant |
public static const DRAG_EXIT:String = dragExit| DRAG_REGION_ENTER | Constant |
public static const DRAG_REGION_ENTER:String = dragRegionEnter| DRAG_REGION_EXIT | Constant |
public static const DRAG_REGION_EXIT:String = dragRegionExit| DRAG_START | Constant |
public static const DRAG_START:String = dragStart| DRAG_STARTING | Constant |
public static const DRAG_STARTING:String = dragStarting