Package jmri.jmrix.can.swing

Class CanNamedPaneAction

java.lang.Object

javax.swing.AbstractAction

jmri.util.swing.JmriAbstractAction

jmri.util.swing.JmriNamedPaneAction

jmri.jmrix.can.swing.CanNamedPaneAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, SystemConnectionAction<CanSystemConnectionMemo>

Direct Known Subclasses:

CanSendPane.Default, CbusBootloaderPane.Default, CbusConsolePane.Default, CbusEventRequestTablePane.Default, CbusEventTablePane.Default, CbusHubAction, CbusSlotMonitorPane.Default, ConfigToolPane.Default, EventTablePane.Default, HubAction, IdToolPane.Default, LoaderPane.Default, MemoryToolPane.Default, MonitorAction, MonitorPane.Default, NetworkTreeAction, NodeConfigToolPane.Default, OpenLcbCanSendAction, SimulatorPane.Default, StlEditorPane.Default

public class CanNamedPaneAction
extends JmriNamedPaneAction
implements SystemConnectionAction<CanSystemConnectionMemo>

Action to create and load a CAN-specific JmriPanel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
(package private) CanSystemConnectionMemo	memo

Fields inherited from class jmri.util.swing.JmriNamedPaneAction

paneClass

Fields inherited from class jmri.util.swing.JmriAbstractAction

context, hint, wi

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
CanNamedPaneAction(java.lang.String s, javax.swing.Icon i, WindowInterface wi, java.lang.String paneClass, CanSystemConnectionMemo memo)	Enhanced constructor for placing the pane in various GUIs.
CanNamedPaneAction(java.lang.String s, WindowInterface wi, java.lang.String paneClass, CanSystemConnectionMemo memo)	Enhanced constructor for placing the pane in various GUIs.

Method Summary

Modifier and Type	Method	Description
CanSystemConnectionMemo	getSystemConnectionMemo()	Get the SystemConnectionMemo this action is bound to.
java.util.Set<java.lang.Class<? extends SystemConnectionMemo>>	getSystemConnectionMemoClasses()	Get a list of SystemConnectionMemo subclasses that the implementing class accepts.
JmriPanel	makePanel()	Makes Panel and calls initComponents Invoked as part of the action being invoked, e.g. when button pressed or menu item selected, this runs the panel through the initial part of its life cycle and installs in the given window interface.
void	setSystemConnectionMemo(CanSystemConnectionMemo memo)	Set the SystemConnectionMemo this action is bound to.

Methods inherited from class jmri.util.swing.JmriAbstractAction

actionPerformed, dispose, setContext, setHint, setName, setParameter, setParameter, setWindowInterface, toString

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, wait, wait, wait

Methods inherited from interface javax.swing.Action

accept

Field Detail

memo

CanSystemConnectionMemo memo

Constructor Detail

CanNamedPaneAction

public CanNamedPaneAction(java.lang.String s,
                          WindowInterface wi,
                          java.lang.String paneClass,
                          CanSystemConnectionMemo memo)

Enhanced constructor for placing the pane in various GUIs.

Parameters:

s - Window Name

wi - JmriJFrameInterface

paneClass - Name of class to open

memo - System Connection

CanNamedPaneAction

public CanNamedPaneAction(java.lang.String s,
                          javax.swing.Icon i,
                          WindowInterface wi,
                          java.lang.String paneClass,
                          CanSystemConnectionMemo memo)

Enhanced constructor for placing the pane in various GUIs.

Parameters:

s - Window Name

i - Icon to display

wi - JmriJFrameInterface

paneClass - Name of class to open

memo - System Connection

Method Detail

makePanel

public JmriPanel makePanel()

Makes Panel and calls initComponents Invoked as part of the action being invoked, e.g. when button pressed or menu item selected, this runs the panel through the initial part of its life cycle and installs in the given window interface.

If different or additional initialization is needed, inherit from this class and override this method to do it.

Overrides:

makePanel in class JmriNamedPaneAction

getSystemConnectionMemo

public CanSystemConnectionMemo getSystemConnectionMemo()

Description copied from interface: SystemConnectionAction

Get the SystemConnectionMemo this action is bound to.

Specified by:

getSystemConnectionMemo in interface SystemConnectionAction<CanSystemConnectionMemo>

Returns:

the SystemConnectionMemo or null if not bound.

setSystemConnectionMemo

public void setSystemConnectionMemo(CanSystemConnectionMemo memo)
                             throws java.lang.IllegalArgumentException

Description copied from interface: SystemConnectionAction

Set the SystemConnectionMemo this action is bound to.

Implementing classes may throw an IllegalArgumentException if the implementing class requires a specific subclass of SystemConnectionMemo.

Specified by:

setSystemConnectionMemo in interface SystemConnectionAction<CanSystemConnectionMemo>

Parameters:

memo - the SystemConnectionMemo

Throws:

java.lang.IllegalArgumentException - if the SystemConnectionMemo is invalid

getSystemConnectionMemoClasses

public java.util.Set<java.lang.Class<? extends SystemConnectionMemo>> getSystemConnectionMemoClasses()

Description copied from interface: SystemConnectionAction

Get a list of SystemConnectionMemo subclasses that the implementing class accepts.

If the implementing class is a subclass of a class that does accept SystemConnectionMemos, but the implementing class does not accept any, return an empty array instead of null.

Specified by:

getSystemConnectionMemoClasses in interface SystemConnectionAction<CanSystemConnectionMemo>

Returns:

Set of SystemConnectionMemo subclasses or empty array.