ardisia.components.buttonBar.ButtonBar

Package	ardisia.components.buttonBar
Class	public class ButtonBar
Inheritance	ButtonBar ButtonBarBase spark.components.supportClasses.ButtonBarBase
Subclasses	FloatPaneControlBar

ButtonBar that supports dragging.

Since the selectedIndex can change via dragging, it is better to bind to the selectedItem property of the dataProvider.

View the technical documentation on the Ardisia Labs website for more information.

Default MXML PropertydataProvider

Public Properties

	Property		Defined By
		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

Public Methods

	Method		Defined By
		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

Protected Methods

	Method		Defined By
		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 Handles events on the control.	ButtonBarBase
		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
		rendererHandler(event:Event):void Handles events on the renderers.	ButtonBarBase
		setupFinalRemoveAnimation():void Setup the final animation for a removal session.	ButtonBarBase
		updateButtonSnapshot():void Creates a vector of SlidingButtonData objects for each button from left to right.	ButtonBarBase

Events

	Summary	Defined By
buttonClose	Dispatched when a button is closed via the close button.	ButtonBarBase
buttonClosing	Dispatched when a button is about to be closed via the close button.	ButtonBarBase
closeButtonClick	Dispatched when a ButtonBarButton's closeButtonPart is clicked.	ButtonBarBase
dragEnd	Dispatched when a drag ends.	ButtonBarBase
dragging	Dispatched while a button is dragging.	ButtonBarBase
dragStart	Dispatched when a button drag starts.	ButtonBarBase
dragStarting	Dispatched immediately before a button is dragged.	ButtonBarBase

Ardisia Component Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
ButtonBar	Properties \| Methods \| Events