DividerEvent

Package	mx.events
Class	public class DividerEvent
Inheritance	DividerEvent Event Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.containers.DividedBox

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] 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
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		DividerEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, dividerIndex:int = -1, delta:Number = NaN) Constructor.	DividerEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined 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

delta

property

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.

dividerIndex

property

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 = NaN)

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_DRAG

Constant

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`delta`	Contains 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.
`dividerIndex`	Contains the zero-based index of the divider being dragged. The leftmost or topmost divider has a `dividerIndex` of 0.
`target`	The 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_PRESS

Constant

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`delta`	Contains 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.
`dividerIndex`	Contains the zero-based index of the divider being dragged. The leftmost or topmost divider has a `dividerIndex` of 0.
`target`	The 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_RELEASE

Constant

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:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The 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`.
`delta`	Contains 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.
`dividerIndex`	Contains the zero-based index of the divider being dragged. The leftmost or topmost divider has a `dividerIndex` of 0.
`target`	The 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.

Legal Notices | Online Privacy Policy

DividerEvent - AS3 Flex

Classes x

delta

dividerIndex

DividerEvent

DIVIDER_DRAG

DIVIDER_PRESS

DIVIDER_RELEASE