ilog.views.gantt.swing

Interface IlvJTreeRenderPolicy

All Known Implementing Classes:

IlvAbstractJTreeRenderPolicy, IlvJTreeStringRenderPolicy

public interface IlvJTreeRenderPolicy

IlvJTreeRenderPolicy defines the rendering and editing policy for rows (that is, activities or resources) being displayed in an IlvJTree.

See Also:

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

Method Summary

Modifier and Type	Method and Description
TreeCellEditor	getEditor() Return this policy's TreeCellEditor, or null if the tree should not be editable.
TreeCellRenderer	getRenderer() Return this policy's TreeCellRenderer.
String	getValueAsText(IlvHierarchyNode row) Returns the text value of the specified row.
boolean	isEditable(IlvHierarchyNode row) Return whether the specified row is editable.
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.

Method Detail

setTree

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.

Parameters:

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

setGanttConfiguration

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.

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.

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

getRenderer

TreeCellRenderer getRenderer()

Return this policy's TreeCellRenderer.

getEditor

TreeCellEditor getEditor()

Return this policy's TreeCellEditor, or null if the tree should not be editable.

isEditable

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

Parameters:

row - the row

getValueAsText

String getValueAsText(IlvHierarchyNode row)

Returns the text value of the specified row. This method is called by the tree renderer to convert the data model value to the text to be rendered. Therefore, implementations of this method should not circularly call the renderer.

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:

setValue(ilog.views.gantt.IlvHierarchyNode, java.lang.Object), IlvJTree.convertValueToText(java.lang.Object, boolean, boolean, boolean, int, boolean)

setValue

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 typeis 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