Package jmri.jmrit.roster.swing.functiontable

Class FunctionTableModel

java.lang.Object

javax.swing.table.AbstractTableModel

jmri.jmrit.roster.swing.functiontable.FunctionTableModel

All Implemented Interfaces:

PropertyChangeListener, Serializable, EventListener, TableModel

public class FunctionTableModel
extends AbstractTableModel
implements PropertyChangeListener

A TableModel that provides a way for the user to edit details of functions of a decoder in the roster. It is used in the FunctionLabelPane. 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.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COL_DO
static final int	COL_FN
static final int	COL_LA
static final int	COL_LK
static final int	COL_OF
static final int	COL_ON
static final int	COL_SH
static final int	COL_VI
static final String	FB_ORDER_ATTR
static final int	NBCOL
static final int	NBVISCOL

Fields inherited from class javax.swing.table.AbstractTableModel

listenerList

Constructor Summary

Constructors

Constructor	Description
FunctionTableModel(RosterEntry re)	Create a new FunctionTableModel for a COPY of the given RosterEntry,

Method Summary

Modifier and Type	Method	Description
Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
String	getColumnName(int columnIndex)
int	getFnForRow(int rowIndex)	Return the function number for a row index.
EditableResizableImagePanel	getFunctionImagePanel(int fn)	Return the EditableResizableImagePanel for the function image (off) for a function number.
EditableResizableImagePanel	getFunctionSelectedImagePanel(int fn)	Return the EditableResizableImagePanel for the function image (on) for a function number.
String	getLabel(int fn)	Return the function label for a function number
List<String>	getLabels()	Return list of all function label ordered by function number
boolean	getLockable(int fn)	Return the function lockable flag for a function number
RosterEntry	getRosterEntry()	Returns the RosterEntry being edited by that table model
RosterFunctionEntry	getRosterFunctionEntryAtRow(int row)
int	getRowCount()
int	getRowForFn(int fn)	Return the row index for a function number.
Object	getValueAt(int rowIndex, int columnIndex)
String	getVisibilityOrderAttributeString()	Return the function visibility order attribute string to be stored in the RosterEntry.
boolean	isCellEditable(int rowIndex, int columnIndex)
void	moveRow(int from, int to)	Move one row from first ndex to second index.
void	propertyChange(PropertyChangeEvent evt)
void	reset(RosterFunctionEntry[] fnEntries, String shuntFn, String fnDisplayOrder)	Reset the FunctionTableModel from the given inputs
void	setLabel(int fn, String label)	Set the function label for a function number
void	setLockable(int fn, boolean lockable)	Set a function lockable flag for a function number
void	setRosterEntry(RosterEntry re)	Update the FunctionTableModel with a COPY of the given RosterEntry,
void	setRosterFunctionEntryAtRow(RosterFunctionEntry rfe, int rowIndex)
void	setValueAt(Object value, int rowIndex, int columnIndex)

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 Details

FB_ORDER_ATTR

public static final String FB_ORDER_ATTR

See Also:

• Constant Field Values

COL_FN

public static final int COL_FN

See Also:

• Constant Field Values

COL_LK

public static final int COL_LK

See Also:

• Constant Field Values

COL_OF

public static final int COL_OF

See Also:

• Constant Field Values

COL_ON

public static final int COL_ON

See Also:

• Constant Field Values

COL_VI

public static final int COL_VI

See Also:

• Constant Field Values

COL_SH

public static final int COL_SH

See Also:

• Constant Field Values

COL_LA

public static final int COL_LA

See Also:

• Constant Field Values

NBCOL

public static final int NBCOL

See Also:

• Constant Field Values

NBVISCOL

public static final int NBVISCOL

See Also:

• Constant Field Values

COL_DO

public static final int COL_DO

See Also:

• Constant Field Values

Constructor Details

FunctionTableModel

public FunctionTableModel(RosterEntry re)

Create a new FunctionTableModel for a COPY of the given RosterEntry,

Parameters:

re - the RosterEntry on which to base this model. A copy of the RosterEntry is made so that changes to the model do not affect the original RosterEntry.

Method Details

setRosterEntry

public void setRosterEntry(RosterEntry re)

Update the FunctionTableModel with a COPY of the given RosterEntry,

Parameters:

re - the RosterEntry on which to base this model. A copy of the RosterEntry is made so that changes to the model do not affect the original RosterEntry.

reset

public void reset(RosterFunctionEntry[] fnEntries,
 String shuntFn,
 String fnDisplayOrder)

Reset the FunctionTableModel from the given inputs

Parameters:

fnEntries - an array of RosterFunctionEntry

shuntFn - the shunting function string, if any, or null

fnDisplayOrder - the function display order JSON array, if any, or null

getRosterFunctionEntryAtRow

public RosterFunctionEntry getRosterFunctionEntryAtRow(int row)

setRosterFunctionEntryAtRow

public void setRosterFunctionEntryAtRow(RosterFunctionEntry rfe,
 int rowIndex)

getFunctionImagePanel

public EditableResizableImagePanel getFunctionImagePanel(int fn)

Return the EditableResizableImagePanel for the function image (off) for a function number.

Parameters:

fn - the function number

Returns:

the EditableResizableImagePanel

getFunctionSelectedImagePanel

public EditableResizableImagePanel getFunctionSelectedImagePanel(int fn)

Return the EditableResizableImagePanel for the function image (on) for a function number.

Parameters:

fn - the function number

Returns:

the EditableResizableImagePanel

getFnForRow

public int getFnForRow(int rowIndex)

Return the function number for a row index.

Parameters:

rowIndex - the row index

Returns:

the function number, -1 if out of bounds

getRowForFn

public int getRowForFn(int fn)

Return the row index for a function number.

Parameters:

fn - the function number

Returns:

the row index, -1 if out of bounds

moveRow

public void moveRow(int from,
 int to)

Move one row from first ndex to second index. Lines between the two indexes are shifted up or down to make room for the moved line.

Parameters:

from - moving from this index

to - moving to this index

getVisibilityOrderAttributeString

public String getVisibilityOrderAttributeString()

Return the function visibility order attribute string to be stored in the RosterEntry. This is a JSON string representing the rowFn array, or null if the order is the default order (i.e. rowFn[i] == i for all i). At index i is the function number of the function to be shown at that position in the GUI (Throttle for instance).. The function number is the index in the RosterEntry function list.

Returns:

the attriute string to be stored in the RosterEntry, or null if not needed

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractTableModel

getValueAt

public Object getValueAt(int rowIndex,
 int columnIndex)

Specified by:

getValueAt in interface TableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
 int columnIndex)

Specified by:

isCellEditable in interface TableModel

Overrides:

isCellEditable in class AbstractTableModel

setValueAt

public void setValueAt(Object value,
 int rowIndex,
 int columnIndex)

Specified by:

setValueAt in interface TableModel

Overrides:

setValueAt in class AbstractTableModel

getColumnName

public String getColumnName(int columnIndex)

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractTableModel

getLabels

public List<String> getLabels()

Return list of all function label ordered by function number

Returns:

a list of String

getLabel

public String getLabel(int fn)

Return the function label for a function number

Parameters:

fn - the function number

Returns:

a list of String

setLabel

public void setLabel(int fn,
 String label)

Set the function label for a function number

Parameters:

fn - the function number

label - the label to set

getLockable

public boolean getLockable(int fn)

Return the function lockable flag for a function number

Parameters:

fn - the function number

Returns:

the lockable flag

setLockable

public void setLockable(int fn,
 boolean lockable)

Set a function lockable flag for a function number

Parameters:

fn - the function number

lockable - the lockable flag to set

getRosterEntry

public RosterEntry getRosterEntry()

Returns the RosterEntry being edited by that table model

Returns:

the RosterEntry being edited by that table model

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener