ilog.views.gantt.swing

Interface IlvJTableColumn

All Known Implementing Classes:

IlvAbstractJTableColumn, IlvConfigurableTableColumn, IlvStringColumn, IlvTreeColumn

public interface IlvJTableColumn

The IlvJTableColumn interface defines the behavior of a table column that can be added to an IlvJTable through its addColumn() method. An IlvJTableColumn encapsulates both column access to the Gantt data model and the visual representation of the column in the displayed table. The IlvJTableColumn API itself mostly defines how the column data is set and retrieved from the Gantt data model. The column's visual representation is controlled by its internal Swing TableColumn object, which can be obtained from the getColumn() method. For example, to set that the user cannot resize a column use:

 anIlvJTableColumn.getColumn().setResizable(false);
 

A cell in the column is editable if the method isEditable returns true and the internal TableColumn object has a cell editor installed.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COLUMN_WIDTH The default preferred and initial width of table columns.

Method Summary

Modifier and Type	Method and Description
TableColumn	getColumn() Returns the TableColumn that controls the visual appearance of this column.
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.

Field Detail

DEFAULT_COLUMN_WIDTH

static final int DEFAULT_COLUMN_WIDTH

The default preferred and initial width of table columns. This value of 75 is the same default used by the Swing TableColumn class.

See Also:

Constant Field Values

Method Detail

setTable

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.

Parameters:

table - The table that this column is being added to, or null if this column is being removed from its table.

setGanttConfiguration

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.

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.

Parameters:

ganttConfig - The Gantt configuration that this column is being added to, or null if this column is being removed from its Gantt configuration.

getColumn

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 the IlvJTableColumn's lifetime.

Since:

JViews 3.5

isEditable

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.

Parameters:

row - The row.

getValueAsText

String getValueAsText(IlvHierarchyNode row)

Returns the text value that is displayed at the cell intersection of this column and the specified row. 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.

Parameters:

row - The row.

Since:

JViews 6.0

See Also:

getValue(ilog.views.gantt.IlvHierarchyNode)

getValue

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 TableCellRenderer.getTableCellRendererComponent method to render the cell and 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.

Parameters:

row - The row.

See Also:

setValue(ilog.views.gantt.IlvHierarchyNode, java.lang.Object)

setValue

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.

Parameters:

row - The row.

value - The new value.

See Also:

getValue(ilog.views.gantt.IlvHierarchyNode)

updateUI

void updateUI()

This method is a notification that the L&F has changed.