Package hec.ui

Class TristateDecorator

java.lang.Object

hec.ui.TristateDecorator

All Implemented Interfaces:

ItemSelectable, ButtonModel

Direct Known Subclasses:

TristateCheckBoxRenderer

public class TristateDecorator
extends Object
implements ButtonModel

Author: Dr. Heinz M. Kabutz Changed some by Shannon Larson Restricted feature added by Mike Perryman Exactly which Design Pattern is this? Is it an Adapter, a Proxy or a Decorator? In this case, my vote lies with the Decorator, because we are extending functionality and "decorating" the original model with a more powerful model.

Constructor Summary

Constructors

Constructor	Description
TristateDecorator(ButtonModel other)	Instantiates a new tristate decorator.

Method Summary

Modifier and Type	Method	Description
void	addActionListener(ActionListener l)
void	addChangeListener(ChangeListener l)
void	addItemListener(ItemListener l)
String	getActionCommand()
int	getMnemonic()
Object[]	getSelectedObjects()
TristateCheckBox.State	getState()	The current state is embedded in the selection / armed state of the model.
boolean	isArmed()	All these methods simply delegate to the "other" model that is being decorated.
boolean	isEnabled()
boolean	isPressed()
boolean	isRollover()
boolean	isSelected()
void	nextState()	We rotate between NOT_SELECTED, SELECTED and SEMI_SELECTED.
void	nextState(boolean restricted)	We rotate between NOT_SELECTED, SELECTED and SEMI_SELECTED.
void	removeActionListener(ActionListener l)
void	removeChangeListener(ChangeListener l)
void	removeItemListener(ItemListener l)
void	setActionCommand(String s)
void	setArmed(boolean b)	Filter: No one may change the armed status except us.
void	setEnabled(boolean b)	We disable focusing on the component when it is not enabled.
void	setGroup(ButtonGroup group)
void	setMnemonic(int key)
void	setPressed(boolean b)
void	setRollover(boolean b)
void	setSelected(boolean b)
void	setState(TristateCheckBox.State state)	Sets the state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.ButtonModel

getGroup

Constructor Details

TristateDecorator

public TristateDecorator(ButtonModel other)

Instantiates a new tristate decorator.

Parameters:

other - the other

Method Details

setState

public void setState(TristateCheckBox.State state)

Sets the state.

Parameters:

state - the new state

getState

public TristateCheckBox.State getState()

The current state is embedded in the selection / armed state of the model. We return the SELECTED state when the check box is selected but not armed, SEMI_SELECTED state when the check box is selected and armed (grey) and NOT_SELECTED when the check box is de-selected.

Returns:

the state

nextState

public void nextState()

We rotate between NOT_SELECTED, SELECTED and SEMI_SELECTED.

nextState

public void nextState(boolean restricted)

We rotate between NOT_SELECTED, SELECTED and SEMI_SELECTED.

setArmed

public void setArmed(boolean b)

Filter: No one may change the armed status except us.

Specified by:

setArmed in interface ButtonModel

Parameters:

b - the new armed

setEnabled

public void setEnabled(boolean b)

We disable focusing on the component when it is not enabled.

Specified by:

setEnabled in interface ButtonModel

Parameters:

b - the new enabled

isArmed

public boolean isArmed()

All these methods simply delegate to the "other" model that is being decorated.

Specified by:

isArmed in interface ButtonModel

Returns:

true, if is armed

isSelected

public boolean isSelected()

Specified by:

isSelected in interface ButtonModel

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ButtonModel

isPressed

public boolean isPressed()

Specified by:

isPressed in interface ButtonModel

isRollover

public boolean isRollover()

Specified by:

isRollover in interface ButtonModel

setSelected

public void setSelected(boolean b)

Specified by:

setSelected in interface ButtonModel

setPressed

public void setPressed(boolean b)

Specified by:

setPressed in interface ButtonModel

setRollover

public void setRollover(boolean b)

Specified by:

setRollover in interface ButtonModel

setMnemonic

public void setMnemonic(int key)

Specified by:

setMnemonic in interface ButtonModel

getMnemonic

public int getMnemonic()

Specified by:

getMnemonic in interface ButtonModel

setActionCommand

public void setActionCommand(String s)

Specified by:

setActionCommand in interface ButtonModel

getActionCommand

public String getActionCommand()

Specified by:

getActionCommand in interface ButtonModel

setGroup

public void setGroup(ButtonGroup group)

Specified by:

setGroup in interface ButtonModel

addActionListener

public void addActionListener(ActionListener l)

Specified by:

addActionListener in interface ButtonModel

removeActionListener

public void removeActionListener(ActionListener l)

Specified by:

removeActionListener in interface ButtonModel

addItemListener

public void addItemListener(ItemListener l)

Specified by:

addItemListener in interface ButtonModel

Specified by:

addItemListener in interface ItemSelectable

removeItemListener

public void removeItemListener(ItemListener l)

Specified by:

removeItemListener in interface ButtonModel

Specified by:

removeItemListener in interface ItemSelectable

addChangeListener

public void addChangeListener(ChangeListener l)

Specified by:

addChangeListener in interface ButtonModel

removeChangeListener

public void removeChangeListener(ChangeListener l)

Specified by:

removeChangeListener in interface ButtonModel

getSelectedObjects

public Object[] getSelectedObjects()

Specified by:

getSelectedObjects in interface ItemSelectable