Package jmri.jmrit.display.controlPanelEditor

Class CircuitBuilder

java.lang.Object

jmri.jmrit.display.controlPanelEditor.CircuitBuilder

public class CircuitBuilder
extends Object

ControlPanelEditor CircuitBuilder tools.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) class	CircuitBuilder.CBFrame

Field Summary

Fields

Modifier and Type	Field	Description
(package private) JmriJFrame	_cbFrame
static final Color	_editGroupColor
protected ControlPanelEditor	_editor
static final Color	_highlightColor
static final Color	_pathColor
(package private) ArrayList<Positionable>	_saveSelectionGroup	************************** Mouse ************************
(package private) static int	ARROW
(package private) static int	NONE
(package private) static int	OBLOCK
(package private) static int	OPATH
(package private) static int	PORTAL
(package private) static int	SIGNAL
(package private) static int	STRUT_SIZE

Constructor Summary

Constructors

Constructor	Description
CircuitBuilder()	***************************************************************
CircuitBuilder(ControlPanelEditor ed)

Method Summary

Modifier and Type	Method	Description
protected String	checkForPortalIcons(OBlock block, String key)	Check that there is at least one PortalIcon. called from various _editFrame's
protected String	checkForPortals(OBlock block, String key)
protected String	checkForTrackIcons(OBlock block, String key)
protected void	closeCBWindow()
protected void	closeCircuitBuilder(OBlock block)
protected void	deletePortalIcon(PortalIcon icon)
protected boolean	doMouseClicked(List<Positionable> selections, JmriMouseEvent event)
boolean	doMouseDragged(Positionable selection, JmriMouseEvent event)	Prevent dragging when CircuitBuilder is in progress, except for PortalIcon.
protected boolean	doMousePressed(JmriMouseEvent event)	If CircuitBuilder is in progress, restore what editor nulls.
protected boolean	doMousePressed(JmriMouseEvent event, Positionable selection)	Make note of selection.
boolean	doMouseReleased(Positionable selection, boolean dragging)
protected static void	doSize(JComponent comp, int max, int min)
boolean	dragPortal()	Second call needed to only drag the portal icon and not entire selection
protected void	editCircuit(String title, boolean fromMenu)
protected void	editCircuitError(String sysName)
protected void	editCircuitPaths(String title, boolean fromMenu)
protected void	editPortalDirection(String title, boolean fromMenu)
protected void	editPortalError(String name)
protected void	editPortalError(OBlock block, Portal portal, PortalIcon icon)
protected void	editPortals(String title, boolean fromMenu)
protected void	editSignalFrame(String title, boolean fromMenu)
protected ArrayList<Positionable>	getCircuitIcons(OBlock block)
protected EditFrame	getEditFrame()
protected List<PortalIcon>	getPortalIcons(Portal portal)
protected HashMap<NamedBean,ArrayList<PositionableIcon>>	getSignalIconMap()
protected List<PositionableIcon>	getSignalIconMap(NamedBean mast)
protected Portal	getSignalPortal(NamedBean mast)
protected void	hidePortalIcons(boolean hideAll)
protected boolean	iconIntersectsBlock(Positionable icon, OBlock block)
protected static boolean	isTrack(Positionable pos)
protected static JPanel	makeBoxPanel(boolean vertical, JComponent textField, String label, String tooltip)
protected JMenu	makeMenu()	Makes menu for ControlPanelEditor.
protected static JPanel	makeTextBoxPanel(boolean vertical, JTextField textField, String label, boolean editable, String tooltip)
protected void	newCircuit()	************** Set up editing Frames ****************
protected void	openCBWindow()
protected boolean	portalIconMove(PortalIcon pos, int x, int y)
protected void	putSignalPortal(NamedBean mast, Portal portal)
protected boolean	queryConvertTrackIcons(OBlock block, String key)	Check if the block being edited has all its track icons converted to indicator icons If icons need conversion. ask if user wants to convert them
protected boolean	rectIntersectsBlock(Rectangle iconRect, OBlock block)
protected void	removeBlock(OBlock block)	Remove block, but keep the track icons.
protected boolean	saveSelectionGroup(ArrayList<Positionable> selectionGroup)	Keep selections when editing.
protected void	setCurrentBlock(OBlock b)
protected void	setIconGroup(OBlock block)	Edit frame closing, set block's icons to support OBlock's state changes

Methods inherited from class java.lang.Object

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

Field Details

STRUT_SIZE

static int STRUT_SIZE

_cbFrame

JmriJFrame _cbFrame

_editor

protected ControlPanelEditor _editor

_editGroupColor

public static final Color _editGroupColor

_pathColor

public static final Color _pathColor

_highlightColor

public static final Color _highlightColor

_saveSelectionGroup

ArrayList<Positionable> _saveSelectionGroup

************************** Mouse ************************

NONE

static int NONE

OBLOCK

static int OBLOCK

PORTAL

static int PORTAL

OPATH

static int OPATH

ARROW

static int ARROW

SIGNAL

static int SIGNAL

Constructor Details

CircuitBuilder

public CircuitBuilder()

***************************************************************

CircuitBuilder

public CircuitBuilder(ControlPanelEditor ed)

Method Details

makeMenu

protected JMenu makeMenu()

Makes menu for ControlPanelEditor. Called by ControlPanelEditor at init before contents have been loaded.

Returns:

the menu, created if needed

openCBWindow

protected void openCBWindow()

getEditFrame

protected EditFrame getEditFrame()

newCircuit

protected void newCircuit()

************** Set up editing Frames ****************

editCircuit

protected void editCircuit(String title,
 boolean fromMenu)

editCircuitError

protected void editCircuitError(String sysName)

editPortals

protected void editPortals(String title,
 boolean fromMenu)

editPortalError

protected void editPortalError(String name)

editPortalError

protected void editPortalError(OBlock block,
 Portal portal,
 PortalIcon icon)

editPortalDirection

protected void editPortalDirection(String title,
 boolean fromMenu)

editSignalFrame

protected void editSignalFrame(String title,
 boolean fromMenu)

editCircuitPaths

protected void editCircuitPaths(String title,
 boolean fromMenu)

setCurrentBlock

protected void setCurrentBlock(OBlock b)

hidePortalIcons

protected void hidePortalIcons(boolean hideAll)

setIconGroup

protected void setIconGroup(OBlock block)

Edit frame closing, set block's icons to support OBlock's state changes

Parameters:

block - OBlock to set icon selections into data maps

closeCircuitBuilder

protected void closeCircuitBuilder(OBlock block)

iconIntersectsBlock

protected boolean iconIntersectsBlock(Positionable icon,
 OBlock block)

rectIntersectsBlock

protected boolean rectIntersectsBlock(Rectangle iconRect,
 OBlock block)

getCircuitIcons

@Nonnull
protected ArrayList<Positionable> getCircuitIcons(OBlock block)

getPortalIcons

@Nonnull
protected List<PortalIcon> getPortalIcons(@Nonnull
 Portal portal)

getSignalIconMap

@Nonnull
protected List<PositionableIcon> getSignalIconMap(@Nonnull
 NamedBean mast)

getSignalIconMap

protected HashMap<NamedBean,ArrayList<PositionableIcon>> getSignalIconMap()

getSignalPortal

protected Portal getSignalPortal(@Nonnull
 NamedBean mast)

putSignalPortal

protected void putSignalPortal(@Nonnull
 NamedBean mast,
 Portal portal)

removeBlock

protected void removeBlock(OBlock block)

Remove block, but keep the track icons. Sets block reference in icon to null.

Parameters:

block - the block to remove

checkForPortals

protected String checkForPortals(@Nonnull
 OBlock block,
 String key)

checkForPortalIcons

protected String checkForPortalIcons(@Nonnull
 OBlock block,
 String key)

Check that there is at least one PortalIcon. called from various _editFrame's

Parameters:

block - check icons of this block

key - properties key

Returns:

true if at least one PortalIcon found

checkForTrackIcons

protected String checkForTrackIcons(@Nonnull
 OBlock block,
 String key)

deletePortalIcon

protected void deletePortalIcon(PortalIcon icon)

queryConvertTrackIcons

protected boolean queryConvertTrackIcons(@Nonnull
 OBlock block,
 String key)

Check if the block being edited has all its track icons converted to indicator icons If icons need conversion. ask if user wants to convert them

Parameters:

block - OBlock to check

key - properties key

Returns:

true if all track icons are IndicatorTrack icons

isTrack

protected static boolean isTrack(Positionable pos)

portalIconMove

protected boolean portalIconMove(PortalIcon pos,
 int x,
 int y)

Parameters:

pos - PortalIcon attempting a move. allow or disallow

x - new x position

y - new y position

Returns:

allow, or not

saveSelectionGroup

protected boolean saveSelectionGroup(ArrayList<Positionable> selectionGroup)

Keep selections when editing. Editor calls at entry to mousePressed(). CircuitBuilder keeps is own concept of what is "selected".

Parameters:

selectionGroup - the selection group to save

Returns:

true if retaining a reference to a frame

doMousePressed

protected boolean doMousePressed(JmriMouseEvent event,
 Positionable selection)

Make note of selection.

Parameters:

event - the triggering event

selection - the selection

Returns:

true

doMousePressed

protected boolean doMousePressed(JmriMouseEvent event)

If CircuitBuilder is in progress, restore what editor nulls.

Parameters:

event - the triggering event

Returns:

true if the selection group is restored; false otherwise

doMouseReleased

public boolean doMouseReleased(Positionable selection,
 boolean dragging)

doMouseClicked

protected boolean doMouseClicked(List<Positionable> selections,
 JmriMouseEvent event)

doMouseDragged

public boolean doMouseDragged(Positionable selection,
 JmriMouseEvent event)

Prevent dragging when CircuitBuilder is in progress, except for PortalIcon.

Parameters:

selection - the item(s) being dragged

event - the triggering event

Returns:

true to prevent dragging; false otherwise

dragPortal

public boolean dragPortal()

Second call needed to only drag the portal icon and not entire selection

Returns:

true if portal frame is open

closeCBWindow

protected void closeCBWindow()

doSize

protected static void doSize(JComponent comp,
 int max,
 int min)

makeTextBoxPanel

protected static JPanel makeTextBoxPanel(boolean vertical,
 JTextField textField,
 String label,
 boolean editable,
 String tooltip)

makeBoxPanel

protected static JPanel makeBoxPanel(boolean vertical,
 JComponent textField,
 String label,
 String tooltip)