LightBox (LightBox)
UIComponent
|
+--LightBox
- class LightBox
extends UIComponent
Creates an overlay DisplayObject on top of all other DisplayObjects. You can then add content to the LightBox via the content reference.
Property summary
| Property | Description |
|---|---|
| color:uint | Get or Set the LightBox background color.The default value is 0×000000 (black). |
| content:* | [read-only] Reference to the content loaded into the LightBox. |
| displaySpeed:Number | Get or set the speed at which the LightBox hides and shows.The default value is 0.25 (secs). |
| enabled:Boolean | Gets or sets a value that indicates whether the LightBox can accept user interaction. |
| maxAlpha:Number | Get or Set the maximum alpha value of the LightBox background.The default value is 0.5 (50%). |
| visible:Boolean | Gets or sets a value that indicates whether the current component instance is visible. |
Method summary
| Method | Description |
|---|---|
| bringToTop(event:*) : void | Brings the LightBox to the top layer. |
| hide(event:*) : void | Hides the LightBox. Initiates a fade out animation. |
| setSize(w:Number, h:Number) : void | Sets the width and height of the LightBox. |
| show(event:*) : void | Shows the Lightbox. Initiates a fade in animation. |
| toggle(event:*) : void | Specifies whether to show or hide the LightBox depending on it’s current visiblity.If the LightBox is visible, a fade out animation is triggered.
If the LightBox is not visible, a fade in animation is triggered. |
LightBox()
Description
Creates a new LightBox component instance.
bringToTop(event:*) : void
Usage
public function bringToTop(event:* = null):void
Parameters
event:*
- Any qualified event object. Default value is null
Returns
Nothing.
Description
Brings the LightBox to the top layer.
hide(event:*) : void
Usage
public function hide(event:* = null):void
Parameters
event:*
- Any qualified event object. Default value is null
Returns
Nothing.
Description
Hides the LightBox. Initiates a fade out animation
See Also
setSize(w:Number, h:Number) : void
Usage
override public function setSize(w:Number, h:Number):void
Parameters
w:Number
- width
h:Number
- height
Returns
Nothing.
Description
Sets the width and height of the LightBox
show(event:*) : void
Usage
public function show(event:* = null):void
Parameters
event:*
- Any qualified event object. Default value is null
Returns
Nothing.
Description
Shows the Lightbox. Initiates a fade in animation
See Also
toggle(event:*) : void
Usage
public function toggle(event:* = null):void
Parameters
event:*
- Any qualified event object. Default value is null
Returns
Nothing.
Description
Specifies whether to show or hide the LightBox depending on it’s current visiblity.
If the LightBox is visible, a fade out animation is triggered.
If the LightBox is not visible, a fade in animation is triggered.
See Also
color : uint
Usage
public function get color():uint
Description
Get or Set the LightBox background color. The default value is 0×000000 (black).
content : *
Usage
public function get content():*
Description
[read-only] Reference to the content loaded into the LightBox.
displaySpeed : Number
Usage
public function get displaySpeed():Number
Description
Get or set the speed at which the LightBox hides and shows.
The default value is 0.25 (secs).
enabled : Boolean
Usage
override public function get enabled():Boolean
Description
Gets or sets a value that indicates whether the LightBox can accept user interaction.
maxAlpha : Number
Usage
public function get maxAlpha():Number
Description
Get or Set the maximum alpha value of the LightBox background.
The default value is 0.5 (50%).
visible : Boolean
Usage
override public function get visible():Boolean
Description
Gets or sets a value that indicates whether the current component instance is visible.