org.jminor.swing.common.ui.control

Class Control

java.lang.Object

javax.swing.AbstractAction

org.jminor.swing.common.ui.control.Control

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

Direct Known Subclasses:

Controls.ToggleControl, ControlSet

public class Control
extends javax.swing.AbstractAction

A beefed up Action.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Control.Command A simple command interface, allowing for Controls based on method references
static interface	Control.Iterator Used when handling sets of Controls.

Field Summary

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
Control() Constructs a new Control.
Control(java.lang.String name) Constructs a new Control.
Control(java.lang.String name, StateObserver enabledObserver) Constructs a new Control.
Control(java.lang.String name, StateObserver enabledObserver, javax.swing.Icon icon) Constructs a new Control.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected Control	doSetMnemonic(int mnemonic) Sets the mnemonic key, if overridden remember to call super.doSetMnemonic()
java.lang.String	getDescription()
StateObserver	getEnabledObserver()
javax.swing.Icon	getIcon()
int	getMnemonic()
java.lang.String	getName()
Control	setDescription(java.lang.String description)
void	setEnabled(boolean newValue) Unsupported, the enabled state of Controls is based on their enabledObserver
Control	setIcon(javax.swing.Icon icon)
Control	setKeyStroke(javax.swing.KeyStroke ks)
Control	setMnemonic(int key)
Control	setName(java.lang.String name)
java.lang.String	toString()

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

Control

public Control()

Constructs a new Control.

Control

public Control(java.lang.String name)

Constructs a new Control.

Parameters:

name - the control name

Control

public Control(java.lang.String name,
               StateObserver enabledObserver)

Constructs a new Control.

Parameters:

name - the control name

enabledObserver - the state observer controlling the enabled state of this control

Control

public Control(java.lang.String name,
               StateObserver enabledObserver,
               javax.swing.Icon icon)

Constructs a new Control.

Parameters:

name - the control name

enabledObserver - the state observer controlling the enabled state of this control

icon - the icon

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

setEnabled

public final void setEnabled(boolean newValue)

Unsupported, the enabled state of Controls is based on their enabledObserver

Specified by:

setEnabled in interface javax.swing.Action

Overrides:

setEnabled in class javax.swing.AbstractAction

Throws:

java.lang.UnsupportedOperationException - always

See Also:

Control(String, StateObserver)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

getDescription

public final java.lang.String getDescription()

Returns:

the description

setDescription

public final Control setDescription(java.lang.String description)

Parameters:

description - the description string

Returns:

this control instance

getName

public final java.lang.String getName()

Returns:

the name

setName

public final Control setName(java.lang.String name)

Parameters:

name - the name of this Control instance

Returns:

this Control instance

getEnabledObserver

public final StateObserver getEnabledObserver()

Returns:

the state which controls whether this Control instance is enabled

setMnemonic

public final Control setMnemonic(int key)

Parameters:

key - the mnemonic to associate with this Control instance

Returns:

this Control instance

getMnemonic

public final int getMnemonic()

Returns:

the mnemonic, 0 if none is specified

setKeyStroke

public final Control setKeyStroke(javax.swing.KeyStroke ks)

Parameters:

ks - the KeyStroke to associate with this Control

Returns:

this Control instance

setIcon

public final Control setIcon(javax.swing.Icon icon)

Parameters:

icon - the icon to associate with this Control

Returns:

this Control instance

getIcon

public final javax.swing.Icon getIcon()

Returns:

the icon

doSetMnemonic

protected Control doSetMnemonic(int mnemonic)

Sets the mnemonic key, if overridden remember to call super.doSetMnemonic()

Parameters:

mnemonic - the mnemonic key

Returns:

this Control instance