Package org.eclipse.draw2d
Class ButtonGroup
java.lang.Object
org.eclipse.draw2d.ButtonGroup
A ButtonGroup holds a group of 
Clickable's models and
 provides unique selection in them. There is capability to add a default
 selection. Models who want to belong to the group should just add themselves
 to this group. By doing so they listen to this group for changes.
 
 Setting of the default selection results in its being selected any time
 setSelected(ButtonModel, boolean) is called. If no default selection
 is set, the last entry selected is not allowed to deselect.
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidadd(ButtonModel model) Adds the passed ButtonModel to the ButtonGroup.voidAdds the passed listener.protected voidfirePropertyChange(Object oldValue, Object newValue) Fires a PropertyChangeEvent to all PropertyChangeListeners added to this ButtonGroup.Returns the ButtonModel which is selected by default for this ButtonGroup.Returns a List which contains all of theButtonModelsadded to this ButtonGroup.Returns the ButtonModel for the currently selected button.booleanisSelected(ButtonModel model) Determines if the given ButtonModel is selected or not.voidremove(ButtonModel model) Removes the given ButtonModel from this ButtonGroup.voidRemoves the passed PropertyChangeListener from this ButtonGroup.protected voidselectNewModel(ButtonModel model) Sets the passed ButtonModel to be the currently selected ButtonModel of this ButtonGroup.voidsetDefault(ButtonModel model) Sets the default selection of this ButtonGroup.voidsetSelected(ButtonModel model) Sets the button with the given ButtonModel to be selected.voidsetSelected(ButtonModel model, boolean value) Sets model to the passed state.
- 
Constructor Details- 
ButtonGrouppublic ButtonGroup()Constructs a ButtonGroup with no default selection.- Since:
- 2.0
 
 
- 
- 
Method Details- 
addAdds the passed ButtonModel to the ButtonGroup.- Parameters:
- model- ButtonModel to be added to this group
- Since:
- 2.0
 
- 
addPropertyChangeListenerAdds the passed listener. ButtonGroups use PropertyChangeListeners to react to selection changes in the ButtonGroup.- Parameters:
- listener- Listener to be added to this group
- Since:
- 2.0
 
- 
firePropertyChangeFires a PropertyChangeEvent to all PropertyChangeListeners added to this ButtonGroup.- Parameters:
- oldValue- Old selection value
- newValue- New selection value
- Since:
- 2.0
 
- 
getDefaultReturns the ButtonModel which is selected by default for this ButtonGroup.- Returns:
- The default ButtonModel
- Since:
- 2.0
 
- 
getElementsReturns a List which contains all of theButtonModelsadded to this ButtonGroup.- Returns:
- The List of ButtonModels in this ButtonGroup
- Since:
- 2.0
 
- 
getSelectedReturns the ButtonModel for the currently selected button.- Returns:
- The ButtonModel for the currently selected button
- Since:
- 2.0
 
- 
isSelectedDetermines if the given ButtonModel is selected or not.- Parameters:
- model- Model being tested for selected status
- Returns:
- Selection state of the given model
- Since:
- 2.0
 
- 
removeRemoves the given ButtonModel from this ButtonGroup.- Parameters:
- model- ButtonModel being removed
- Since:
- 2.0
 
- 
removePropertyChangeListenerRemoves the passed PropertyChangeListener from this ButtonGroup.- Parameters:
- listener- PropertyChangeListener to be removed
- Since:
- 2.0
 
- 
selectNewModelSets the passed ButtonModel to be the currently selected ButtonModel of this ButtonGroup. Fires a property change.- Parameters:
- model- ButtonModel to be selected
- Since:
- 2.0
 
- 
setDefaultSets the default selection of this ButtonGroup. Does nothing if it is not present in the group. Sets selection to the passed ButtonModel.- Parameters:
- model- ButtonModel which is to be the default selection.
- Since:
- 2.0
 
- 
setSelectedSets the button with the given ButtonModel to be selected.- Parameters:
- model- The ButtonModel to be selected
- Since:
- 2.0
 
- 
setSelectedSets model to the passed state.If value is - true:- The passed ButtonModel will own selection.
 
- false:- If the passed model owns selection, it will lose selection, and selection will be given to the default ButonModel. If no default ButtonModel was set, selection will remain as it was, as one ButtonModel must own selection at all times.
- If the passed model does not own selection, then selection will remain as it was.
 
 - Parameters:
- model- The model to be affected
- value- The selected state
- Since:
- 2.0
 
 
-