ilog.views.gantt.swing

Class IlvAbstractJTreeRenderPolicy

java.lang.Object

ilog.views.gantt.swing.IlvAbstractJTreeRenderPolicy

All Implemented Interfaces:

IlvJTreeRenderPolicy

Direct Known Subclasses:

IlvJTreeStringRenderPolicy

public abstract class IlvAbstractJTreeRenderPolicy
extends Object
implements IlvJTreeRenderPolicy

IlvAbstractJTreeRenderPolicy is the superclass of all rendering policy implementations that can be used with an IlvJTree.

Field Summary

Fields

Modifier and Type	Field and Description
protected IlvJTree	tree The tree for which this is the rendering policy.

Constructor Summary

Constructors

Constructor and Description
IlvAbstractJTreeRenderPolicy() Construct a new cell rendering and editing policy.

Method Summary

Modifier and Type	Method and Description
TreeCellEditor	getEditor() Return this policy's TreeCellEditor.
IlvJTree	getTree() Return the tree for which this policy is rendering, or null if this policy has not been associated with a tree.
boolean	isEditable(IlvHierarchyNode row) Return whether the specified row is editable.
void	rowUpdated(IlvHierarchyNode row) Invoke this method to notify the tree that the representation of the specified row has changed.
void	setGanttConfiguration(IlvGanttConfiguration ganttConfig) This method is invoked whenever this rendering policy is added to or removed from the Gantt configuration.
void	setTree(IlvJTree tree) This method is invoked whenever this rendering policy is added to or removed from its IlvJTree.
void	setValue(IlvHierarchyNode row, Object value) Set the value of the data model at the specified row.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.gantt.swing.IlvJTreeRenderPolicy

getRenderer, getValueAsText

Field Detail

tree

protected IlvJTree tree

The tree for which this is the rendering policy.

Since:

JViews 6.5

Constructor Detail

IlvAbstractJTreeRenderPolicy

public IlvAbstractJTreeRenderPolicy()

Construct a new cell rendering and editing policy.

Method Detail

getTree

public IlvJTree getTree()

Return the tree for which this policy is rendering, or null if this policy has not been associated with a tree.

setTree

public void setTree(IlvJTree tree)

This method is invoked whenever this rendering policy is added to or removed from its IlvJTree.

Warning: This method is considered to be part of an IlvJTreeRenderPolicy's internal implementation and is not a public API. Only the IlvJTree should invoke this method.

Specified by:

setTree in interface IlvJTreeRenderPolicy

Parameters:

tree - the tree that this render policy is being assigned to, or null if this policy is being unassigned from its tree

setGanttConfiguration

public void setGanttConfiguration(IlvGanttConfiguration ganttConfig)

This method is invoked whenever this rendering policy is added to or removed from the Gantt configuration. When the policy is added to the configuration, it should synchronize itself and register for any events that it needs to keep itself properly updated. When the render policy 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 IlvJTreeRenderPolicy's's internal implementation and is not a public API. Only the IlvJTree should invoke this method.

Specified by:

setGanttConfiguration in interface IlvJTreeRenderPolicy

Parameters:

ganttConfig - the Gantt configuration that this rendering policy is being added to, or null if this policy is being removed from its Gantt configuration

getEditor

public TreeCellEditor getEditor()

Return this policy's TreeCellEditor. This default implementation returns null, indicating that the tree is not be editable. Subclasses should override this method as needed.

Specified by:

getEditor in interface IlvJTreeRenderPolicy

isEditable

public boolean isEditable(IlvHierarchyNode row)

Return whether the specified row is editable. The type of the specified row will match the row organization of the Gantt configuration of which the tree 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.

This default implementation always returns false. Subclasses should override this method as needed.

Specified by:

isEditable in interface IlvJTreeRenderPolicy

Parameters:

row - the row

setValue

public void setValue(IlvHierarchyNode row,
                     Object value)

Set the value of the data model at the specified row. The type of the specified row will match the row organization of the Gantt configuration of which the tree 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.

This default implementation does nothing, so subclasses do not have to implement this method if the tree is not editable. If a rendering policy subclass allows the tree to be edited, it should override this method to properly store the edited row value back into the Gantt data model.

Specified by:

setValue in interface IlvJTreeRenderPolicy

Parameters:

row - the row

value - the new value

rowUpdated

public void rowUpdated(IlvHierarchyNode row)

Invoke this method to notify the tree that the representation of the specified row has changed. The tree will then repaint the row.

Parameters:

row - the row whose visual representation has changed