IlpTree (Rogue Wave JViews 9.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - ilog.cpl.IlpTree

All Implemented Interfaces:

IlpStylable, IlpGraphicComponent, IlpInteractiveGraphicComponent, IlpObjectSelectionModel, IlvStylable, ImageObserver, MenuContainer, Serializable
```
public class IlpTree
extends JComponent
implements IlpInteractiveGraphicComponent
```
The Tree Component, used to represent hierarchical data.
This class is a graphical bean which encapsulates an IlpTreeModel, an IlpTreeView and an IlpTreeController.
The tree model can be filled automatically from an IlpDataSource. The data source content is translated into tree model objects, following the containment hierarchy.
The IlpTree class provides convenient methods to access some view, model and controller properties directly.

Since:

JTGO 3.0

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- Nested classes/interfaces inherited from class java.awt.Container
  Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary
- Fields inherited from class javax.swing.JComponent
  listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
- Fields inherited from class java.awt.Component
  accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
- Fields inherited from interface ilog.cpl.css.IlpStylable
  UPDATE_ALL_MASK, UPDATE_COMPONENT_MASK, UPDATE_NONE_MASK, UPDATE_OBJECTS_MASK
- Fields inherited from interface ilog.views.util.styling.IlvStylable
  APPLIED_RULE_MASK, BAD_CLASS_MASK, BAD_PROP_MASK, BAD_PROP_WITH_STACK_MASK, CREATED_MASK, DECL_MASK, DECL_VALUE_MASK, FAILED_CONVERSIONS_MASK, TIME_REPORT_MASK, WARNING_PROP_MASK
- Fields inherited from interface java.awt.image.ImageObserver
  ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description
`IlpTree()` Default constructor.
`IlpTree(IlpContext context)` Creates a Tree with this context and the default MVC.
`IlpTree(IlpContext context, IlpTreeModel model, IlpTreeView view, IlpTreeController controller)` Creates a Tree component with given MVC components.
`IlpTree(IlpTreeModel model, IlpTreeView view, IlpTreeController controller)` Creates a Tree component with given MVC components.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addPseudoClass(IlpObject bo, String pseudo)` Adds a pseudoclass to the specified business object.
`void`	`addSelectionObject(IlpObject object)` Adds the given `IlpObject` to the selection.
`void`	`clearSelection()` Clears the selection.
`protected IlpAbstractTreeAdapter`	`createDefaultAdapter()` Create a tree adapter for the given adapter mode.
`protected IlpTreeController`	`createDefaultController()` Creates the default controller, which is an `IlpTreeController` object.
`protected IlpTreeModel`	`createDefaultModel()` Creates the default model, which is an `IlpTreeModel` object.
`protected IlpTreeView`	`createDefaultView()` Creates the default view, which is an `IlpTreeView` object.
`void`	`dispose()` Cleans up the tree, disconnects the component from the data source and drops references to objects to help the garbage collection.
`void`	`doLayout()` Lays out the components.
`boolean`	`ensureVisible(IlpObject object)` Scrolls the view in such a way that a given object becomes visible.
`boolean`	`ensureVisible(IlpRepresentationObject object)` Scrolls the view in such a way that a given representation object becomes visible.
`IlpAbstractTreeAdapter`	`getAdapter()` Returns the adapter connected to the tree or creates a new one.
`TreeCellRenderer`	`getCellRenderer()` Retrieves the current tree cell renderer from the view.
`IlpContext`	`getContext()` Returns the context.
`IlpTreeController`	`getController()` Returns the current controller.
`IlpDataSource`	`getDataSource()` Retrieves the current data source.
`IlpViewInteractor`	`getDefaultViewInteractor()` Returns the default view interactor.
`IlpFilter`	`getFilter()` Returns the filter used to filter business objects.
`JScrollBar`	`getHorizontalScrollBar()` Returns the horizontal scroll bar that controls the viewport's horizontal view position.
`int`	`getHorizontalScrollBarPolicy()` Returns the horizontal scroll bar policy value.
`IlpTreeModel`	`getModel()` Returns the current model.
`IlpProject`	`getProject()` Returns the component project configuration.
`JScrollPane`	`getScrollView()` Returns the scrollable view of this component.
`IlpObject`	`getSelectedObject()` Returns the first selected `IlpObject` from the collection of selected objects.
`Collection`	`getSelectedObjects()` Returns the set of selected `IlpObject`s.
`TreeSelectionModel`	`getSelectionModel()` Retrieves the current selection model from the component.
`Comparator`	`getSortComparator()` Retrieves the comparator used to sort the nodes.
`IlpStyle`	`getStyle()` Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.
`IlpGraphicViewStyleManager`	`getStyleManager()` Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please use the method `setStyleSheets` or `getStyleSheets` instead.
`int`	`getStyleSheetDebugMask()` Returns the current debug level.
`String[]`	`getStyleSheets()` Returns the cascaded style sheets.
`String`	`getStyleSheets(int index)` Returns one of the cascading style sheets.
`JScrollBar`	`getVerticalScrollBar()` Returns the vertical scroll bar that controls the viewport's horizontal view position.
`int`	`getVerticalScrollBarPolicy()` Returns the vertical scroll bar policy value.
`IlpTreeView`	`getView()` Returns the current view.
`IlpViewInteractor`	`getViewInteractor()` Retrieves the current view interactor from the controller.
`boolean`	`isObjectSelected(IlpObject object)` Returns `true` if the given `IlpObject` is selected, `false` otherwise.
`void`	`refilter()` Reapplies the current filter to the adapter objects.
`void`	`removePseudoClass(IlpObject bo, String pseudo)` Removes a pseudoclass from the specified business object.
`void`	`removeSelectionObject(IlpObject object)` Removes the given `IlpObject` from the selection.
`void`	`setAdapter(IlpAbstractTreeAdapter adapter)` Sets a new data source adapter.
`void`	`setCellRenderer(TreeCellRenderer renderer)` Sets a new tree cell renderer on the view.
`void`	`setController(IlpTreeController controller)` Sets the controller.
`void`	`setDataSource(IlpDataSource dataSource)` Sets a new data source.
`void`	`setDefaultViewInteractor(IlpViewInteractor interactor)` Sets the default view interactor.
`void`	`setEnabled(boolean enabled)` Sets whether or not this component is enabled.
`void`	`setFilter(IlpFilter filter)` Sets the filter.
`void`	`setHorizontalScrollBarPolicy(int policy)` Determines when the horizontal scrollbar appears.
`void`	`setModel(IlpTreeModel model)` Sets the model.
`void`	`setProject(IlpProject proj)` Sets the project configuration, containing data source information and style sheets.
`void`	`setProject(URL projectURL)` Sets a Tree component project configuration.
`void`	`setSelectedObject(IlpObject object)` Sets the selected `IlpObject`.
`void`	`setSelectedObjects(Collection objects)` Sets the set of selected `IlpObject`s.
`void`	`setSelectionLookAndFeel(int selectionLookAndFeel)` Sets the way the selection is rendered to/manipulated by the end-user.
`void`	`setSelectionModel(TreeSelectionModel selectionModel)` Sets a new selection model on the component.
`void`	`setSortComparator(Comparator comparator)` Sets the comparator used to sort the nodes.
`void`	`setStyleSheetDebugMask(int mask)` Sets the debug level while parsing the style sheets.
`void`	`setStyleSheets(int index, String css)` Changes one of the cascading style sheets.
`void`	`setStyleSheets(int index, String css, int updateMask)` Changes one of the cascading style sheets.
`void`	`setStyleSheets(String[] css)` Sets the Cascading Style Sheets.
`void`	`setStyleSheets(String[] css, int updateMask)` Sets the cascading style sheets.
`void`	`setVerticalScrollBarPolicy(int policy)` Determines when the vertical scrollbar appears.
`void`	`setView(IlpTreeView view)` Sets the view, which gets connected to the model and controller.
`void`	`setViewInteractor(IlpViewInteractor interactor)` Sets the interactor associated with the view.
`void`	`sort()` Sorts the model according to the current sort comparator.

Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ilog.views.util.styling.IlvStylable
addPropertyChangeListener, removePropertyChangeListener

- Constructor Detail
  - IlpTree
```
public IlpTree()
```
    Default constructor. Creates an IlpTree component in the default context.
    A default model, view and controller will be created and used.
    
    See Also:
    
    IlpSystem.GetDefaultContext()
  - IlpTree
```
public IlpTree(IlpContext context,
               IlpTreeModel model,
               IlpTreeView view,
               IlpTreeController controller)
```
    Creates a Tree component with given MVC components.
    
    Parameters:
    
    context - The context used by the tree.
    
    model - The model to be used; if null, createDefaultModel() is called.
    
    view - The view to be used; if null, createDefaultView() is called.
    
    controller - The controller to be used; if null, createDefaultController() is called.
  - IlpTree
```
public IlpTree(IlpTreeModel model,
               IlpTreeView view,
               IlpTreeController controller)
```
    Creates a Tree component with given MVC components.
    
    Parameters:
    
    model - The model to be used; if null, createDefaultModel() is called.
    
    view - The view to be used; if null, createDefaultView() is called.
    
    controller - The controller to be used; if null, createDefaultController() is called.
    The Tree component is initialized using the default context.
    
    See Also:
    
    IlpSystem.GetDefaultContext()
  - IlpTree
```
public IlpTree(IlpContext context)
```
    Creates a Tree with this context and the default MVC.
- Method Detail
  - dispose
```
public void dispose()
```
    Cleans up the tree, disconnects the component from the data source and drops references to objects to help the garbage collection.
    Note: After calling this function, this tree is no longer functional.
    
    Since:
    
    JTGO 4.0
  - getContext
```
public IlpContext getContext()
```
    Returns the context.
    
    Specified by:
    
    getContext in interface IlpGraphicComponent
  - getView
```
public IlpTreeView getView()
```
    Returns the current view.
    
    Returns:
    
    The current view.
  - setView
```
public void setView(IlpTreeView view)
```
    Sets the view, which gets connected to the model and controller. The previous view is disconnected from the model and the controller.
    
    Parameters:
    
    view - The new view. When this parameter is null, a default view is created using createDefaultView().
  - getModel
```
public IlpTreeModel getModel()
```
    Returns the current model.
    
    Returns:
    
    The current model.
  - setModel
```
public void setModel(IlpTreeModel model)
```
    Sets the model.
    
    Parameters:
    
    model - The new model. If this parameter is null, a default model is created using <createDefaultModel().
  - getController
```
public IlpTreeController getController()
```
    Returns the current controller.
    
    Returns:
    
    The current controller.
  - setController
```
public void setController(IlpTreeController controller)
```
    Sets the controller.
    
    Parameters:
    
    controller - The new controller. If this parameter is null, a default controller is created using createDefaultController().
  - getStyleManager
```
@Deprecated
public IlpGraphicViewStyleManager getStyleManager()
```
    Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please use the method setStyleSheets or getStyleSheets instead.
    
    Returns the style manager of the encapsulated view.
    
    Deprecated Since:
    
    JTGO 3.5
  - getStyle
```
@Deprecated
public IlpStyle getStyle()
```
    Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.
    
    Returns the style used to configure the tree view graphically. Returns null if the tree view has no graphic view style manager. (This should not occur.)
    
    Deprecated Since:
    
    JTGO 3.5
  - getSelectedObject
```
public IlpObject getSelectedObject()
```
    Returns the first selected IlpObject from the collection of selected objects. Returns null if there is no selected object.
    
    Specified by:
    
    getSelectedObject in interface IlpObjectSelectionModel
  - getSelectedObjects
```
public Collection getSelectedObjects()
```
    Returns the set of selected IlpObjects. Returns an empty set if there is no selected object.
    
    Specified by:
    
    getSelectedObjects in interface IlpObjectSelectionModel
    
    Returns:
    
    An unmodifiable Collection of IlpObjects.
  - isObjectSelected
```
public boolean isObjectSelected(IlpObject object)
```
    Returns true if the given IlpObject is selected, false otherwise.
    
    Specified by:
    
    isObjectSelected in interface IlpObjectSelectionModel
    
    Parameters:
    
    object - The object which may be selected.
  - addSelectionObject
```
public void addSelectionObject(IlpObject object)
```
    Adds the given IlpObject to the selection. This has no effect if the given object is null.
    
    Specified by:
    
    addSelectionObject in interface IlpObjectSelectionModel
    
    Parameters:
    
    object - The object that will be added to the selection.
  - removeSelectionObject
```
public void removeSelectionObject(IlpObject object)
```
    Removes the given IlpObject from the selection. This has no effect if the given object is null.
    
    Specified by:
    
    removeSelectionObject in interface IlpObjectSelectionModel
    
    Parameters:
    
    object - The object that will be removed from the selection.
  - setSelectedObject
```
public void setSelectedObject(IlpObject object)
```
    Sets the selected IlpObject. This has no effect if the given object is already selected.
    
    Specified by:
    
    setSelectedObject in interface IlpObjectSelectionModel
    
    Parameters:
    
    object - The object that will become the selection.
    
    Since:
    
    JTGO 4.0
  - setSelectedObjects
```
public void setSelectedObjects(Collection objects)
```
    Sets the set of selected IlpObjects.
    
    Specified by:
    
    setSelectedObjects in interface IlpObjectSelectionModel
    
    Parameters:
    
    objects - The collection of objects that will become the selection.
    
    Since:
    
    JTGO 4.0
  - clearSelection
```
public void clearSelection()
```
    Clears the selection.
    
    Specified by:
    
    clearSelection in interface IlpObjectSelectionModel
  - setSelectionModel
```
public void setSelectionModel(TreeSelectionModel selectionModel)
```
    Sets a new selection model on the component.
    
    Parameters:
    
    selectionModel - The new selection model.
  - getSelectionModel
```
public TreeSelectionModel getSelectionModel()
```
    Retrieves the current selection model from the component.
    
    Returns:
    
    The selection model.
  - setSelectionLookAndFeel
```
public void setSelectionLookAndFeel(int selectionLookAndFeel)
```
    Sets the way the selection is rendered to/manipulated by the end-user.
    
    Parameters:
    
    selectionLookAndFeel - One of: IlpTreeView.HIGHLIGHT_SELECTION_LOOK_AND_FEEL, IlpTreeView.CHECKBOX_SELECTION_LOOK_AND_FEEL.
    
    See Also:
    
    IlpTreeView.setSelectionLookAndFeel(int)
  - setSortComparator
```
public void setSortComparator(Comparator comparator)
```
    Sets the comparator used to sort the nodes. The comparator will be invoked with a pair of IlpObject instances, and should return a value indicating the order in which they should appear in the tree.
    
    Parameters:
    
    comparator - The new comparator.
  - getSortComparator
```
public Comparator getSortComparator()
```
    Retrieves the comparator used to sort the nodes. The comparator will be invoked with a pair of IlpObject instances, and should return a value indicating the order in which they should appear in the tree.
    
    Returns:
    
    The comparator used to sort the nodes.
    
    See Also:
    
    IlpAttributeComparator
  - sort
```
public void sort()
```
    Sorts the model according to the current sort comparator.
    This method can be used, for example, if the comparator behavior has changed.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IlpAbstractTreeAdapter.sort()
  - ensureVisible
```
public boolean ensureVisible(IlpRepresentationObject object)
```
    Scrolls the view in such a way that a given representation object becomes visible.
    The operation is ignored if the given representation object is not part of the tree component model.
    
    Returns:
    
    true if the object is visible, false otherwise
    
    Since:
    
    JTGO 4.5
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether or not this component is enabled.
    A component that is enabled may respond to user input, while a component that is not enabled cannot respond to user input.
    Note: Disabling a component does not disable it's children.
    Note: Disabling a lightweight component does not prevent it from receiving MouseEvents.
    
    Overrides:
    
    setEnabled in class JComponent
    
    Parameters:
    
    enabled - true if this component should be enabled, false otherwise
    
    Since:
    
    JTGO 4.5
  - ensureVisible
```
public boolean ensureVisible(IlpObject object)
```
    Scrolls the view in such a way that a given object becomes visible.
    This operation forces the tree path of the given object to be expanded, therefore loading the objects if they are yet represented in the view.
    
    Returns:
    
    true if the object is visible, false otherwise
    
    Since:
    
    JTGO 4.5
  - setCellRenderer
```
public void setCellRenderer(TreeCellRenderer renderer)
```
    Sets a new tree cell renderer on the view.
    
    Parameters:
    
    renderer - The new cell renderer.
  - getCellRenderer
```
public TreeCellRenderer getCellRenderer()
```
    Retrieves the current tree cell renderer from the view.
    
    Returns:
    
    The tree cell renderer.
  - getDefaultViewInteractor
```
public IlpViewInteractor getDefaultViewInteractor()
```
    Returns the default view interactor. This is called when view interactors detach themselves: they install the default view interactor instead of themselves.
    
    Specified by:
    
    getDefaultViewInteractor in interface IlpInteractiveGraphicComponent
  - setDefaultViewInteractor
```
public void setDefaultViewInteractor(IlpViewInteractor interactor)
```
    Sets the default view interactor. This is usually called during initialization of the component only.
    
    Specified by:
    
    setDefaultViewInteractor in interface IlpInteractiveGraphicComponent
    
    See Also:
    
    IlpInteractiveGraphicComponent.setViewInteractor(ilog.cpl.interactor.IlpViewInteractor)
  - getViewInteractor
```
public IlpViewInteractor getViewInteractor()
```
    Retrieves the current view interactor from the controller.
    
    Specified by:
    
    getViewInteractor in interface IlpInteractiveGraphicComponent
    
    Returns:
    
    The view interactor.
  - setViewInteractor
```
public void setViewInteractor(IlpViewInteractor interactor)
```
    Sets the interactor associated with the view.
    
    Specified by:
    
    setViewInteractor in interface IlpInteractiveGraphicComponent
    
    Parameters:
    
    interactor - The interactor to be set.
  - setDataSource
```
public void setDataSource(IlpDataSource dataSource)
```
    Sets a new data source. The data source contains business objects of type IlpObject. Creation, removal, and updates of IlpObjects in the IlpDataSource object are translated by an adapter into creation, removal, and updates of representation objects (IlpTreeNode objects).
    The adapter is created automatically by the IlpTree object. By default, an IlpContainmentTreeAdapter is created.
    
    Specified by:
    
    setDataSource in interface IlpGraphicComponent
    
    Parameters:
    
    dataSource - The new data source.
    
    See Also:
    
    IlpDataSource, IlpAbstractTreeAdapter
  - getDataSource
```
public IlpDataSource getDataSource()
```
    Retrieves the current data source.
    
    Specified by:
    
    getDataSource in interface IlpGraphicComponent
    
    Returns:
    
    The data source.
  - getAdapter
```
public IlpAbstractTreeAdapter getAdapter()
```
    Returns the adapter connected to the tree or creates a new one.
    The adapter is lazily created the first time it is required. By default an IlpContainmentTreeAdapter is created.
    
    Returns:
    
    The adapter connected to the network.
    
    See Also:
    
    setAdapter(ilog.cpl.tree.IlpAbstractTreeAdapter), setDataSource(ilog.cpl.datasource.IlpDataSource)
  - setAdapter
```
public void setAdapter(IlpAbstractTreeAdapter adapter)
```
    Sets a new data source adapter.
    
    Parameters:
    
    adapter - The adapter that connects the tree component to its data source; cannot be null.
    
    Throws:
    
    IllegalArgumentException - if the given adapter is null.
    
    See Also:
    
    getAdapter(), setDataSource(ilog.cpl.datasource.IlpDataSource)
  - setFilter
```
public void setFilter(IlpFilter filter)
```
    Sets the filter. The data source objects are filtered, so only IlpObjects that pass through the filter are added to the model.
    
    Parameters:
    
    filter - The filter to use to filter business objects. This parameter may be null meaning the business objects are not filtered.
  - getFilter
```
public IlpFilter getFilter()
```
    Returns the filter used to filter business objects.
    
    Returns:
    
    The filter used to filter business objects.
    
    See Also:
    
    setFilter(IlpFilter)
  - refilter
```
public void refilter()
```
    Reapplies the current filter to the adapter objects.
    This is a convenience method for the filter feature that is supported by the adapter. It applies the current filter to the objects that are represented. This method allows you to change the filter criterion without having to set a new filter in the adapter.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IlpAbstractAdapter.refilter()
  - createDefaultModel
```
protected IlpTreeModel createDefaultModel()
```
    Creates the default model, which is an IlpTreeModel object. A subclass can override this method to return a different model.
    
    Returns:
    
    The default model.
    
    See Also:
    
    IlpTreeModel
  - createDefaultView
```
protected IlpTreeView createDefaultView()
```
    Creates the default view, which is an IlpTreeView object. A subclass can override this method to return a different view.
    
    Returns:
    
    The default view.
    
    See Also:
    
    IlpTreeView
  - createDefaultController
```
protected IlpTreeController createDefaultController()
```
    Creates the default controller, which is an IlpTreeController object. A subclass can override this method to return a different controller.
    
    Returns:
    
    The default controller.
    
    See Also:
    
    IlpTreeController
  - createDefaultAdapter
```
protected IlpAbstractTreeAdapter createDefaultAdapter()
```
    Create a tree adapter for the given adapter mode. By default, an IlpContainmentTreeAdapter is created.
  - doLayout
```
public void doLayout()
```
    Lays out the components.
    
    Overrides:
    
    doLayout in class Container
  - getVerticalScrollBarPolicy
```
public int getVerticalScrollBarPolicy()
```
    Returns the vertical scroll bar policy value.
    
    Returns:
    
    the verticalScrollBarPolicy property
    
    See Also:
    
    setVerticalScrollBarPolicy(int)
  - setVerticalScrollBarPolicy
```
public void setVerticalScrollBarPolicy(int policy)
```
    Determines when the vertical scrollbar appears. Legal values are:
    - JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED
    - JScrollPane.VERTICAL_SCROLLBAR_NEVER
    - JScrollPane.VERTICAL_SCROLLBAR_ALWAYS
    Parameters:
    
    policy - one of the three values listed above
    
    Throws:
    
    IllegalArgumentException - if policy is not one of the legal values shown above
    
    See Also:
    
    getVerticalScrollBarPolicy()
  - getHorizontalScrollBarPolicy
```
public int getHorizontalScrollBarPolicy()
```
    Returns the horizontal scroll bar policy value.
    
    Returns:
    
    the horizontalScrollBarPolicy property
    
    See Also:
    
    setHorizontalScrollBarPolicy(int)
  - setHorizontalScrollBarPolicy
```
public void setHorizontalScrollBarPolicy(int policy)
```
    Determines when the horizontal scrollbar appears. The options are:
    - JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED
    - JScrollPane.HORIZONTAL_SCROLLBAR_NEVER
    - JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS
    Parameters:
    
    policy - one of the three values listed above
    
    Throws:
    
    IllegalArgumentException - if policy is not one of the legal values shown above
    
    See Also:
    
    getHorizontalScrollBarPolicy()
  - getScrollView
```
public final JScrollPane getScrollView()
```
    Returns the scrollable view of this component.
    
    Returns:
    
    Scrollable view
    
    Since:
    
    JViews 7.5
  - getHorizontalScrollBar
```
public final JScrollBar getHorizontalScrollBar()
```
    Returns the horizontal scroll bar that controls the viewport's horizontal view position.
    
    Since:
    
    JViews 7.5
  - getVerticalScrollBar
```
public final JScrollBar getVerticalScrollBar()
```
    Returns the vertical scroll bar that controls the viewport's horizontal view position.
    
    Since:
    
    JViews 7.5
  - setStyleSheets
```
public void setStyleSheets(String[] css)
                    throws IlvStylingException
```
    Sets the Cascading Style Sheets.
    Each element can be a URL, a filename, or the style sheet string directly. The order is by priority (the last CSS takes precedence).
    
    Specified by:
    
    setStyleSheets in interface IlvStylable
    
    Parameters:
    
    css - An array of strings containing the URLs, the file names of CSS files (usually with a .css suffix) or CSS extracts.
    
    Throws:
    
    IlvStylingException
    
    Since:
    
    JTGO 3.5
    
    See Also:
    
    getStyleSheets()
  - setStyleSheets
```
public void setStyleSheets(String[] css,
                           int updateMask)
                    throws IlvStylingException
```
    Sets the cascading style sheets.
    Each element can be a URL, a filename, or directly the style sheet string. The order is by priority (the last CSS takes precedence).
    
    Specified by:
    
    setStyleSheets in interface IlpStylable
    
    Parameters:
    
    css - An array of strings containing the URLs, the file names of CSS files (usually with a .css suffix) or CSS extracts.
    
    updateMask - A flag that indicates whether the component and/or the business objects need to be updated to use this new configuration. When IlpStylable.UPDATE_COMPONENT_MASK is set, the view and adapter are reconfigured with the new style sheets. When IlpStylable.UPDATE_OBJECTS_MASK is set, the representation objects that are displayed in this view are reconfigured according to the new style sheets.
    
    Throws:
    
    IlvStylingException
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IlpStylable.UPDATE_COMPONENT_MASK, IlpStylable.UPDATE_OBJECTS_MASK, getStyleSheets()
  - setStyleSheets
```
public void setStyleSheets(int index,
                           String css)
                    throws IlvStylingException
```
    Changes one of the cascading style sheets.
    This method is an alternative to setStyleSheets(java.lang.String[]). It lets you change one particular style sheet file, instead of setting the whole style sheet array.
    
    Specified by:
    
    setStyleSheets in interface IlvStylable
    
    Parameters:
    
    index - The index of the style sheet to replace.
    
    css - The URL, file name of the new style sheet file or CSS extract.
    
    Throws:
    
    IlvStylingException
    
    Since:
    
    JTGO 3.5
    
    See Also:
    
    setStyleSheets(java.lang.String[]), getStyleSheets(int)
  - setStyleSheets
```
public void setStyleSheets(int index,
                           String css,
                           int updateMask)
                    throws IlvStylingException
```
    Changes one of the cascading style sheets.
    This method is an alternative to setStyleSheets(java.lang.String[]). It lets you change one particular style sheet file, instead of setting the whole style sheet array. When this method is used, you can indicate whether you want to reapply this configuration immediately to the view, the adapter and all the objects that are already being displayed in the component.
    
    Specified by:
    
    setStyleSheets in interface IlpStylable
    
    Parameters:
    
    index - The index of the style sheet to replace.
    
    css - The URL, file name or CSS extract of the new style sheet.
    
    updateMask - A flag that indicates whether the component and/or the business objects need to be updated to use this new configuration. When IlpStylable.UPDATE_COMPONENT_MASK is set, the view and adapter are reconfigured with the new style sheets. When IlpStylable.UPDATE_OBJECTS_MASK is set, the representation objects that are displayed in this view are reconfigured according to the new style sheets.
    
    Throws:
    
    IlvStylingException
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IlpStylable.UPDATE_COMPONENT_MASK, IlpStylable.UPDATE_OBJECTS_MASK, getStyleSheets(int)
  - getStyleSheets
```
public String[] getStyleSheets()
```
    Returns the cascaded style sheets.
    
    Specified by:
    
    getStyleSheets in interface IlvStylable
    
    Returns:
    
    An array containing the URLs, file names of the style sheets or CSS extracts directly.
    
    Since:
    
    JTGO 3.5
    
    See Also:
    
    setStyleSheets(String[])
  - getStyleSheets
```
public String getStyleSheets(int index)
```
    Returns one of the cascading style sheets.
    
    Specified by:
    
    getStyleSheets in interface IlvStylable
    
    Parameters:
    
    index - The position of the cascading style sheet to return.
    
    Returns:
    
    The URL, file name or CSS extract of the style sheet at index-th position in the style sheet array.
    
    Since:
    
    JTGO 3.5
    
    See Also:
    
    setStyleSheets(int, String)
  - setStyleSheetDebugMask
```
public void setStyleSheetDebugMask(int mask)
```
    Sets the debug level while parsing the style sheets. Set this property before calling setStyleSheets(java.lang.String[]) to debug problems during configuration.
    
    Specified by:
    
    setStyleSheetDebugMask in interface IlvStylable
    
    Parameters:
    
    mask - The debug mask, expressed as an OR combination of the predefined flags.
    
    Since:
    
    JTGO 3.5
    
    See Also:
    
    setStyleSheets(java.lang.String[]), getStyleSheetDebugMask(), IlvStylable.APPLIED_RULE_MASK, IlvStylable.BAD_CLASS_MASK, IlvStylable.BAD_PROP_MASK, IlvStylable.BAD_PROP_WITH_STACK_MASK, IlvStylable.CREATED_MASK, IlvStylable.DECL_MASK, IlvStylable.DECL_VALUE_MASK, IlvStylable.FAILED_CONVERSIONS_MASK, IlvStylable.TIME_REPORT_MASK, IlvStylable.WARNING_PROP_MASK
  - getStyleSheetDebugMask
```
public int getStyleSheetDebugMask()
```
    Returns the current debug level.
    
    Specified by:
    
    getStyleSheetDebugMask in interface IlvStylable
    
    Since:
    
    JTGO 3.5
    
    See Also:
    
    setStyleSheetDebugMask(int)
  - addPseudoClass
```
public void addPseudoClass(IlpObject bo,
                           String pseudo)
```
    Adds a pseudoclass to the specified business object.
    Pseudoclasses are used to modify the appearance of an object depending on state information, such as whether the object is selected, expanded, and so on.
    The pseudoclasses expanded, selected, and focus are automatically used to customize the objects. Add your own pseudoclasses to create new types of customization that depend on the graphic view characteristics.
    
    Parameters:
    
    bo - The business object.
    
    pseudo - A string that identifies a pseudoclass to add to the classes already associated with the data object.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IlpTreeView.addPseudoClass(ilog.cpl.model.IlpObject, java.lang.String)
  - removePseudoClass
```
public void removePseudoClass(IlpObject bo,
                              String pseudo)
```
    Removes a pseudoclass from the specified business object.
    Pseudoclasses are used to modify the appearance of an object depending on state information, such as whether the object is selected, expanded, and so on.
    The pseudoclasses expanded, selected, and focus are automatically used to customize the objects. Add your own pseudoclasses to create new types of customization that depend on the graphic view characteristics.
    
    Parameters:
    
    bo - The business object.
    
    pseudo - A string that identifies a pseudoclass to move from the classes associated with the data object.
    
    Since:
    
    JTGO 4.0
    
    See Also:
    
    IlpTreeView.removePseudoClass(ilog.cpl.model.IlpObject, java.lang.String)
  - setProject
```
public void setProject(URL projectURL)
                throws IOException
```
    Sets a Tree component project configuration.
    The project configuration will be applied to the component, modifying the datasource and style sheet configuration.
    
    Parameters:
    
    projectURL - New project configuration
    
    Throws:
    
    IOException, - if the project URL contains invalid data
    
    IOException
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setDataSource(IlpDataSource), setStyleSheets(String[]), getProject(), IlpProject
  - setProject
```
public void setProject(IlpProject proj)
```
    Sets the project configuration, containing data source information and style sheets.
    The project configuration will be applied to the component, modifying the datasource and style sheet configuration.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    IlpProject, setDataSource(IlpDataSource), setStyleSheets(String[]), getProject()
  - getProject
```
public IlpProject getProject()
```
    Returns the component project configuration.
    
    Returns:
    
    Project configuration or null if a project configuration has not been set in this component.
    
    Since:
    
    JViews 7.5

Class IlpTree

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface ilog.cpl.css.IlpStylable

Fields inherited from interface ilog.views.util.styling.IlvStylable

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface ilog.views.util.styling.IlvStylable

Constructor Detail

IlpTree

IlpTree

IlpTree

IlpTree

Method Detail

dispose

getContext

getView

setView

getModel

setModel

getController

setController

getStyleManager

getStyle

getSelectedObject

getSelectedObjects

isObjectSelected

addSelectionObject

removeSelectionObject

setSelectedObject

setSelectedObjects

clearSelection

setSelectionModel

getSelectionModel

setSelectionLookAndFeel

setSortComparator

getSortComparator

sort

ensureVisible

setEnabled

ensureVisible

setCellRenderer

getCellRenderer

getDefaultViewInteractor

setDefaultViewInteractor

getViewInteractor

setViewInteractor

setDataSource

getDataSource

getAdapter

setAdapter

setFilter

getFilter

refilter

createDefaultModel

createDefaultView

createDefaultController

createDefaultAdapter

doLayout

getVerticalScrollBarPolicy

setVerticalScrollBarPolicy

getHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy

getScrollView

getHorizontalScrollBar

getVerticalScrollBar

setStyleSheets

setStyleSheets

setStyleSheets

setStyleSheets