| Package | feathers.controls.popups |
| Class | public class BottomDrawerPopUpContentManager |
| Inheritance | BottomDrawerPopUpContentManager  EventDispatcher Object |
| Implements | IPersistentPopUpContentManager, IPopUpContentManagerWithPrompt |
| Product Version : | Feathers 2.3.0 |
| Property | Defined By | ||
|---|---|---|---|
| closeButtonFactory : Function = null
Creates the Button that closes the pop-up. | BottomDrawerPopUpContentManager | ||
| closeButtonLabel : String
The text to display in the label of the close button. | BottomDrawerPopUpContentManager | ||
| customCloseButtonStyleName : String = null
Adds a style name to the close button. | BottomDrawerPopUpContentManager | ||
| customPanelStyleName : String = null
Adds a style name to the Panel that wraps the content. | BottomDrawerPopUpContentManager | ||
| isOpen : Boolean [read-only]
Indicates if the pop-up content is open or not. | BottomDrawerPopUpContentManager | ||
| openOrCloseDuration : Number
The duration, in seconds, of the animation to open or close the
pop-up. | BottomDrawerPopUpContentManager | ||
| openOrCloseEase : Object
The easing function used for opening or closing the pop-up. | BottomDrawerPopUpContentManager | ||
| overlayFactory : Function
This function may be used to customize the modal overlay displayed by
the pop-up manager. | BottomDrawerPopUpContentManager | ||
| panelFactory : Function = null
Creates the Panel that wraps the content. | BottomDrawerPopUpContentManager | ||
| prompt : String
A prompt to display in the panel's title. | BottomDrawerPopUpContentManager | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | BottomDrawerPopUpContentManager | ||
 | addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | |
close():void
Closes the pop-up content. | BottomDrawerPopUpContentManager | ||
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
dispose():void
Cleans up the manager. | BottomDrawerPopUpContentManager | ||
| hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
Displays the pop-up content. | BottomDrawerPopUpContentManager | ||
| removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher | |
| removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the pop-up content closes. | BottomDrawerPopUpContentManager | |||
| Dispatched when the pop-up content opens. | BottomDrawerPopUpContentManager | |||
| closeButtonFactory | property |
Hide Inherited Public Methods
Show Inherited Public Methodspublic var closeButtonFactory:Function = null
Creates the Button that closes the pop-up.
In the following example, a custom close button factory is provided:
manager.closeButtonFactory = function():Button
{
var closeButton:Button = new Button();
closeButton.defaultSkin = new Image( texture );
return closeButton;
}; The default value is null.
See also
| closeButtonLabel | property |
closeButtonLabel:StringThe text to display in the label of the close button.
In the following example, a custom close button label is provided:
manager.closeButtonLabel = "Save"; The default value is "Done".
public function get closeButtonLabel():String public function set closeButtonLabel(value:String):void| customCloseButtonStyleName | property |
public var customCloseButtonStyleName:String = nullAdds a style name to the close button.
In the following example, a custom style name is provided:
manager.customCloseButtonStyleName = "my-custom-close-button"; The default value is null.
See also
| customPanelStyleName | property |
public var customPanelStyleName:String = null
Adds a style name to the Panel that wraps the content.
In the following example, a custom style name is provided:
manager.customPanelStyleName = "my-custom-pop-up-panel"; The default value is null.
See also
| isOpen | property |
isOpen:Boolean [read-only] Indicates if the pop-up content is open or not.
public function get isOpen():Boolean| openOrCloseDuration | property |
openOrCloseDuration:NumberThe duration, in seconds, of the animation to open or close the pop-up.
In the following example, the duration is changed to 2 seconds:
manager.openOrCloseDuration = 2.0; The default value is 0.5.
public function get openOrCloseDuration():Number public function set openOrCloseDuration(value:Number):void| openOrCloseEase | property |
openOrCloseEase:ObjectThe easing function used for opening or closing the pop-up.
In the following example, the animation ease is changed:
manager.openOrCloseEase = Transitions.EASE_IN_OUT; The default value is starling.animation.Transitions.EASE_OUT.
public function get openOrCloseEase():Object public function set openOrCloseEase(value:Object):voidSee also
| overlayFactory | property |
overlayFactory:Function
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.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
| panelFactory | property |
public var panelFactory:Function = null
Creates the Panel that wraps the content.
In the following example, a custom panel factory is provided:
manager.panelFactory = function():Panel
{
var panel:Panel = new Panel();
panel.backgroundSkin = new Image( texture );
return panel;
}; The default value is null.
See also
| prompt | property |
prompt:StringA prompt to display in the panel's title.
Note: If using this manager with a component that has its own
prompt (like PickerList), this value may be overridden
by the component.
In the following example, a custom title is provided:
manager.prompt = "Pick a value"; The default value is null.
public function get prompt():String public function set prompt(value:String):void| BottomDrawerPopUpContentManager | () | Constructor |
public function BottomDrawerPopUpContentManager()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. |