| Package | feathers.controls.popups |
| Class | public class DropDownPopUpContentManager |
| Inheritance | DropDownPopUpContentManager  starling.events.EventDispatcher |
| Implements | IPopUpContentManager |
| Product Version : | Feathers 1.0.0 |
| Property | Defined By | ||
|---|---|---|---|
| fitContentMinWidthToOrigin : Boolean
If enabled, the pop-up content's minWidth property will
be set to the width property of the origin, if it is
smaller. | DropDownPopUpContentManager | ||
| gap : Number
The space, in pixels, between the source and the pop-up. | DropDownPopUpContentManager | ||
| isModal : Boolean
Determines if the pop-up will be modal or not. | DropDownPopUpContentManager | ||
| isOpen : Boolean [read-only]
Indicates if the pop-up content is open or not. | DropDownPopUpContentManager | ||
| openCloseDuration : Number
The duration, in seconds, of the open and close animation. | DropDownPopUpContentManager | ||
| openCloseEase : Object
The easing function to use for the open and close animation. | DropDownPopUpContentManager | ||
| overlayFactory : Function
If isModal is true, this function may be
used to customize the modal overlay displayed by the pop-up manager. | DropDownPopUpContentManager | ||
| primaryDirection : String
The preferred position of the pop-up, relative to the source. | DropDownPopUpContentManager | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | DropDownPopUpContentManager | ||
close():void
Closes the pop-up content. | DropDownPopUpContentManager | ||
dispose():void
Cleans up the manager. | DropDownPopUpContentManager | ||
open(content:DisplayObject, source:DisplayObject):void
Displays the pop-up content. | DropDownPopUpContentManager | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the pop-up content closes. | DropDownPopUpContentManager | |||
| Dispatched when the pop-up content opens. | DropDownPopUpContentManager | |||
| fitContentMinWidthToOrigin | property |
fitContentMinWidthToOrigin:Boolean
If enabled, the pop-up content's minWidth property will
be set to the width property of the origin, if it is
smaller.
The default value is true.
public function get fitContentMinWidthToOrigin():Boolean public function set fitContentMinWidthToOrigin(value:Boolean):void| gap | property |
gap:NumberThe space, in pixels, between the source and the pop-up.
public function get gap():Number public function set gap(value:Number):void| isModal | property |
isModal:BooleanDetermines if the pop-up will be modal or not.
Note: If you change this value while a pop-up is displayed, the new value will not go into effect until the pop-up is removed and a new pop-up is added.
In the following example, the pop-up is modal:
manager.isModal = true;
The default value is false.
public function get isModal():Boolean public function set isModal(value:Boolean):void| isOpen | property |
isOpen:Boolean [read-only] Indicates if the pop-up content is open or not.
public function get isOpen():Boolean| openCloseDuration | property |
openCloseDuration:NumberThe duration, in seconds, of the open and close animation.
public function get openCloseDuration():Number public function set openCloseDuration(value:Number):void| openCloseEase | property |
openCloseEase:ObjectThe easing function to use for the open and close animation.
public function get openCloseEase():Object public function set openCloseEase(value:Object):void| overlayFactory | property |
overlayFactory:Function
If isModal is true, this function may be
used to customize the modal overlay displayed by the pop-up manager.
If the value of overlayFactory is null, the
pop-up manager's default overlay factory will be used instead.
This function is expected to have the following signature:
function():DisplayObject
In the following example, the overlay is customized:
manager.isModal = true;
manager.overlayFactory = function():DisplayObject
{
var quad:Quad = new Quad(1, 1, 0xff00ff);
quad.alpha = 0;
return quad;
}; The default value is null.
public function get overlayFactory():Function public function set overlayFactory(value:Function):voidSee also
| primaryDirection | property |
primaryDirection:StringThe preferred position of the pop-up, relative to the source. If there is not enough space to position pop-up at the preferred position, it may be positioned elsewhere.
The default value is feathers.layout.RelativePosition.BOTTOM.
public function get primaryDirection():String public function set primaryDirection(value:String):voidSee also
| DropDownPopUpContentManager | () | Constructor |
public function DropDownPopUpContentManager()Constructor.
| close | () | method |
public function close():voidCloses the pop-up content. If it is not opened, nothing happens.
| dispose | () | method |
public function dispose():voidCleans up the manager.
| open | () | method |
public function open(content:DisplayObject, source:DisplayObject):voidDisplays the pop-up content.
Parameters
content:DisplayObject — The content for the pop-up content manager to display.
| |
source:DisplayObject — The source of the pop-up. May be used to position and/or size the pop-up. May be completely ignored instead.
|
| close | Event |
starling.events.Eventstarling.events.Event.CLOSEDispatched when the pop-up content closes.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | 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. |
data | null |
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. |
| open | Event |
starling.events.Eventstarling.events.Event.OPENDispatched when the pop-up content opens.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | 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. |
data | null |
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. |