ilog.cpl.tree

Class IlpTreeView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JTree

ilog.cpl.tree.IlpTreeView

All Implemented Interfaces:

IlpStylable, AdapterListener, ilog.cpl.graphic.css.internal.IlpCSSGraphicView, IlpGraphicView, IlpStylableGraphicView, IlvStylable, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, Scrollable

public class IlpTreeView
extends JTree
implements IlpStylableGraphicView, ilog.cpl.graphic.css.internal.IlpCSSGraphicView, AdapterListener

Graphic view part of the MVC architecture for the tree component.

This class displays the content of a TreeModel object in the form of a tree.

In addition to the common 'what is highlighted is what is selected' paradigm, this tree offers an alternate look-and-feel using check boxes to render/manipulate the selection. See setSelectionLookAndFeel(int).

Since:

JTGO 3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	IlpTreeView.IlpTreeModelHandler Listens to the model and updates the graphic representation of the nodes accordingly when nodes are changed.

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

JTree.AccessibleJTree, JTree.DropLocation, JTree.DynamicUtilTreeNode, JTree.EmptySelectionModel, JTree.TreeModelHandler, JTree.TreeSelectionRedirector

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

Modifier and Type	Field and Description
static int	CHECKBOX_SELECTION_LOOK_AND_FEEL Selection is displayed/modified by check boxes.
static String	HIGHLIGHT_MODE_PROPERTY Bound property name for highlightMode.
static int	HIGHLIGHT_SELECTION_LOOK_AND_FEEL Selection is displayed/modified by highlighting nodes.
static int	LEAD_SELECTION_HIGHLIGHT Only the lead selection is highlighted.
static int	SELECTED_SELECTION_HIGHLIGHT The selected objects from the selection model are highlighted.
static String	SELECTION_CHECKBOX_VISIBLE_PROPERTY Bound property name for selectionCheckBoxVisible.

Fields inherited from class javax.swing.JTree

ANCHOR_SELECTION_PATH_PROPERTY, CELL_EDITOR_PROPERTY, CELL_RENDERER_PROPERTY, cellEditor, cellRenderer, editable, EDITABLE_PROPERTY, EXPANDS_SELECTED_PATHS_PROPERTY, INVOKES_STOP_CELL_EDITING_PROPERTY, invokesStopCellEditing, LARGE_MODEL_PROPERTY, largeModel, LEAD_SELECTION_PATH_PROPERTY, ROOT_VISIBLE_PROPERTY, rootVisible, ROW_HEIGHT_PROPERTY, rowHeight, SCROLLS_ON_EXPAND_PROPERTY, scrollsOnExpand, SELECTION_MODEL_PROPERTY, selectionModel, selectionRedirector, SHOWS_ROOT_HANDLES_PROPERTY, showsRootHandles, TOGGLE_CLICK_COUNT_PROPERTY, toggleClickCount, TREE_MODEL_PROPERTY, treeModel, treeModelListener, VISIBLE_ROW_COUNT_PROPERTY, visibleRowCount

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
IlpTreeView() Creates an IlpTreeView object.

Method Summary

Modifier and Type	Method and Description
void	addPseudoClass(IlpObject bo, String pseudo) Adds a pseudoclass to the specified business object.
void	addPseudoClass(IlpRepresentationObject ro, String pseudo) Adds a pseudoclass to the given representation object.
protected TreePath	createPathForNode(TreeNode node) Creates a tree path for the given node.
protected TreeModelListener	createTreeModelListener() Creates and returns an instance of IlpTreeModelHandler.
boolean	ensureVisible(IlpObject object) Scrolls the view in such a way that a given object becomes visible.
boolean	ensureVisible(IlpRepresentationObject ro) Scrolls the view in such a way that a given representation object becomes visible.
IlpAttribute	getAttribute(IlpPoint viewLocation) Returns the IlpAttribute object at the given position in this object.
boolean	getCollapseUnselectsDescendants() Returns true if collapsing a node deselects its descendants.
Container	getContainer() Returns the concrete container where the graphics are currently being displayed.
IlpContext	getContext() Returns the application context.
IlpGraphicController	getController() Returns the controller, which is responsible for the interaction between the user and the view.
IlpGraphic	getGraphic(IlpPoint viewLocation) Returns the IlpGraphic object at the given position in this object.
Class<?>	getGraphicComponentClass() Returns the graphic component class supported by this implementation of graphic view.
IlpGraphicHolder	getGraphicHolder() Returns the association between object representations and graphics.
int	getHighlightMode() Returns the highlight mode.
IlpGraphic	getInnermostGraphic(IlpPoint viewLocation) Returns the innermost graphic at the given position in this object.
List<String>	getPseudoClasses(IlpRepresentationObject ro, IlpAttribute a) Returns the custom pseudoclasses currently active for the object
IlpRepresentationObject	getRepresentationObject(IlpPoint viewLocation) Returns the IlpRepresentationObject object at the given position in this object.
IlpRepresentationObjectMapper	getRepresentationObjectMapper() Returns the mapper that allows the tree view to know the correspondence between IlpRepresentationObject and IlpObject.
IlpRepresentationObjectSelectionModel	getRepresentationObjectSelectionModel() Returns the IlpRepresentationObjectSelectionModel used to handle the selection of representation objects.
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 cascading style sheets.
String	getStyleSheets(int index) Returns one of the cascading style sheets.
ilog.cpl.tree.internal.IlpTreeViewSupport	getTreeViewSupport() useful for our friend: the controller.
ilog.cpl.graphic.css.internal.IlpViewCSSContext	getViewCSSContext() Returns the context information that provides Cascading Style Sheets support for this graphic view.
boolean	hasStyleSheets() Returns true if style sheets have been defined for this view.
void	invalidate(IlpRepresentationObject ro) Invalidates the graphic representation of the given object.
void	invalidateGraphics() Invalidates all the graphic representations in this view.
void	invalidateLayoutCache() This is a convenient method to allow for explicitly invalidating the layout cache.
void	invalidateLayoutCache(IlpRepresentationObject ro) Deprecated. Invalidating the layout cache for a specific representation object is no longer supported. Please use method {invalidateLayoutCache() instead.
boolean	isSelectionCheckBoxVisible() Indicates whether the selected nodes are displayed using check boxes.
void	makeVisible(TreePath path) Ensures that the node identified by path is currently viewable.
protected void	processKeyEvent(KeyEvent e) Processes key events occurring on this component by dispatching them to any registered KeyListener objects.
protected void	processMouseEvent(MouseEvent e) Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects.
protected boolean	removeDescendantSelectedPaths(TreePath path, boolean includePath) Removes any paths in the selection that are descendants of path.
void	removePseudoClass(IlpObject bo, String pseudo) Removes a pseudoclass from the specified business object.
void	removePseudoClass(IlpRepresentationObject ro, String pseudo) Removes a pseudoclass from the given representation object.
void	representationObjectsAdded(AdapterEvent e) Called when objects have been added to the adapter.
void	representationObjectsRemoved(AdapterEvent e) Called when objects have been removed from the adapter.
void	setCellRenderer(TreeCellRenderer x) Sets the TreeCellRenderer that will be used to draw each cell.
void	setCollapseUnselectsDescendants(boolean collapseUnselectsDescendants) Sets the descendants of a collapsed node to be deselected or not.
void	setController(IlpGraphicController controller) Sets the controller, which is responsible for the interaction between the user and the view.
void	setHighlightMode(int highlightMode) Sets the mode used to determine whether a cell is highlighted or not.
void	setModel(TreeModel newModel) Sets the TreeModel that will provide the data.
void	setRepresentationObjectMapper(IlpRepresentationObjectMapper mapper) Sets a mapper that allows the tree view to know the correspondence between IlpRepresentationObject and IlpObject
void	setSelectionCheckBoxVisible(boolean selectionCheckBoxVisible) Activates or deactivates the use of check boxes to display and modify the selection status of nodes.
void	setSelectionInterval(int index0, int index1) Selects the nodes between index0 and index1, inclusive.
void	setSelectionLookAndFeel(int selectionLookAndFeel) Sets the way the selection is rendered to/manipulated by the end-user.
void	setStyleManager(IlpGraphicViewStyleManager config) Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please use the method setStyleSheets or getStyleSheets instead.
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.

Methods inherited from class javax.swing.JTree

addSelectionInterval, addSelectionPath, addSelectionPaths, addSelectionRow, addSelectionRows, addTreeExpansionListener, addTreeSelectionListener, addTreeWillExpandListener, cancelEditing, clearSelection, clearToggledPaths, collapsePath, collapseRow, convertValueToText, createTreeModel, expandPath, expandRow, fireTreeCollapsed, fireTreeExpanded, fireTreeWillCollapse, fireTreeWillExpand, fireValueChanged, getAccessibleContext, getAnchorSelectionPath, getCellEditor, getCellRenderer, getClosestPathForLocation, getClosestRowForLocation, getDefaultTreeModel, getDescendantToggledPaths, getDragEnabled, getDropLocation, getDropMode, getEditingPath, getExpandedDescendants, getExpandsSelectedPaths, getInvokesStopCellEditing, getLastSelectedPathComponent, getLeadSelectionPath, getLeadSelectionRow, getMaxSelectionRow, getMinSelectionRow, getModel, getNextMatch, getPathBetweenRows, getPathBounds, getPathForLocation, getPathForRow, getPreferredScrollableViewportSize, getRowBounds, getRowCount, getRowForLocation, getRowForPath, getRowHeight, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getScrollsOnExpand, getSelectionCount, getSelectionModel, getSelectionPath, getSelectionPaths, getSelectionRows, getShowsRootHandles, getToggleClickCount, getToolTipText, getTreeExpansionListeners, getTreeSelectionListeners, getTreeWillExpandListeners, getUI, getUIClassID, getVisibleRowCount, hasBeenExpanded, isCollapsed, isCollapsed, isEditable, isEditing, isExpanded, isExpanded, isFixedRowHeight, isLargeModel, isPathEditable, isPathSelected, isRootVisible, isRowSelected, isSelectionEmpty, isVisible, paramString, removeDescendantToggledPaths, removeSelectionInterval, removeSelectionPath, removeSelectionPaths, removeSelectionRow, removeSelectionRows, removeTreeExpansionListener, removeTreeSelectionListener, removeTreeWillExpandListener, scrollPathToVisible, scrollRowToVisible, setAnchorSelectionPath, setCellEditor, setDragEnabled, setDropMode, setEditable, setExpandedState, setExpandsSelectedPaths, setInvokesStopCellEditing, setLargeModel, setLeadSelectionPath, setRootVisible, setRowHeight, setScrollsOnExpand, setSelectionModel, setSelectionPath, setSelectionPaths, setSelectionRow, setSelectionRows, setShowsRootHandles, setToggleClickCount, setUI, setVisibleRowCount, startEditingAtPath, stopEditing, treeDidChange, updateUI

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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, 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, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, 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, 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

Field Detail

SELECTION_CHECKBOX_VISIBLE_PROPERTY

public static final String SELECTION_CHECKBOX_VISIBLE_PROPERTY

Bound property name for selectionCheckBoxVisible.

See Also:

Constant Field Values

Internal: do not use!

HIGHLIGHT_MODE_PROPERTY

public static final String HIGHLIGHT_MODE_PROPERTY

Bound property name for highlightMode.

See Also:

Constant Field Values

Internal: do not use!

LEAD_SELECTION_HIGHLIGHT

public static final int LEAD_SELECTION_HIGHLIGHT

Only the lead selection is highlighted.

Since the highlight does not reflect the actual selection, you probably want to display the selection check boxes, using setSelectionCheckBoxVisible(true).

See Also:

setHighlightMode(int), setSelectionCheckBoxVisible(boolean), Constant Field Values

SELECTED_SELECTION_HIGHLIGHT

public static final int SELECTED_SELECTION_HIGHLIGHT

The selected objects from the selection model are highlighted. This mode imitates the Swing JTree behavior.

See Also:

setHighlightMode(int), Constant Field Values

HIGHLIGHT_SELECTION_LOOK_AND_FEEL

public static final int HIGHLIGHT_SELECTION_LOOK_AND_FEEL

Selection is displayed/modified by highlighting nodes. In this mode, 'highlighted' is equivalent to 'selected.' Also, collapsing a node deselects its descendants.

This is the common selection look-and-feel implemented in the Swing JTree.

Note that setting the selectionLookAndFeel to HIGHLIGHT_SELECTION_LOOK_AND_FEEL is strictly equivalent to the following:

    setSelectionCheckBoxVisible(false);
    setCollapseUnselectsDescendants(true);
    setHighlightMode(SELECTED_SELECTION_HIGHLIGHT);
 

See Also:

Constant Field Values

CHECKBOX_SELECTION_LOOK_AND_FEEL

public static final int CHECKBOX_SELECTION_LOOK_AND_FEEL

Selection is displayed/modified by check boxes. In this mode, 'checked' is equivalent to 'selected.' Only the focused cell is highlighted. Selection is preserved when a node is collapsed.

Note that setting the selectionLookAndFeel to CHECKBOX_SELECTION_LOOK_AND_FEEL is strictly equivalent to the following:

    setSelectionCheckBoxVisible(true);
    setCollapseUnselectsDescendants(false);
    setHighlightMode(LEAD_SELECTION_HIGHLIGHT);
 

See Also:

Constant Field Values

Constructor Detail

IlpTreeView

public IlpTreeView()

Creates an IlpTreeView object. By default, the selectionLookAndFeel is: HIGHLIGHT_SELECTION_LOOK_AND_FEEL; the treeCellRenderer is an IlpTreeCellRenderer object; the selectionModel is an IlpDefaultTreeSelectionModel object.

Method Detail

getTreeViewSupport

public ilog.cpl.tree.internal.IlpTreeViewSupport getTreeViewSupport()

useful for our friend: the controller.

Internal: do not use!

getContext

public IlpContext getContext()

Returns the application context.

Specified by:

getContext in interface IlpGraphicView

getController

public IlpGraphicController getController()

Returns the controller, which is responsible for the interaction between the user and the view.

Specified by:

getController in interface IlpGraphicView

setController

public void setController(IlpGraphicController controller)

Sets the controller, which is responsible for the interaction between the user and the view.

Specified by:

setController in interface IlpGraphicView

Parameters:

controller - The controller to be set.

setModel

public void setModel(TreeModel newModel)

Sets the TreeModel that will provide the data.

Overrides:

setModel in class JTree

Parameters:

newModel - the TreeModel that is to provide the data

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 view style manager.

Specified by:

getStyleManager in interface IlpGraphicView

Deprecated Since:

JTGO 3.5

setStyleManager

@Deprecated
public void setStyleManager(IlpGraphicViewStyleManager config)

Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please use the method setStyleSheets or getStyleSheets instead.

Sets the graphic view style manager.

Specified by:

setStyleManager in interface IlpGraphicView

Parameters:

config - The view style manager to be set.

Deprecated Since:

JTGO 3.5

getGraphicHolder

public IlpGraphicHolder getGraphicHolder()

Returns the association between object representations and graphics.

Specified by:

getGraphicHolder in interface IlpGraphicView

getRepresentationObjectSelectionModel

public IlpRepresentationObjectSelectionModel getRepresentationObjectSelectionModel()

Returns the IlpRepresentationObjectSelectionModel used to handle the selection of representation objects.

Specified by:

getRepresentationObjectSelectionModel in interface IlpGraphicView

Returns:

The current selection model if it is an instance of IlpRepresentationObjectSelectionModel, null otherwise.

See Also:

JTree.setSelectionModel(javax.swing.tree.TreeSelectionModel)

setSelectionLookAndFeel

public void setSelectionLookAndFeel(int selectionLookAndFeel)

Sets the way the selection is rendered to/manipulated by the end-user. This method is provided as a convenient way to set the selection rendering properties.

Parameters:

selectionLookAndFeel - One of: HIGHLIGHT_SELECTION_LOOK_AND_FEEL, CHECKBOX_SELECTION_LOOK_AND_FEEL.

See Also:

setSelectionCheckBoxVisible(boolean), setHighlightMode(int), setCollapseUnselectsDescendants(boolean)

setSelectionCheckBoxVisible

public void setSelectionCheckBoxVisible(boolean selectionCheckBoxVisible)

Activates or deactivates the use of check boxes to display and modify the selection status of nodes.

isSelectionCheckBoxVisible

public boolean isSelectionCheckBoxVisible()

Indicates whether the selected nodes are displayed using check boxes.

setHighlightMode

public void setHighlightMode(int highlightMode)

Sets the mode used to determine whether a cell is highlighted or not.

Parameters:

highlightMode - One of: LEAD_SELECTION_HIGHLIGHT, SELECTED_SELECTION_HIGHLIGHT.

getHighlightMode

public int getHighlightMode()

Returns the highlight mode.

Returns:

One of: LEAD_SELECTION_HIGHLIGHT, SELECTED_SELECTION_HIGHLIGHT.

setCollapseUnselectsDescendants

public void setCollapseUnselectsDescendants(boolean collapseUnselectsDescendants)

Sets the descendants of a collapsed node to be deselected or not. When you use the selectionCheckBox mode, you will probably want collapsing to leave the descendants selected.

Parameters:

collapseUnselectsDescendants - true if collapsing a node deselects its descendants.

getCollapseUnselectsDescendants

public boolean getCollapseUnselectsDescendants()

Returns true if collapsing a node deselects its descendants.

removeDescendantSelectedPaths

protected boolean removeDescendantSelectedPaths(TreePath path,
                                                boolean includePath)

Removes any paths in the selection that are descendants of path. If includePath is true, and path is selected, the path will be removed from the selection. Overridden so that deselecting is controlled by the collapseUnselectsDescendants property.

Overrides:

removeDescendantSelectedPaths in class JTree

Parameters:

path - The path whose descendants are to be removed.

includePath - true if path is to be deselected.

Returns:

true if descendants are to be deselected.

See Also:

setCollapseUnselectsDescendants(boolean)

getRepresentationObject

public IlpRepresentationObject getRepresentationObject(IlpPoint viewLocation)

Returns the IlpRepresentationObject object at the given position in this object.

Specified by:

getRepresentationObject in interface IlpGraphicView

Parameters:

viewLocation - The position to be checked.

Returns:

The representation object at the given position.

getAttribute

public IlpAttribute getAttribute(IlpPoint viewLocation)

Returns the IlpAttribute object at the given position in this object.

If the view graphic holder is configured explicitly to not store the IlpGraphic instance (see IlpEmptyGraphicHolder), this method returns null.

If the tree cell renderer is configured to not work with IlpGraphic instances, then this method returns null.

Specified by:

getAttribute in interface IlpGraphicView

Parameters:

viewLocation - The position to be checked.

Returns:

The attribute represented at the given position, or null if there is no attribute represented at this position.

Since:

JViews 7.5

getGraphic

public IlpGraphic getGraphic(IlpPoint viewLocation)

Returns the IlpGraphic object at the given position in this object.

If the view graphic holder is configured explicitly to not store the IlpGraphic instance (see IlpEmptyGraphicHolder), this method returns null.

If the tree cell renderer is configured to not work with IlpGraphic instances, then this method returns null. In this case, use getRepresentationObject(IlpPoint) instead.

Specified by:

getGraphic in interface IlpGraphicView

Parameters:

viewLocation - The position to be checked.

Returns:

The graphic object at the given position.

getInnermostGraphic

public IlpGraphic getInnermostGraphic(IlpPoint viewLocation)

Returns the innermost graphic at the given position in this object.

If the view graphic holder is configured explicitly to not store the IlpGraphic instance (see IlpEmptyGraphicHolder), this method returns null.

If the tree cell renderer is configured to not work with IlpGraphic instances, then this method returns null.

Specified by:

getInnermostGraphic in interface IlpGraphicView

Parameters:

viewLocation - The position to be checked.

Returns:

The innermost graphic object at the given position.

getContainer

public Container getContainer()

Returns the concrete container where the graphics are currently being displayed.

Specified by:

getContainer in interface IlpGraphicView

representationObjectsAdded

public void representationObjectsAdded(AdapterEvent e)

Called when objects have been added to the adapter.

Specified by:

representationObjectsAdded in interface AdapterListener

Parameters:

e - Adapter event

representationObjectsRemoved

public void representationObjectsRemoved(AdapterEvent e)

Called when objects have been removed from the adapter.

Specified by:

representationObjectsRemoved in interface AdapterListener

Parameters:

e - Adapter event

getGraphicComponentClass

public Class<?> getGraphicComponentClass()

Returns the graphic component class supported by this implementation of graphic view.

Specified by:

getGraphicComponentClass in interface IlpGraphicView

invalidate

public void invalidate(IlpRepresentationObject ro)

Invalidates the graphic representation of the given object.

Indicates that it needs to be recomputed.

Specified by:

invalidate in interface IlpGraphicView

Since:

JTGO 3.1

invalidateGraphics

public void invalidateGraphics()

Invalidates all the graphic representations in this view. Indicates that they need to be recomputed.

Specified by:

invalidateGraphics in interface IlpGraphicView

Since:

JTGO 3.5

invalidateLayoutCache

public void invalidateLayoutCache()

This is a convenient method to allow for explicitly invalidating the layout cache.

invalidateLayoutCache

@Deprecated
public void invalidateLayoutCache(IlpRepresentationObject ro)

Deprecated. Invalidating the layout cache for a specific representation object is no longer supported. Please use method {invalidateLayoutCache() instead.

This is a convenient method to allow for explicitely invalidating the layout cache for a specific object.

Deprecated Since:

JViews 8.6

createPathForNode

protected TreePath createPathForNode(TreeNode node)

Creates a tree path for the given node.

Internal: do not use!

ensureVisible

public boolean ensureVisible(IlpRepresentationObject ro)

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

ensureVisible

public boolean ensureVisible(IlpObject object)

Scrolls the view in such a way that a given object becomes visible.

The operation is ignored if the given business object is not currently represented in the component. For instance, if the business object has not yet been represented in the view due to the fact that its parent nodes have not yet been expanded.

Returns:

true if the object is visible, false otherwise.

Since:

JTGO 4.5

getRepresentationObjectMapper

public IlpRepresentationObjectMapper getRepresentationObjectMapper()

Returns the mapper that allows the tree view to know the correspondence between IlpRepresentationObject and IlpObject.

setRepresentationObjectMapper

public void setRepresentationObjectMapper(IlpRepresentationObjectMapper mapper)

Sets a mapper that allows the tree view to know the correspondence between IlpRepresentationObject and IlpObject

See Also:

getRepresentationObjectMapper()

createTreeModelListener

protected TreeModelListener createTreeModelListener()

Creates and returns an instance of IlpTreeModelHandler. The returned object is responsible for updating the expanded state when the TreeModel changes.

For more information on what expanded state means, see JTree.

Overrides:

createTreeModelListener in class JTree

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

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

updateMask - Flag that indicates whether the view and/or the business objects have to be updated to use this new configuration. When IlpStylable.UPDATE_COMPONENT_MASK is set, the view is reconfigured with the new style sheets. When IlpStylable.UPDATE_OBJECTS_MASK is set, the representation objects that are managed by this adapter 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 directly

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.

Specified by:

setStyleSheets in interface IlpStylable

Parameters:

index - The index of the style sheet to replace.

css - The URL, file name of the new style sheet file or CSS extract directly.

updateMask - Flag that indicates whether the view and/or the business objects must be updated to use this new configuration. When IlpStylable.UPDATE_COMPONENT_MASK is set, the view is reconfigured with the new style sheets. When IlpStylable.UPDATE_OBJECTS_MASK is set, the representation objects that are managed by this adapter are reconfigured according to the new style sheets.

Throws:

IlvStylingException

Since:

JTGO 4.0

See Also:

IlpStylable.UPDATE_COMPONENT_MASK, IlpStylable.UPDATE_OBJECTS_MASK, setStyleSheets(java.lang.String[]), getStyleSheets(int)

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 set on this component in the index-th position.

Since:

JTGO 3.5

See Also:

setStyleSheets(int, String), setStyleSheets(String[])

getStyleSheets

public String[] getStyleSheets()

Returns the cascading 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[])

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

hasStyleSheets

public boolean hasStyleSheets()

Returns true if style sheets have been defined for this view.

Specified by:

hasStyleSheets in interface ilog.cpl.graphic.css.internal.IlpCSSGraphicView

getViewCSSContext

public ilog.cpl.graphic.css.internal.IlpViewCSSContext getViewCSSContext()

Returns the context information that provides Cascading Style Sheets support for this graphic view.

Specified by:

getViewCSSContext in interface ilog.cpl.graphic.css.internal.IlpCSSGraphicView

Returns:

The CSS context for this graphic view.

Since:

JTGO 3.5

Internal: do not use!

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

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 some 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 remove from the classes associated with the data object.

Since:

JTGO 4.0

addPseudoClass

public void addPseudoClass(IlpRepresentationObject ro,
                           String pseudo)

Adds a pseudoclass to the given representation object.

If the given representation object is associated to a business model then this method is similar to calling addPseudoClass(IlpObject,String).

Pseudoclasses are used to modify the appearance of an object depending on some 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:

ro - The representation object.

pseudo - A string that identifies a pseudoclass to add to the classes already associated with the data object.

Since:

JTGO 3.5

See Also:

addPseudoClass(IlpObject,String)

removePseudoClass

public void removePseudoClass(IlpRepresentationObject ro,
                              String pseudo)

Removes a pseudoclass from the given representation object.

If the given representation object is associated to a business model then this method is similar to calling removePseudoClass(IlpObject,String).

Pseudoclasses are used to modify the appearance of an object depending on some 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:

ro - The representation object.

pseudo - A string that identifies a pseudoclass to move from the classes associated with the data object.

Since:

JTGO 3.5

See Also:

removePseudoClass(IlpObject,String)

getPseudoClasses

public List<String> getPseudoClasses(IlpRepresentationObject ro,
                                     IlpAttribute a)

Returns the custom pseudoclasses currently active for the object

Specified by:

getPseudoClasses in interface ilog.cpl.graphic.css.internal.IlpCSSGraphicView

Internal: do not use!

setCellRenderer

public void setCellRenderer(TreeCellRenderer x)

Sets the TreeCellRenderer that will be used to draw each cell.

Overrides:

setCellRenderer in class JTree

Parameters:

x - the TreeCellRenderer that is to render each cell

processMouseEvent

protected void processMouseEvent(MouseEvent e)

Processes mouse events occurring on this component by dispatching them to any registered MouseListener objects.

Overrides:

processMouseEvent in class JComponent

Parameters:

e - The mouse event

processKeyEvent

protected void processKeyEvent(KeyEvent e)

Processes key events occurring on this component by dispatching them to any registered KeyListener objects.

Overrides:

processKeyEvent in class JComponent

Parameters:

e - The key event

makeVisible

public void makeVisible(TreePath path)

Ensures that the node identified by path is currently viewable.

Overrides:

makeVisible in class JTree

Parameters:

path - the TreePath to make visible

setSelectionInterval

public void setSelectionInterval(int index0,
                                 int index1)

Selects the nodes between index0 and index1, inclusive.

Overrides:

setSelectionInterval in class JTree

Parameters:

index0 - an integer specifying a display row, where 0 is the first row in the display

index1 - an integer specifying a second display row