Package jmri.jmrit.beantable.oblock

Class TableFrames

java.lang.Object

jmri.jmrit.beantable.oblock.TableFrames

All Implemented Interfaces:

EventListener, InternalFrameListener, Disposable

public class TableFrames
extends Object
implements InternalFrameListener, Disposable

GUI to define OBlocks.

Core code can be used with two interfaces:

• original "desktop" InternalFrames (displays as InternalJFrames inside a JmriJFrame)
• JMRI standard Tabbed tables (displays as Js inside a ListedTableFrame)

The _tabbed field decides, it is set in prefs (restart required). TableFrames itself has no UI. 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TableFrames.BlockPathFrame
static class	TableFrames.BlockPathJPanel
protected static class	TableFrames.PathTurnoutFrame	********************* Path-Turnout Frame ***********************************
protected static class	TableFrames.PathTurnoutJPanel	********************* Path-Turnout JPanel class for _tabbed *****************

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ROW_HEIGHT
protected static final String	SET_CLOSED
protected static final String	SET_THROWN
static final int	STRUT_SIZE

Constructor Summary

Constructors

Constructor	Description
TableFrames()
TableFrames(String actionName)

Method Summary

Modifier and Type	Method	Description
(package private) void	addCloseListener(JmriJFrame desktop)
JMenuBar	addMenus(JMenuBar mBar)
protected void	addTurnoutPane(OPath path, PathTurnoutTableModel pathTurnoutModel)	Add new Turnout pane, called from makePathTurnoutPanel on _tabbed interface.
protected JInternalFrame	buildFrame(AbstractTableModel tableModel, String title, String prompt)	Wrapper for shared code around each Table in a JInternal window on _desktop interface.
void	dispose()	Called when disposing of a disposable.
protected void	disposeBlockPathFrame(OBlock block)
BlockPathTableModel	getBlockPathTableModel(OBlock block)
protected JmriJFrame	getDesktopFrame()	Get the JFrame containig all UI windows.
OBlockTableModel	getOblockTableModel()
JMenu	getOptionMenu()
PortalTableModel	getPortalTableModel()
BlockPortalTableModel	getPortalXRefTableModel()
JMenu	getPrintMenuItems(JTable oBlockTable, JTable portalTable, JTable signalTable, JTable blockPortalTable)
SignalTableModel	getSignalTableModel()
JMenu	getTablesMenu()
protected void	importBlocks()	Convert a copy of your current JMRI Blocks to OBlocks and connect them with Portals and Paths.
void	initComponents()
void	internalFrameActivated(InternalFrameEvent e)
void	internalFrameClosed(InternalFrameEvent e)
void	internalFrameClosing(InternalFrameEvent e)
void	internalFrameDeactivated(InternalFrameEvent e)
void	internalFrameDeiconified(InternalFrameEvent e)
void	internalFrameIconified(InternalFrameEvent e)
void	internalFrameOpened(InternalFrameEvent e)
protected boolean	isPathEdit()
protected TableFrames.BlockPathJPanel	makeBlockPathEditPanel(OBlock block)
protected TableFrames.BlockPathFrame	makeBlockPathFrame(OBlock block)
protected JTable	makeBlockPathTable(BlockPathTableModel _model)
protected JPanel	makeBlockPathTablePanel(BlockPathTableModel _model)
protected JTable	makeBlockPortalTable(BlockPortalTableModel model)
protected JTable	makeOBlockTable(OBlockTableModel model)
protected TableFrames.PathTurnoutFrame	makePathTurnoutFrame(OBlock block, String pathName)
protected String	makePathTurnoutName(String blockSysName, String pathName)	Create a coded id for a path turnout.
protected TableFrames.PathTurnoutJPanel	makePathTurnoutPanel(OBlock block, String pathName)
protected JTable	makePathTurnoutTable(PathTurnoutTableModel model)
protected JTable	makePortalTable(PortalTableModel model)
protected JTable	makeSignalTable(SignalTableModel model)
protected void	openBlockPathFrame(String blockSystemName)	Open a block-specific Block-Path table in _desktop interface.
void	openBlockPathPane(String blockSystemName, String editorTabName)
protected boolean	openOBlockEditor(String blockSystemName, String tabname)
protected boolean	openPathEditor(String blockName, String pathName, BlockPathTableModel bpmodel)	Open the Edit Path panel for _tabbed.
protected void	openPathTurnoutEditor(String pathTurnoutName)	Open a block-specific PathTurnouts edit pane as a JmriJFrame for _tabbed from menu.
void	openPathTurnoutEditPane(String pathTurnoutName)
protected void	openPathTurnoutFrame(String pathTurnoutName)	Open a block-specific PathTurnouts table as a JInternalFrame for _desktop from BlockPathTableModel
protected void	setPathEdit(boolean edit)
protected void	setShowWarnings(String cmd)
protected void	updateOBlockTablesMenu()	Fill in the Open/Hide Tables menu on tablesMenu.
protected int	verifyWarning(String message)

Methods inherited from class java.lang.Object

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

Field Details

ROW_HEIGHT

public static final int ROW_HEIGHT

STRUT_SIZE

public static final int STRUT_SIZE

See Also:

• Constant Field Values

SET_CLOSED

protected static final String SET_CLOSED

SET_THROWN

protected static final String SET_THROWN

Constructor Details

TableFrames

public TableFrames()

TableFrames

public TableFrames(String actionName)

Method Details

getOblockTableModel

public OBlockTableModel getOblockTableModel()

getPortalTableModel

public PortalTableModel getPortalTableModel()

getPortalXRefTableModel

public BlockPortalTableModel getPortalXRefTableModel()

getBlockPathTableModel

public BlockPathTableModel getBlockPathTableModel(OBlock block)

getSignalTableModel

public SignalTableModel getSignalTableModel()

initComponents

public void initComponents()

addMenus

public JMenuBar addMenus(JMenuBar mBar)

getPrintMenuItems

public JMenu getPrintMenuItems(JTable oBlockTable,
 JTable portalTable,
 JTable signalTable,
 JTable blockPortalTable)

getOptionMenu

public JMenu getOptionMenu()

getTablesMenu

public JMenu getTablesMenu()

getDesktopFrame

protected JmriJFrame getDesktopFrame()

Get the JFrame containig all UI windows.

Returns:

the contentframe

importBlocks

protected void importBlocks()
                     throws IllegalArgumentException

Convert a copy of your current JMRI Blocks to OBlocks and connect them with Portals and Paths. Accessed from the Options menu.

Throws:

IllegalArgumentException - exception

setShowWarnings

protected void setShowWarnings(String cmd)

addCloseListener

void addCloseListener(JmriJFrame desktop)

updateOBlockTablesMenu

protected void updateOBlockTablesMenu()

Fill in the Open/Hide Tables menu on tablesMenu.

openPathTurnoutEditPane

public void openPathTurnoutEditPane(String pathTurnoutName)

buildFrame

protected JInternalFrame buildFrame(AbstractTableModel tableModel,
 String title,
 String prompt)

Wrapper for shared code around each Table in a JInternal window on _desktop interface.

Parameters:

tableModel - underlying model for the table

title - text displayed as title of frame

prompt - text below bottom line

Returns:

iframe to put on _desktop interface

makeOBlockTable

protected JTable makeOBlockTable(OBlockTableModel model)

openOBlockEditor

protected boolean openOBlockEditor(String blockSystemName,
 String tabname)

openPathEditor

protected boolean openPathEditor(@Nonnull
 String blockName,
 @CheckForNull
 String pathName,
 BlockPathTableModel bpmodel)

Open the Edit Path panel for _tabbed. Compare with openOBlockEditor(block, selectedtabname) and OBlockTableAction.

Parameters:

blockName - system or user name of the owning oblock

pathName - name of the path under edit, or null to create a new path

bpmodel - blockpathtablemodel that should be informed about changes

Returns:

true if successful

makePortalTable

protected JTable makePortalTable(PortalTableModel model)

makeBlockPortalTable

protected JTable makeBlockPortalTable(BlockPortalTableModel model)

makeSignalTable

protected JTable makeSignalTable(SignalTableModel model)

openBlockPathPane

public void openBlockPathPane(String blockSystemName,
 String editorTabName)

openBlockPathFrame

protected void openBlockPathFrame(String blockSystemName)

Open a block-specific Block-Path table in _desktop interface.

Parameters:

blockSystemName - of the OBlock

disposeBlockPathFrame

protected void disposeBlockPathFrame(OBlock block)

makeBlockPathFrame

protected TableFrames.BlockPathFrame makeBlockPathFrame(@Nonnull
 OBlock block)

makeBlockPathEditPanel

protected TableFrames.BlockPathJPanel makeBlockPathEditPanel(@Nonnull
 OBlock block)

setPathEdit

protected void setPathEdit(boolean edit)

isPathEdit

protected boolean isPathEdit()

dispose

public void dispose()

Description copied from interface: Disposable

Called when disposing of a disposable.

Note there are no assurances this method will not be called multiple times against a single instance of this Disposable. It is the responsibility of this Disposable to protect itself and the application from ensuring that calling this method multiple times has no unwanted side effects.

Specified by:

dispose in interface Disposable

makeBlockPathTablePanel

protected JPanel makeBlockPathTablePanel(BlockPathTableModel _model)

makeBlockPathTable

protected JTable makeBlockPathTable(BlockPathTableModel _model)

makePathTurnoutFrame

protected TableFrames.PathTurnoutFrame makePathTurnoutFrame(OBlock block,
 String pathName)

makePathTurnoutPanel

protected TableFrames.PathTurnoutJPanel makePathTurnoutPanel(@Nonnull
 OBlock block,
 @CheckForNull
 String pathName)

makePathTurnoutTable

protected JTable makePathTurnoutTable(PathTurnoutTableModel model)

makePathTurnoutName

protected String makePathTurnoutName(String blockSysName,
 String pathName)

Create a coded id for a path turnout.

Parameters:

blockSysName - oblock system name

pathName - the path through the oblock for which to display turnouts set

Returns:

name of the pathTurnout, example "%path 1-3&block-1"

openPathTurnoutFrame

protected void openPathTurnoutFrame(String pathTurnoutName)

Open a block-specific PathTurnouts table as a JInternalFrame for _desktop from BlockPathTableModel

Parameters:

pathTurnoutName - name of turnout configured on Path

openPathTurnoutEditor

protected void openPathTurnoutEditor(String pathTurnoutName)

Open a block-specific PathTurnouts edit pane as a JmriJFrame for _tabbed from menu. TODO fix menu access to pathturnouts on _tabbed in ListedTableView, single table menus OK

Parameters:

pathTurnoutName - name of turnout configured on Path

addTurnoutPane

protected void addTurnoutPane(OPath path,
 PathTurnoutTableModel pathTurnoutModel)

Add new Turnout pane, called from makePathTurnoutPanel on _tabbed interface.

Parameters:

path - to link this turnout setting to

pathTurnoutModel - displayed table of turnouts currently set on this path

verifyWarning

protected int verifyWarning(String message)

internalFrameClosing

public void internalFrameClosing(InternalFrameEvent e)

Specified by:

internalFrameClosing in interface InternalFrameListener

internalFrameClosed

public void internalFrameClosed(InternalFrameEvent e)

Specified by:

internalFrameClosed in interface InternalFrameListener

internalFrameOpened

public void internalFrameOpened(InternalFrameEvent e)

Specified by:

internalFrameOpened in interface InternalFrameListener

internalFrameIconified

public void internalFrameIconified(InternalFrameEvent e)

Specified by:

internalFrameIconified in interface InternalFrameListener

internalFrameDeiconified

public void internalFrameDeiconified(InternalFrameEvent e)

Specified by:

internalFrameDeiconified in interface InternalFrameListener

internalFrameActivated

public void internalFrameActivated(InternalFrameEvent e)

Specified by:

internalFrameActivated in interface InternalFrameListener

internalFrameDeactivated

public void internalFrameDeactivated(InternalFrameEvent e)

Specified by:

internalFrameDeactivated in interface InternalFrameListener