| Package | feathers.extensions.toaster |
| Class | public class Toaster |
| Inheritance | Toaster  Object |
See also
| Property | Defined By | ||
|---|---|---|---|
| anchorBottom : Number
The distance between the toaster an the bottom of the stage. | Toaster | ||
| backgroundSkin : Image
The default background to display behind all content. | Toaster | ||
| delay : Number
The duration to display totally the toaster message in seconds (without fade effect). | Toaster | ||
| delayToDisplay : Number
The delay to display totally the toaster message in seconds (fade effect). | Toaster | ||
| isCentered : Boolean
Determines if the toaster is centered. | Toaster | ||
| isPlaying : Boolean [read-only]
Indicates whether a toaster is currently playing. | Toaster | ||
| offsetX : Number
The minimum space, in pixels, between the toaster's left and right edge and the toaster's content. | Toaster | ||
| offsetY : Number
The minimum space, in pixels, between the toaster's top and bottom edge and the toaster's content. | Toaster | ||
| taskManager : Boolean
If taskManager is set to true, every toaster start when the previous toaster is finished. | Toaster | ||
| toasterRenderer : Object [write-only]
The class used to instantiate toaster renderer. | Toaster | ||
| Property | Defined By | ||
|---|---|---|---|
| toasters : Vector.<Object>
The toasters added on the stage. | Toaster | ||
| Method | Defined By | ||
|---|---|---|---|
Toaster(root:Object) | Toaster | ||
dispose():void
Disposes all resources of the display object. | Toaster | ||
moveTo(toasterRenderer:Object, x:Number, y:Number):void
Move the toaster to the specified position. | Toaster | ||
open():Object
Add a toaster to the stage. | Toaster | ||
| anchorBottom | property |
anchorBottom:NumberThe distance between the toaster an the bottom of the stage.
The default value is NaN.
public function get anchorBottom():Number public function set anchorBottom(value:Number):void| backgroundSkin | property |
public var backgroundSkin:ImageThe default background to display behind all content. The background skin is resized to fill the full width and height of the layout group.
In the following example, the group is given a background skin:
group.backgroundSkin = new Image( texture );
The default value is null.
See also
| delay | property |
delay:NumberThe duration to display totally the toaster message in seconds (without fade effect).
The default value is 1.0.
public function get delay():Number public function set delay(value:Number):void| delayToDisplay | property |
delayToDisplay:NumberThe delay to display totally the toaster message in seconds (fade effect). It's the same delay to remove the toaster.
The default value is 1.0.
public function get delayToDisplay():Number public function set delayToDisplay(value:Number):void| isCentered | property |
public var isCentered:BooleanDetermines if the toaster is centered.
The default value is false.
| isPlaying | property |
isPlaying:Boolean [read-only] Indicates whether a toaster is currently playing.
public function get isPlaying():Boolean| offsetX | property |
offsetX:NumberThe minimum space, in pixels, between the toaster's left and right edge and the toaster's content.
The default value is 8.
public function get offsetX():Number public function set offsetX(value:Number):void| offsetY | property |
offsetY:NumberThe minimum space, in pixels, between the toaster's top and bottom edge and the toaster's content.
The default value is 8.
public function get offsetY():Number public function set offsetY(value:Number):void| taskManager | property |
public var taskManager:BooleanIf taskManager is set to true, every toaster start when the previous toaster is finished.
The default value is false.
| toasterRenderer | property |
toasterRenderer:Object [write-only] The class used to instantiate toaster renderer.
public function set toasterRenderer(value:Object):void| toasters | property |
protected var toasters:Vector.<Object>The toasters added on the stage.
| Toaster | () | Constructor |
public function Toaster(root:Object)root:Object |
| dispose | () | method |
public function dispose():voidDisposes all resources of the display object. GPU buffers are released, event listeners are removed, filters and masks are disposed.
| moveTo | () | method |
public function moveTo(toasterRenderer:Object, x:Number, y:Number):voidMove the toaster to the specified position.
Parameters
toasterRenderer:Object — A ToasterRenderer control
| |
x:Number — The horizontal coordinate
| |
y:Number — The vertical coordinate
|
| open | () | method |
public function open():ObjectAdd a toaster to the stage.
ReturnsObject |