com.zfqjava.swing
Class DefaultDataGridModel

java.lang.Object
  com.zfqjava.swing.AbstractDataGridModel
      com.zfqjava.swing.DefaultDataGridModel

All Implemented Interfaces:

CellSpanModel, DataGridModel, Serializable, TableModel

public class DefaultDataGridModel
extends AbstractDataGridModel
implements Serializable

DefaultDataGridModel provides a default data grid model.

Note:All methods with Cell parameter pass null value will throws java.lang.NullPointerException.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.zfqjava.swing.AbstractDataGridModel

listenerList

Constructor Summary

DefaultDataGridModel()
Constructs a data grid model with 0 rows and 0 cols.

DefaultDataGridModel(int rowCount, int columnCount)
Constructs a data grid model with rowCount rows and columnCount columns.

Method Summary

void	addColumn(int firstColumn, int lastColumn, List[] l) Adds column from firstColumn to lastColumn use the specified list data.
void	addColumn(int columnIndex, List l) Adds a column at the columnIndex of the model use the specified list.
void	addColumn(List l) Adds a column at the end of the model use the specified list.
void	addRow(int firstRow, int lastRow, List[] l) Adds row from firstRow to lastRow use the specified list.
void	addRow(int rowIndex, List l) Adds a row at the rowIndex of the model use the specified list.
void	addRow(List l) Adds a row to the end of the model use the specified list.
boolean	clear(Cell c) Clears the cell data for the specified cell area c.
boolean	clearCellAttributes(Cell c) Clears the cell attributes for the specified cell area c.
boolean	clearCellClass(Cell c) Clears the cell class for the specified cell area c.
boolean	clearCellEditable(Cell c) Clears the cell editable for the specified cell area c.
boolean	clearValue(Cell c) Clears the cell value for the specified cell area c.
boolean	equals(Object o)
boolean	fill(Cell c, TableModel model) Fills the cell area c use the specified data.
boolean	fillCellAttributes(Cell c, List[] l) Fills the cell attributes of the cell area c use the specified data.
boolean	fillCellClass(Cell c, List[] l) Fills the cell class of the cell area c use the specified data.
boolean	fillCellEditable(Cell c, List[] l) Fills the cell editable of the cell area c use the specified data.
boolean	fillValue(Cell c, List[] l) Fills the value of the cell area c use the specified data.
AttributeSet	getCellAttributes(int rowIndex, int columnIndex) Returns the cell attributes.
Class	getCellClass(int rowIndex, int columnIndex) Returns the cell class.
Boolean	getCellEditable(int rowIndex, int columnIndex) Returns the editable property for the specified cell at rowIndex and columnIndex.
Class	getColumnClass(int columnIndex) Returns the most specific superclass for all the cell values in the column.
int	getColumnCount() Returns the number of columns in the model.
String	getColumnName(int columnIndex) Returns the name of the column at columnIndex.
Cell[]	getFormulaCells() Returns all formula cells.
int	getRowCount() Returns the number of rows in the model.
Object	getValueAt(int rowIndex, int columnIndex) Returns the value for the cell at columnIndex and rowIndex.
int	hashCode()
boolean	isCellEditable(int rowIndex, int columnIndex) Returns true if the cell at rowIndex and columnIndex is editable.
boolean	move(Cell from, Cell to) Moves the cell area from to to.
void	removeColumn(int columnIndex) Removes a column at the columnIndex of the model.
void	removeColumn(int firstColumn, int lastColumn) Removes column from firstColumn to lastColumn.
void	removeRow(int rowIndex) Removes a row at the rowIndex of the model.
void	removeRow(int firstRow, int lastRow) Removes row from firstRow to lastRow
void	setCellAttributes(AttributeSet attributes, Cell c) Sets the cell attributes.
void	setCellAttributes(AttributeSet attributes, int rowIndex, int columnIndex) Sets the cell attributes.
void	setCellClass(Class cc, Cell c) Sets the cell class.
void	setCellClass(Class c, int rowIndex, int columnIndex) Sets the cell class.
void	setCellEditable(boolean editable, Cell c) Sets the cell editable.
void	setCellEditable(boolean editable, int rowIndex, int columnIndex) Sets the editable value for the specified cell at rowIndex and columnIndex.
void	setColumnClass(Class c, int columnIndex) Sets the column class for the specified columnIndex.
void	setColumnCount(int columnCount) Sets the number of columns in the model.
void	setColumnName(String name, int columnIndex) Sets the column name for the specified columnIndex.
void	setRowCount(int rowCount) Sets the number of rows in the model.
void	setValueAt(Object aValue, Cell c) Sets the cell value.
void	setValueAt(Object aValue, int rowIndex, int columnIndex) Sets the value in the cell at columnIndex and rowIndex to aValue.
boolean	sort(Cell c, boolean ascending) Sorts the cell area.Returns true if this model changes as a result of the call.
boolean	sort(Cell c, boolean[] orders, int[] keys, boolean byColumn) Sorts the cell area.
boolean	sort(Cell c, boolean[] orders, int[] keys, boolean byColumn, boolean ignoreBlank) Sorts the cell area.
boolean	sort(Cell c, boolean ascending, int index, boolean byColumn) Sorts the cell area.
boolean	sort(Cell c, boolean ascending, int index, boolean byColumn, boolean ignoreBlank) Sorts the cell area.
DataGridModel	toModel(Cell c) Converts the cell area to the model.
String	toString()

Methods inherited from class com.zfqjava.swing.AbstractDataGridModel

addCellSpanListener, addDataGridModelListener, addTableModelListener, addUndoableEditListener, calculateFormula, endUndoableEdit, fireCellAttributesChanged, fireCellAttributesChanged, fireCellChanged, fireCellChanged, fireCellChanged, fireCellClassChanged, fireCellClassChanged, fireCellEditableChanged, fireCellEditableChanged, fireCellMerged, fireCellSpanChanged, fireCellSpanChanged, fireCellSplitted, fireCellValueChanged, fireCellValueChanged, fireTableCellUpdated, fireTableChanged, fireTableColumnsDeleted, fireTableColumnsInserted, fireTableColumnsUpdated, fireTableColumnUpdated, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableRowUpdated, fireTableStructureChanged, fireUndoableEditHappened, getAutoCalculateFormula, getAutoSetsCellClass, getAutoSetsCellValue, getCellSpanListeners, getCellSpans, getCellSpans, getColumnAttributes, getColumnEditable, getColumnHeaderAttributes, getDataGridModelListeners, getFormulaContext, getListeners, getRowAttributes, getRowEditable, getRowHeaderAttributes, getSpannedCells, getStringEscapeChar, getTableModelListeners, getUndoableEditListeners, hasCellSpans, hasCellSpans, isColumnEditable, isRowEditable, isSpannedCell, merge, removeCellSpanListener, removeDataGridModelListener, removeTableModelListener, removeUndoableEditListener, setAutoCalculateFormula, setAutoSetsCellClass, setAutoSetsCellValue, setColumnAttributes, setColumnEditable, setColumnHeaderAttributes, setRowAttributes, setRowEditable, setRowHeaderAttributes, setStringEscapeChar, split, startUndoableEdit

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultDataGridModel

public DefaultDataGridModel()

Constructs a data grid model with 0 rows and 0 cols.

DefaultDataGridModel

public DefaultDataGridModel(int rowCount,
                            int columnCount)

Constructs a data grid model with rowCount rows and columnCount columns.

Method Detail

addRow

public void addRow(List l)

Adds a row to the end of the model use the specified list.

Parameters:

l - the specified list

See Also:

addRow(int,List), removeRow(int)

addRow

public void addRow(int rowIndex,
                   List l)

Adds a row at the rowIndex of the model use the specified list.

Parameters:

rowIndex - the rowIndex

l - the specified list

See Also:

addRow(List), removeRow(int)

addRow

public void addRow(int firstRow,
                   int lastRow,
                   List[] l)

Adds row from firstRow to lastRow use the specified list.

Parameters:

firstRow - the first row index

lastRow - the last row index

l - the specified list data

Since:

JDataGrid 1.1

removeRow

public void removeRow(int rowIndex)

Removes a row at the rowIndex of the model.

Parameters:

rowIndex - the rowIndex

See Also:

addRow(List), addRow(int,List)

removeRow

public void removeRow(int firstRow,
                      int lastRow)

Removes row from firstRow to lastRow

Parameters:

firstRow - the first row index

lastRow - the last row index

Since:

JDataGrid 1.1

addColumn

public void addColumn(List l)

Adds a column at the end of the model use the specified list.

Parameters:

l - the specified list

See Also:

addColumn(int,List), removeColumn(int)

addColumn

public void addColumn(int columnIndex,
                      List l)

Adds a column at the columnIndex of the model use the specified list.

Parameters:

columnIndex - the column index

l - the specified list

See Also:

addColumn(List), removeColumn(int)

addColumn

public void addColumn(int firstColumn,
                      int lastColumn,
                      List[] l)

Adds column from firstColumn to lastColumn use the specified list data.

Parameters:

firstColumn - the first column index

lastColumn - the last column index

l - the specified list data

Since:

JDataGrid 1.1

removeColumn

public void removeColumn(int columnIndex)

Removes a column at the columnIndex of the model.

Parameters:

columnIndex - the column index

See Also:

addColumn(List), addColumn(int,List)

removeColumn

public void removeColumn(int firstColumn,
                         int lastColumn)

Removes column from firstColumn to lastColumn.

Parameters:

firstColumn - the first column index

lastColumn - the last column index

Since:

JDataGrid 1.1

getRowCount

public int getRowCount()

Returns the number of rows in the model. A JTable uses this method to determine how many rows it should display. This method should be quick, as it is called frequently during rendering.

Specified by:

getRowCount in interface TableModel

Returns:

the number of rows in the model

See Also:

getColumnCount(), setColumnCount(int), getColumnCount()

setRowCount

public void setRowCount(int rowCount)

Sets the number of rows in the model.

Specified by:

setRowCount in interface DataGridModel

Parameters:

rowCount - the number of rows in the model

See Also:

getRowCount(), setColumnCount(int), getColumnCount()

getColumnCount

public int getColumnCount()

Returns the number of columns in the model. A JTable uses this method to determine how many columns it should create and display by default.

Specified by:

getColumnCount in interface TableModel

Returns:

the number of columns in the model

See Also:

getRowCount(), setRowCount(int), setColumnCount(int)

setColumnCount

public void setColumnCount(int columnCount)

Sets the number of columns in the model.

Specified by:

setColumnCount in interface DataGridModel

Parameters:

columnCount - the number of columns in the model

See Also:

getRowCount(), setRowCount(int), getColumnCount()

getColumnName

public String getColumnName(int columnIndex)

Returns the name of the column at columnIndex. This is used to initialize the table's column header name. Note: this name does not need to be unique; two columns in a table can have the same name.

Specified by:

getColumnName in interface TableModel

Overrides:

getColumnName in class AbstractDataGridModel

Parameters:

columnIndex - the index of the column

Returns:

the name of the column

See Also:

setColumnName(String,int)

setColumnName

public void setColumnName(String name,
                          int columnIndex)

Sets the column name for the specified columnIndex.

Specified by:

setColumnName in interface DataGridModel

Parameters:

name - the column name

columnIndex - the specified columnIndex

See Also:

getColumnName(int)

getColumnClass

public Class getColumnClass(int columnIndex)

Returns the most specific superclass for all the cell values in the column. This is used by the JTable to set up a default renderer and editor for the column.

Specified by:

getColumnClass in interface TableModel

Overrides:

getColumnClass in class AbstractDataGridModel

Parameters:

columnIndex - the index of the column

Returns:

the common ancestor class of the object values in the model.

See Also:

setColumnClass(Class,int)

setColumnClass

public void setColumnClass(Class c,
                           int columnIndex)

Sets the column class for the specified columnIndex.

Specified by:

setColumnClass in interface DataGridModel

Parameters:

c - the column class

columnIndex - the specified columnIndex

See Also:

getColumnClass(int)

getFormulaCells

public Cell[] getFormulaCells()

Returns all formula cells.

Overrides:

getFormulaCells in class AbstractDataGridModel

Returns:

all formula cells

Since:

JDataGrid 1.5.1

sort

public boolean sort(Cell c,
                    boolean ascending)

Sorts the cell area.Returns true if this model changes as a result of the call. (Returns false if this model does not permit such operation.)

Note:Current only support single column or row sorting. Multiple cell sorting may be supported in the future.

Parameters:

c - the cell area

ascending - the sort direction

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.1

sort

public boolean sort(Cell c,
                    boolean ascending,
                    int index,
                    boolean byColumn)

Sorts the cell area. Returns true if this model changes as a result of the call. (Returns false if this model does not change.)

Note:The index is in cell coordinate

Parameters:

c - the cell area

ascending - the sort direction

index - the sort lead index

byColumn - the sort orientation

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.5

sort

public boolean sort(Cell c,
                    boolean ascending,
                    int index,
                    boolean byColumn,
                    boolean ignoreBlank)

Sorts the cell area. Returns true if this model changes as a result of the call. (Returns false if this model does not change.)

Note:The index is in cell coordinate

Parameters:

c - the cell area

ascending - the sort direction

index - the sort lead index

byColumn - the sort orientation

ignoreBlank - true if ignore the blank cell when sorting

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.8

sort

public boolean sort(Cell c,
                    boolean[] orders,
                    int[] keys,
                    boolean byColumn)

Sorts the cell area. Returns true if this model changes as a result of the call. (Returns false if this model does not change.)

Note:The index is in cell coordinate

Parameters:

c - the cell area

orders - the sort direction

keys - the sort key index

byColumn - the sort orientation

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.6.0

sort

public boolean sort(Cell c,
                    boolean[] orders,
                    int[] keys,
                    boolean byColumn,
                    boolean ignoreBlank)

Sorts the cell area. Returns true if this model changes as a result of the call. (Returns false if this model does not change.)

Note:The index is in cell coordinate

Parameters:

c - the cell area

orders - the sort direction

keys - the sort key index

byColumn - the sort orientation

ignoreBlank - true if ignore the blank cell when sorting

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.8

move

public boolean move(Cell from,
                    Cell to)

Moves the cell area from to to. The from cell area will clear.

Parameters:

from - the from cell area

to - the to cell area

Returns:

true if this model changed as a result of the call

Throws:

IllegalArgumentException - if the cell area is not same width and height or out of the model row and column count

Since:

JDataGrid 1.1

fillCellAttributes

public boolean fillCellAttributes(Cell c,
                                  List[] l)

Fills the cell attributes of the cell area c use the specified data.

Overrides:

fillCellAttributes in class AbstractDataGridModel

Parameters:

c - the cell area

l - the cell data

Returns:

true if this model changed as a result of the call

Throws:

IllegalArgumentException - if the cell area out of the model row and column count or list data is not enough

Since:

JDataGrid 1.1

fillCellClass

public boolean fillCellClass(Cell c,
                             List[] l)

Fills the cell class of the cell area c use the specified data.

Parameters:

c - the cell area

l - the cell data

Returns:

true if this model changed as a result of the call

Throws:

IllegalArgumentException - if the cell area out of the model row and column count or list data is not enough

Since:

JDataGrid 1.1

fillCellEditable

public boolean fillCellEditable(Cell c,
                                List[] l)

Fills the cell editable of the cell area c use the specified data.

Parameters:

c - the cell area

l - the cell data

Returns:

true if this model changed as a result of the call

Throws:

IllegalArgumentException - if the cell area out of the model row and column count or list data is not enough

Since:

JDataGrid 1.1

fillValue

public boolean fillValue(Cell c,
                         List[] l)

Fills the value of the cell area c use the specified data.

Parameters:

c - the cell area

l - the cell data

Returns:

true if this model changed as a result of the call

Throws:

IllegalArgumentException - if the cell area out of the model row and column count or list data is not enough

Since:

JDataGrid 1.1

fill

public boolean fill(Cell c,
                    TableModel model)

Fills the cell area c use the specified data.

Overrides:

fill in class AbstractDataGridModel

Parameters:

c - the cell area

model - the cell data

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.5

toModel

public DataGridModel toModel(Cell c)

Converts the cell area to the model. Return a new instance when invoke this method every time.

Overrides:

toModel in class AbstractDataGridModel

Parameters:

c - the cell area

Returns:

the model contains the data of the cell area

Since:

JDataGrid 1.5

clear

public boolean clear(Cell c)

Clears the cell data for the specified cell area c.

Overrides:

clear in class AbstractDataGridModel

Parameters:

c - the cell area

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.1

clearCellAttributes

public boolean clearCellAttributes(Cell c)

Clears the cell attributes for the specified cell area c.

Parameters:

c - the cell area

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.1

clearCellClass

public boolean clearCellClass(Cell c)

Clears the cell class for the specified cell area c.

Parameters:

c - the cell area

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.1

clearCellEditable

public boolean clearCellEditable(Cell c)

Clears the cell editable for the specified cell area c.

Parameters:

c - the cell area

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.1

clearValue

public boolean clearValue(Cell c)

Clears the cell value for the specified cell area c.

Parameters:

c - the cell area

Returns:

true if this model changed as a result of the call

Since:

JDataGrid 1.1

setCellAttributes

public void setCellAttributes(AttributeSet attributes,
                              Cell c)

Sets the cell attributes.

Overrides:

setCellAttributes in class AbstractDataGridModel

Parameters:

attributes - the cell attributes

c - the cell area

Since:

JDataGrid 1.1

See Also:

getCellAttributes(int, int)

setCellClass

public void setCellClass(Class cc,
                         Cell c)

Sets the cell class.

Overrides:

setCellClass in class AbstractDataGridModel

Parameters:

cc - the cell class

c - the cell area

Since:

JDataGrid 1.1

See Also:

getCellClass(int, int)

setCellEditable

public void setCellEditable(boolean editable,
                            Cell c)

Sets the cell editable.

Parameters:

editable - the cell editable

c - the cell area

Since:

JDataGrid 1.1

See Also:

isCellEditable(int, int)

setValueAt

public void setValueAt(Object aValue,
                       Cell c)

Sets the cell value.

Parameters:

aValue - the cell value

c - the cell area

Since:

JDataGrid 1.1

See Also:

getValueAt(int, int)

getCellAttributes

public AttributeSet getCellAttributes(int rowIndex,
                                      int columnIndex)

Returns the cell attributes.

Specified by:

getCellAttributes in interface DataGridModel

Parameters:

rowIndex - the index of the row

columnIndex - the index of the column

Returns:

the attributes for the specified cell

See Also:

setCellAttributes(javax.swing.text.AttributeSet, com.zfqjava.swing.cell.Cell)

setCellAttributes

public void setCellAttributes(AttributeSet attributes,
                              int rowIndex,
                              int columnIndex)

Sets the cell attributes.

Specified by:

setCellAttributes in interface DataGridModel

Parameters:

attributes - the cell attributes

rowIndex - the index of the row

columnIndex - the index of the column

See Also:

getCellAttributes(int, int)

getCellClass

public Class getCellClass(int rowIndex,
                          int columnIndex)

Returns the cell class.

Specified by:

getCellClass in interface DataGridModel

Parameters:

rowIndex - the index of the row

columnIndex - the index of the column

Returns:

the class for the specified cell

See Also:

setCellClass(java.lang.Class, com.zfqjava.swing.cell.Cell)

setCellClass

public void setCellClass(Class c,
                         int rowIndex,
                         int columnIndex)

Sets the cell class.

Specified by:

setCellClass in interface DataGridModel

Parameters:

c - the class for the specified cell

rowIndex - the index of the row

columnIndex - the index of the column

See Also:

getCellClass(int, int)

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Returns true if the cell at rowIndex and columnIndex is editable. Otherwise, setValueAt on the cell will not change the value of that cell.

Specified by:

isCellEditable in interface TableModel

Parameters:

rowIndex - the row whose value to be queried

columnIndex - the column whose value to be queried

Returns:

true if the cell is editable

See Also:

setValueAt(java.lang.Object, com.zfqjava.swing.cell.Cell), setCellEditable(boolean,int,int)

getCellEditable

public Boolean getCellEditable(int rowIndex,
                               int columnIndex)

Description copied from class: AbstractDataGridModel

Returns the editable property for the specified cell at rowIndex and columnIndex.

Overrides:

getCellEditable in class AbstractDataGridModel

Parameters:

rowIndex - the row whose value to be queried

columnIndex - the column whose value to be queried

Returns:

the editable property for the specified cell

See Also:

TableModel.setValueAt(java.lang.Object, int, int), DataGridModel.setCellEditable(boolean,int,int)

setCellEditable

public void setCellEditable(boolean editable,
                            int rowIndex,
                            int columnIndex)

Sets the editable value for the specified cell at rowIndex and columnIndex.

Specified by:

setCellEditable in interface DataGridModel

Parameters:

editable - the cell editable value

rowIndex - the row whose value to be queried

columnIndex - the column whose value to be queried

See Also:

setValueAt(java.lang.Object, com.zfqjava.swing.cell.Cell), isCellEditable(int,int)

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Returns the value for the cell at columnIndex and rowIndex.

Specified by:

getValueAt in interface TableModel

Parameters:

rowIndex - the row whose value is to be queried

columnIndex - the column whose value is to be queried

Returns:

the value Object at the specified cell

See Also:

setValueAt(java.lang.Object, com.zfqjava.swing.cell.Cell), isCellEditable(int, int), setCellEditable(boolean,int,int)

setValueAt

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

Sets the value in the cell at columnIndex and rowIndex to aValue.

Specified by:

setValueAt in interface TableModel

Parameters:

aValue - the new value

rowIndex - the row whose value is to be changed

columnIndex - the column whose value is to be changed

See Also:

getValueAt(int, int), isCellEditable(int, int), setCellEditable(boolean,int,int)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object