Package jmri.jmrit.beantable.block

Class BlockTableDataModel

java.lang.Object

javax.swing.table.AbstractTableModel

jmri.jmrit.beantable.BeanTableDataModel<Block>

jmri.jmrit.beantable.block.BlockTableDataModel

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.swing.table.TableModel

public class BlockTableDataModel
extends BeanTableDataModel<Block>

Data model for a Block Table. Code originally within BlockTableAction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BlockTableDataModel.ImageIconRenderer	Visualize state in table as a graphic, customized for Blocks (2 states).

Nested classes/interfaces inherited from class jmri.jmrit.beantable.BeanTableDataModel

BeanTableDataModel.BeanTableTooltipHeaderRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static int	COLUMNCOUNT
static int	CURRENTREPCOL
static int	CURVECOL
static int	DIRECTIONCOL
static int	EDITCOL
static int	GHOSTCOL
static int	LENGTHCOL
static int	PERMISCOL
static int	REPORTERCOL
static int	SENSORCOL
static int	SPEEDCOL
static int	STATECOL

Fields inherited from class jmri.jmrit.beantable.BeanTableDataModel

COMMENTCOL, DELETECOL, NUMCOLUMN, SYSNAMECOL, sysNameList, USERNAMECOL, VALUECOL

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor	Description
BlockTableDataModel(Manager<Block> mgr)

Method Summary

Modifier and Type	Method	Description
void	clickOn(Block t)	Process a click on The value cell.
protected void	configStateColumn(javax.swing.JTable table)	Customize the block table State column to show an appropriate graphic for the block occupancy state if _graphicState = true, or (default) just show the localized state text when the TableDataModel is being called from ListedTableAction.
javax.swing.JButton	configureButton()
void	configureTable(javax.swing.JTable table)	Configure a table to have our standard rows and columns.
void	configValueColumn(javax.swing.JTable table)
(package private) void	editButton(Block b)
Block	getBySystemName(java.lang.String name)
Block	getByUserName(java.lang.String name)
java.lang.String	getCellToolTip(javax.swing.JTable table, int modelRow, int modelCol)	Display the comment text for the current row as a tool tip.
java.lang.Class<?>	getColumnClass(int col)
int	getColumnCount()	Get Column Count INCLUDING Bean Property Columns.
java.lang.String	getColumnName(int col)
Manager<Block>	getManager()	Get the Table Model Bean Manager.
protected java.lang.String	getMasterClassName()
int	getPreferredWidth(int col)
java.lang.String	getValue(java.lang.String name)	Get the current Bean state value in human readable form.
java.lang.Object	getValueAt(int row, int col)	SYSNAMECOL returns the actual Bean, NOT the System Name.
boolean	isCellEditable(int row, int col)
javax.swing.JTable	makeJTable(java.lang.String name, javax.swing.table.TableModel model, javax.swing.RowSorter<? extends javax.swing.table.TableModel> sorter)	Create and configure a new table using the given model and row sorter.
protected boolean	matchPropertyName(java.beans.PropertyChangeEvent e)	returns true for all Block properties.
void	propertyChange(java.beans.PropertyChangeEvent e)
void	setDefaultSpeeds(javax.swing.JFrame frame)
void	setMetric(boolean boo)	Set and refresh the UI to use Metric or Imperial values.
void	setValueAt(java.lang.Object value, int row, int col)

Methods inherited from class jmri.jmrit.beantable.BeanTableDataModel

addMouseListenerToHeader, configDeleteColumn, configureJTable, copySystemName, copyUserName, deleteBean, dispose, doDelete, editComment, exportToCSV, formatToolTip, getBeanType, getDisplayDeleteMsg, getFilter, getHeaderTooltip, getPropertyColumnCount, getPropertyColumnDescriptor, getRowCount, isClearUserNameAllowed, moveBean, persistTable, printColumns, printTable, removeName, renameBean, setColumnIdentities, setColumnToHoldButton, setDisplayDeleteMsg, setFilter, setManager, setPropertyColumnsVisible, showPopup, showTableHeaderPopup, stopPersistingTable, updateNameList

Methods inherited from class javax.swing.table.AbstractTableModel

addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getListeners, getTableModelListeners, removeTableModelListener

Methods inherited from class java.lang.Object

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

Field Detail

EDITCOL

public static final int EDITCOL

See Also:

Constant Field Values

DIRECTIONCOL

public static final int DIRECTIONCOL

See Also:

Constant Field Values

LENGTHCOL

public static final int LENGTHCOL

See Also:

Constant Field Values

CURVECOL

public static final int CURVECOL

See Also:

Constant Field Values

STATECOL

public static final int STATECOL

See Also:

Constant Field Values

SENSORCOL

public static final int SENSORCOL

See Also:

Constant Field Values

REPORTERCOL

public static final int REPORTERCOL

See Also:

Constant Field Values

CURRENTREPCOL

public static final int CURRENTREPCOL

See Also:

Constant Field Values

PERMISCOL

public static final int PERMISCOL

See Also:

Constant Field Values

SPEEDCOL

public static final int SPEEDCOL

See Also:

Constant Field Values

GHOSTCOL

public static final int GHOSTCOL

See Also:

Constant Field Values

COLUMNCOUNT

public static final int COLUMNCOUNT

See Also:

Constant Field Values

Constructor Detail

BlockTableDataModel

public BlockTableDataModel(Manager<Block> mgr)

Method Detail

getValue

public java.lang.String getValue(java.lang.String name)

Description copied from class: BeanTableDataModel

Get the current Bean state value in human readable form.

Specified by:

getValue in class BeanTableDataModel<Block>

Parameters:

name - System name of Bean.

Returns:

state value in localised human readable form.

getManager

public Manager<Block> getManager()

Description copied from class: BeanTableDataModel

Get the Table Model Bean Manager. In many cases, especially around Model startup, this will be the Proxy Manager, which is then changed to the hardware specific manager.

Specified by:

getManager in class BeanTableDataModel<Block>

Returns:

current Manager in use by the Model.

getBySystemName

public Block getBySystemName(@Nonnull
                             java.lang.String name)

Specified by:

getBySystemName in class BeanTableDataModel<Block>

getByUserName

public Block getByUserName(@Nonnull
                           java.lang.String name)

Specified by:

getByUserName in class BeanTableDataModel<Block>

getMasterClassName

protected java.lang.String getMasterClassName()

Specified by:

getMasterClassName in class BeanTableDataModel<Block>

clickOn

public void clickOn(Block t)

Description copied from class: BeanTableDataModel

Process a click on The value cell.

Specified by:

clickOn in class BeanTableDataModel<Block>

Parameters:

t - the Bean that has been clicked.

getColumnCount

public int getColumnCount()

Description copied from class: BeanTableDataModel

Get Column Count INCLUDING Bean Property Columns.

Specified by:

getColumnCount in interface javax.swing.table.TableModel

Overrides:

getColumnCount in class BeanTableDataModel<Block>

getValueAt

public java.lang.Object getValueAt(int row,
                                   int col)

Description copied from class: BeanTableDataModel

SYSNAMECOL returns the actual Bean, NOT the System Name.

Specified by:

getValueAt in interface javax.swing.table.TableModel

Overrides:

getValueAt in class BeanTableDataModel<Block>

setValueAt

public void setValueAt(java.lang.Object value,
                       int row,
                       int col)

Description copied from class: BeanTableDataModel

Specified by:

setValueAt in interface javax.swing.table.TableModel

Overrides:

setValueAt in class BeanTableDataModel<Block>

getColumnName

public java.lang.String getColumnName(int col)

Description copied from class: BeanTableDataModel

Specified by:

getColumnName in interface javax.swing.table.TableModel

Overrides:

getColumnName in class BeanTableDataModel<Block>

getColumnClass

public java.lang.Class<?> getColumnClass(int col)

Description copied from class: BeanTableDataModel

Specified by:

getColumnClass in interface javax.swing.table.TableModel

Overrides:

getColumnClass in class BeanTableDataModel<Block>

getPreferredWidth

public int getPreferredWidth(int col)

Overrides:

getPreferredWidth in class BeanTableDataModel<Block>

configValueColumn

public void configValueColumn(javax.swing.JTable table)

Overrides:

configValueColumn in class BeanTableDataModel<Block>

isCellEditable

public boolean isCellEditable(int row,
                              int col)

Description copied from class: BeanTableDataModel

Specified by:

isCellEditable in interface javax.swing.table.TableModel

Overrides:

isCellEditable in class BeanTableDataModel<Block>

makeJTable

public javax.swing.JTable makeJTable(@Nonnull
                                     java.lang.String name,
                                     @Nonnull
                                     javax.swing.table.TableModel model,
                                     @CheckForNull
                                     javax.swing.RowSorter<? extends javax.swing.table.TableModel> sorter)

Description copied from class: BeanTableDataModel

Create and configure a new table using the given model and row sorter.

Overrides:

makeJTable in class BeanTableDataModel<Block>

Parameters:

name - the name of the table

model - the data model for the table

sorter - the row sorter for the table; if null, the table will not be sortable

Returns:

the table

configureTable

public void configureTable(javax.swing.JTable table)

Description copied from class: BeanTableDataModel

Configure a table to have our standard rows and columns. This is optional, in that other table formats can use this table model. But we put it here to help keep it consistent. This also persists the table user interface state.

Overrides:

configureTable in class BeanTableDataModel<Block>

Parameters:

table - JTable to configure

editButton

void editButton(Block b)

matchPropertyName

protected boolean matchPropertyName(java.beans.PropertyChangeEvent e)

returns true for all Block properties.

Overrides:

matchPropertyName in class BeanTableDataModel<Block>

Parameters:

e - property event that has changed.

Returns:

true as all matched.

configureButton

public javax.swing.JButton configureButton()

Overrides:

configureButton in class BeanTableDataModel<Block>

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Description copied from class: BeanTableDataModel

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Overrides:

propertyChange in class BeanTableDataModel<Block>

setMetric

public void setMetric(boolean boo)

Set and refresh the UI to use Metric or Imperial values.

Parameters:

boo - true if metric, false for Imperial.

setDefaultSpeeds

public void setDefaultSpeeds(javax.swing.JFrame frame)

configStateColumn

protected void configStateColumn(javax.swing.JTable table)

Customize the block table State column to show an appropriate graphic for the block occupancy state if _graphicState = true, or (default) just show the localized state text when the TableDataModel is being called from ListedTableAction.

Parameters:

table - a JTable of Blocks

getCellToolTip

public java.lang.String getCellToolTip(javax.swing.JTable table,
                                       int modelRow,
                                       int modelCol)

Description copied from class: BeanTableDataModel

Display the comment text for the current row as a tool tip. Most of the bean tables use the standard model with comments in column 3.

Overrides:

getCellToolTip in class BeanTableDataModel<Block>

Parameters:

table - The current table.

modelRow - The current row.

modelCol - The current column.

Returns:

a formatted tool tip or null if there is none.