Packagefeathers.controls.popups
Interfacepublic interface IPopUpContentManager extends IFeathersEventDispatcher
Implementors CalloutPopUpContentManager, DropDownPopUpContentManager, VerticalCenteredPopUpContentManager

Product Version : Feathers 1.0.0

Automatically manages pop-up content layout and positioning.


Public Properties
 PropertyDefined By
  isOpen : Boolean
[read-only] Indicates if the pop-up content is open or not.
IPopUpContentManager
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function):void
Adds a listener for an event type.
IFeathersEventDispatcher
  
close():void
Closes the pop-up content.
IPopUpContentManager
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all listeners added for the specified event type.
IFeathersEventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event from the pool with the specified to all listeners for the specified event type.
IFeathersEventDispatcher
  
dispose():void
Cleans up the manager.
IPopUpContentManager
 Inherited
hasEventListener(type:String, listener:Function = null):Boolean
Checks if a listener has been added for the specified event type.
IFeathersEventDispatcher
  
open(content:DisplayObject, source:DisplayObject):void
Displays the pop-up content.
IPopUpContentManager
 Inherited
removeEventListener(type:String, listener:Function):void
Removes a listener for an event type.
IFeathersEventDispatcher
 Inherited
removeEventListeners(type:String = null):void
Removes all listeners for an event type.
IFeathersEventDispatcher
Events
 Event Summary Defined By
  
close
Dispatched when the pop-up content closes.IPopUpContentManager
  
open
Dispatched when the pop-up content opens.IPopUpContentManager
Property Detail
isOpenproperty
isOpen:Boolean  [read-only]

Indicates if the pop-up content is open or not.


Implementation
    public function get isOpen():Boolean
Method Detail
close()method
public function close():void

Closes the pop-up content. If it is not opened, nothing happens.

dispose()method 
public function dispose():void

Cleans up the manager.

open()method 
public function open(content:DisplayObject, source:DisplayObject):void

Displays 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.

Event Detail
close Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CLOSE

Dispatched when the pop-up content closes.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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  
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.OPEN

Dispatched when the pop-up content opens.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
currentTargetThe 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.
datanull
targetThe 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.





Sat Jun 18 2022, 02:58 PM -07:00