PropertySheetTableModel (l2fprod-properties-editor 1.0 API)

java.lang.Object
- javax.swing.table.AbstractTableModel
- - com.l2fprod.common.propertysheet.PropertySheetTableModel

All Implemented Interfaces:

PropertySheet, ObjectTableModel, PropertyChangeListener, Serializable, EventListener, TableModel
```
public class PropertySheetTableModel
extends AbstractTableModel
implements PropertyChangeListener, PropertySheet, ObjectTableModel
```
PropertySheetTableModel.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`PropertySheetTableModel.Item`
`static class`	`PropertySheetTableModel.NaturalOrderStringComparator`
`static class`	`PropertySheetTableModel.PropertyComparator` The default comparator for Properties.

Field Summary

Fields
Modifier and Type Field and Description

static int NAME_COLUMN

static int NUM_COLUMNS

static int VALUE_COLUMN
- Fields inherited from class javax.swing.table.AbstractTableModel
  listenerList
- Fields inherited from interface com.l2fprod.common.propertysheet.PropertySheet
  VIEW_AS_CATEGORIES, VIEW_AS_FLAT_LIST

Fields
Modifier and Type	Field and Description
`static int`	`NAME_COLUMN`
`static int`	`NUM_COLUMNS`
`static int`	`VALUE_COLUMN`

Constructor Summary

Constructors
Constructor and Description

PropertySheetTableModel()

Constructors
Constructor and Description
`PropertySheetTableModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProperty(int index, Property property)`
`void`	`addProperty(Property property)`
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Add a `PropertyChangeListener` to the current model.
`Class`	`getColumnClass(int columnIndex)`
`int`	`getColumnCount()`
`int`	`getMode()` Get the current mode, either `PropertySheet.VIEW_AS_CATEGORIES` or `PropertySheet.VIEW_AS_FLAT_LIST`.
`Object`	`getObject(int rowIndex)`
`Property[]`	`getProperties()`
`protected List`	`getPropertyCategories(List localProperties)`
`int`	`getPropertyCount()`
`PropertySheetTableModel.Item`	`getPropertySheetElement(int rowIndex)` Get the current property sheet element, of type `PropertySheetTableModel.Item`, at the specified row.
`int`	`getRowCount()`
`Map`	`getToggleStates()`
`Object`	`getValueAt(int rowIndex, int columnIndex)` Retrieve the value at the specified row and column location.
`boolean`	`isRestoreToggleStates()` Get whether this model is restoring toggle states
`boolean`	`isSortingCategories()` Get whether this model is currently sorting categories.
`boolean`	`isSortingProperties()` Get whether this model is currently sorting properties.
`void`	`propertyChange(PropertyChangeEvent evt)`
`Iterator`	`propertyIterator()`
`void`	`removeProperty(Property property)`
`void`	`removePropertyChangeListener(PropertyChangeListener listener)`
`void`	`setCategorySortingComparator(Comparator comp)` Set the comparator used for sorting categories.
`void`	`setMode(int mode)` Set the current mode, either `PropertySheet.VIEW_AS_CATEGORIES` or `PropertySheet.VIEW_AS_FLAT_LIST`.
`void`	`setProperties(Property[] newProperties)`
`void`	`setPropertySortingComparator(Comparator comp)` Set the comparator used for sorting properties.
`void`	`setRestoreToggleStates(boolean value)` Set whether or not this model will restore the toggle states when new properties are applied.
`void`	`setSortingCategories(boolean value)` Set whether this model is currently sorting categories.
`void`	`setSortingProperties(boolean value)` Set whether this model is currently sorting properties.
`void`	`setToggleStates(Map toggleStates)` Sets the toggle states for the category views.
`void`	`setValueAt(Object value, int rowIndex, int columnIndex)` Sets the value at the specified row and column.
`protected List`	`sortCategories(List localCategories)`
`protected List`	`sortProperties(List localProperties)`
`protected void`	`visibilityChanged(boolean restoreOldStates)`

Methods inherited from class javax.swing.table.AbstractTableModel
addTableModelListener, findColumn, fireTableCellUpdated, fireTableChanged, fireTableDataChanged, fireTableRowsDeleted, fireTableRowsInserted, fireTableRowsUpdated, fireTableStructureChanged, getColumnName, getListeners, getTableModelListeners, isCellEditable, removeTableModelListener

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.swing.table.TableModel
addTableModelListener, getColumnName, isCellEditable, removeTableModelListener

- Field Detail
  - NAME_COLUMN
```
public static final int NAME_COLUMN
```
    See Also:
    
    Constant Field Values
  - VALUE_COLUMN
```
public static final int VALUE_COLUMN
```
    See Also:
    
    Constant Field Values
  - NUM_COLUMNS
```
public static final int NUM_COLUMNS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PropertySheetTableModel
```
public PropertySheetTableModel()
```
- Method Detail
  - setProperties
```
public void setProperties(Property[] newProperties)
```
    Specified by:
    
    setProperties in interface PropertySheet
  - getProperties
```
public Property[] getProperties()
```
    Specified by:
    
    getProperties in interface PropertySheet
  - addProperty
```
public void addProperty(Property property)
```
    Specified by:
    
    addProperty in interface PropertySheet
  - addProperty
```
public void addProperty(int index,
                        Property property)
```
    Specified by:
    
    addProperty in interface PropertySheet
  - removeProperty
```
public void removeProperty(Property property)
```
    Specified by:
    
    removeProperty in interface PropertySheet
  - getPropertyCount
```
public int getPropertyCount()
```
    Specified by:
    
    getPropertyCount in interface PropertySheet
  - propertyIterator
```
public Iterator propertyIterator()
```
    Specified by:
    
    propertyIterator in interface PropertySheet
  - setMode
```
public void setMode(int mode)
```
    Set the current mode, either PropertySheet.VIEW_AS_CATEGORIES or PropertySheet.VIEW_AS_FLAT_LIST.
    
    Parameters:
    
    mode -
  - getMode
```
public int getMode()
```
    Get the current mode, either PropertySheet.VIEW_AS_CATEGORIES or PropertySheet.VIEW_AS_FLAT_LIST.
    
    Returns:
  - getColumnClass
```
public Class getColumnClass(int columnIndex)
```
    Specified by:
    
    getColumnClass in interface TableModel
    
    Overrides:
    
    getColumnClass in class AbstractTableModel
  - getColumnCount
```
public int getColumnCount()
```
    Specified by:
    
    getColumnCount in interface TableModel
  - getRowCount
```
public int getRowCount()
```
    Specified by:
    
    getRowCount in interface TableModel
  - getObject
```
public Object getObject(int rowIndex)
```
    Specified by:
    
    getObject in interface ObjectTableModel
  - getPropertySheetElement
```
public PropertySheetTableModel.Item getPropertySheetElement(int rowIndex)
```
    Get the current property sheet element, of type PropertySheetTableModel.Item, at the specified row.
    
    Parameters:
    
    rowIndex -
    
    Returns:
  - isSortingCategories
```
public boolean isSortingCategories()
```
    Get whether this model is currently sorting categories.
    
    Returns:
  - setSortingCategories
```
public void setSortingCategories(boolean value)
```
    Set whether this model is currently sorting categories. If this changes the sorting, the model will be rebuilt.
    
    Parameters:
    
    value -
  - isSortingProperties
```
public boolean isSortingProperties()
```
    Get whether this model is currently sorting properties.
    
    Returns:
  - setSortingProperties
```
public void setSortingProperties(boolean value)
```
    Set whether this model is currently sorting properties. If this changes the sorting, the model will be rebuilt.
    
    Parameters:
    
    value -
  - setCategorySortingComparator
```
public void setCategorySortingComparator(Comparator comp)
```
    Set the comparator used for sorting categories. If this changes the comparator, the model will be rebuilt.
    
    Parameters:
    
    comp -
  - setPropertySortingComparator
```
public void setPropertySortingComparator(Comparator comp)
```
    Set the comparator used for sorting properties. If this changes the comparator, the model will be rebuilt.
    
    Parameters:
    
    comp -
  - setRestoreToggleStates
```
public void setRestoreToggleStates(boolean value)
```
    Set whether or not this model will restore the toggle states when new properties are applied.
    
    Parameters:
    
    value -
  - isRestoreToggleStates
```
public boolean isRestoreToggleStates()
```
    Get whether this model is restoring toggle states
    
    Returns:
  - getToggleStates
```
public Map getToggleStates()
```
    Returns:
    
    the category view toggle states.
  - setToggleStates
```
public void setToggleStates(Map toggleStates)
```
    Sets the toggle states for the category views. Note this MUST be called BEFORE setting any properties.
    
    Parameters:
    
    toggleStates - the toggle states as returned by getToggleStates
  - getValueAt
```
public Object getValueAt(int rowIndex,
                         int columnIndex)
```
    Retrieve the value at the specified row and column location. When the row contains a category or the column is NAME_COLUMN, an PropertySheetTableModel.Item object will be returned. If the row is a property and the column is VALUE_COLUMN, the value of the property will be returned.
    
    Specified by:
    
    getValueAt in interface TableModel
    
    Parameters:
    
    rowIndex -
    
    columnIndex -
    
    Returns:
    
    See Also:
    
    TableModel.getValueAt(int, int)
  - setValueAt
```
public void setValueAt(Object value,
                       int rowIndex,
                       int columnIndex)
```
    Sets the value at the specified row and column. This will have no effect unless the row is a property and the column is VALUE_COLUMN.
    
    Specified by:
    
    setValueAt in interface TableModel
    
    Overrides:
    
    setValueAt in class AbstractTableModel
    
    Parameters:
    
    value -
    
    rowIndex -
    
    columnIndex -
    
    See Also:
    
    TableModel.setValueAt(java.lang.Object, int, int)
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener listener)
```
    Add a PropertyChangeListener to the current model.
    
    Parameters:
    
    listener -
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener listener)
```
  - propertyChange
```
public void propertyChange(PropertyChangeEvent evt)
```
    Specified by:
    
    propertyChange in interface PropertyChangeListener
  - visibilityChanged
```
protected void visibilityChanged(boolean restoreOldStates)
```
  - sortProperties
```
protected List sortProperties(List localProperties)
```
  - sortCategories
```
protected List sortCategories(List localCategories)
```
  - getPropertyCategories
```
protected List getPropertyCategories(List localProperties)
```

Class PropertySheetTableModel

Nested Class Summary

Field Summary

Fields inherited from class javax.swing.table.AbstractTableModel

Fields inherited from interface com.l2fprod.common.propertysheet.PropertySheet

Constructor Summary

Method Summary

Methods inherited from class javax.swing.table.AbstractTableModel

Methods inherited from class java.lang.Object

Methods inherited from interface javax.swing.table.TableModel

Field Detail

NAME_COLUMN

VALUE_COLUMN

NUM_COLUMNS

Constructor Detail

PropertySheetTableModel

Method Detail

setProperties

getProperties

addProperty

addProperty

removeProperty

getPropertyCount

propertyIterator

setMode

getMode

getColumnClass

getColumnCount

getRowCount

getObject

getPropertySheetElement

isSortingCategories

setSortingCategories

isSortingProperties

setSortingProperties

setCategorySortingComparator

setPropertySortingComparator

setRestoreToggleStates

isRestoreToggleStates

getToggleStates

setToggleStates

getValueAt

setValueAt

addPropertyChangeListener

removePropertyChangeListener

propertyChange

visibilityChanged

sortProperties

sortCategories

getPropertyCategories