| Package | ardisia.components.iconButton |
| Class | public class IconButton |
| Inheritance | IconButton  spark.components.Button |
View the technical documentation on the Ardisia Labs website for more information.
Default MXML Propertylabel
| Property | Defined By | ||
|---|---|---|---|
| duration : Number = 150
The duration of the flyout effect in milliseconds. | IconButton | ||
| flyoutDirection : String = right
The position of the flyout label relative to the button when it is
displayed. | IconButton | ||
| flyoutDistance : Number = 20
Sets the number of pixels for the flyout label to animate. | IconButton | ||
| showFlyoutLabel : Boolean = true
True to display the flyout label. | IconButton | ||
| Method | Defined By | ||
|---|---|---|---|
| IconButton | |||
removeFlyoutLabel():void
Call to immediately remove the flyout label. | IconButton | ||
| Method | Defined By | ||
|---|---|---|---|
displayLabel():void
Displays the label by animating it initially from a position adjacent to
the button to its final position, as determined by the "flyoutDistance"
property. | IconButton | ||
eventHandler(event:Event):void
Handles event on the component. | IconButton | ||
getFlyoutPositions(direction:String = null):Array
Return the coordinates for the flyout move effect. | IconButton | ||
hideAnimationHandler(event:EffectEvent):void
After the animation ends, fires the "labelHide" event and removes the
label. | IconButton | ||
hideLabel():void
Hides the label by animating it initially from its current position
to a position adjacent to the button. | IconButton | ||
willOverflow(xTo:Number, yTo:Number):Boolean
Check if the proposed xTo and yTo will cause the flyout label to
overflow the screen bounds. | IconButton | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the flyout label has finished animating out and has been removed. | IconButton | |||
| Dispatched when the flyout label has finished animating in and is displayed. | IconButton | |||
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
| duration | property |
public var duration:Number = 150The duration of the flyout effect in milliseconds.
Set to zero to skip the flyout animation.
The default value is 150.
| flyoutDirection | property |
public var flyoutDirection:String = rightThe position of the flyout label relative to the button when it is displayed.
The default value is "right".
| flyoutDistance | property |
public var flyoutDistance:Number = 20Sets the number of pixels for the flyout label to animate.
Set to zero to align the label adjacent to the button and skip the flyout animation.
The default value is 20.
| showFlyoutLabel | property |
public var showFlyoutLabel:Boolean = trueTrue to display the flyout label.
The default value is true.
| IconButton | () | Constructor |
public function IconButton()| displayLabel | () | method |
protected function displayLabel():voidDisplays the label by animating it initially from a position adjacent to the button to its final position, as determined by the "flyoutDistance" property.
| eventHandler | () | method |
protected function eventHandler(event:Event):voidHandles event on the component.
Parameters
event:Event — Event
|
| getFlyoutPositions | () | method |
protected function getFlyoutPositions(direction:String = null):ArrayReturn the coordinates for the flyout move effect.
Parameters
direction:String (default = null) |
Array — [xFrom, xTo, yFrom, yTo]
|
| hideAnimationHandler | () | method |
protected function hideAnimationHandler(event:EffectEvent):voidAfter the animation ends, fires the "labelHide" event and removes the label.
Parameters
event:EffectEvent — the EffectEvent that triggered the handler
|
| hideLabel | () | method |
protected function hideLabel():voidHides the label by animating it initially from its current position to a position adjacent to the button.
| removeFlyoutLabel | () | method |
public function removeFlyoutLabel():voidCall to immediately remove the flyout label.
| willOverflow | () | method |
protected function willOverflow(xTo:Number, yTo:Number):BooleanCheck if the proposed xTo and yTo will cause the flyout label to overflow the screen bounds.
Parameters
xTo:Number — the proposed x coordinate
| |
yTo:Number — the proposed y coordinate
|
Boolean — Boolean
|
| flyoutHide | Event |
ardisia.components.iconButton.events.IconButtonEventardisia.components.flyoutButton.events.FlyoutButtonEventDispatched when the flyout label has finished animating out and has been removed.
| flyoutShow | Event |
ardisia.components.iconButton.events.IconButtonEventardisia.components.flyoutButton.events.FlyoutButtonEventDispatched when the flyout label has finished animating in and is displayed.