Packageardisia.components.buttonBar
Classpublic class ButtonBarButton
InheritanceButtonBarButton Inheritance spark.components.ButtonBarButton

Button class used by the ButtonBar control.

Adds support for a close button that is added directly to the button that triggers the button's removal by the ButtonBar class.

Default MXML Propertylabel


Public Properties
 PropertyDefined By
  canBeClosed : Boolean
If true, can be closed via the close icon.
ButtonBarButton
  markedForDeletion : Boolean
If true, this button's data will be deleted by the ButtonBar class in the future.
ButtonBarButton
Public Methods
 MethodDefined By
  
ButtonBarButton()
ButtonBarButton
  
setHovered(value:Boolean):void
Update the hovered property.
ButtonBarButton
Protected Methods
 MethodDefined By
  
closeButtonPartHandler(event:MouseEvent):void
Handles events for the close button skin part.
ButtonBarButton
Events
 Event Summary Defined By
  
closeButtonClick
Dispatched when the closeButtonPart is clicked.ButtonBarButton
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
closeButtonPart:mx.core.IVisualElement
Required: false Part Type: Static
Optional skin part used to dispatch a "closeButtonDown" event.
ButtonBarButton
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
  
disabledAndClosable
ButtonBarButton
  
disabledAndSelectedAndClosable
ButtonBarButton
  
downAndClosable
ButtonBarButton
  
downAndSelectedAndClosable
ButtonBarButton
  
overAndClosable
ButtonBarButton
  
overAndSelectedAndClosable
ButtonBarButton
  
upAndClosable
ButtonBarButton
  
upAndSelectedAndClosable
ButtonBarButton
Property Detail
canBeClosedproperty
canBeClosed:Boolean

If true, can be closed via the close icon.

The default value is true.


Implementation
    public function get canBeClosed():Boolean
    public function set canBeClosed(value:Boolean):void
markedForDeletionproperty 
public var markedForDeletion:Boolean

If true, this button's data will be deleted by the ButtonBar class in the future.

The default value is false.

Constructor Detail
ButtonBarButton()Constructor
public function ButtonBarButton()



Method Detail
closeButtonPartHandler()method
protected function closeButtonPartHandler(event:MouseEvent):void

Handles events for the close button skin part.

Parameters

event:MouseEvent — the Event that triggered the handler

setHovered()method 
public function setHovered(value:Boolean):void

Update the hovered property.

Parameters

value:Boolean — Boolean value to set the "hovered" property

Event Detail
closeButtonClick Event
Event Object Type: ardisia.components.buttonBar.events.ButtonBarEvent
ButtonBarEvent.type property = ardisia.components.buttonBar.events.ButtonBarEvent

Dispatched when the closeButtonPart is clicked.





Mon Sep 15 2014, 01:55 AM -06:00