Package	mx.controls
Class	public class ToggleButtonBar
Inheritance	ToggleButtonBar ButtonBar NavBar Box Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Subclasses	TabBar

If you set the toggleOnClick property of the ToggleButtonBar container to true, selecting the currently selected button deselects it. By default the toggleOnClick property is set to false.

You can use the ButtonBar control to define a group of push buttons.

The typical use for a toggle button is for maintaining selection among a set of options, such as switching between views in a ViewStack container.

The ToggleButtonBar control creates Button controls based on the value of its dataProvider property. Even though ToggleButtonBar is a subclass of Container, do not use methods such as Container.addChild() and Container.removeChild() to add or remove Button controls. Instead, use methods such as addItem() and removeItem() to manipulate the dataProvider property. The ToggleButtonBar control automatically adds or removes the necessary children based on changes to the dataProvider property.

To control the styling of the buttons of the ToggleButtonBar control, use the buttonStyleName, firstButtonStyleName, and lastButtonStyleName style properties; do not try to style the individual Button controls that make up the ToggleButtonBar control.

ToggleButtonBar control has the following default characteristics:

Show MXML Syntax

Hide MXML Syntax

  <mx:ToggleButtonBar
    Properties
    selectedIndex="0"
    toggleOnClick="false|true"
 
    Styles
    selectedButtonTextStyleName="Name of CSS style declaration that specifies styles for the text of the selected button.">
    ...
       child tags
    ...
  </mx:ToggleButtonBar>
  

View the examples

See also