| Package | lunas.components.buttons |
| Class | public class IconButton |
| Inheritance | IconButton LabelButton BackgroundButton CoreButton CoreComponent Background CoreSprite flash.display.Sprite |
| Implements | Iconifiable |
| Subclasses | ItemButton |
Example :
import lunas.components.buttons.IconButton ;
import flash.display.StageScaleMode ;
import flash.net.URLRequest;
import flash.events.KeyboardEent ;
stage.scaleMode = StageScaleMode.NO_SCALE ;
var bt:IconButton = new IconButton() ;
bt.x = 25 ;
bt.y = 25 ;
bt.icon = new URLRequest("library/icons/none.png") ;
bt.label = "Hello world" ;
bt.toggle = true ;
addChild( bt ) ;
var keyDown:Function = function( e:KeyboardEvent ):void
{
var code:Number = e.keyCode ;
switch(code)
{
case Keyboard.UP :
{
bt.icon = new URLRequest("library/icons/de.png") ;
break ;
}
case Keyboard.DOWN :
{
bt.icon = new URLRequest("library/icons/none.png") ;
break ;
}
case Keyboard.SPACE :
{
bt.icon = new Bitmap( new FR(16,11) ) ; // Bitmap icon in the library
break ;
}
}
}
stage.addEventListener( KeyboardEvent.KEY_DOWN , keyDown ) ;
| Property | Defined By | ||
|---|---|---|---|
![]() | align : uint
The alignement of the background. | Background | |
![]() | autoSize : Boolean
Indicates if the background is resizing when the stage resize event is invoked. | Background | |
![]() | border : EdgeMetrics
Indicates the thickness, in pixels, of the four edge regions around a visual component. | CoreComponent | |
![]() | bottomLeftRadius : Number
The radius of the bottom-left corner, in pixels. | Background | |
![]() | bottomRightRadius : Number
The radius of the bottom-right corner, in pixels. | Background | |
![]() | bubbles : Boolean = true
Indicates if the events use bubbling when are dispatched. | CoreComponent | |
![]() | builder : Builder
Indicates the Builder reference of this instance. | CoreComponent | |
![]() | buttonMode : Boolean [override] [write-only]
Specifies whether this object receives mouse messages. | CoreButton | |
![]() | componentInspectorSetting : Boolean
Initialize when the Flash component settings are initialized (only in Flash with a compiled component). | CoreComponent | |
![]() | data : *
Indicates the data value object of the component. | CoreButton | |
![]() | direction : String
Indicates the direction value of the background when the display is in this "full" mode (default value is null). | Background | |
![]() | enabled : Boolean
Indicates the enabled state of the component. | CoreComponent | |
![]() | fill : IFillStyle
Determinates the IFillStyle reference of this display. | Background | |
![]() | gradientMatrix : Matrix
The matrix value to draw the gradient fill. | Background | |
![]() | gradientRotation : Number = 0
The rotation value to draw the gradient fill. | Background | |
![]() | gradientTranslation : Point
The translation vector to draw the gradient fill. | Background | |
![]() | group : Boolean
Indicates with a boolean if this object is grouped. | CoreComponent | |
![]() | groupName : String
Indicates the name of the group of this object. | CoreComponent | |
![]() | h : Number
Determinates the virtual height value of this component. | Background | |
| icon : *
Indicates the icon value of this display (URLRequest or DisplayObject reference). | IconButton | ||
| iconAlign : uint
The alignement of the icon (can be Align.LEFT or Align.RIGHT only, default Align.LEFT). | IconButton | ||
| iconContent : * [read-only]
Indicates the icon content reference of the component. | IconButton | ||
![]() | index : Number
A number value to indicated the index of this IButton. | CoreButton | |
![]() | isFull : Boolean
Indicates if the background use full size (use Stage.stageWidth and Stage.stageHeight to resize the background). | Background | |
![]() | isReleaseOutside : Boolean = true
Indicates if the button notify a releaseOutside event. | CoreButton | |
![]() | label : String
Returns the text label for a button instance. | CoreButton | |
![]() | layout : Layout
Determinates the layout of this container. | CoreComponent | |
![]() | line : ILineStyle
Determinates the ILineStyle reference of this display. | Background | |
![]() | logger : Logger
Determinates the internal ILogger reference of this Logable object. | CoreSprite | |
![]() | maxHeight : Number
This property defined the maximum height of this display. | Background | |
![]() | maxWidth : Number
Defines the maximum width of this display. | Background | |
![]() | minHeight : Number
This property defined the mimimun height of this display (This value is >= 0). | Background | |
![]() | minWidth : Number
This property defined the mimimun width of this display (This value is >= 0). | Background | |
![]() | mouseEnabled : Boolean [override]
Specifies whether this object receives mouse messages. | CoreButton | |
![]() | selected : Boolean
A flag that indicates whether this control is selected. | CoreButton | |
![]() | style : Style
Returns the style of this component. | CoreComponent | |
![]() | toggle : Boolean
Indicates a boolean value indicating whether the button behaves as a toggle switch (true) or not (false). | CoreButton | |
![]() | topLeftRadius : Number
The radius of the upper-left corner, in pixels. | Background | |
![]() | topRightRadius : Number
The radius of the upper-right corner, in pixels. | Background | |
![]() | useGradientBox : Boolean
Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle). | Background | |
![]() | useHandCursor : Boolean [override]
A Boolean value that, when set to true, indicates whether Flash Player displays the hand cursor when the mouse rolls over a button. | CoreButton | |
![]() | w : Number
Determinates the virtual height value of this component. | Background | |
| Method | Defined By | ||
|---|---|---|---|
IconButton(w:Number = 120, h:Number = 20)
Creates a new IconButton instance. | IconButton | ||
![]() | doLater():void
Launch an event with a delayed interval. | Background | |
![]() | draw(... arguments):void
Draw the display. | Background | |
getBuilderRenderer():Class [override]
Returns the Builder constructor use to initialize this component. | IconButton | ||
getStyleRenderer():Class [override]
Returns the Style constructor use to initialize this component. | IconButton | ||
![]() | groupPolicyChanged():void [override]
Invoked when the group property or the groupName property changed. | CoreButton | |
![]() | hide():void
Hides the component. | CoreComponent | |
![]() | initBackgroundPen(graphic:* = null):IPen
Init the pen to draw the background of this display. | Background | |
![]() | initialize():void
Initialize the component. | CoreComponent | |
![]() | isLocked():Boolean
Returns true if the object is locked. | CoreSprite | |
![]() | isVisible():Boolean
Returns true if the component is visible. | CoreComponent | |
![]() | lock():void [override]
Locks the object. | CoreComponent | |
![]() | move(x:Number, y:Number):void
Moves the component. | CoreComponent | |
![]() | notifyChanged():void
Notify a change in this component. | CoreComponent | |
![]() | notifyEnabled():void
Notify an event when the enabled property is changed. | CoreComponent | |
![]() | notifyResized():void
Notify an event when you resize the component. | Background | |
![]() | refresh(init:*):void
Refresh and initialize the display with a generic object and invoke the "update" method. | Background | |
![]() | registerView(scope:DisplayObjectContainer = null):void [override]
Register the view in argument. | CoreButton | |
![]() | resetLock():void
Reset the lock security of the display. | CoreSprite | |
![]() | resize(e:Event = null):void
Resize and update the background. | Background | |
![]() | scope():DisplayObject
Returns the real scope reference of this component. | CoreComponent | |
![]() | setCornerRadius(n:Number):void
Defines all corner radius of the background (upper-left, upper-right, bottom-left and bottom-right). | Background | |
![]() | setSelected(b:Boolean, options:* = null):void
Sets a boolean value indicating whether the button is selected (true) or not (false). | CoreButton | |
![]() | setSize(w:Number, h:Number):void
Sets the virtual width (w) and height (h) values of the component. | Background | |
![]() | setStyle(... args):void
Sets the style property on the style declaration or object. | CoreComponent | |
![]() | show():void
Shows the component. | CoreComponent | |
![]() | unlock():void [override]
Unlocks the display. | CoreComponent | |
![]() | unregisterView():void [override]
Unregister the view of this button. | CoreButton | |
![]() | update():void [override]
Updates the component. | CoreComponent | |
![]() | viewChanged():void
This method is invoked after the draw() method in the update() method. | Background | |
![]() | viewDestroyed(e:Event = null):void
Invoked when the component is removed. | CoreComponent | |
![]() | viewEnabled():void [override]
Invoked when the enabled property of the component change. | CoreButton | |
![]() | viewLabelChanged():void [override]
Invoked when the label property of the component change. | LabelButton | |
![]() | viewResize():void
Invoked when the component is resized. | Background | |
![]() | viewStyleChanged(e:Event = null):void [override]
Invoked when the component Style changed. | BackgroundButton | |
| icon | property |
icon:*Indicates the icon value of this display (URLRequest or DisplayObject reference). If the icon property is a URLRequest an external picture or swf is loading to populate the view of the icon; If the icon property is a DisplayObject the component attach the visual reference to populate the view of the icon;
public function get icon():* public function set icon(value:any):void| iconAlign | property |
iconAlign:uintThe alignement of the icon (can be Align.LEFT or Align.RIGHT only, default Align.LEFT).
public function get iconAlign():uint public function set iconAlign(value:uint):voidSee also
| iconContent | property |
iconContent:* [read-only] Indicates the icon content reference of the component.
public function get iconContent():*| IconButton | () | Constructor |
public function IconButton(w:Number = 120, h:Number = 20)Creates a new IconButton instance.
Parametersw:Number (default = 120) — The prefered width of the button (default 120 pixels).
| |
h:Number (default = 20) — The prefered height of the button (default 20 pixels).
|
| getBuilderRenderer | () | method |
override public function getBuilderRenderer():Class
Returns the Builder constructor use to initialize this component.
Class — the Builder constructor use to initialize this component.
|
| getStyleRenderer | () | method |
override public function getStyleRenderer():Class
Returns the Style constructor use to initialize this component.
Class — the Style constructor use to initialize this component.
|