Package jmri.jmrit.logix

Class WarrantFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

jmri.util.JmriJFrame

jmri.jmrit.logix.WarrantRoute

jmri.jmrit.logix.WarrantFrame

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ComponentListener, java.awt.event.WindowListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, BeanInterface, ModifiedFlag, WindowInterface

public class WarrantFrame
extends WarrantRoute

WarrantFame creates and edits Warrants
This file is part of JMRI.

JMRI is free software; you can redistribute it and/or modify it under the terms of version 2 of the GNU General Public License as published by the Free Software Foundation. See the "COPYING" file for a copy of this license.

JMRI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jmri.jmrit.logix.WarrantRoute

WarrantRoute.AddressTextField, WarrantRoute.Display, WarrantRoute.DisplayButton, WarrantRoute.Location, WarrantRoute.RouteLocation

Nested classes/interfaces inherited from class jmri.util.JmriJFrame

JmriJFrame.ScreenDimensions

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface jmri.util.swing.WindowInterface

WindowInterface.Hint

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String[]	ON_OFF
(package private) static java.lang.String[]	SENSOR_STATES
(package private) static java.lang.String[]	TRUE_FALSE

Fields inherited from class jmri.jmrit.logix.WarrantRoute

_avoid, _destination, _displayPref, _focusedField, _orders, _origin, _scale, _speedUtil, _units, _via, PAD, STRUT_SIZE

Fields inherited from class jmri.util.JmriJFrame

allowInFrameServlet, properties, reuseFrameSavedPosition, reuseFrameSavedSized, windowInterface

Fields inherited from class javax.swing.JFrame

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WarrantFrame(Warrant w)	Constructor for opening an existing warrant for editing.
protected	WarrantFrame(Warrant startW, Warrant endW)	Constructor for creating a new warrant or copy or concatenation of warrants.

Method Summary

Modifier and Type	Method	Description
boolean	askClose()
(package private) static java.lang.String	checkBeanName(ThrottleSetting.Command command, java.lang.String beanName)
protected void	close()
protected java.util.List<ThrottleSetting>	getThrottleCommands()
protected Warrant	getWarrant()
protected boolean	isRunning()	Called by WarrantTableAction before closing the editing of this warrant
(package private) void	makeEditWindow(ThrottleSetting ts, ThrottleSetting.Command cmd)
protected void	maxThrottleEventAction()
void	propertyChange(java.beans.PropertyChangeEvent e)	Property names from Warrant: "runMode" - from setRunMode "controlChange" - from controlRunTrain "blockChange" - from goingActive "allocate" - from allocateRoute, deAllocate "setRoute" - from setRoute, goingActive Property names from Engineer: "Command" - from run "SpeedRestriction" - ThrottleRamp run Property names from RouteFinder: "RouteSearch" - from run
protected void	runTrain()
protected void	selectedRoute(java.util.ArrayList<BlockOrder> orders)
protected void	setSpeedCommand(float speed)
protected void	setThrottleCommand(java.lang.String cmd, java.lang.String value)

Methods inherited from class jmri.jmrit.logix.WarrantRoute

actionPerformed, calculate, calculatePanel, checkLocoAddress, clearRoute, clearTempWarrant, closeProfileTable, debugRoute, dispose, doAction, getAddress, getAvoidBlockOrder, getOrders, getTrainName, getViaBlockOrder, makeBlockPanels, makePickListPanel, makeRouteTablePanel, makeTextAndButtonPanel, makeTextBoxPanel, makeTextBoxPanel, makeTrainIdPanel, mouseClickedOnBlock, pathIsValid, pathsAreValid, pickRoute, routeIsValid, searchDepthPanel, setAddress, setSpeedUtil, setTrainInfo, setTrainName, showWarning, stopRouteFinder

Methods inherited from class jmri.util.JmriJFrame

addHelpMenu, componentHidden, componentMoved, componentResized, componentShown, generateWindowRef, getAllowInFrameServlet, getEscapeKeyAction, getEscapeKeyClosesWindow, getFrame, getFrame, getFrameList, getFrameList, getIndexedProperty, getMaximumSize, getModifiedFlag, getPreferredSize, getProperty, getPropertyNames, getSavePosition, getSaveSize, getScreenDimensions, getWindowFrameRef, getWindowInterface, handleModified, hasIndexedProperty, hasProperty, initComponents, makePrivateWindow, makePublicWindow, markWindowModified, multipleInstances, pack, setAllowInFrameServlet, setEscapeKeyAction, setEscapeKeyClosesWindow, setFrameLocation, setIndexedProperty, setModifiedFlag, setProperty, setSavePosition, setSaveSize, setShutDownTask, setWindowInterface, show, show, storeValues, undecorate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMinimumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

TRUE_FALSE

static final java.lang.String[] TRUE_FALSE

ON_OFF

static final java.lang.String[] ON_OFF

SENSOR_STATES

static final java.lang.String[] SENSOR_STATES

Constructor Detail

WarrantFrame

protected WarrantFrame(@Nonnull
                       Warrant w)

Constructor for opening an existing warrant for editing.

Parameters:

w - the Warrant to edit.

WarrantFrame

protected WarrantFrame(@CheckForNull
                       Warrant startW,
                       @CheckForNull
                       Warrant endW)

Constructor for creating a new warrant or copy or concatenation of warrants. Called by WarrantTableAction.

Parameters:

startW - the Warrant to Copy or Concatenate.

endW - the other Warrant to Concatenate with.

Method Detail

askClose

public boolean askClose()

selectedRoute

protected void selectedRoute(java.util.ArrayList<BlockOrder> orders)

Specified by:

selectedRoute in class WarrantRoute

checkBeanName

static java.lang.String checkBeanName(ThrottleSetting.Command command,
                                      java.lang.String beanName)

runTrain

protected void runTrain()

getWarrant

protected Warrant getWarrant()

maxThrottleEventAction

protected void maxThrottleEventAction()

Specified by:

maxThrottleEventAction in class WarrantRoute

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Property names from Warrant: "runMode" - from setRunMode "controlChange" - from controlRunTrain "blockChange" - from goingActive "allocate" - from allocateRoute, deAllocate "setRoute" - from setRoute, goingActive Property names from Engineer: "Command" - from run "SpeedRestriction" - ThrottleRamp run Property names from RouteFinder: "RouteSearch" - from run

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Specified by:

propertyChange in class WarrantRoute

setThrottleCommand

protected void setThrottleCommand(java.lang.String cmd,
                                  java.lang.String value)

setSpeedCommand

protected void setSpeedCommand(float speed)

isRunning

protected boolean isRunning()

Called by WarrantTableAction before closing the editing of this warrant

Returns:

true if this warrant or its pre-editing version is running

getThrottleCommands

protected java.util.List<ThrottleSetting> getThrottleCommands()

close

protected void close()

makeEditWindow

void makeEditWindow(ThrottleSetting ts,
                    ThrottleSetting.Command cmd)