spark.components.supportClasses.DropDownController - Adobe® Flex® 4 Language Reference (Flex 4)

Package	spark.components.supportClasses
Class	public class DropDownController
Inheritance	DropDownController EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The DropDownController class handles the mouse, keyboard, and focus interactions for an anchor button and its associated drop down. This class is used by the drop-down components, such as DropDownList, to handle the opening and closing of the drop down due to user interactions.

See also

spark.components.DropDownList

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		hitAreaAdditions : Vector.<DisplayObject> A list of display objects to consider part of the hit area of the drop down.	DropDownController
		isOpen : Boolean [read-only] Contains true if the drop down is open.	DropDownController
		openButton : ButtonBase A reference to the openButton skin part of the drop-down component.	DropDownController
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		rollOverOpenDelay : Number Specifies the delay, in milliseconds, to wait for opening the drop down when the anchor button is rolled over.	DropDownController
		systemManager : ISystemManager A reference to the SystemManager used for mouse tracking.	DropDownController

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DropDownController() Constructor.	DropDownController
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		closeDropDown(commit:Boolean):void Close the drop down and dispatch a DropDownEvent.CLOSE event.	DropDownController
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		openDropDown():void Open the drop down and dispatch a DropdownEvent.OPEN event.	DropDownController
		processFocusOut(event:FocusEvent):void Close the drop down if it is no longer in focus.	DropDownController
		processKeyDown(event:KeyboardEvent):Boolean Handles the keyboard user interactions.	DropDownController
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

hitAreaAdditions

property

public var hitAreaAdditions:Vector.<DisplayObject>

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A list of display objects to consider part of the hit area of the drop down. Mouse clicks within any component listed as an inclusion will not automatically close the drop down.

isOpen

property

isOpen:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Contains true if the drop down is open.

Implementation
public function get isOpen():Boolean

openButton

property

openButton:ButtonBase

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A reference to the openButton skin part of the drop-down component.

Implementation
public function get openButton():ButtonBase
public function set openButton(value:ButtonBase):void

rollOverOpenDelay

property

rollOverOpenDelay:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Specifies the delay, in milliseconds, to wait for opening the drop down when the anchor button is rolled over. If set to NaN, then the drop down opens on a click, not a rollover.

The default value is NaN.

Implementation
public function get rollOverOpenDelay():Number
public function set rollOverOpenDelay(value:Number):void

systemManager

property

systemManager:ISystemManager

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A reference to the SystemManager used for mouse tracking. if none is specified, the controller will use the systemManager associated with the openButton.

Implementation
public function get systemManager():ISystemManager
public function set systemManager(value:ISystemManager):void

Constructor Detail

DropDownController

()

Constructor

public function DropDownController()

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Method Detail

closeDropDown

()

method

public function closeDropDown(commit:Boolean):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Close the drop down and dispatch a DropDownEvent.CLOSE event.

Parameters

commit:Boolean — If true, commit the selected data item.

openDropDown

()

method

public function openDropDown():void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Open the drop down and dispatch a DropdownEvent.OPEN event.

processFocusOut

()

method

public function processFocusOut(event:FocusEvent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Close the drop down if it is no longer in focus.

Parameters

event:FocusEvent — The event object for the FOCUS_OUT event.

processKeyDown

()

method

public function processKeyDown(event:KeyboardEvent):Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Handles the keyboard user interactions.

Parameters

event:KeyboardEvent — The event object from the keyboard event.

Returns

Boolean — Returns true if the keyCode was recognized and handled.