Packagefeathers.controls.popups
Classpublic class CalloutPopUpContentManager
InheritanceCalloutPopUpContentManager Inheritance starling.events.EventDispatcher
Implements IPopUpContentManager

Product Version : Feathers 1.0.0

Displays pop-up content (such as the List in a PickerList) in a Callout.

See also

feathers.controls.PickerList
feathers.controls.Callout


Public Properties
 PropertyDefined By
  calloutFactory : Function
The factory used to create the Callout instance.
CalloutPopUpContentManager
  isModal : Boolean = true
Determines if the callout will be modal or not.
CalloutPopUpContentManager
  isOpen : Boolean
[read-only] Indicates if the pop-up content is open or not.
CalloutPopUpContentManager
  overlayFactory : Function
If isModal is true, this function may be used to customize the modal overlay displayed by the pop-up manager.
CalloutPopUpContentManager
  supportedPositions : Vector.<String>
The direction of the callout.
CalloutPopUpContentManager
Public Methods
 MethodDefined By
  
Constructor.
CalloutPopUpContentManager
  
close():void
Closes the pop-up content.
CalloutPopUpContentManager
  
dispose():void
Cleans up the manager.
CalloutPopUpContentManager
  
open(content:DisplayObject, source:DisplayObject):void
Displays the pop-up content.
CalloutPopUpContentManager
Events
 Event Summary Defined By
  Dispatched when the pop-up content closes.CalloutPopUpContentManager
  Dispatched when the pop-up content opens.CalloutPopUpContentManager
Property Detail
calloutFactoryproperty
public var calloutFactory:Function

The factory used to create the Callout instance. If null, Callout.calloutFactory() will be used.

Note: If you change this value while a callout is open, the new value will not go into effect until the callout is closed and a new callout is opened.

The default value is null.

See also

isModalproperty 
public var isModal:Boolean = true

Determines if the callout will be modal or not.

Note: If you change this value while a callout is open, the new value will not go into effect until the callout is closed and a new callout is opened.

In the following example, the callout is not modal:

manager.isModal = false;

The default value is true.

isOpenproperty 
isOpen:Boolean  [read-only]

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


Implementation
    public function get isOpen():Boolean
overlayFactoryproperty 
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.


Implementation
    public function get overlayFactory():Function
    public function set overlayFactory(value:Function):void

See also

supportedPositionsproperty 
public var supportedPositions:Vector.<String>

The direction of the callout.

Note: If you change this value while a callout is open, the new value will not go into effect until the callout is closed and a new callout is opened.

In the following example, the callout direction is restricted to down:

manager.direction = Callout.DIRECTION_DOWN;

The default value is Callout.DIRECTION_ANY.

See also

Constructor Detail
CalloutPopUpContentManager()Constructor
public function CalloutPopUpContentManager()

Constructor.

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.