Package jmri.jmrit.beantable.beanedit

Class BeanEditAction<B extends NamedBean>

java.lang.Object

javax.swing.AbstractAction

jmri.jmrit.beantable.beanedit.BeanEditAction<B>

Type Parameters:

B - the type of supported NamedBean

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

Direct Known Subclasses:

BlockEditAction, LightEditAction, OBlockEditAction, SensorDebounceEditAction, SensorEditAction, SensorPullUpEditAction, TurnoutEditAction

public abstract class BeanEditAction<B extends NamedBean>
extends AbstractAction

Provides the basic information and structure for for a editing the details of a bean object.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JButton	applyBut	Apply Button.
(package private) B	bean
protected ArrayList<BeanItemPanel>	bei
(package private) JTextArea	commentField
(package private) JScrollPane	commentFieldScroller
(package private) JmriJFrame	f
(package private) NamedBeanHandleManager	nbMan
protected Component	selectedTab
(package private) JTextField	userNameField

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
BeanEditAction()
BeanEditAction(String s)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
protected void	addToPanel(JPanel panel, List<BeanEditItem> items)	Set out the panel based upon the items passed in via the ArrayList.
(package private) boolean	allowBlockNameChange(String changeType, String newName)	Determine whether it is safe to rename/remove a Block user name.
protected void	applyButtonAction(ActionEvent e)
(package private) BeanItemPanel	basicDetails()	Create a generic panel that holds the basic bean information System Name, User Name, and Comment.
protected void	cancelButtonAction(ActionEvent e)
(package private) void	formatTextAreaAsLabel(JTextPane pane)
protected abstract B	getByUserName(String name)
protected abstract String	helpTarget()
protected void	initPanels()	Call to create all the different tabs that will be added to the frame.
protected void	initPanelsFirst()	Initialise panels to be at start of Tabbed Panel menu.
protected void	initPanelsLast()	Initialise panels to be at end of Tabbed Panel menu.
(package private) BeanItemPanel	propertiesDetails()	Create a generic panel that holds Bean Property details.
void	removeName()	Generic method to remove the user name from a bean.
void	renameBean(String _newName)	Generic method to change the user name of a Bean.
protected void	resetBasicItems(ActionEvent e)
void	save()
protected void	saveBasicItems(ActionEvent e)
void	setBean(B bean)
void	setSelectedComponent(Component c)
(package private) BeanItemPanel	usageDetails()	Create a generic panel that holds Bean usage details.
(package private) static boolean	validateNumericalInput(String text)

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

bean

B extends NamedBean bean

userNameField

JTextField userNameField

commentField

JTextArea commentField

commentFieldScroller

JScrollPane commentFieldScroller

bei

protected ArrayList<BeanItemPanel> bei

f

JmriJFrame f

selectedTab

protected Component selectedTab

applyBut

protected JButton applyBut

Apply Button. Accessible so Edit Actions can set custom tool tip.

nbMan

NamedBeanHandleManager nbMan

Constructor Details

BeanEditAction

public BeanEditAction(String s)

BeanEditAction

public BeanEditAction()

Method Details

setBean

public void setBean(B bean)

initPanels

protected void initPanels()

Call to create all the different tabs that will be added to the frame.

initPanelsFirst

protected void initPanelsFirst()

Initialise panels to be at start of Tabbed Panel menu. Default empty.

initPanelsLast

protected void initPanelsLast()

Initialise panels to be at end of Tabbed Panel menu. Startup usage details and Properties.

basicDetails

BeanItemPanel basicDetails()

Create a generic panel that holds the basic bean information System Name, User Name, and Comment.

Returns:

a new panel

usageDetails

BeanItemPanel usageDetails()

Create a generic panel that holds Bean usage details.

Returns:

a new panel

propertiesDetails

BeanItemPanel propertiesDetails()

Create a generic panel that holds Bean Property details.

Returns:

a new panel

saveBasicItems

@OverridingMethodsMustInvokeSuper
protected void saveBasicItems(ActionEvent e)

resetBasicItems

@OverridingMethodsMustInvokeSuper
protected void resetBasicItems(ActionEvent e)

helpTarget

protected abstract String helpTarget()

setSelectedComponent

public void setSelectedComponent(Component c)

actionPerformed

public void actionPerformed(ActionEvent e)

applyButtonAction

protected void applyButtonAction(ActionEvent e)

cancelButtonAction

protected void cancelButtonAction(ActionEvent e)

addToPanel

protected void addToPanel(JPanel panel,
 List<BeanEditItem> items)

Set out the panel based upon the items passed in via the ArrayList.

Parameters:

panel - JPanel to add stuff to

items - a BeanEditItem list of key-value pairs for the items to add

formatTextAreaAsLabel

void formatTextAreaAsLabel(JTextPane pane)

save

public void save()

validateNumericalInput

static boolean validateNumericalInput(String text)

getByUserName

protected abstract B getByUserName(String name)

renameBean

public void renameBean(String _newName)

Generic method to change the user name of a Bean.

Parameters:

_newName - string to use as the new user name

removeName

public void removeName()

Generic method to remove the user name from a bean.

allowBlockNameChange

boolean allowBlockNameChange(String changeType,
 String newName)

Determine whether it is safe to rename/remove a Block user name.

The user name is used by the LayoutBlock to link to the block and by Layout Editor track components to link to the layout block.

Parameters:

changeType - This will be Remove or Rename.

newName - For Remove this will be empty, for Rename it will be the new user name.

Returns:

true to continue with the user name change.