Packagemx.events
Classpublic class DividerEvent
InheritanceDividerEvent Inheritance flash.events.Event

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Represents events that are dispatched when a divider has been pressed, dragged or released. These events are dispatched by the DividedBox control and its children.

See also

mx.containers.DividedBox

Public Properties
 PropertyDefined By
  delta : Number
The number of pixels that the divider has been dragged.
DividerEvent
  dividerIndex : int
The zero-based index of the divider being pressed or dragged.
DividerEvent
Public Methods
 MethodDefined By
  
DividerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dividerIndex:int = -1, delta:Number)
Constructor.
DividerEvent
Public Constants
 ConstantDefined By
  DIVIDER_DRAG : String = dividerDrag
[static] The DividerEvent.DIVIDER_DRAG constant defines the value of the type property of the event object for a dividerDrag event.
DividerEvent
  DIVIDER_PRESS : String = dividerPress
[static] The DividerEvent.DIVIDER_PRESS constant defines the value of the type property of the event object for a dividerPress event.
DividerEvent
  DIVIDER_RELEASE : String = dividerRelease
[static] The DividerEvent.DIVIDER_RELEASE constant defines the value of the type property of the event object for a dividerRelease event.
DividerEvent
Property Detail
deltaproperty
public var delta:Number

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.

dividerIndexproperty 
public var dividerIndex:int

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The zero-based index of the divider being pressed or dragged. The leftmost or topmost divider has a dividerIndex of 0.

Constructor Detail
DividerEvent()Constructor
public function DividerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dividerIndex:int = -1, delta:Number)

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
dividerIndex:int (default = -1) — Index of the divider that generated the event.
 
delta:Number (default = NaN) — The number of pixels by which the divider has been dragged.
Constant Detail
DIVIDER_DRAGConstant
public static const DIVIDER_DRAG:String = dividerDrag

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The DividerEvent.DIVIDER_DRAG constant defines the value of the type property of the event object for a dividerDrag event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.
dividerIndexContains the zero-based index of the divider being dragged. The leftmost or topmost divider has a dividerIndex of 0.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DIVIDER_PRESSConstant 
public static const DIVIDER_PRESS:String = dividerPress

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The DividerEvent.DIVIDER_PRESS constant defines the value of the type property of the event object for a dividerPress event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.
dividerIndexContains the zero-based index of the divider being dragged. The leftmost or topmost divider has a dividerIndex of 0.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

DIVIDER_RELEASEConstant 
public static const DIVIDER_RELEASE:String = dividerRelease

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

The DividerEvent.DIVIDER_RELEASE constant defines the value of the type property of the event object for a dividerRelease event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the number of pixels that the divider has been dragged. Positive numbers represent a drag toward the right or bottom, negative numbers toward the left or top.
dividerIndexContains the zero-based index of the divider being dragged. The leftmost or topmost divider has a dividerIndex of 0.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.





Mon Dec 24 2012, 01:18 PM +11:00