Packagelunas.components.buttons
Classpublic class BackgroundButtonStyle
InheritanceBackgroundButtonStyle Inheritance CoreStyle Inheritance ConfigurableObject Inheritance CoreEventDispatcher Inheritance Object
Subclasses LabelButtonStyle, PictureButtonStyle, SwitchLabelButtonStyle

This style of the BackgroundButton component.



Public Properties
 PropertyDefined By
  align : uint = 10
The alignement of the background.
BackgroundButtonStyle
  bottomLeftRadius : Number = 0
The radius of the bottom-left corner, in pixels.
BackgroundButtonStyle
  bottomRightRadius : Number = 0
The radius of the bottom-left corner, in pixels.
BackgroundButtonStyle
 Inheritedchannel : String
[read-only] Indicates the channel of this dispatcher if this instance is global.
CoreEventDispatcher
  gradientMatrix : Matrix
The matrix value to draw the gradient fill.
BackgroundButtonStyle
  gradientRotation : Number = 0
The rotation value to draw the gradient fill.
BackgroundButtonStyle
  gradientTranslation : Point
The translation vector to draw the gradient fill.
BackgroundButtonStyle
 Inheritedid : *
Returns the id of this object.
ConfigurableObject
 InheritedisConfigurable : Boolean
Indicates if the object is configurable and receive the notification of the ConfigCollector in the setup() method.
ConfigurableObject
  margin : EdgeMetrics
The margin values of the component.
BackgroundButtonStyle
 InheritedstyleSheet : StyleSheet
Indicates the style sheet reference of this object.
CoreStyle
  theme : IFillStyle
The theme style when the component is up.
BackgroundButtonStyle
  themeBorder : ILineStyle
The border style when the component is up.
BackgroundButtonStyle
  themeBorderDisabled : ILineStyle
The border style when the component is disabled.
BackgroundButtonStyle
  themeBorderRollOver : ILineStyle
The border style when the component is over.
BackgroundButtonStyle
  themeBorderSelected : ILineStyle
The border style when the component is selected.
BackgroundButtonStyle
  themeDisabled : IFillStyle
The theme style when the component is disabled.
BackgroundButtonStyle
  themeFilters : Array
The collection of all filters of the theme.
BackgroundButtonStyle
  themeRollOver : IFillStyle
The theme style when the component is over.
BackgroundButtonStyle
  themeSelected : IFillStyle
The theme style when the component is selected.
BackgroundButtonStyle
  topLeftRadius : Number = 0
The radius of the upper-left corner, in pixels.
BackgroundButtonStyle
  topRightRadius : Number = 0
The radius of the upper-right corner, in pixels.
BackgroundButtonStyle
  tweenOver : TweenTo
The tween invoked when the button is over.
BackgroundButtonStyle
  tweenSelected : TweenTo
The tween invoked when the button is selected.
BackgroundButtonStyle
  useGradientBox : Boolean
Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle).
BackgroundButtonStyle
  useLight : Boolean = true
Indicates if the background use a motion light effect when the button is over or selected.
BackgroundButtonStyle
Public Methods
 MethodDefined By
  
BackgroundButtonStyle(init:* = null, id:* = null)
Creates a new BackgroundButtonStyle instance.
BackgroundButtonStyle
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0.0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target.
CoreEventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
CoreEventDispatcher
 Inherited
Returns the internal system.events.EventDispatcher reference.
CoreEventDispatcher
 Inherited
getStyle(prop:String):*
Returns the value of the specified property if it's exist in the object, else returns null.
CoreStyle
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
CoreEventDispatcher
  
initialize():void
[override] Initialize the Style object.
BackgroundButtonStyle
 Inherited
isGlobal():Boolean
Indicates if the dispatcher use a global event flow.
CoreEventDispatcher
 Inherited
isLocked():Boolean
Returns true if the object is locked.
CoreEventDispatcher
 Inherited
lock():void
Locks the object.
CoreEventDispatcher
 Inherited
Invoked when the style is changed.
CoreStyle
 Inherited
registerEventListener(type:String, listener:*, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Allows the registration of event listeners on the event target (Function or EventListener).
CoreEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
CoreEventDispatcher
 Inherited
Sets the internal EventDispatcher reference.
CoreEventDispatcher
 Inherited
setGlobal(flag:Boolean = false, channel:String = null):void
Sets if the instance use a global system.events.EventDispatcher to dispatch this events, if the flag value is false the instance use a local EventDispatcher.
CoreEventDispatcher
 Inherited
setStyle(... args):void
This method is invoked to change a style attribute in this IStyle object with a generic object or a key(String)/value pair of arguments.
CoreStyle
 Inherited
setup():void
[override] Invoked when this object when the ConfigCollector is run.
CoreStyle
 Inherited
Invoked when a style property of this IStyle change.
CoreStyle
 Inherited
Invoked when the styleSheet value of this IStyle change.
CoreStyle
 Inherited
toString():String
Returns the String representation of this object.
CoreStyle
 Inherited
unlock():void
Unlocks the display.
CoreEventDispatcher
 Inherited
unregisterEventListener(type:String, listener:*, useCapture:Boolean = false):void
Removes a listener (Function or EventListener object) from the EventDispatcher object.
CoreEventDispatcher
 Inherited
update():void
Update the display.
ConfigurableObject
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
CoreEventDispatcher
Protected Methods
 MethodDefined By
 Inherited
_setID(id:*):void
[override] Sets the id of the object and register it in the StyleCollector if it's possible.
CoreStyle
 Inherited
Creates and returns the internal EventDispatcher reference (this method is invoked in the constructor).
CoreEventDispatcher
Property Detail
alignproperty
public var align:uint = 10

The alignement of the background.

See also

bottomLeftRadiusproperty 
public var bottomLeftRadius:Number = 0

The radius of the bottom-left corner, in pixels.

bottomRightRadiusproperty 
public var bottomRightRadius:Number = 0

The radius of the bottom-left corner, in pixels.

gradientMatrixproperty 
public var gradientMatrix:Matrix

The matrix value to draw the gradient fill. This property override the gradientRotation and gradientTranslation properties.

gradientRotationproperty 
public var gradientRotation:Number = 0

The rotation value to draw the gradient fill.

gradientTranslationproperty 
public var gradientTranslation:Point

The translation vector to draw the gradient fill.

marginproperty 
public var margin:EdgeMetrics

The margin values of the component.

themeproperty 
public var theme:IFillStyle

The theme style when the component is up.

themeBorderproperty 
public var themeBorder:ILineStyle

The border style when the component is up.

themeBorderDisabledproperty 
public var themeBorderDisabled:ILineStyle

The border style when the component is disabled.

themeBorderRollOverproperty 
public var themeBorderRollOver:ILineStyle

The border style when the component is over.

themeBorderSelectedproperty 
public var themeBorderSelected:ILineStyle

The border style when the component is selected.

themeDisabledproperty 
public var themeDisabled:IFillStyle

The theme style when the component is disabled.

themeFiltersproperty 
public var themeFilters:Array

The collection of all filters of the theme.

themeRollOverproperty 
public var themeRollOver:IFillStyle

The theme style when the component is over.

themeSelectedproperty 
public var themeSelected:IFillStyle

The theme style when the component is selected.

topLeftRadiusproperty 
public var topLeftRadius:Number = 0

The radius of the upper-left corner, in pixels.

topRightRadiusproperty 
public var topRightRadius:Number = 0

The radius of the upper-right corner, in pixels.

tweenOverproperty 
public var tweenOver:TweenTo

The tween invoked when the button is over.

tweenSelectedproperty 
public var tweenSelected:TweenTo

The tween invoked when the button is selected.

useGradientBoxproperty 
public var useGradientBox:Boolean

Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle).

useLightproperty 
public var useLight:Boolean = true

Indicates if the background use a motion light effect when the button is over or selected.

Constructor Detail
BackgroundButtonStyle()Constructor
public function BackgroundButtonStyle(init:* = null, id:* = null)

Creates a new BackgroundButtonStyle instance.

Parameters
init:* (default = null) — An object that contains properties with which to populate the newly Style object. If init is not an object, it is ignored.
 
id:* (default = null) — The id of the object.
Method Detail
initialize()method
override public function initialize():void

Initialize the Style object.