ToggleGroup

isSelectionRequired: Boolean

Determines if the user can deselect the currently selected item or not. The selection may always be cleared programmatically by setting the selected index to -1 or the selected item to null.

If isSelectionRequired is set to true and the toggle group has items that were added previously, and there is no currently selected item, the item at index 0 will be selected automatically.

selectedIndex: Number

The index of the currently selected toggle.

selectedItem: IToggle

The currently selected toggle.

addEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Registers an event listener at a certain object.

addItem ( item: IToggle ): Void

Adds a toggle to the group. If it is the first item added to the group, and isSelectionRequired is true, it will be selected automatically.

dispatchEvent ( event: Event ): Void
Inherited from EventDispatcher

Dispatches an event to all objects that have registered listeners for its type. If an event with enabled 'bubble' property is dispatched to a display object, it will travel up along the line of parents, until it either hits the root object or someone stops its propagation manually.

dispatchEventWith ( type: String , bubbles: Boolean = false , data: Object = null ): Void
Inherited from EventDispatcher

Dispatches an event with the given parameters to all objects that have registered listeners for the given type. The method uses an internal pool of event objects to avoid allocations.

getFullTypeName (): String
Inherited from Object

native

Gets the fully qualified type name of the Object. The fully qualified type name includes the package of the type.

getType (): Type
Inherited from Object

native

Gets the Type that describes the Object.

getTypeName (): String
Inherited from Object

native

Gets the type name of the Object.

hasEventListener ( type: String ): Boolean
Inherited from EventDispatcher

Returns if there are listeners registered for a certain event type.

hasItem ( item: IToggle ): Boolean

Determines if the group includes the specified item.

removeAllItems (): Void

Removes all toggles from the group. No item will be selected.

removeEventListener ( type: String , listener: Function ): Void
Inherited from EventDispatcher

Removes an event listener from the object.

removeEventListeners ( type: String = null ): Void
Inherited from EventDispatcher

Removes all event listeners with a certain type, or all of them if type is null. Be careful when removing all event listeners: you never know who else was listening.

removeItem ( item: IToggle ): Void

Removes a toggle from the group. If the item being removed is selected and isSelectionRequired is true, the final item will be selected. If isSelectionRequired is false instead, no item will be selected.

toString (): String
Inherited from Object

native

Returns a String that describes the Object. This can be overriden to provide extra details when printing objects using trace().