ilog.views.gantt.swing

Class IlvJTreeStringRenderPolicy

java.lang.Object

ilog.views.gantt.swing.IlvAbstractJTreeRenderPolicy

ilog.views.gantt.swing.IlvJTreeStringRenderPolicy

All Implemented Interfaces:

IlvJTreeRenderPolicy, GenericEventListener, EventListener

public class IlvJTreeStringRenderPolicy
extends IlvAbstractJTreeRenderPolicy
implements GenericEventListener

IlvJTreeStringRenderPolicy is a policy that can render and edit a String property of an IlvHierarchyNode (that is, an activity or a resource) in an IlvJTree. 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IlvJTreeStringRenderPolicy.PropertyEditor PropertyEditor is a text field that can edit this policy's property as a string.
static class	IlvJTreeStringRenderPolicy.PropertyRenderer PropertyRenderer is the default TreeCellRenderer for IlvJTreeStringRenderPolicy.

Field Summary

Fields inherited from class ilog.views.gantt.swing.IlvAbstractJTreeRenderPolicy

tree

Constructor Summary

Constructors

Constructor and Description
IlvJTreeStringRenderPolicy(IlvStringProperty property) Constructs a new IlvJTreeStringRenderPolicy that will render and edit the specified activity or resource property.

Method Summary

Modifier and Type	Method and Description
protected TreeCellEditor	createDefaultEditor() Creates and returns a default tree cell editor for this policy.
protected TreeCellRenderer	createDefaultRenderer() Creates and returns a default tree cell renderer for this policy.
TreeCellEditor	getEditor() Returns this policy's TreeCellEditor, or null if the tree should not be editable.
IlvStringProperty	getProperty() Returns the activity or resource property that this policy renders and edits.
TreeCellRenderer	getRenderer() Returns this policy's TreeCellRenderer.
String	getValueAsText(IlvHierarchyNode row) Returns the text value of the specified row.
void	inform(EventObject event) Invoked when the property being rendered has been modified in one of the rows.
boolean	isChildrenEditable() Returns whether leaf rows in the tree are editable.
boolean	isEditable(IlvHierarchyNode row) Returns whether the specified row is editable.
boolean	isParentsEditable() Returns whether parent rows in the tree are editable.
void	setChildrenEditable(boolean editable) Sets whether the leaf rows in the tree are editable.
void	setGanttConfiguration(IlvGanttConfiguration ganttConfig) Invoked whenever this rendering policy is added to or removed from the Gantt configuration.
void	setParentsEditable(boolean editable) Sets whether the parent rows in the tree are editable.
void	setTree(IlvJTree tree) Invoked whenever this rendering policy is added to or removed from its IlvJTree.
void	setValue(IlvHierarchyNode row, Object value) Sets the value of the data model at the specified row.

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

getTree, rowUpdated

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvJTreeStringRenderPolicy

public IlvJTreeStringRenderPolicy(IlvStringProperty property)

Constructs a new IlvJTreeStringRenderPolicy that will render and edit the specified activity or resource property.

Parameters:

property - The activity or resource property to be rendered and edited.

Method Detail

getProperty

public IlvStringProperty getProperty()

Returns the activity or resource property that this policy renders and edits.

setTree

public void setTree(IlvJTree tree)

Invoked whenever this rendering policy is added to or removed from its IlvJTree. It is overridden here to synchronize the editable properties of this rendering policy and the tree.

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

Overrides:

setTree in class IlvAbstractJTreeRenderPolicy

Parameters:

tree - The tree that this renderer policy is being assigned to, or null if this policy is being unassigned from its tree.

setGanttConfiguration

public void setGanttConfiguration(IlvGanttConfiguration ganttConfig)

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 renderer 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 internal implementation and is not a public API. Only the IlvJTree should invoke this method.

Specified by:

setGanttConfiguration in interface IlvJTreeRenderPolicy

Overrides:

setGanttConfiguration in class IlvAbstractJTreeRenderPolicy

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

public TreeCellRenderer getRenderer()

Returns this policy's TreeCellRenderer.

Specified by:

getRenderer in interface IlvJTreeRenderPolicy

createDefaultRenderer

protected TreeCellRenderer createDefaultRenderer()

Creates and returns a default tree cell renderer for this policy.

getEditor

public TreeCellEditor getEditor()

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

Specified by:

getEditor in interface IlvJTreeRenderPolicy

Overrides:

getEditor in class IlvAbstractJTreeRenderPolicy

createDefaultEditor

protected TreeCellEditor createDefaultEditor()

Creates and returns a default tree cell editor for this policy.

isEditable

public boolean isEditable(IlvHierarchyNode row)

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

Specified by:

isEditable in interface IlvJTreeRenderPolicy

Overrides:

isEditable in class IlvAbstractJTreeRenderPolicy

Parameters:

row - The row.

See Also:

isParentsEditable(), isChildrenEditable()

isParentsEditable

public boolean isParentsEditable()

Returns whether parent rows in the tree 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 the tree are editable.

See Also:

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

isChildrenEditable

public boolean isChildrenEditable()

Returns whether leaf rows in the tree 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 the tree are editable.

See Also:

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

getValueAsText

public 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.

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.

Specified by:

getValueAsText in interface IlvJTreeRenderPolicy

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

public void setValue(IlvHierarchyNode row,
                     Object value)

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

Specified by:

setValue in interface IlvJTreeRenderPolicy

Overrides:

setValue in class IlvAbstractJTreeRenderPolicy

Parameters:

row - The row.

value - The new value.

inform

public void inform(EventObject event)

Invoked when the property being rendered has been modified in one of the rows.

Specified by:

inform in interface GenericEventListener

Parameters:

event - The value event.