IlvAbstractJTableColumn (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.gantt.swing.IlvAbstractJTableColumn

All Implemented Interfaces:

IlvJTableColumn

Direct Known Subclasses:

IlvStringColumn, IlvTreeColumn
```
public abstract class IlvAbstractJTableColumn
extends Object
implements IlvJTableColumn
```
The class IlvAbstractJTableColumn is the superclass of all table column implementations that can be used with an IlvJTable. By default, the cells in the column are not editable. To enable editing of cells, you should override the isEditable and createEditor methods.

Field Summary
- Fields inherited from interface ilog.views.gantt.swing.IlvJTableColumn
  DEFAULT_COLUMN_WIDTH

Constructor Summary

Constructors
Constructor and Description
`IlvAbstractJTableColumn()` Constructs a new column with a default header value and a default width of 75.
`IlvAbstractJTableColumn(Object headerValue)` Constructs a new column with the specified value displayed in its header and a default width of 75.
`IlvAbstractJTableColumn(Object headerValue, int width)` Constructs a new column with the specified value displayed in its header and the specified width.
`IlvAbstractJTableColumn(Object headerValue, int width, Object identifier)` Constructs a new column with the specified value displayed in its header, the specified width, and an identifier.
`IlvAbstractJTableColumn(Object headerValue, Object identifier)` Constructs a new column with the specified value displayed in its header, a default width of 75, and an identifier.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cellUpdated(IlvHierarchyNode row)` Invoke this method to notify the table that the representation of the cell at the intersection of this column and the specified row has changed.
`void`	`columnHeaderUpdated()` Invoke this method to notify the table that the representation of this column header has changed.
`void`	`columnUpdated()` Invoke this method to notify the table that the representation of this column has changed.
`protected TableCellEditor`	`createEditor()` Creates the editor that will be used to edit the cells in this column.
`protected TableCellRenderer`	`createRenderer()` Creates the renderer that will be used to render the cells in this column.
`TableColumn`	`getColumn()` Returns the `TableColumn` that controls the visual appearance of this column.
`int`	`getColumnIndex()` Returns the column display index in the view, or -1 if the column has not been added to a table.
`int`	`getModelIndex()` Returns the column index within the table's data model, or -1 if the column has not been added to a table.
`IlvJTable`	`getTable()` Returns the table that this column is a member of, or `null` if this column has not been added to a table.
`abstract Object`	`getValue(IlvHierarchyNode row)` Returns the value that is displayed at the cell intersection of this column and the specified row.
`String`	`getValueAsText(IlvHierarchyNode row)` Returns the text value that is displayed at the cell intersection of this column and the specified row.
`boolean`	`isEditable(IlvHierarchyNode row)` Returns whether the cell at the intersection of this column and the specified row is editable.
`void`	`setGanttConfiguration(IlvGanttConfiguration ganttConfig)` This method is invoked whenever this column is added to or removed from the Gantt configuration.
`void`	`setTable(IlvJTable table)` This method is invoked whenever this column is added to or removed from its `IlvJTable`.
`void`	`setValue(IlvHierarchyNode row, Object value)` Sets the value of the data model at the cell intersection of this column and the specified row.
`void`	`updateUI()` This method is a notification that the L&F has changed.

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

- Constructor Detail
  - IlvAbstractJTableColumn
```
public IlvAbstractJTableColumn()
```
    Constructs a new column with a default header value and a default width of 75. Note that in this case, the column identifier, if not set, will be the header value.
  - IlvAbstractJTableColumn
```
public IlvAbstractJTableColumn(Object headerValue)
```
    Constructs a new column with the specified value displayed in its header and a default width of 75. Note that in this case, the column identifier, if not set, will be the header value.
    
    Parameters:
    
    headerValue - The value rendered in the column header.
  - IlvAbstractJTableColumn
```
public IlvAbstractJTableColumn(Object headerValue,
                               Object identifier)
```
    Constructs a new column with the specified value displayed in its header, a default width of 75, and an identifier.
    
    Parameters:
    
    headerValue - The value rendered in the column header.
    
    identifier - The column identifier.
    
    Since:
    
    JViews 5.5
  - IlvAbstractJTableColumn
```
public IlvAbstractJTableColumn(Object headerValue,
                               int width)
```
    Constructs a new column with the specified value displayed in its header and the specified width. The width parameter is used to set both the preferred and initial width of the column. Note that in this case, the column identifier, if not set, will be the header value.
    
    Parameters:
    
    headerValue - The value rendered in the column header.
    
    width - The width of the column.
  - IlvAbstractJTableColumn
```
public IlvAbstractJTableColumn(Object headerValue,
                               int width,
                               Object identifier)
```
    Constructs a new column with the specified value displayed in its header, the specified width, and an identifier. The width parameter is used to set both the preferred and initial width of the column.
    
    Parameters:
    
    headerValue - The value rendered in the column header.
    
    width - The width of the column.
    
    identifier - The column identifier.
    
    Since:
    
    JViews 5.5
- Method Detail
  - createRenderer
```
protected TableCellRenderer createRenderer()
```
    Creates the renderer that will be used to render the cells in this column. For each cell, the renderer will be passed the value returned by the column's getValue(ilog.views.gantt.IlvHierarchyNode) method. The renderer returned by this method is installed onto the column's internal TableColumn object.
    This default implementation creates an IlvDefaultTableCellRenderer that renders the cell value as a string by invoking the value's toString method. Subclasses should override this method as needed.
    
    Returns:
    
    An IlvDefaultTableCellRenderer as the default table cell renderer.
    
    Since:
    
    JViews 3.5
  - createEditor
```
protected TableCellEditor createEditor()
```
    Creates the editor that will be used to edit the cells in this column. When editing of a cell begins, the editor's getTableCellEditorComponent method will be passed the value returned by the column's getValue(ilog.views.gantt.IlvHierarchyNode) method. When editing is completed, the value returned by the editor's getCellEditorValue method will be passed to the column's setValue(ilog.views.gantt.IlvHierarchyNode, java.lang.Object) method. The editor returned by this method is installed onto the column's internal TableColumn object.
    This default implementation returns null. Subclasses should override this method as needed.
    
    Returns:
    
    null, as the default table cell editor.
    
    Since:
    
    JViews 3.5
  - getColumn
```
public final TableColumn getColumn()
```
    Returns the TableColumn that controls the visual appearance of this column. It is assumed that this method will always return the same TableColumn object during this column's lifetime.
    
    Specified by:
    
    getColumn in interface IlvJTableColumn
    
    Returns:
    
    The TableColumn controlling this column.
    
    Since:
    
    JViews 3.5
  - getTable
```
public IlvJTable getTable()
```
    Returns the table that this column is a member of, or null if this column has not been added to a table.
    
    Returns:
    
    The IlvJTable containing this column.
  - setTable
```
public void setTable(IlvJTable table)
```
    This method is invoked whenever this column is added to or removed from its IlvJTable.
    Warning: This method is considered to be part of an IlvJTableColumn's internal implementation and is not a public API. Only the IlvJTable should invoke this method.
    
    Specified by:
    
    setTable in interface IlvJTableColumn
    
    Parameters:
    
    table - The table that this column is being added to, or null if this column is being removed from its table.
  - setGanttConfiguration
```
public void setGanttConfiguration(IlvGanttConfiguration ganttConfig)
```
    This method is invoked whenever this column is added to or removed from the Gantt configuration. When the column is added to the configuration, it should synchronize itself and register for any events that it needs to keep itself properly updated. When the column is removed from the configuration, it should unregister itself from any events that it was previously listening to.
    This default implementation does nothing. Subclasses should override this method as needed.
    Warning: This method is considered to be part of an IlvJTableColumn's internal implementation and is not a public API. Only the IlvJTable should invoke this method.
    
    Specified by:
    
    setGanttConfiguration in interface IlvJTableColumn
    
    Parameters:
    
    ganttConfig - The Gantt configuration that this column is being added to, or null if this column is being removed from its Gantt configuration.
  - isEditable
```
public boolean isEditable(IlvHierarchyNode row)
```
    Returns whether the cell at the intersection of this column and the specified row is editable. The type of the specified row will match the row organization of the Gantt configuration of which the table is a member. In other words, if the Gantt configuration's row type is ACTIVITY_ROWS, then row will be an IlvActivity. Otherwise, the Gantt configuration's rowtype is RESOURCE_ROWS and row will be an IlvResource.
    This default implementation always returns false. Subclasses should override this method as needed.
    
    Specified by:
    
    isEditable in interface IlvJTableColumn
    
    Parameters:
    
    row - The row.
    
    Returns:
    
    true if the cell is editable, false otherwise.
  - getValueAsText
```
public String getValueAsText(IlvHierarchyNode row)
```
    Returns the text value that is displayed at the cell intersection of this column and the specified row. This default implementation returns getValue(row).toString().
    The type of the specified row will match the row organization of the Gantt configuration of which the table is a member. In other words, if row type of the Gantt configuration is ACTIVITY_ROWS, then row will be an IlvActivity. Otherwise, rowtype of the Gantt configuration is RESOURCE_ROWS and row will be an IlvResource.
    
    Specified by:
    
    getValueAsText in interface IlvJTableColumn
    
    Parameters:
    
    row - The row.
    
    Returns:
    
    The value as a String.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    getValue(ilog.views.gantt.IlvHierarchyNode)
  - getValue
```
public abstract Object getValue(IlvHierarchyNode row)
```
    Returns the value that is displayed at the cell intersection of this column and the specified row. The returned value will be passed to the TableCellEditor.getTableCellEditorComponent method when editing of the cell begins.
    The type of the specified row will match the row organization of the Gantt configuration of which the table is a member. In other words, if the Gantt configuration's row type is ACTIVITY_ROWS, then row will be an IlvActivity. Otherwise, the Gantt configuration's rowtype is RESOURCE_ROWS and row will be an IlvResource.
    
    Specified by:
    
    getValue in interface IlvJTableColumn
    
    Parameters:
    
    row - The row.
    
    Returns:
    
    The cell's value.
    
    Since:
    
    JViews 3.5
    
    See Also:
    
    setValue(ilog.views.gantt.IlvHierarchyNode, java.lang.Object), createRenderer(), createEditor()
  - setValue
```
public void setValue(IlvHierarchyNode row,
                     Object value)
```
    Sets the value of the data model at the cell intersection of this column and the specified row. The value will be the result returned by the TableCellEditor.getCellEditorValue method.
    The type of the specified row will match the row organization of the Gantt configuration of which the table is a member. In other words, if the Gantt configuration's row type is ACTIVITY_ROWS, then row will be an IlvActivity. Otherwise, the Gantt configuration's rowtype is RESOURCE_ROWS and row will be an IlvResource.
    This default implementation does nothing, so subclasses do not have to implement this method if the column is not editable. If a column subclass is editable, it should override this method to properly store the edited cell value back into the Gantt data model.
    
    Specified by:
    
    setValue in interface IlvJTableColumn
    
    Parameters:
    
    row - The row.
    
    value - The new value.
    
    See Also:
    
    getValue(ilog.views.gantt.IlvHierarchyNode), createEditor()
  - getModelIndex
```
public int getModelIndex()
```
    Returns the column index within the table's data model, or -1 if the column has not been added to a table.
    
    Returns:
    
    The column index.
  - getColumnIndex
```
public int getColumnIndex()
```
    Returns the column display index in the view, or -1 if the column has not been added to a table.
    
    Returns:
    
    The column index.
  - updateUI
```
public void updateUI()
```
    This method is a notification that the L&F has changed. This default implementation does nothing. Subclasses should override this method as needed.
    
    Specified by:
    
    updateUI in interface IlvJTableColumn
  - cellUpdated
```
public void cellUpdated(IlvHierarchyNode row)
```
    Invoke this method to notify the table that the representation of the cell at the intersection of this column and the specified row has changed. The table will then repaint the cell.
    
    Parameters:
    
    row - The row whose visual representation has changed.
  - columnHeaderUpdated
```
public void columnHeaderUpdated()
```
    Invoke this method to notify the table that the representation of this column header has changed. The table will then repaint the column header.
    
    Since:
    
    JViews 3.5
  - columnUpdated
```
public void columnUpdated()
```
    Invoke this method to notify the table that the representation of this column has changed. The table will then repaint the column.
    
    Since:
    
    JViews 3.5

Class IlvAbstractJTableColumn

Field Summary

Fields inherited from interface ilog.views.gantt.swing.IlvJTableColumn

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvAbstractJTableColumn

IlvAbstractJTableColumn

IlvAbstractJTableColumn

IlvAbstractJTableColumn

IlvAbstractJTableColumn

Method Detail

createRenderer

createEditor

getColumn

getTable

setTable

setGanttConfiguration

isEditable

getValueAsText

getValue

setValue

getModelIndex

getColumnIndex

updateUI

cellUpdated

columnHeaderUpdated

columnUpdated