| Package | ardisia.components.floatPaneControlBar |
| Class | public class FloatPaneControlBar |
| Inheritance | FloatPaneControlBar  ButtonBar ButtonBarBase spark.components.supportClasses.ButtonBarBase |
View the technical documentation on the Ardisia Labs website for more information.
DESIGN NOTES
Default MXML PropertydataProvider
| Property | Defined By | ||
|---|---|---|---|
| activePane : Pane
The pane managed by this control that is activated. | FloatPaneControlBar | ||
| animationDuration : Number = 350
The duration of animations for the minimize and maximize animations. | FloatPaneControlBar | ||
 | closableField : String
The field on the data to look for a boolean value if the button can be
closed by clicking the close button skin part. | ButtonBarBase | |
| duration : Number = 150
The duration of animations in milliseconds. | ButtonBarBase | |
| easer : IEaser
The default easer to apply to animations. | ButtonBarBase | |
| isAnimating : Boolean [read-only]
True if a animation is running. | ButtonBarBase | |
| isDragging : Boolean [read-only]
True if a button is being dragged. | ButtonBarBase | |
| maximizeBottom : Number = 0
The offset from the bottom of the screen when a pane is maximized. | FloatPaneControlBar | ||
| maximizeLeft : Number = 0
The offset from the left of the screen when a pane is maximized. | FloatPaneControlBar | ||
| maximizeRight : Number = 0
The offset from the right of the screen when a pane is maximized. | FloatPaneControlBar | ||
| maximizeTop : Number = 0
The offset from the top of the screen when a pane is maximized. | FloatPaneControlBar | ||
| paneEaser : IEaser
The easer to use for the minimize and maximize animations. | FloatPaneControlBar | ||
| Method | Defined By | ||
|---|---|---|---|
| FloatPaneControlBar | |||
| addButton(data:Object, selected:Boolean):void
Use this method to add a button via animation. | ButtonBarBase | |
| endButtonDrag():void
End a selected button drag. | ButtonBarBase | |
| removeButton(index:int):void
Use this method to remove a button via animation. | ButtonBarBase | |
| startButtonDrag(initialX:Number):void
Start dragging the selected button. | ButtonBarBase | |
| Method | Defined By | ||
|---|---|---|---|
addSysManListeners():void
Add handlers to the systemManager. | FloatPaneControlBar | ||
awmHandler(event:FocusEvent):void
Handles events for the ActiveWindowManager. | FloatPaneControlBar | ||
| commitButtonSnapshot():void
Commits the buttonSnapshot to the underlying collection and updates the
buttons to reflect the buttonSnapshot. | ButtonBarBase | |
| dragHandler(event:Event):void
Handles the events and logic for user initiated dragging. | ButtonBarBase | |
| effectHandler(event:EffectEvent):void
Handles the events and logic for effects. | ButtonBarBase | |
eventHandler(event:Event):void [override]
Handles the changes to selection made via user interaction. | FloatPaneControlBar | ||
| finalRemoveAnimation():void
Sets up the final animations after a removeSession is finished. | ButtonBarBase | |
| getFadeButtonEffect(slidingData:ButtonBarButtonData):IEffect
Creates and returns a Fade effect on the passed data. | ButtonBarBase | |
| getMoveButtonEffect(slidingData:ButtonBarButtonData):IEffect
Creates and returns a Move animation to move a button to the new position. | ButtonBarBase | |
| getResizeButtonEffect(slidingData:ButtonBarButtonData):IEffect
Creates and returns a resize effect on the passed data. | ButtonBarBase | |
maximizePane(pane:Pane, minToMax:Boolean = false):void
Maximize a pane. | FloatPaneControlBar | ||
minimizePane(pane:Pane):void
Minimize a pane. | FloatPaneControlBar | ||
paneEffectHandler(event:EffectEvent = null):void
Handles effect events. | FloatPaneControlBar | ||
paneHandler(event:PaneEvent):void
Handles events on the managed panes. | FloatPaneControlBar | ||
| rendererHandler(event:Event):void
Handles events on the renderers. | ButtonBarBase | |
restorePane(pane:Pane):void
Restore a pane. | FloatPaneControlBar | ||
setActivePane(pane:Pane):void
Sets the activePane property and updates bindings and dispatches a
change event. | FloatPaneControlBar | ||
setPendingActivePane(pane:Pane):void
Set a pending active pane that is commited after a short pause to
prevent the activePane property from changing rapidly. | FloatPaneControlBar | ||
setupAnimation(type:String, pane:Pane):void
Handles the animation for minimizing, maximizing, or restoring a pane. | FloatPaneControlBar | ||
| setupFinalRemoveAnimation():void
Setup the final animation for a removal session. | ButtonBarBase | |
stageHandler(event:Event):void
Handles events for the Stage. | FloatPaneControlBar | ||
systemManagerEventHandler(event:Event):void
Handles events on the systemManager. | FloatPaneControlBar | ||
timerHandler(event:TimerEvent):void
Handles timer events to update the activePane. | FloatPaneControlBar | ||
| updateButtonSnapshot():void
Creates a vector of SlidingButtonData objects for each button from left
to right. | ButtonBarBase | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the "activePane" property changes. | FloatPaneControlBar | |||
| Dispatched when a button is closed via the close button. | ButtonBarBase | ||
| Dispatched when a button is about to be closed via the close button. | ButtonBarBase | ||
| Dispatched when a ButtonBarButton's closeButtonPart is clicked. | ButtonBarBase | ||
| Dispatched when a drag ends. | ButtonBarBase | ||
| Dispatched while a button is dragging. | ButtonBarBase | ||
| Dispatched when a button drag starts. | ButtonBarBase | ||
| Dispatched immediately before a button is dragged. | ButtonBarBase | ||
| activePane | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesactivePane:PaneThe pane managed by this control that is activated. If null, all managed panes are deactivated.
The default value is null.
This property can be used as the source for data binding.
public function get activePane():Pane public function set activePane(value:Pane):void| animationDuration | property |
public var animationDuration:Number = 350The duration of animations for the minimize and maximize animations.
Set to 0 to skip animation.
The default value is 350.
| maximizeBottom | property |
public var maximizeBottom:Number = 0The offset from the bottom of the screen when a pane is maximized.
The default value is 0.
| maximizeLeft | property |
public var maximizeLeft:Number = 0The offset from the left of the screen when a pane is maximized.
The default value is 0.
| maximizeRight | property |
public var maximizeRight:Number = 0The offset from the right of the screen when a pane is maximized.
The default value is 0.
| maximizeTop | property |
public var maximizeTop:Number = 0The offset from the top of the screen when a pane is maximized.
The default value is 0.
| paneEaser | property |
public var paneEaser:IEaserThe easer to use for the minimize and maximize animations.
The default value is Power easer.
| FloatPaneControlBar | () | Constructor |
public function FloatPaneControlBar()| addSysManListeners | () | method |
protected function addSysManListeners():voidAdd handlers to the systemManager.
| awmHandler | () | method |
protected function awmHandler(event:FocusEvent):voidHandles events for the ActiveWindowManager.
Parameters
event:FocusEvent — the FocusEvent
|
| eventHandler | () | method |
override protected function eventHandler(event:Event):voidHandles the changes to selection made via user interaction.
Parameters
event:Event — the Event that triggered the handler
|
| maximizePane | () | method |
protected function maximizePane(pane:Pane, minToMax:Boolean = false):voidMaximize a pane.
Parameters
pane:Pane — the Pane to maximize
| |
minToMax:Boolean (default = false) |
| minimizePane | () | method |
protected function minimizePane(pane:Pane):voidMinimize a pane.
Parameters
pane:Pane — the Pane to minimize
|
| paneEffectHandler | () | method |
protected function paneEffectHandler(event:EffectEvent = null):voidHandles effect events.
Parameters
event:EffectEvent (default = null) |
| paneHandler | () | method |
protected function paneHandler(event:PaneEvent):voidHandles events on the managed panes.
Parameters
event:PaneEvent — the PaneEvent dispatched by the pane
|
| restorePane | () | method |
protected function restorePane(pane:Pane):voidRestore a pane.
Parameters
pane:Pane — the Pane to restore
|
| setActivePane | () | method |
protected function setActivePane(pane:Pane):voidSets the activePane property and updates bindings and dispatches a change event.
Parameters
pane:Pane — the Pane that is activated
|
| setPendingActivePane | () | method |
protected function setPendingActivePane(pane:Pane):voidSet a pending active pane that is commited after a short pause to prevent the activePane property from changing rapidly.
Parameters
pane:Pane — the Pane to set as the pending active pane
|
| setupAnimation | () | method |
protected function setupAnimation(type:String, pane:Pane):voidHandles the animation for minimizing, maximizing, or restoring a pane.
Parameters
type:String — description of the animation to run
| |
pane:Pane — the Pane run the animation on
|
| stageHandler | () | method |
protected function stageHandler(event:Event):voidHandles events for the Stage.
Parameters
event:Event — the Event
|
| systemManagerEventHandler | () | method |
protected function systemManagerEventHandler(event:Event):voidHandles events on the systemManager.
Parameters
event:Event — the Event that triggered the handler
|
| timerHandler | () | method |
protected function timerHandler(event:TimerEvent):voidHandles timer events to update the activePane.
Parameters
event:TimerEvent — the TimerEvent that triggered the handler
|
| activePaneChange | Event |
ardisia.components.floatPaneControlBar.events.FloatPaneControlBarEventardisia.components.floatPaneControlBar.events.FloatPaneControlBarEventDispatched when the "activePane" property changes.