jmri.jmrit.display
Class LayoutEditorTools

java.lang.Object
  jmri.jmrit.display.LayoutEditorTools

public class LayoutEditorTools
extends Object

Layout Editor Tools provides tools making use of layout connectivity available in Layout Editor panels.

The tools in this module are accessed via the Tools menu in Layout Editor.

Author:

Dave Duchamp Copyright (c) 2007

Field Summary

int	A1
int	A2
int	B1
int	B2
int	C1
int	C2
int	D1
int	D2
int	NONE

Constructor Summary

LayoutEditorTools(LayoutEditor thePanel)

Method Summary

void	finalizeBlockBossLogic()
SignalHead	getHeadFromName(String str) Returns a SignalHead given a name
LayoutTurnout	getLayoutTurnoutFromTurnout(Turnout turnout, boolean requireDoubleXover, String str, JFrame theFrame) Returns the layout turnout corresponding to a given turnout.
SignalHead	getNextSignalFromObject(TrackSegment track, Object object)
SignalHead	getSignalHeadFromEntry(JTextField signalName, boolean requireEntry, JmriJFrame frame) Returns the SignalHead corresponding to an entry field in the specified dialog.
boolean	initializeBlockBossLogic(String signalHeadName)
boolean	isAtWestEndOfAnchor(TrackSegment t, PositionablePoint p)
boolean	isHeadAssignedAnywhere(SignalHead head) Returns true if the specified Signal Head is assigned to an object on the panel, regardless of whether an icon is displayed or not
boolean	isHeadOnPanel(SignalHead head) Returns true if an icon for the specified SignalHead is on the panel
boolean	reachedEndBumper()
void	removeAssignment(SignalHead head) Removes the assignment of the specified SignalHead to either a turnout, a positionable point, or a level crossing wherever it is assigned
void	removeSignalHeadFromPanel(String signalName) Removes the SignalHead with the specified name from the panel and from assignment to any turnout, positionable point, or level crossing
void	setSignalHeadOnPanel(int rotation, String headName, int xLoc, int yLoc) Places a signal head icon on the panel after rotation at the designated place, with all with all icons taken care of.
void	setSignalsAtBlockBoundary(MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtBlockBoundaryFromMenu(PositionablePoint p, MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtLevelXing(MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtLevelXingFromMenu(LevelXing xing, MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtTToTTurnouts(MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtTurnout(MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtTurnoutFromMenu(LayoutTurnout to, MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtXoverTurnout(MultiIconEditor theEditor, JFrame theFrame)
void	setSignalsAtXoverTurnoutFromMenu(LayoutTurnout to, MultiIconEditor theEditor, JFrame theFrame)

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public int NONE

A1

public int A1

A2

public int A2

B1

public int B1

B2

public int B2

C1

public int C1

C2

public int C2

D1

public int D1

D2

public int D2

Constructor Detail

LayoutEditorTools

public LayoutEditorTools(LayoutEditor thePanel)

Method Detail

setSignalsAtTurnoutFromMenu

public void setSignalsAtTurnoutFromMenu(LayoutTurnout to,
                                        MultiIconEditor theEditor,
                                        JFrame theFrame)

setSignalsAtTurnout

public void setSignalsAtTurnout(MultiIconEditor theEditor,
                                JFrame theFrame)

getLayoutTurnoutFromTurnout

public LayoutTurnout getLayoutTurnoutFromTurnout(Turnout turnout,
                                                 boolean requireDoubleXover,
                                                 String str,
                                                 JFrame theFrame)

Returns the layout turnout corresponding to a given turnout. If require double crossover is requested, and error message is sent to the user if the layout turnout is not a double crossover, and null is returned. If a layout turnout corresponding to the turnout is not found, an error message is sent to the user and null is returned.

getSignalHeadFromEntry

public SignalHead getSignalHeadFromEntry(JTextField signalName,
                                         boolean requireEntry,
                                         JmriJFrame frame)

Returns the SignalHead corresponding to an entry field in the specified dialog. This also takes care of UpperCase and trimming of leading and trailing blanks. If entry is required, and no entry is present, and error message is sent. An error message also results if a signal head with the entered name is not found in the SignalTable.

getHeadFromName

public SignalHead getHeadFromName(String str)

Returns a SignalHead given a name

setSignalHeadOnPanel

public void setSignalHeadOnPanel(int rotation,
                                 String headName,
                                 int xLoc,
                                 int yLoc)

Places a signal head icon on the panel after rotation at the designated place, with all with all icons taken care of.

isHeadOnPanel

public boolean isHeadOnPanel(SignalHead head)

Returns true if an icon for the specified SignalHead is on the panel

isHeadAssignedAnywhere

public boolean isHeadAssignedAnywhere(SignalHead head)

Returns true if the specified Signal Head is assigned to an object on the panel, regardless of whether an icon is displayed or not

removeAssignment

public void removeAssignment(SignalHead head)

Removes the assignment of the specified SignalHead to either a turnout, a positionable point, or a level crossing wherever it is assigned

removeSignalHeadFromPanel

public void removeSignalHeadFromPanel(String signalName)

Removes the SignalHead with the specified name from the panel and from assignment to any turnout, positionable point, or level crossing

initializeBlockBossLogic

public boolean initializeBlockBossLogic(String signalHeadName)

finalizeBlockBossLogic

public void finalizeBlockBossLogic()

getNextSignalFromObject

public SignalHead getNextSignalFromObject(TrackSegment track,
                                          Object object)

reachedEndBumper

public boolean reachedEndBumper()

isAtWestEndOfAnchor

public boolean isAtWestEndOfAnchor(TrackSegment t,
                                   PositionablePoint p)

setSignalsAtBlockBoundaryFromMenu

public void setSignalsAtBlockBoundaryFromMenu(PositionablePoint p,
                                              MultiIconEditor theEditor,
                                              JFrame theFrame)

setSignalsAtBlockBoundary

public void setSignalsAtBlockBoundary(MultiIconEditor theEditor,
                                      JFrame theFrame)

setSignalsAtXoverTurnoutFromMenu

public void setSignalsAtXoverTurnoutFromMenu(LayoutTurnout to,
                                             MultiIconEditor theEditor,
                                             JFrame theFrame)

setSignalsAtXoverTurnout

public void setSignalsAtXoverTurnout(MultiIconEditor theEditor,
                                     JFrame theFrame)

setSignalsAtLevelXingFromMenu

public void setSignalsAtLevelXingFromMenu(LevelXing xing,
                                          MultiIconEditor theEditor,
                                          JFrame theFrame)

setSignalsAtLevelXing

public void setSignalsAtLevelXing(MultiIconEditor theEditor,
                                  JFrame theFrame)

setSignalsAtTToTTurnouts

public void setSignalsAtTToTTurnouts(MultiIconEditor theEditor,
                                     JFrame theFrame)