Package jmri.jmrit.operations.automation.actions

Class Action

java.lang.Object

jmri.beans.PropertyChangeSupport

jmri.jmrit.operations.automation.actions.Action

All Implemented Interfaces:

PropertyChangeFirer, PropertyChangeProvider

Direct Known Subclasses:

ActivateTrainScheduleAction, ApplyTrainScheduleAction, BuildTrainAction, BuildTrainIfSelectedAction, CounterAction, DeselectTrainAction, GenerateSwitchListChangesAction, GotoAction, HaltAction, IsTrainEnRouteAction, MessageYesNoAction, MoveTrainAction, NoAction, PrintSwitchListChangesAction, PrintTrainBuildReportAction, PrintTrainManifestAction, PrintTrainManifestIfSelectedAction, ResetSwitchListsAction, ResetTrainAction, RunAutomationAction, RunSwitchListChangesAction, RunTrainAction, SelectTrainAction, TerminateTrainAction, UpdateSwitchListAction, WaitSwitchListAction, WaitTrainAction, WaitTrainTerminatedAction

public abstract class Action
extends PropertyChangeSupport

Field Summary

Fields

Modifier and Type	Field	Description
protected AutomationItem	_automationItem
static final String	ACTION_COMPLETE_CHANGED_PROPERTY
static final String	ACTION_GOTO_CHANGED_PROPERTY
static final String	ACTION_HALT_CHANGED_PROPERTY
static final String	ACTION_RUNNING_CHANGED_PROPERTY
static final int	CLOSED
static final int	FINISH_FAILED
static final int	HALT
static final int	NO_MESSAGE_SENT
static final int	OKAY

Fields inherited from class jmri.beans.PropertyChangeSupport

propertyChangeSupport

Constructor Summary

Constructors

Constructor	Description
Action()

Method Summary

Modifier and Type	Method	Description
abstract void	cancelAction()
abstract void	doAction()
int	finishAction(boolean success)	Completes the action by displaying the correct message if there's one.
int	finishAction(boolean success, Object[] buttons)	Completes the action by displaying the correct message if there's one.
String	getActionFailedString()
String	getActionString()
String	getActionSuccessfulString()
AutomationItem	getAutomationItem()
abstract int	getCode()
protected int	getCode(int code)	Mask off menu bits.
JComboBox<?>	getComboBox()
String	getFormatedMessage(String message)	Formats a message using fixed arguments in the following order:
abstract String	getName()
String	getStatus()
boolean	isAutomationMenuEnabled()
boolean	isConcurrentAction()	Used to determine if this action can run concurrently with other actions.
boolean	isGotoMenuEnabled()
boolean	isMessageFailEnabled()
boolean	isMessageOkEnabled()
boolean	isRouteMenuEnabled()
boolean	isTrainMenuEnabled()
int	sendMessage(String message, Object[] buttons, boolean success)	Displays message if there's one.
void	setAutomationItem(AutomationItem item)
void	setRunning(boolean running)
String	toString()	For combo boxes.

Methods inherited from class jmri.beans.PropertyChangeSupport

addPropertyChangeListener, addPropertyChangeListener, fireIndexedPropertyChange, fireIndexedPropertyChange, fireIndexedPropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Field Details

ACTION_COMPLETE_CHANGED_PROPERTY

public static final String ACTION_COMPLETE_CHANGED_PROPERTY

See Also:

• Constant Field Values

ACTION_HALT_CHANGED_PROPERTY

public static final String ACTION_HALT_CHANGED_PROPERTY

See Also:

• Constant Field Values

ACTION_RUNNING_CHANGED_PROPERTY

public static final String ACTION_RUNNING_CHANGED_PROPERTY

See Also:

• Constant Field Values

ACTION_GOTO_CHANGED_PROPERTY

public static final String ACTION_GOTO_CHANGED_PROPERTY

See Also:

• Constant Field Values

HALT

public static final int HALT

See Also:

• Constant Field Values

OKAY

public static final int OKAY

See Also:

• Constant Field Values

CLOSED

public static final int CLOSED

See Also:

• Constant Field Values

NO_MESSAGE_SENT

public static final int NO_MESSAGE_SENT

See Also:

• Constant Field Values

FINISH_FAILED

public static final int FINISH_FAILED

See Also:

• Constant Field Values

_automationItem

protected AutomationItem _automationItem

Constructor Details

Action

public Action()

Method Details

getCode

public abstract int getCode()

getName

public abstract String getName()

doAction

public abstract void doAction()

cancelAction

public abstract void cancelAction()

toString

public String toString()

For combo boxes.

Overrides:

toString in class Object

getCode

protected int getCode(int code)

Mask off menu bits.

Parameters:

code - the integer to be modified by masking off menu bits.

Returns:

code and ActionCodes.CODE_MASK

isTrainMenuEnabled

public boolean isTrainMenuEnabled()

isRouteMenuEnabled

public boolean isRouteMenuEnabled()

isMessageOkEnabled

public boolean isMessageOkEnabled()

isMessageFailEnabled

public boolean isMessageFailEnabled()

isAutomationMenuEnabled

public boolean isAutomationMenuEnabled()

isGotoMenuEnabled

public boolean isGotoMenuEnabled()

isConcurrentAction

public boolean isConcurrentAction()

Used to determine if this action can run concurrently with other actions.

Returns:

true if a concurrent action

setAutomationItem

public void setAutomationItem(AutomationItem item)

getAutomationItem

public AutomationItem getAutomationItem()

getActionString

public String getActionString()

getStatus

public String getStatus()

getActionSuccessfulString

public String getActionSuccessfulString()

getActionFailedString

public String getActionFailedString()

setRunning

public void setRunning(boolean running)

finishAction

public int finishAction(boolean success)

Completes the action by displaying the correct message if there's one. Will halt if the option to halt the automation is enabled or the user requested the automation to halt.

Parameters:

success - true if action succeeded

Returns:

OKAY, HALT, CLOSED, NO_MESSAGE_SENT, FINISH_FAILED

finishAction

public int finishAction(boolean success,
 Object[] buttons)

Completes the action by displaying the correct message if there's one. Will halt if the option to halt the automation is enabled or the user requested the automation to halt.

Parameters:

success - true if action succeeded

buttons - buttons to display in message

Returns:

OKAY, HALT, CLOSED, NO_MESSAGE_SENT, FINISH_FAILED

sendMessage

public int sendMessage(String message,
 Object[] buttons,
 boolean success)

Displays message if there's one.

Parameters:

buttons - the buttons to display, if success and two or more buttons, the second button becomes the default

success - true if action succeeded

message - the text to be displayed

Returns:

array number for which button was pressed, NO_MESSAGE_SENT, CLOSED

getFormatedMessage

public String getFormatedMessage(String message)

Formats a message using fixed arguments in the following order:

action name, train name, route location name, automation name, goto item id, train schedule day.

Parameters:

message - the string to be formated

Returns:

formated message

getComboBox

public JComboBox<?> getComboBox()