ilog.views.gantt.swing

Class IlvTreeColumn

java.lang.Object

ilog.views.gantt.swing.IlvAbstractJTableColumn

ilog.views.gantt.swing.IlvTreeColumn

All Implemented Interfaces:

IlvJTableColumn

public class IlvTreeColumn
extends IlvAbstractJTableColumn

IlvTreeColumn is a column definition that can render an IlvJTree as a column of an IlvJTable. Attributes of the column, such as its width or resizability, can be changed in the usual manner by changing properties of the TableColumn returned by the IlvAbstractJTableColumn.getColumn() method. For example, to set that the user cannot resize the column use:

 anIlvTreeColumn.getColumn().setResizable(false);
 

You can obtain the IlvJTree being used to render this column by calling the getTree() method. The default row separators of the tree are disabled because they are superfluous inside a table.

The IlvJTree that is used to render this column is completely passive. All user input events are handled by the table and selection highlighting of rows in the tree is simulated by color changes. The tree itself does not have any selections and does not track the table's row selections.

Field Summary

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

DEFAULT_COLUMN_WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvTreeColumn(Object headerValue) Constructs a new tree column with the specified value displayed in its header.
IlvTreeColumn(Object headerValue, IlvJTreeRenderPolicy renderPolicy) Constructs a new tree column with the specified value displayed in its header and the tree rendered using the specified policy.
IlvTreeColumn(Object headerValue, IlvJTreeRenderPolicy renderPolicy, int width) Constructs a new tree column with the specified value displayed in its header and the tree rendered using the specified policy.
IlvTreeColumn(Object headerValue, IlvJTreeRenderPolicy renderPolicy, int width, Object identifier) Constructs a new tree column with the specified value displayed in its header, the tree rendered using the specified policy, a width, and a column identifier.
IlvTreeColumn(Object headerValue, IlvJTreeRenderPolicy renderPolicy, Object identifier) Constructs a new tree column with the specified value displayed in its header, the tree rendered using the specified policy, and a column identifier.
IlvTreeColumn(Object headerValue, Object identifier) Constructs a new tree column with the specified value displayed in its header, and a column identifier.

Method Summary

Modifier and Type	Method and Description
protected TableCellEditor	createEditor() Creates the editor that will be used to edit the cells in this column.
protected TableCellRenderer	createRenderer() Creates the tree renderer that will be used to render the cells in this column.
TreeCellEditor	getEditor() Returns the editor that is being used to edit each row in this tree column or null if the column should not be editable.
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.
TreeCellRenderer	getRenderer() Returns the renderer that is being used to display each row in this tree column.
IlvJTreeRenderPolicy	getRenderPolicy() Returns the policy for rendering and editing rows displayed in this tree column.
int	getRowHeight() Returns the height of each row in the tree.
IlvJTree	getTree() Returns the tree that is rendering this column.
Object	getValue(IlvHierarchyNode row) Returns row as the value 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.
boolean	isRootExpandIconVisible() Returns whether the root row's expand/collapse icon is visible.
void	setGanttConfiguration(IlvGanttConfiguration ganttConfig) Invoked whenever this column is added to or removed from the Gantt configuration.
void	setRenderPolicy(IlvJTreeRenderPolicy policy) Sets the rendering and editing policy for rows displayed in this tree column.
void	setRootExpandIconVisible(boolean visible) Sets whether the root row's expand/collapse icon is visible.
void	setRowHeight(int rowHeight) Sets the height of each row in the tree.
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 ilog.views.gantt.swing.IlvAbstractJTableColumn

cellUpdated, columnHeaderUpdated, columnUpdated, getColumn, getColumnIndex, getModelIndex, getTable, setTable

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvTreeColumn

public IlvTreeColumn(Object headerValue)

Constructs a new tree column with the specified value displayed in its header. The tree rows will be rendered and edited using a default rendering policy. 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.

IlvTreeColumn

public IlvTreeColumn(Object headerValue,
                     Object identifier)

Constructs a new tree column with the specified value displayed in its header, and a column identifier. The tree rows will be rendered and edited using a default rendering policy. The column will have a default width of 75.

Parameters:

headerValue - The value rendered in the column header.

identifier - The column identifier.

Since:

JViews 5.5

IlvTreeColumn

public IlvTreeColumn(Object headerValue,
                     IlvJTreeRenderPolicy renderPolicy)

Constructs a new tree column with the specified value displayed in its header and the tree rendered using the specified policy. 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.

renderPolicy - The rendering policy for the tree.

IlvTreeColumn

public IlvTreeColumn(Object headerValue,
                     IlvJTreeRenderPolicy renderPolicy,
                     Object identifier)

Constructs a new tree column with the specified value displayed in its header, the tree rendered using the specified policy, and a column identifier. The column will have a default width of 75.

Parameters:

headerValue - The value rendered in the column header.

renderPolicy - The rendering policy for the tree.

identifier - The column identifier.

Since:

JViews 5.5

IlvTreeColumn

public IlvTreeColumn(Object headerValue,
                     IlvJTreeRenderPolicy renderPolicy,
                     int width)

Constructs a new tree column with the specified value displayed in its header and the tree rendered using the specified policy. 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.

renderPolicy - The rendering policy for the tree.

width - The width of the column.

IlvTreeColumn

public IlvTreeColumn(Object headerValue,
                     IlvJTreeRenderPolicy renderPolicy,
                     int width,
                     Object identifier)

Constructs a new tree column with the specified value displayed in its header, the tree rendered using the specified policy, a width, and a column 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.

renderPolicy - The rendering policy for the tree.

width - The width of the column.

identifier - The column identifier.

Since:

JViews 5.5

Method Detail

createRenderer

protected final TableCellRenderer createRenderer()

Creates the tree renderer that will be used to render the cells in this column. This method returns a private subclass of IlvJTree that is configured with this column's rendering policy. This IlvJTree subclass to behaves as a TableCellRenderer.

Overrides:

createRenderer in class IlvAbstractJTableColumn

Returns:

An IlvDefaultTableCellRenderer as the default table cell renderer.

Since:

JViews 3.5

createEditor

protected final TableCellEditor createEditor()

Creates the editor that will be used to edit the cells in this column. This method returns a private, lightweight proxy that wraps this column's rendering policy editor. The lightweight proxy makes the TreeCellEditor of the rendering policy behave as a TableCellEditor.

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.

Overrides:

createEditor in class IlvAbstractJTableColumn

Returns:

null, as the default table cell editor.

Since:

JViews 3.5

getTree

public IlvJTree getTree()

Returns the tree that is rendering this column.

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)

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

getRenderPolicy

public IlvJTreeRenderPolicy getRenderPolicy()

Returns the policy for rendering and editing rows displayed in this tree column.

setRenderPolicy

public void setRenderPolicy(IlvJTreeRenderPolicy policy)

Sets the rendering and editing policy for rows displayed in this tree column. If set to null, the tree's default rendering and editing policy will be used.

getRenderer

public TreeCellRenderer getRenderer()

Returns the renderer that is being used to display each row in this tree column. Typically, this will be an instance of the Swing DefaultTreeCellRenderer class. Attributes of the returned renderer can be modified to affect the display of this column. For example, to change the icon for leaf rows you can use:

     IlvTreeColumn treeColumn = anIlvJTable.getTreeColumn(...);
     TreeCellRenderer treeRenderer = treeColumn.getRenderer();
     if (renderer instanceof DefaultTreeCellRenderer)
       ((DefaultTreeCellRenderer)renderer).setLeafIcon(...);

 

In order to replace the tree renderer entirely, you must create a new IlvJTreeRenderPolicy and call the setRenderPolicy method.

Since:

JViews 3.5

getEditor

public TreeCellEditor getEditor()

Returns the editor that is being used to edit each row in this tree column or null if the column should not be editable. Typically, the editor will be an instance of IlvTextFieldTreeEditor. In order to replace the tree editor, you must create a new IlvJTreeRenderPolicy and call the setRenderPolicy method.

Since:

JViews 3.5

getValueAsText

public 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 row type is RESOURCE_ROWS and row will be an IlvResource.

Specified by:

getValueAsText in interface IlvJTableColumn

Overrides:

getValueAsText in class IlvAbstractJTableColumn

Parameters:

row - The row.

Returns:

The value as a String.

Since:

JViews 6.0

See Also:

getValue(ilog.views.gantt.IlvHierarchyNode)

getValue

public Object getValue(IlvHierarchyNode row)

Returns row as the value displayed at the cell intersection of this column and the specified row. The returned row 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), 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 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. This is determined by querying the tree's rendering policy.

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:

setRenderPolicy(ilog.views.gantt.swing.IlvJTreeRenderPolicy)

getRowHeight

public int getRowHeight()

Returns the height of each row in the tree.

Since:

JViews 3.5

setRowHeight

public void setRowHeight(int rowHeight)

Sets the height of each row in the tree.

isRootExpandIconVisible

public boolean isRootExpandIconVisible()

Returns whether the root row's expand/collapse icon is visible.

Since:

JViews 3.5

See Also:

setRootExpandIconVisible(boolean)

setRootExpandIconVisible

public void setRootExpandIconVisible(boolean visible)

Sets whether the root row's expand/collapse icon is visible.

This setting has only an effect while the root row is visible.

Since:

JViews 3.5

See Also:

isRootExpandIconVisible(), IlvHierarchyChart.setRootRowVisible(boolean), IlvGanttConfiguration.setRootRowVisible(boolean), IlvVerticalDisplayController.setRootNodeVisible(boolean)

updateUI

public void updateUI()

This method is a notification that the L&F has changed. We forward the message to the tree because it is not actually part of the component hierarchy.

Specified by:

updateUI in interface IlvJTableColumn

Overrides:

updateUI in class IlvAbstractJTableColumn