Package jmri.jmrit.display.layoutEditor

Class LevelXingView

java.lang.Object

jmri.jmrit.display.layoutEditor.LayoutTrackView

jmri.jmrit.display.layoutEditor.LevelXingView

All Implemented Interfaces:

InlineLogixNG

public class LevelXingView
extends LayoutTrackView

MVC View component for the LevelXing class

Field Summary

Fields

Modifier and Type	Field	Description
(package private) ArrayList<JMenuItem>	editAdditionalMenu	Remove this object from display and persistance.
(package private) JPopupMenu	popup
(package private) ArrayList<JMenuItem>	viewAdditionalMenu

Fields inherited from class jmri.jmrit.display.layoutEditor.LayoutTrackView

decorations, layoutEditor, NUM_ARROW_TYPES

Constructor Summary

Constructors

Constructor	Description
LevelXingView(LevelXing xing, Point2D c, LayoutEditor layoutEditor)	constructor method
LevelXingView(LevelXing xing, LayoutEditor layoutEditor)	Constructor method.

Method Summary

Modifier and Type	Method	Description
void	addEditPopUpMenu(JMenuItem menu)
void	addViewPopUpMenu(JMenuItem menu)
boolean	canRemove()	Check for active block boundaries.
List<HitPointType>	checkForFreeConnections()	return a list of the available connections for this layout track
void	checkForNonContiguousBlocks(HashMap<String,List<Set<String>>> blockNamesToTrackNameSetsMap)	check this track and its neighbors for non-contiguous blocks
boolean	checkForUnAssignedBlocks()	determine if all the appropriate blocks have been assigned to this track
void	collectContiguousTracksNamesInBlockNamed(String blockName, Set<String> TrackNameSet)	recursive routine to check for all contiguous tracks in this blockName
void	dispose()	Clean up when this object is no longer needed.
protected void	draw1(Graphics2D g2, boolean isMain, boolean isBlock)	Draw this level crossing.
protected void	draw2(Graphics2D g2, boolean isMain, float railDisplacement)	draw two lines (rails)
protected void	drawDecorations(Graphics2D g2)	Draw track decorations.
protected void	drawEditControls(Graphics2D g2)	draw the edit controls
protected void	drawTurnoutControls(Graphics2D g2)	Draw the turnout controls
protected HitPointType	findHitPointType(Point2D hitPoint, boolean useRectangles, boolean requireUnconnected)	find the hit (location) type for a point
String	getBlockNameAC()
String	getBlockNameBD()
Rectangle2D	getBounds()
LayoutTrack	getConnectA()
LayoutTrack	getConnectB()
LayoutTrack	getConnectC()
LayoutTrack	getConnectD()
LayoutTrack	getConnection(HitPointType connectionType)	get the LayoutTrack connected at the specified connection type
Point2D	getCoordsA()
Point2D	getCoordsB()
Point2D	getCoordsC()
Point2D	getCoordsD()
Point2D	getCoordsForConnectionType(HitPointType connectionType)	Get the coordinates for a specified connection type.
LayoutBlock	getLayoutBlockAC()
LayoutBlock	getLayoutBlockBD()
protected ArrayList<LayoutConnectivity>	getLayoutConnectivity()	get the layout connectivity for this track
LevelXing	getLevelXing()
Sensor	getSensor(LevelXing.Geometry loc)
Sensor	getSensorA()
String	getSensorAName()
Sensor	getSensorB()
String	getSensorBName()
Sensor	getSensorC()
String	getSensorCName()
Sensor	getSensorD()
String	getSensorDName()
SignalMast	getSignalAMast()
String	getSignalAMastName()
String	getSignalAName()
SignalMast	getSignalBMast()
String	getSignalBMastName()
String	getSignalBName()
SignalMast	getSignalCMast()
String	getSignalCMastName()
String	getSignalCName()
SignalMast	getSignalDMast()
String	getSignalDMastName()
String	getSignalDName()
SignalHead	getSignalHead(LevelXing.Geometry loc)
SignalMast	getSignalMast(LevelXing.Geometry loc)
protected void	highlightUnconnected(Graphics2D g2, HitPointType specificType)	highlight unconnected connections
boolean	isMainlineAC()	Test if mainline track or not.
boolean	isMainlineBD()
void	reCheckBlockBoundary()	abstract method... subclasses should implement _IF_ they need to recheck their block boundaries
void	removeBeanReference(NamedBean nb)
void	rotateCoords(double angleDEG)	rotate this LayoutTrack's coordinates by angleDEG's
void	scaleCoords(double xFactor, double yFactor)	scale this LayoutTrack's coordinates by the x and y factors
void	setAdditionalEditPopUpMenu(JPopupMenu popup)
void	setAdditionalViewPopUpMenu(JPopupMenu popup)
void	setAllLayoutBlocks(LayoutBlock layoutBlock)	Assign all the layout blocks in this track
void	setConnectA(LayoutTrack o, HitPointType type)
void	setConnectB(LayoutTrack o, HitPointType type)
void	setConnectC(LayoutTrack o, HitPointType type)
void	setConnectD(LayoutTrack o, HitPointType type)
void	setConnection(HitPointType connectionType, LayoutTrack o, HitPointType type)	set the LayoutTrack connected at the specified connection type
void	setCoordsA(Point2D p)
void	setCoordsB(Point2D p)
void	setCoordsC(Point2D p)
void	setCoordsD(Point2D p)
void	setSensorAName(String sensorName)
void	setSensorBName(String sensorName)
void	setSensorCName(String sensorName)
void	setSensorDName(String sensorName)
void	setSignalAMast(String signalMast)
void	setSignalAName(String signalHead)
void	setSignalBMast(String signalMast)
void	setSignalBName(String signalHead)
void	setSignalCMast(String signalMast)
void	setSignalCName(String signalHead)
void	setSignalDMast(String signalMast)
void	setSignalDName(String signalHead)
protected JPopupMenu	showPopup(JmriMouseEvent mouseEvent)	show the popup menu for this layout track
String	toString()
void	translateCoords(double xFactor, double yFactor)	translate this LayoutTrack's coordinates by the x and y factors

Methods inherited from class jmri.jmrit.display.layoutEditor.LayoutTrackView

addCommonPopupItems, displayRemoveWarningDialog, drawHidden, drawLayoutTrackText, findHitPointType, findHitPointType, getColorForTrackBlock, getColorForTrackBlock, getCoordsCenter, getDecorations, getEditorName, getId, getLayoutEditor, getLayoutEditorToolBarPanel, getLayoutTrack, getLogixNG, getName, getNameString, getTurnoutStateString, getTypeName, getX, getY, hasDecorations, highlightUnconnected, isDisconnected, isHidden, loadArrowImageToJCBItem, removeInlineLogixNG, rotatePoint, setColorForTrackBlock, setColorForTrackBlock, setCoordsCenter, setDecorations, setHidden, setIdent, setLogixNG, setLogixNG_SystemName, setLogixNGPositionableMenu, setupLogixNG, showPopup, showPopup, trackControlCircleAt, trackControlCircleRectAt, trackEditControlCircleAt

Methods inherited from class java.lang.Object

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

Field Details

popup

JPopupMenu popup

editAdditionalMenu

ArrayList<JMenuItem> editAdditionalMenu

Remove this object from display and persistance.

viewAdditionalMenu

ArrayList<JMenuItem> viewAdditionalMenu

Constructor Details

LevelXingView

public LevelXingView(@Nonnull
 LevelXing xing,
 @Nonnull
 LayoutEditor layoutEditor)

Constructor method.

Parameters:

xing - the level crossing.

layoutEditor - for access to tools

LevelXingView

public LevelXingView(@Nonnull
 LevelXing xing,
 @Nonnull
 Point2D c,
 @Nonnull
 LayoutEditor layoutEditor)

constructor method

Parameters:

xing - the level crossing.

c - display location

layoutEditor - for access to tools

Method Details

getLevelXing

@Nonnull
public LevelXing getLevelXing()

toString

public String toString()

Overrides:

toString in class Object

getBlockNameAC

@Nonnull
public String getBlockNameAC()

getBlockNameBD

@Nonnull
public String getBlockNameBD()

getSignalHead

public SignalHead getSignalHead(LevelXing.Geometry loc)

getSignalMast

public SignalMast getSignalMast(LevelXing.Geometry loc)

getSensor

public Sensor getSensor(LevelXing.Geometry loc)

getSignalAName

@Nonnull
public String getSignalAName()

setSignalAName

public void setSignalAName(String signalHead)

getSignalBName

@Nonnull
public String getSignalBName()

setSignalBName

public void setSignalBName(String signalHead)

getSignalCName

@Nonnull
public String getSignalCName()

setSignalCName

public void setSignalCName(String signalHead)

getSignalDName

@Nonnull
public String getSignalDName()

setSignalDName

public void setSignalDName(String signalHead)

removeBeanReference

public void removeBeanReference(NamedBean nb)

getSignalAMastName

public String getSignalAMastName()

getSignalAMast

public SignalMast getSignalAMast()

setSignalAMast

public void setSignalAMast(String signalMast)

getSignalBMastName

public String getSignalBMastName()

getSignalBMast

public SignalMast getSignalBMast()

setSignalBMast

public void setSignalBMast(String signalMast)

getSignalCMastName

public String getSignalCMastName()

getSignalCMast

public SignalMast getSignalCMast()

setSignalCMast

public void setSignalCMast(String signalMast)

getSignalDMastName

public String getSignalDMastName()

getSignalDMast

public SignalMast getSignalDMast()

setSignalDMast

public void setSignalDMast(String signalMast)

getSensorAName

public String getSensorAName()

getSensorA

public Sensor getSensorA()

setSensorAName

public void setSensorAName(String sensorName)

getSensorBName

public String getSensorBName()

getSensorB

public Sensor getSensorB()

setSensorBName

public void setSensorBName(String sensorName)

getSensorCName

public String getSensorCName()

getSensorC

public Sensor getSensorC()

setSensorCName

public void setSensorCName(String sensorName)

getSensorDName

public String getSensorDName()

getSensorD

public Sensor getSensorD()

setSensorDName

public void setSensorDName(String sensorName)

getConnection

public LayoutTrack getConnection(HitPointType connectionType)
                          throws JmriException

get the LayoutTrack connected at the specified connection type

Specified by:

getConnection in class LayoutTrackView

Parameters:

connectionType - where on us to get the connection

Returns:

the LayoutTrack connected at the specified connection type

Throws:

JmriException - - if the connectionType is invalid

setConnection

public void setConnection(HitPointType connectionType,
 LayoutTrack o,
 HitPointType type)
                   throws JmriException

set the LayoutTrack connected at the specified connection type

Specified by:

setConnection in class LayoutTrackView

Parameters:

connectionType - where on us to set the connection

o - the LayoutTrack that is to be connected

type - where on the LayoutTrack we are connected

Throws:

JmriException - - if connectionType or type are invalid

getConnectA

public LayoutTrack getConnectA()

getConnectB

public LayoutTrack getConnectB()

getConnectC

public LayoutTrack getConnectC()

getConnectD

public LayoutTrack getConnectD()

setConnectA

public void setConnectA(LayoutTrack o,
 HitPointType type)

setConnectB

public void setConnectB(LayoutTrack o,
 HitPointType type)

setConnectC

public void setConnectC(LayoutTrack o,
 HitPointType type)

setConnectD

public void setConnectD(LayoutTrack o,
 HitPointType type)

getLayoutBlockAC

public LayoutBlock getLayoutBlockAC()

getLayoutBlockBD

public LayoutBlock getLayoutBlockBD()

getCoordsA

public Point2D getCoordsA()

getCoordsB

public Point2D getCoordsB()

getCoordsC

public Point2D getCoordsC()

getCoordsD

public Point2D getCoordsD()

getCoordsForConnectionType

public Point2D getCoordsForConnectionType(HitPointType connectionType)

Get the coordinates for a specified connection type.

Specified by:

getCoordsForConnectionType in class LayoutTrackView

Parameters:

connectionType - the connection type

Returns:

the coordinates for the specified connection type

getBounds

public Rectangle2D getBounds()

Specified by:

getBounds in class LayoutTrackView

Returns:

the bounds of this crossing

isMainlineAC

public boolean isMainlineAC()

Test if mainline track or not.

Returns:

true if either connecting track segment is mainline; Defaults to not mainline if connecting track segments are missing

isMainlineBD

public boolean isMainlineBD()

setCoordsA

public void setCoordsA(Point2D p)

setCoordsB

public void setCoordsB(Point2D p)

setCoordsC

public void setCoordsC(Point2D p)

setCoordsD

public void setCoordsD(Point2D p)

scaleCoords

public void scaleCoords(double xFactor,
 double yFactor)

scale this LayoutTrack's coordinates by the x and y factors

Specified by:

scaleCoords in class LayoutTrackView

Parameters:

xFactor - the amount to scale X coordinates

yFactor - the amount to scale Y coordinates

translateCoords

public void translateCoords(double xFactor,
 double yFactor)

translate this LayoutTrack's coordinates by the x and y factors

Specified by:

translateCoords in class LayoutTrackView

Parameters:

xFactor - the amount to translate X coordinates

yFactor - the amount to translate Y coordinates

rotateCoords

public void rotateCoords(double angleDEG)

rotate this LayoutTrack's coordinates by angleDEG's

Specified by:

rotateCoords in class LayoutTrackView

Parameters:

angleDEG - the amount to rotate in degrees

findHitPointType

protected HitPointType findHitPointType(Point2D hitPoint,
 boolean useRectangles,
 boolean requireUnconnected)

find the hit (location) type for a point

Specified by:

findHitPointType in class LayoutTrackView

Parameters:

hitPoint - the point

useRectangles - whether to use (larger) rectangles or (smaller) circles for hit testing

requireUnconnected - whether to only return hit types for free connections

Returns:

the location type for the point (or NONE)

canRemove

public boolean canRemove()

Check for active block boundaries.

If any connection point of a layout track object has attached objects, such as signal masts, signal heads or NX sensors, the layout track object cannot be deleted.

Specified by:

canRemove in class LayoutTrackView

Returns:

true if the layout track object can be deleted.

showPopup

@Nonnull
protected JPopupMenu showPopup(@Nonnull
 JmriMouseEvent mouseEvent)

show the popup menu for this layout track

Specified by:

showPopup in class LayoutTrackView

Parameters:

mouseEvent - the mouse down event that triggered this popup

Returns:

the popup menu for this layout track

dispose

public void dispose()

Clean up when this object is no longer needed. Should not be called while the object is still displayed; see remove().

addEditPopUpMenu

public void addEditPopUpMenu(JMenuItem menu)

addViewPopUpMenu

public void addViewPopUpMenu(JMenuItem menu)

setAdditionalEditPopUpMenu

public void setAdditionalEditPopUpMenu(JPopupMenu popup)

setAdditionalViewPopUpMenu

public void setAdditionalViewPopUpMenu(JPopupMenu popup)

drawDecorations

protected void drawDecorations(Graphics2D g2)

Draw track decorations. This type of track has none, so this method is empty.

Specified by:

drawDecorations in class LayoutTrackView

Parameters:

g2 - the graphics context

draw1

protected void draw1(Graphics2D g2,
 boolean isMain,
 boolean isBlock)

Draw this level crossing.

Specified by:

draw1 in class LayoutTrackView

Parameters:

g2 - the graphics port to draw to

isMain - true if drawing mainlines

isBlock - true if drawing block lines

draw2

protected void draw2(Graphics2D g2,
 boolean isMain,
 float railDisplacement)

draw two lines (rails)

Specified by:

draw2 in class LayoutTrackView

Parameters:

g2 - the graphics context

isMain - true if drawing mainlines

railDisplacement - the offset from center to draw the lines

highlightUnconnected

protected void highlightUnconnected(Graphics2D g2,
 HitPointType specificType)

highlight unconnected connections

Specified by:

highlightUnconnected in class LayoutTrackView

Parameters:

g2 - the graphics context

specificType - the specific connection to draw (or NONE for all)

drawEditControls

protected void drawEditControls(Graphics2D g2)

Description copied from class: LayoutTrackView

draw the edit controls

Specified by:

drawEditControls in class LayoutTrackView

Parameters:

g2 - the graphics context

drawTurnoutControls

protected void drawTurnoutControls(Graphics2D g2)

Description copied from class: LayoutTrackView

Draw the turnout controls

Specified by:

drawTurnoutControls in class LayoutTrackView

Parameters:

g2 - the graphics context

reCheckBlockBoundary

public void reCheckBlockBoundary()

Description copied from class: LayoutTrackView

abstract method... subclasses should implement _IF_ they need to recheck their block boundaries

Specified by:

reCheckBlockBoundary in class LayoutTrackView

getLayoutConnectivity

protected ArrayList<LayoutConnectivity> getLayoutConnectivity()

Description copied from class: LayoutTrackView

get the layout connectivity for this track

Specified by:

getLayoutConnectivity in class LayoutTrackView

Returns:

the list of Layout Connectivity objects

checkForFreeConnections

public List<HitPointType> checkForFreeConnections()

return a list of the available connections for this layout track

Specified by:

checkForFreeConnections in class LayoutTrackView

Returns:

the list of available connections

checkForUnAssignedBlocks

public boolean checkForUnAssignedBlocks()

determine if all the appropriate blocks have been assigned to this track

Specified by:

checkForUnAssignedBlocks in class LayoutTrackView

Returns:

true if all appropriate blocks have been assigned

checkForNonContiguousBlocks

public void checkForNonContiguousBlocks(@Nonnull
 HashMap<String,List<Set<String>>> blockNamesToTrackNameSetsMap)

check this track and its neighbors for non-contiguous blocks

For each (non-null) blocks of this track do: #1) If it's got an entry in the blockNamesToTrackNameSetMap then #2) If this track is not in one of the TrackNameSets for this block #3) add a new set (with this block/track) to blockNamesToTrackNameSetMap and #4) check all the connections in this block (by calling the 2nd method below)

Basically, we're maintaining contiguous track sets for each block found (in blockNamesToTrackNameSetMap)

Specified by:

checkForNonContiguousBlocks in class LayoutTrackView

Parameters:

blockNamesToTrackNameSetsMap - hashmap of key:block names to lists of track name sets for those blocks

collectContiguousTracksNamesInBlockNamed

public void collectContiguousTracksNamesInBlockNamed(@Nonnull
 String blockName,
 @Nonnull
 Set<String> TrackNameSet)

recursive routine to check for all contiguous tracks in this blockName

Specified by:

collectContiguousTracksNamesInBlockNamed in class LayoutTrackView

Parameters:

blockName - the block that we're checking for

TrackNameSet - the set of track names in this block

setAllLayoutBlocks

public void setAllLayoutBlocks(LayoutBlock layoutBlock)

Assign all the layout blocks in this track

Specified by:

setAllLayoutBlocks in class LayoutTrackView

Parameters:

layoutBlock - to this layout block (used by the Tools menu's "Assign block to selection" item)