Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
DropDownController

Package | spark.components.supportClasses
Class | public class DropDownController
Inheritance | DropDownController flash.events.EventDispatcher

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

| Property | Defined By
--- | --- | ---
|  | closeOnResize : Boolean When true, resizing the system manager closes the drop down. | DropDownController
|  | 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
|  | 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

| Method | Defined By
--- | --- | ---
|  | DropDownController() Constructor. | DropDownController
|  | closeDropDown(commit:Boolean):void Close the drop down and dispatch a DropDownEvent.CLOSE event. | DropDownController
|  | 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

Property Detail

closeOnResize | property

`closeOnResize:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.6

Runtime Versions : | AIR 3

When `true`, resizing the system manager closes the drop down. For mobile applications, you can set this property to `false` so that the drop down stays open when the page orientation changes.

The default value is `true`.

Implementation
`public function get closeOnResize():Boolean`
`public function set closeOnResize(value:Boolean):void`

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.

Sun Mar 5 2017, 03:42 PM +11:00