| Package | lunas.components.buttons |
| Class | public dynamic class CoreButton |
| Inheritance | CoreButton CoreComponent Background CoreSprite flash.display.Sprite |
| Implements | Button |
| Subclasses | BackgroundButton, FrameLabelButton, LightButton, MediaButton, RadioIconButton |
Button interface,
to minimize the effort required to implement this interface.
| 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 | |
| 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 | ||
|---|---|---|---|
Creates a new CoreButton instance. | CoreButton | ||
![]() | doLater():void
Launch an event with a delayed interval. | Background | |
![]() | draw(... arguments):void
Draw the display. | Background | |
![]() | getBuilderRenderer():Class
Returns the Builder constructor use to initialize this component. | CoreComponent | |
![]() | getStyleRenderer():Class
Returns the Style constructor use to initialize this component. | CoreComponent | |
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
Invoked when the label property of the component change. | CoreButton | ||
![]() | viewResize():void
Invoked when the component is resized. | Background | |
![]() | viewStyleChanged(e:Event = null):void
Invoked when the component Style changed. | CoreComponent | |
| Method | Defined By | ||
|---|---|---|---|
_fireButtonEvent(type:String):void
Dispatchs a ButtonEvent with the specified type. | CoreButton | ||
![]() | addedToStage(e:Event = null):void
Invoked when the display is added to the stage. | CoreSprite | |
![]() | addedToStageResize(e:Event = null):void
Invoked when the display is removed from the stage to enable the autoSize mode. | Background | |
![]() | fireComponentEvent(type:String):void
Dispatchs a ComponentEvent with the specified type. | CoreComponent | |
removedFromStage(e:Event = null):void [override]
Invoked when the display is removed from the stage. | CoreButton | ||
![]() | removedFromStageResize(e:Event = null):void
Invoked when the display is removed from the stage to disable the autoSize mode. | Background | |
![]() | renderLayout(layout:Layout = null):void
Receives a message when the layout emit when is rendered. | CoreComponent | |
![]() | updateLayout(layout:Layout = null):void
Receives a message when the layout emit when is updated. | CoreComponent | |
| buttonMode | property |
buttonMode:Boolean [write-only] [override] Specifies whether this object receives mouse messages.
public function set buttonMode(value:Boolean):void| data | property |
data:*Indicates the data value object of the component.
public function get data():* public function set data(value:any):void| index | property |
public var index:NumberA number value to indicated the index of this IButton.
| isReleaseOutside | property |
public var isReleaseOutside:Boolean = trueIndicates if the button notify a releaseOutside event.
| label | property |
label:StringReturns the text label for a button instance.
public function get label():String public function set label(value:String):void| mouseEnabled | property |
mouseEnabled:Boolean[override] Specifies whether this object receives mouse messages.
public function get mouseEnabled():Boolean public function set mouseEnabled(value:Boolean):void| selected | property |
selected:BooleanA flag that indicates whether this control is selected.
public function get selected():Boolean public function set selected(value:Boolean):void| toggle | property |
toggle:BooleanIndicates a boolean value indicating whether the button behaves as a toggle switch (true) or not (false).
public function get toggle():Boolean public function set toggle(value:Boolean):void| useHandCursor | property |
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.
public function get useHandCursor():Boolean public function set useHandCursor(value:Boolean):void| CoreButton | () | Constructor |
public function CoreButton()Creates a new CoreButton instance.
| _fireButtonEvent | () | method |
protected function _fireButtonEvent(type:String):voidDispatchs a ButtonEvent with the specified type.
Parameters
type:String |
| groupPolicyChanged | () | method |
override public function groupPolicyChanged():voidInvoked when the group property or the groupName property changed.
| registerView | () | method |
override public function registerView(scope:DisplayObjectContainer = null):voidRegister the view in argument.
Parameters
scope:DisplayObjectContainer (default = null) |
| removedFromStage | () | method |
override protected function removedFromStage(e:Event = null):voidInvoked when the display is removed from the stage.
Parameters
e:Event (default = null) |
| setSelected | () | method |
public function setSelected(b:Boolean, options:* = null):voidSets a boolean value indicating whether the button is selected (true) or not (false).
Parameters
b:Boolean — The selected flag value.
| |
options:* (default = null) — The optional flag to control the method (default null). Use the "true" value
to disabled the ButtonEvent.SELECT or ButtonEvent.UNSELECT events propagation.
Use the value "ButtonEvent.DESELECT" to enforce the propagatio of this event.
|
| unregisterView | () | method |
override public function unregisterView():voidUnregister the view of this button.
| viewEnabled | () | method |
override public final function viewEnabled():voidInvoked when the enabled property of the component change.
| viewLabelChanged | () | method |
public function viewLabelChanged():voidInvoked when the label property of the component change.