dataProvider property
* does not refer to a ViewStack container.
*
* @eventType mx.events.ItemClickEvent.ITEM_CLICK
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Royale 0.9.3
*/
[Event(name="itemClick", type="mx.events.ItemClickEvent")]
//copied from flexsdk ButtonBar
/**
* Number of pixels between children in the horizontal direction.
*
* The default value for the Halo theme is 0.
* The default value for the Spark theme is -1.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
[Style(name="horizontalGap", type="Number", format="Length", inherit="no")]
//copied from flexsdk ButtonBar
/**
* Width of each button, in pixels.
* If undefined, the default width of each button is calculated from its label text.
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Flex 3
*/
//[Style(name="buttonWidth", type="Number", format="Length", inherit="no")]
//--------------------------------------
// Other metadata
//--------------------------------------
//[IconFile("ButtonBar.png")]
[Alternative(replacement="spark.components.ButtonBar", since="4.0")]
[DefaultTriggerEvent("itemClick")]
/**
* The ToggleButtonBar control defines a horizontal or vertical
* group of buttons that maintain their selected or deselected state.
* Only one button in the ToggleButtonBar control
* can be in the selected state.
* This means that when a user selects a button in a ToggleButtonBar control,
* the button stays in the selected state until the user selects a different button.
*
* 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:
*| Characteristic | *Description | *
|---|---|
| Preferred size | *Wide enough to contain all buttons with their label text and icons, if any, plus any * padding and separators, and high enough to accommodate the button height. | *
| Control resizing rules | *The controls do not resize by default. Specify percentage sizes if you want your * ToggleButtonBar to resize based on the size of its parent container. | *
| selectedIndex | *Determines which button will be selected when the control is created. The default value is "0" * and selects the leftmost button in the bar. Setting the selectedIndex property to "-1" deselects * all buttons in the bar. | *
| Padding | *0 pixels for the top, bottom, left, and right properties. | *
The <mx:ToggleButtonBar> tag inherits all of the tag attributes
* of its superclass, and adds the following tag attributes:
* <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> ** * @includeExample examples/ToggleButtonBarExample.mxml * * @see mx.controls.ButtonBar * @see mx.controls.LinkBar * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Royale 0.9.3 */ public class ToggleButtonBar extends UIComponent implements ILayoutParent, ILayoutView, IHasLabelField { // include "../core/Version.as"; //-------------------------------------------------------------------------- // // Constructor // //-------------------------------------------------------------------------- /** * Constructor. * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Royale 0.9.3 */ public function ToggleButtonBar() { super(); widthType = ButtonBarModel.NATURAL_WIDTHS; } /** * @see org.apache.royale.html.beads.models.ButtonBarModel#buttonWidths * * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 * @productversion Royale 0.9 * @royaleignorecoercion org.apache.royale.html.beads.models.ButtonBarModel */ public function get buttonWidths():Array { return ButtonBarModel(model).buttonWidths; } /** * @royaleignorecoercion org.apache.royale.html.beads.models.ButtonBarModel */ public function set buttonWidths(value:Array):void { ButtonBarModel(model).buttonWidths = value; } /** * @see org.apache.royale.html.beads.models.ButtonBarModel#widthType * * @langversion 3.0 * @playerversion Flash 10.2 * @playerversion AIR 2.6 * @productversion Royale 0.9 * @royaleignorecoercion org.apache.royale.html.beads.models.ButtonBarModel */ public function get widthType():Number { return ButtonBarModel(model).widthType; } /** * @royaleignorecoercion org.apache.royale.html.beads.models.ButtonBarModel */ public function set widthType(value:Number):void { ButtonBarModel(model).widthType = value; } //---------------------------------- // dataProvider //---------------------------------- [Bindable("collectionChange")] [Inspectable(category="Data", defaultValue="undefined")] /** * Set of data to be viewed. * This property lets you use most types of objects as data providers. * If you set the
dataProvider property to an Array,
* it will be converted to an ArrayCollection. If you set the property to
* an XML object, it will be converted into an XMLListCollection with
* only one item. If you set the property to an XMLList, it will be
* converted to an XMLListCollection.
* If you set the property to an object that implements the
* IList or ICollectionView interface, the object will be used directly.
*
* As a consequence of the conversions, when you get the
* dataProvider property, it will always be
* an ICollectionView, and therefore not necessarily be the type of object
* you used to you set the property.
* This behavior is important to understand if you want to modify the data
* in the data provider: changes to the original data may not be detected,
* but changes to the ICollectionView object that you get back from the
* dataProvider property will be detected.
The default value is -1 (no selected item).
* * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 * @royaleignorecoercion org.apache.royale.core.ISelectionModel */ public function get selectedIndex():int { return (model as ISelectionModel).selectedIndex; } /** * @private * @royaleignorecoercion org.apache.royale.core.ISelectionModel */ public function set selectedIndex(value:int):void { // if (!collection || collection.length == 0) // { (model as ISelectionModel).selectedIndex = value; // bSelectionChanged = true; // bSelectedIndexChanged = true; // invalidateDisplayList(); // } //commitSelectedIndex(value); } /** * The name of the field in the data provider items to display * as the label. * * @langversion 3.0 * @playerversion Flash 9 * @playerversion AIR 1.1 * @productversion Flex 3 * @royaleignorecoercion org.apache.royale.core.ISelectionModel */ public function get labelField():String { return (model as ISelectionModel).labelField; } /** * @private * @royaleignorecoercion org.apache.royale.core.ISelectionModel */ public function set labelField(value:String):void { (model as ISelectionModel).labelField = value; } //-------------------------------------------------------------------------- // // Overridden properties // //-------------------------------------------------------------------------- //-------------------------------------------------------------------------- // // Properties // //-------------------------------------------------------------------------- //---------------------------------- // toggleOnClick //---------------------------------- /** * @private * Storage for the toggleOnClick property. */ private var _toggleOnClick:Boolean = false; [Inspectable(category="General", defaultValue="false")] /** * Specifies whether the currently selected button can be deselected by * the user. * * By default, the currently selected button gets deselected * automatically only when another button in the group is selected. * Setting this property totrue lets the user
* deselect it.
* When the currently selected button is deselected,
* the selectedIndex property is set to -1.
*
* @default false
*
* @langversion 3.0
* @playerversion Flash 9
* @playerversion AIR 1.1
* @productversion Royale 0.9.3
*/
public function get toggleOnClick():Boolean
{
return _toggleOnClick;
}
/**
* @private
*/
public function set toggleOnClick(value:Boolean):void
{
_toggleOnClick = value;
}
/**
* Returns the ILayoutHost which is its view. From ILayoutParent.
*
* @langversion 3.0
* @playerversion Flash 10.2
* @playerversion AIR 2.6
* @productversion Royale 0.8
* @royaleignorecoercion org.apache.royale.core.ILayoutHost
*/
public function getLayoutHost():ILayoutHost
{
return view as ILayoutHost;
}
/**
* @private
*/
override public function addedToParent():void
{
super.addedToParent();
// Load the layout bead if it hasn't already been loaded.
loadBeadFromValuesManager(IBeadLayout, "iBeadLayout", this);
// Even though super.addedToParent dispatched "beadsAdded", DataContainer still needs its data mapper
// and item factory beads. These beads are added after super.addedToParent is called in case substitutions
// were made; these are just defaults extracted from CSS.
loadBeadFromValuesManager(IDataProviderItemRendererMapper, "iDataProviderItemRendererMapper", this);
loadBeadFromValuesManager(IItemRendererClassFactory, "iItemRendererClassFactory", this);
dispatchEvent(new Event("initComplete"));
}
private var _buttonWidth:int;
public function get buttonWidth():int
{
return _buttonWidth;
}
public function set buttonWidth(value:int):void
{
_buttonWidth = value;
}
override public function get measuredWidth():Number
{
if (dataProvider)
return buttonWidth * dataProvider.length;
return 0;
}
override public function get measuredHeight():Number
{
if (dataProvider)
{
COMPILE::JS
{
// if the height was set to zero by setActualSize because
// there were no buttons to measure, clear the width
// style so the buttonbar can get its natural height
if (height == 0 && isNaN(explicitHeight))
{
element.style.height = null;
_height = NaN;
}
}
return height; // do a better measurement someday
}
return 0;
}
}
}