Package jmri.jmrit.beantable

Class LightTableAction

java.lang.Object

javax.swing.AbstractAction

jmri.jmrit.beantable.AbstractTableAction<Light>

jmri.jmrit.beantable.LightTableAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public class LightTableAction
extends AbstractTableAction<Light>

Swing action to create and register a LightTable GUI.

Based on SignalHeadTableAction.java

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrit.beantable.AbstractTableAction

AbstractTableAction.TableItem<E extends NamedBean>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) JmriJFrame	addFrame
(package private) JCheckBox	addRangeBox
(package private) JButton	cancel
(package private) PropertyChangeListener	colorChangeListener
(package private) Manager<Light>	connectionChoice
(package private) JButton	create
(package private) Light	curLight
(package private) JTextField	hardwareAddressTextField
(package private) SystemNameValidator	hardwareAddressValidator
(package private) JLabel	labelNumToAdd
static String	lightControlTitle
(package private) boolean	lightCreatedOrUpdated
protected LightManager	lightManager
(package private) boolean	noWarn
(package private) JSpinner	numberToAdd
(package private) ManagerComboBox<Light>	prefixBox
(package private) SpinnerNumberModel	rangeSpinner
(package private) JLabel	status1
(package private) JLabel	status2
(package private) JLabel	systemLabel
(package private) JLabel	systemNameLabel
(package private) String	systemSelectionCombo
(package private) JTextField	userName
(package private) JLabel	userNameLabel

Fields inherited from class jmri.jmrit.beantable.AbstractTableAction

f, includeAddButton, m

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	Description
LightTableAction()
LightTableAction(String s)	Create an action with a specific title.

Method Summary

Modifier and Type	Method	Description
protected void	addPressed(ActionEvent e)
protected void	addRangeChanged()
(package private) void	cancelPressed(ActionEvent e)	Respond to the Cancel/Close button on the Add/Edit Light pane.
protected void	createModel()	Create the JTable DataModel, along with the changes for the specific case of Lights.
(package private) void	createPressed(ActionEvent e)	Create lights when the Create New button on the Add/Create pane is pressed and entry is valid.
String	getClassDescription()
protected String	getClassName()
static String	getDescriptionText(LightControl lc, int type)	Get the description of the type of Light Control.
(package private) void	handleCreateException(Exception ex, String sysName)
protected String	helpTarget()	Specify the JavaHelp target for this specific panel.
protected void	prefixChanged()
void	setManager(Manager<Light> man)	If the subClass is being included in a greater tabbed frame, then this is used to specify which manager the subclass should be using.
void	setMessagePreferencesDetails()
protected void	setTitle()	Include the correct title.
(package private) boolean	supportsVariableLights()	Check if LightManager supports variable Lights.
boolean	validatePhysicalTurnout(String inTurnoutName, Component inOpenPane)	Validates that a physical turnout exists.

Methods inherited from class jmri.jmrit.beantable.AbstractTableAction

actionPerformed, addBottomButtons, addToFrame, addToFrame, addToPanel, columnsVisibleUpdated, configureManagerComboBox, configureTable, displayHwError, dispose, getDataModel, getFrame, getManager, getPanel, getTableDataModel, includeAddButton, nextName, print, removePrefixBoxListener, setFrame, setMenuBar

Methods inherited from class javax.swing.AbstractAction

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

accept

Field Details

lightManager

protected LightManager lightManager

addFrame

JmriJFrame addFrame

curLight

Light curLight

lightCreatedOrUpdated

boolean lightCreatedOrUpdated

noWarn

boolean noWarn

systemLabel

JLabel systemLabel

prefixBox

ManagerComboBox<Light> prefixBox

addRangeBox

JCheckBox addRangeBox

hardwareAddressTextField

JTextField hardwareAddressTextField

hardwareAddressValidator

SystemNameValidator hardwareAddressValidator

rangeSpinner

SpinnerNumberModel rangeSpinner

numberToAdd

JSpinner numberToAdd

labelNumToAdd

JLabel labelNumToAdd

systemSelectionCombo

String systemSelectionCombo

systemNameLabel

JLabel systemNameLabel

userName

JTextField userName

userNameLabel

JLabel userNameLabel

create

JButton create

cancel

JButton cancel

colorChangeListener

PropertyChangeListener colorChangeListener

status1

JLabel status1

status2

JLabel status2

connectionChoice

Manager<Light> connectionChoice

lightControlTitle

public static String lightControlTitle

Constructor Details

LightTableAction

public LightTableAction(String s)

Create an action with a specific title.

Note that the argument is the Action title, not the title of the resulting frame. Perhaps this should be changed?

Parameters:

s - title of the action

LightTableAction

public LightTableAction()

Method Details

setManager

public void setManager(@Nonnull
 Manager<Light> man)

If the subClass is being included in a greater tabbed frame, then this is used to specify which manager the subclass should be using.

Overrides:

setManager in class AbstractTableAction<Light>

Parameters:

man - Manager for this table tab

createModel

protected void createModel()

Create the JTable DataModel, along with the changes for the specific case of Lights.

Specified by:

createModel in class AbstractTableAction<Light>

setTitle

protected void setTitle()

Include the correct title.

Specified by:

setTitle in class AbstractTableAction<Light>

helpTarget

protected String helpTarget()

Specify the JavaHelp target for this specific panel.

Overrides:

helpTarget in class AbstractTableAction<Light>

Returns:

a fixed default string "index" pointing to to highest level in JMRI Help

addPressed

protected void addPressed(ActionEvent e)

Specified by:

addPressed in class AbstractTableAction<Light>

prefixChanged

protected void prefixChanged()

addRangeChanged

protected void addRangeChanged()

supportsVariableLights

boolean supportsVariableLights()

Check if LightManager supports variable Lights. TODO: Will only verify against formats which accept "11" as a Hardware address.

Returns:

true if system can support variable lights.

createPressed

void createPressed(ActionEvent e)

Create lights when the Create New button on the Add/Create pane is pressed and entry is valid.

Parameters:

e - the button press action

handleCreateException

void handleCreateException(Exception ex,
 String sysName)

cancelPressed

void cancelPressed(ActionEvent e)

Respond to the Cancel/Close button on the Add/Edit Light pane.

Parameters:

e - the button press action

getDescriptionText

public static String getDescriptionText(LightControl lc,
 int type)

Get the description of the type of Light Control.

Parameters:

lc - the light control

type - the type of lc

Returns:

description of the type of lc or an empty string if type is not recognized

validatePhysicalTurnout

public boolean validatePhysicalTurnout(String inTurnoutName,
 Component inOpenPane)

Validates that a physical turnout exists.

Parameters:

inTurnoutName - the (system or user) name of the turnout

inOpenPane - the pane over which to show dialogs (null to suppress dialogs)

Returns:

true if valid turnout was entered, false otherwise

getClassDescription

public String getClassDescription()

Overrides:

getClassDescription in class AbstractTableAction<Light>

setMessagePreferencesDetails

public void setMessagePreferencesDetails()

Overrides:

setMessagePreferencesDetails in class AbstractTableAction<Light>

getClassName

protected String getClassName()

Specified by:

getClassName in class AbstractTableAction<Light>