Packagemx.events
Classpublic class DividerEvent
InheritanceDividerEvent Inheritance Event Inheritance Object

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
 Inheritedbubbles : Boolean
Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
The object that is actively processing the Event object with an event listener.
Event
  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
 InheritedeventPhase : uint
The current phase in the event flow.
Event
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedtarget : Object
The event target.
Event
 Inheritedtype : String
The type of event.
Event
Public Methods
 MethodDefined by
  
DividerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dividerIndex:int = -1, delta:Number)
Constructor.
DividerEvent
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in your custom Event class.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether preventDefault() has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined by
 InheritedACTIVATE : String = "activate"
[static] Defines the value of the type property of an activate event object.
Event
 InheritedADDED : String = "added"
[static] Defines the value of the type property of an added event object.
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] Defines the value of the type property of an addedToStage event object.
Event
 InheritedCANCEL : String = "cancel"
[static] Defines the value of the type property of a cancel event object.
Event
 InheritedCHANGE : String = "change"
[static] Defines the value of the type property of a change event object.
Event
 InheritedCLOSE : String = "close"
[static] Defines the value of the type property of a close event object.
Event
 InheritedCOMPLETE : String = "complete"
[static] Defines the value of the type property of a complete event object.
Event
 InheritedCONNECT : String = "connect"
[static] Defines the value of the type property of a connect event object.
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] Defines the value of the type property of a deactivate event object.
Event
  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
 InheritedENTER_FRAME : String = "enterFrame"
[static] Defines the value of the type property of an enterFrame event object.
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] Defines the value of the type property of a fullScreen event object.
Event
 InheritedID3 : String = "id3"
[static] Defines the value of the type property of an id3 event object.
Event
 InheritedINIT : String = "init"
[static] Defines the value of the type property of an init event object.
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] Defines the value of the type property of a mouseLeave event object.
Event
 InheritedOPEN : String = "open"
[static] Defines the value of the type property of an open event object.
Event
 InheritedREMOVED : String = "removed"
[static] Defines the value of the type property of a removed event object.
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] Defines the value of the type property of a removedFromStage event object.
Event
 InheritedRENDER : String = "render"
[static] Defines the value of the type property of a render event object.
Event
 InheritedRESIZE : String = "resize"
[static] Defines the value of the type property of a resize event object.
Event
 InheritedSCROLL : String = "scroll"
[static] Defines the value of the type property of a scroll event object.
Event
 InheritedSELECT : String = "select"
[static] Defines the value of the type property of a select event object.
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] Defines the value of the type property of a soundComplete event object.
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] Defines the value of the type property of a tabChildrenChange event object.
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] Defines the value of the type property of a tabEnabledChange event object.
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] Defines the value of the type property of a tabIndexChange event object.
Event
 InheritedUNLOAD : String = "unload"
[static] Defines the value of the type property of an unload event object.
Event
Property detail
deltaproperty
public var delta:Number

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

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)

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 — The number of pixels by which the divider has been dragged.
Constant detail
DIVIDER_DRAGconstant
public static const DIVIDER_DRAG:String = "dividerDrag"

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"

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"

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.




Take a survey


 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flex/201/langref/mx/events/DividerEvent.html