| Package | feathers.controls |
| Class | public class ButtonGroup |
| Inheritance | ButtonGroup  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Subclasses | PGN_PluginButtonBar |
Default MXML PropertydataProvider
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| buttonFactory : Function
Creates a new button. | ButtonGroup | ||
| buttonInitializer : Function
Modifies a button, perhaps by changing its label and icons, based on the
item from the data provider that the button is meant to represent. | ButtonGroup | ||
| buttonProperties : Object
A set of key/value pairs to be passed down to all of the button
group's buttons. | ButtonGroup | ||
| clipRect : Rectangle [override] | FeathersControl | |
| customButtonName : String
A name to add to all buttons in this button group. | ButtonGroup | ||
| customFirstButtonName : String
A name to add to the first button in this button group. | ButtonGroup | ||
| customLastButtonName : String
A name to add to the last button in this button group. | ButtonGroup | ||
| dataProvider : ListCollection
The collection of data to be displayed with buttons. | ButtonGroup | ||
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| direction : String
The button group layout is either vertical or horizontal. | ButtonGroup | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| firstButtonFactory : Function
Creates a new first button. | ButtonGroup | ||
| firstGap : Number
Space, in pixels, between the first two buttons. | ButtonGroup | ||
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| gap : Number
Space, in pixels, between buttons. | ButtonGroup | ||
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| lastButtonFactory : Function
Creates a new last button. | ButtonGroup | ||
| lastGap : Number
Space, in pixels, between the last two buttons. | ButtonGroup | ||
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
| minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Property | Defined By | ||
|---|---|---|---|
| actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
| actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
| buttonName : String = feathers-button-group-button
The value added to the nameList of the buttons. | ButtonGroup | ||
| explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
| explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
| firstButtonName : String = feathers-button-group-button
The value added to the nameList of the first button. | ButtonGroup | ||
| lastButtonName : String = feathers-button-group-button
The value added to the nameList of the last button. | ButtonGroup | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ButtonGroup | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_CHILD_NAME_BUTTON : String = feathers-button-group-button [static]
The default value added to the nameList of the buttons. | ButtonGroup | ||
| DIRECTION_HORIZONTAL : String = horizontal [static]
The buttons are displayed in order from left to right. | ButtonGroup | ||
| DIRECTION_VERTICAL : String = vertical [static]
The buttons are displayed in order from top to bottom. | ButtonGroup | ||
| INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
| INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
| INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
| INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
| INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
| INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
| INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
| buttonFactory | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbuttonFactory:FunctionCreates a new button.
This function is expected to have the following signature:
function():Button
public function get buttonFactory():Function public function set buttonFactory(value:Function):voidSee also
| buttonInitializer | property |
buttonInitializer:Function
Modifies a button, perhaps by changing its label and icons, based on the
item from the data provider that the button is meant to represent. The
default buttonInitializer function can set the button's label and icons if
label and/or any of the Button icon fields
(defaultIcon, upIcon, etc.) are present in
the item. onPress and onRelease events can also be listened to by
passing in functions for each.
public function get buttonInitializer():Function public function set buttonInitializer(value:Function):void| buttonName | property |
protected var buttonName:String = feathers-button-group-button
The value added to the nameList of the buttons.
| buttonProperties | property |
buttonProperties:Object
A set of key/value pairs to be passed down to all of the button
group's buttons. These values are shared by each button, so values
that cannot be shared (such as display objects that need to be added
to the display list) should be passed to buttons in another way (such
as with an AddedWatcher).
If the subcomponent has its own subcomponents, their properties
can be set too, using attribute @ notation. For example,
to set the skin on the thumb of a SimpleScrollBar
which is in a Scroller which is in a List,
you can use the following syntax:
list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
public function get buttonProperties():Object public function set buttonProperties(value:Object):voidSee also
| customButtonName | property |
customButtonName:StringA name to add to all buttons in this button group. Typically used by a theme to provide different skins to different button groups.
public function get customButtonName():String public function set customButtonName(value:String):voidSee also
| customFirstButtonName | property |
customFirstButtonName:StringA name to add to the first button in this button group. Typically used by a theme to provide different skins to the first button.
public function get customFirstButtonName():String public function set customFirstButtonName(value:String):voidSee also
| customLastButtonName | property |
customLastButtonName:StringA name to add to the last button in this button group. Typically used by a theme to provide different skins to the last button.
public function get customLastButtonName():String public function set customLastButtonName(value:String):voidSee also
| dataProvider | property |
dataProvider:ListCollectionThe collection of data to be displayed with buttons.
public function get dataProvider():ListCollection public function set dataProvider(value:ListCollection):voidSee also
| direction | property |
direction:StringThe button group layout is either vertical or horizontal.
public function get direction():String public function set direction(value:String):void| firstButtonFactory | property |
firstButtonFactory:FunctionCreates a new first button. If the firstButtonFactory is null, then the ButtonGroup will use the buttonFactory.
This function is expected to have the following signature:
function():Button
public function get firstButtonFactory():Function public function set firstButtonFactory(value:Function):voidSee also
| firstButtonName | property |
protected var firstButtonName:String = feathers-button-group-button
The value added to the nameList of the first button.
| firstGap | property |
firstGap:NumberSpace, in pixels, between the first two buttons. If NaN, the standard gap will be used.
public function get firstGap():Number public function set firstGap(value:Number):voidSee also
| gap | property |
gap:NumberSpace, in pixels, between buttons.
public function get gap():Number public function set gap(value:Number):void| lastButtonFactory | property |
lastButtonFactory:FunctionCreates a new last button. If the lastButtonFactory is null, then the ButtonGroup will use the buttonFactory.
This function is expected to have the following signature:
function():Button
public function get lastButtonFactory():Function public function set lastButtonFactory(value:Function):voidSee also
| lastButtonName | property |
protected var lastButtonName:String = feathers-button-group-button
The value added to the nameList of the last button.
| lastGap | property |
lastGap:NumberSpace, in pixels, between the last two buttons. If NaN, the standard gap will be used.
public function get lastGap():Number public function set lastGap(value:Number):voidSee also
| ButtonGroup | () | Constructor |
public function ButtonGroup()Constructor.
| DEFAULT_CHILD_NAME_BUTTON | Constant |
public static const DEFAULT_CHILD_NAME_BUTTON:String = feathers-button-group-button
The default value added to the nameList of the buttons.
| DIRECTION_HORIZONTAL | Constant |
public static const DIRECTION_HORIZONTAL:String = horizontalThe buttons are displayed in order from left to right.
| DIRECTION_VERTICAL | Constant |
public static const DIRECTION_VERTICAL:String = verticalThe buttons are displayed in order from top to bottom.