ilog.views.gantt.swing

Class IlvStringColumn

java.lang.Object

ilog.views.gantt.swing.IlvAbstractJTableColumn

ilog.views.gantt.swing.IlvStringColumn

All Implemented Interfaces:

IlvJTableColumn, GenericEventListener, EventListener

Direct Known Subclasses:

IlvConfigurableTableColumn

public class IlvStringColumn
extends IlvAbstractJTableColumn
implements GenericEventListener

IlvStringColumn is a column definition that can render a String property of an IlvHierarchyNode (that is, an activity or a resource) in an IlvJTable. The property that is rendered is defined by an IlvStringProperty. Editing of the property can be enabled separately for parent rows and leaf rows. When enabled, editing is done in a text field.

Field Summary

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

DEFAULT_COLUMN_WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvStringColumn(Object headerValue, IlvStringProperty property) Constructs a new column with the specified header value and that will render the specified activity or resource property.
IlvStringColumn(Object headerValue, IlvStringProperty property, int width) Constructs a new column with the specified header value and that will render the specified activity or resource property.
IlvStringColumn(Object headerValue, IlvStringProperty property, int width, Object identifier) Constructs a new column with the specified header value, a width, a column identifier, and that will render the specified activity or resource property.
IlvStringColumn(Object headerValue, IlvStringProperty property, Object identifier) Constructs a new column with the specified header value, that will render the specified activity or resource property, and with a column identifier.

Method Summary

Modifier and Type	Method and Description
protected TableCellEditor	createEditor() Creates the IlvTextFieldTableEditor that will be used to edit the cells in this column.
protected IlvGanttConfiguration	getGanttConfiguration() Returns the Gantt configuration that this column is coordinating with.
protected IlvGanttModel	getGanttModel() Returns the data model currently being displayed by the column.
IlvStringProperty	getProperty() Returns the activity or resource property that will be displayed in the column.
Object	getValue(IlvHierarchyNode row) Returns the string value of this column property for the specified row.
void	inform(EventObject event) Invoked when the property represented by this column has been modified in one of the rows.
boolean	isChildrenEditable() Returns whether leaf rows in this column are editable.
boolean	isEditable(IlvHierarchyNode row) Returns whether the cell at the intersection of this column and the specified row is editable.
boolean	isParentsEditable() Returns whether parent rows in this column are editable.
void	setChildrenEditable(boolean editable) Sets whether the leaf rows in this column are editable.
void	setGanttConfiguration(IlvGanttConfiguration ganttConfig) This method is invoked whenever this column is added to or removed from the Gantt configuration.
void	setParentsEditable(boolean editable) Sets whether the parent rows in this column are editable.
void	setValue(IlvHierarchyNode row, Object value) Sets the string value of this column property for the specified row.

Methods inherited from class ilog.views.gantt.swing.IlvAbstractJTableColumn

cellUpdated, columnHeaderUpdated, columnUpdated, createRenderer, getColumn, getColumnIndex, getModelIndex, getTable, getValueAsText, setTable, updateUI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvStringColumn

public IlvStringColumn(Object headerValue,
                       IlvStringProperty property)

Constructs a new column with the specified header value and that will render the specified activity or resource property. The column will have 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.

property - The activity or resource property that will be displayed in the column.

IlvStringColumn

public IlvStringColumn(Object headerValue,
                       IlvStringProperty property,
                       Object identifier)

Constructs a new column with the specified header value, that will render the specified activity or resource property, and with a column identifier. The column will have a default width of 75.

Parameters:

headerValue - The value rendered in the column header.

property - The activity or resource property that will be displayed in the column.

identifier - The column identifier.

Since:

JViews 5.5

IlvStringColumn

public IlvStringColumn(Object headerValue,
                       IlvStringProperty property,
                       int width)

Constructs a new column with the specified header value and that will render the specified activity or resource property. 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.

property - The activity or resource property that will be displayed in the column.

width - The width of the column.

Since:

JViews 3.5

IlvStringColumn

public IlvStringColumn(Object headerValue,
                       IlvStringProperty property,
                       int width,
                       Object identifier)

Constructs a new column with the specified header value, a width, a column identifier, and that will render the specified activity or resource property. 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.

property - The activity or resource property that will be displayed in the column.

width - The width of the column.

identifier - The column identifier.

Since:

JViews 5.5

Method Detail

createEditor

protected TableCellEditor createEditor()

Creates the IlvTextFieldTableEditor 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 IlvTextFieldTableEditor returned by this method is installed onto the column's internal TableColumn object.

Overrides:

createEditor in class IlvAbstractJTableColumn

Returns:

null, as the default table cell editor.

Since:

JViews 3.5

getGanttConfiguration

protected final IlvGanttConfiguration getGanttConfiguration()

Returns the Gantt configuration that this column is coordinating with.

Since:

JViews 5.5

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.

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

Overrides:

setGanttConfiguration in class IlvAbstractJTableColumn

Parameters:

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

getGanttModel

protected final IlvGanttModel getGanttModel()

Returns the data model currently being displayed by the column.

Since:

JViews 5.5

getProperty

public IlvStringProperty getProperty()

Returns the activity or resource property that will be displayed in the column.

Since:

JViews 3.5

getValue

public Object getValue(IlvHierarchyNode row)

Returns the string value of this column property for the specified row. The returned string 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 row type is RESOURCE_ROWS and row will be an IlvResource.

Specified by:

getValue in interface IlvJTableColumn

Specified by:

getValue in class IlvAbstractJTableColumn

Parameters:

row - The row.

Returns:

The cell's value.

See Also:

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

setValue

public void setValue(IlvHierarchyNode row,
                     Object value)

Sets the string value of this column property for the specified row. The value will be the string returned by the IlvTextFieldTableEditor's 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 row type is RESOURCE_ROWS and row will be an IlvResource.

Specified by:

setValue in interface IlvJTableColumn

Overrides:

setValue in class IlvAbstractJTableColumn

Parameters:

row - The row.

value - The new value.

See Also:

getValue(ilog.views.gantt.IlvHierarchyNode), createEditor()

isEditable

public boolean isEditable(IlvHierarchyNode row)

Returns whether the cell at the intersection of this column and the specified row is editable. Editing can be enabled/disabled for parent rows and leaf rows within the column by calling setParentsEditable(boolean) or setChildrenEditable(boolean), respectively. The default is true.

Specified by:

isEditable in interface IlvJTableColumn

Overrides:

isEditable in class IlvAbstractJTableColumn

Parameters:

row - The row.

Returns:

true if the cell is editable, false otherwise.

See Also:

isParentsEditable(), isChildrenEditable()

isParentsEditable

public boolean isParentsEditable()

Returns whether parent rows in this column are editable. The default is true.

Since:

JViews 3.5

See Also:

setParentsEditable(boolean), isEditable(ilog.views.gantt.IlvHierarchyNode)

setParentsEditable

public void setParentsEditable(boolean editable)

Sets whether the parent rows in this column are editable.

See Also:

isParentsEditable(), isEditable(ilog.views.gantt.IlvHierarchyNode)

isChildrenEditable

public boolean isChildrenEditable()

Returns whether leaf rows in this column are editable. The default is true.

Since:

JViews 3.5

See Also:

setChildrenEditable(boolean), isEditable(ilog.views.gantt.IlvHierarchyNode)

setChildrenEditable

public void setChildrenEditable(boolean editable)

Sets whether the leaf rows in this column are editable.

See Also:

isChildrenEditable(), isEditable(ilog.views.gantt.IlvHierarchyNode)

inform

public void inform(EventObject event)

Invoked when the property represented by this column has been modified in one of the rows.

Specified by:

inform in interface GenericEventListener

Parameters:

event - The value event.