| Package | feathers.controls.popups |
| Class | public class VerticalCenteredPopUpContentManager |
| Inheritance | VerticalCenteredPopUpContentManager  starling.events.EventDispatcher |
| Implements | IPopUpContentManager |
| Product Version : | Feathers 1.0.0 |
| Property | Defined By | ||
|---|---|---|---|
| isOpen : Boolean [read-only]
Indicates if the pop-up content is open or not. | VerticalCenteredPopUpContentManager | ||
| margin : Number
Quickly sets all margin properties to the same value. | VerticalCenteredPopUpContentManager | ||
| marginBottom : Number = 0
The minimum space, in pixels, between the bottom edge of the content
and the bottom edge of the stage. | VerticalCenteredPopUpContentManager | ||
| marginLeft : Number = 0
The minimum space, in pixels, between the left edge of the content
and the left edge of the stage. | VerticalCenteredPopUpContentManager | ||
| marginRight : Number = 0
The minimum space, in pixels, between the right edge of the content
and the right edge of the stage. | VerticalCenteredPopUpContentManager | ||
| marginTop : Number = 0
The minimum space, in pixels, between the top edge of the content and
the top edge of the stage. | VerticalCenteredPopUpContentManager | ||
| overlayFactory : Function
This function may be used to customize the modal overlay displayed by
the pop-up manager. | VerticalCenteredPopUpContentManager | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | VerticalCenteredPopUpContentManager | ||
close():void
Closes the pop-up content. | VerticalCenteredPopUpContentManager | ||
dispose():void
Cleans up the manager. | VerticalCenteredPopUpContentManager | ||
open(content:DisplayObject, source:DisplayObject):void
Displays the pop-up content. | VerticalCenteredPopUpContentManager | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the pop-up content closes. | VerticalCenteredPopUpContentManager | |||
| Dispatched when the pop-up content opens. | VerticalCenteredPopUpContentManager | |||
| isOpen | property |
isOpen:Boolean [read-only] Indicates if the pop-up content is open or not.
public function get isOpen():Boolean| margin | property |
margin:Number
Quickly sets all margin properties to the same value. The
margin getter always returns the value of
marginTop, but the other padding values may be
different.
The following example gives the pop-up a minimum of 20 pixels of margin on all sides:
manager.margin = 20;
The default value is 0.
public function get margin():Number public function set margin(value:Number):voidSee also
| marginBottom | property |
public var marginBottom:Number = 0The minimum space, in pixels, between the bottom edge of the content and the bottom edge of the stage.
The following example gives the pop-up a minimum of 20 pixels of margin on the bottom:
manager.marginBottom = 20;
The default value is 0.
See also
| marginLeft | property |
public var marginLeft:Number = 0The minimum space, in pixels, between the left edge of the content and the left edge of the stage.
The following example gives the pop-up a minimum of 20 pixels of margin on the left:
manager.marginLeft = 20;
The default value is 0.
See also
| marginRight | property |
public var marginRight:Number = 0The minimum space, in pixels, between the right edge of the content and the right edge of the stage.
The following example gives the pop-up a minimum of 20 pixels of margin on the right:
manager.marginRight = 20;
The default value is 0.
See also
| marginTop | property |
public var marginTop:Number = 0The minimum space, in pixels, between the top edge of the content and the top edge of the stage.
The following example gives the pop-up a minimum of 20 pixels of margin on the top:
manager.marginTop = 20;
The default value is 0.
See 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
| VerticalCenteredPopUpContentManager | () | Constructor |
public function VerticalCenteredPopUpContentManager()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. |