ilog.views.symbology.palettes.swing

Class IlvPaletteTreeViewer

java.lang.Object

ilog.views.symbology.palettes.swing.IlvPaletteTreeViewer

All Implemented Interfaces:

IlvPaletteViewer

Direct Known Subclasses:

IlvPaletteDockTreeViewer

public class IlvPaletteTreeViewer
extends Object
implements IlvPaletteViewer

This viewer creates a JTree that displays the associated palette as a nested hierarchy of nodes (categories, class IlvPaletteCategory) and leaves (symbols, class IlvPaletteSymbol). It supports drag and drop of symbols and categories. By default this viewer is not editable, meaning that drag-and-drop has no effect; to change this state use setEditabel(true). It also does not support multiselection by default. The main component returned by this viewer is a instance of JTree

Since:

JViews 8.0

Constructor Summary

Constructors

Constructor and Description
IlvPaletteTreeViewer() Creates a palette viewer containing a JTree.

Method Summary

Modifier and Type	Method and Description
void	addDropListener(PaletteDropListener l) Adds a listener that listens to drag and drop events.
void	addPaletteViewerListener(PaletteViewerListener l) Adds a listener to track category or symbol selection in the viewer
protected String	convertValueToText(IlvPaletteBaseObject obj, boolean selected, boolean expanded, boolean leaf, int row, boolean hasFocus) Returns the string representation of the value.
protected void	fireCategoryDeselected(IlvPalette p, IlvPaletteCategory c) Fires a PaletteViewerEvent to the registered listeners, indicating that a category has been deselected.
protected void	fireCategorySelected(IlvPalette p, IlvPaletteCategory c) Fires a PaletteViewerEvent to the registered listeners, indicating that a category has been selected.
protected void	fireObjectCopied(IlvPalette sourcePalette, IlvPalette targetPalette, Collection objects) Fire an event when copying objects into a palette using drag and drop
protected void	fireObjectMoved(IlvPalette sourcePalette, IlvPalette targetPalette, Collection objects) Fire an event when moving objects into a palette using drag and drop
protected void	fireSymbolDeselected(IlvPalette p, IlvPaletteSymbol s) Fire a PaletteViewerEvent to the registered listeners, indicating that a symbol has been deselected.
protected void	fireSymbolSelected(IlvPalette p, IlvPaletteSymbol s) Fire a PaletteViewerEvent to the registered listeners, indicating that a symbol has been selected.
JComponent	getComponent() Returns the Swing component used to display the content of the palette.
IlvPalette	getPalette() Returns the palette represented in this viewer
IlvPaletteObject[]	getSelectedPaletteObjects() Returns the selected palette objects selected in the tree
boolean	isEditable() Indicates if the viewer allows edition of palette
void	removeDropListener(PaletteDropListener l) Removed a listener that listens to drag and drop events.
void	removePaletteViewerListener(PaletteViewerListener l) Removes a listener used to track category or symbol selection in the viewer
void	select(IlvPaletteObject object) Selects an object in the viewer.
void	setEditable(boolean editable) Indicates if the viewer will allow interactive edition of palette (for example by drag and drop operation).
void	setMultiSelectionEnabled(boolean multiselection) Enabled or disabled multiselection in this palette viewer.
void	setPalette(IlvPalette palette) Sets the palette represented in this viewer.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPaletteTreeViewer

public IlvPaletteTreeViewer()

Creates a palette viewer containing a JTree.

Method Detail

setPalette

public void setPalette(IlvPalette palette)

Sets the palette represented in this viewer.

Specified by:

setPalette in interface IlvPaletteViewer

Parameters:

palette - The palette to display.

getPalette

public IlvPalette getPalette()

Returns the palette represented in this viewer

Specified by:

getPalette in interface IlvPaletteViewer

getComponent

public JComponent getComponent()

Returns the Swing component used to display the content of the palette.

Specified by:

getComponent in interface IlvPaletteViewer

addPaletteViewerListener

public void addPaletteViewerListener(PaletteViewerListener l)

Adds a listener to track category or symbol selection in the viewer

Specified by:

addPaletteViewerListener in interface IlvPaletteViewer

Parameters:

l - The listener to add

removePaletteViewerListener

public void removePaletteViewerListener(PaletteViewerListener l)

Removes a listener used to track category or symbol selection in the viewer

Specified by:

removePaletteViewerListener in interface IlvPaletteViewer

Parameters:

l - The listener to remove

fireCategorySelected

protected void fireCategorySelected(IlvPalette p,
                                    IlvPaletteCategory c)

Fires a PaletteViewerEvent to the registered listeners, indicating that a category has been selected.

fireCategoryDeselected

protected void fireCategoryDeselected(IlvPalette p,
                                      IlvPaletteCategory c)

Fires a PaletteViewerEvent to the registered listeners, indicating that a category has been deselected.

Since:

JViews 8.1

fireSymbolSelected

protected void fireSymbolSelected(IlvPalette p,
                                  IlvPaletteSymbol s)

Fire a PaletteViewerEvent to the registered listeners, indicating that a symbol has been selected.

fireSymbolDeselected

protected void fireSymbolDeselected(IlvPalette p,
                                    IlvPaletteSymbol s)

Fire a PaletteViewerEvent to the registered listeners, indicating that a symbol has been deselected.

Since:

JViews 8.1

setEditable

public void setEditable(boolean editable)

Indicates if the viewer will allow interactive edition of palette (for example by drag and drop operation).

Specified by:

setEditable in interface IlvPaletteViewer

Parameters:

editable - true if the viewer must be editable, otherwise false

isEditable

public boolean isEditable()

Indicates if the viewer allows edition of palette

Specified by:

isEditable in interface IlvPaletteViewer

Returns:

boolean true is the viewer is editable, otherwise false

select

public void select(IlvPaletteObject object)

Selects an object in the viewer. The object is highlighted in the viewer (selection appearance may depends on the viewer type). The palette associated with the viewer will be replaced with object's parent palette if different.

Specified by:

select in interface IlvPaletteViewer

Parameters:

object - The palette object to select

getSelectedPaletteObjects

public IlvPaletteObject[] getSelectedPaletteObjects()

Returns the selected palette objects selected in the tree

Returns:

IlvPaletteObject[] the array containing the selected object

addDropListener

public void addDropListener(PaletteDropListener l)

Adds a listener that listens to drag and drop events.

Parameters:

l - The listener to add

Since:

JViews 8.1

removeDropListener

public void removeDropListener(PaletteDropListener l)

Removed a listener that listens to drag and drop events.

Parameters:

l - The listener to remove

Since:

JViews 8.1

fireObjectMoved

protected void fireObjectMoved(IlvPalette sourcePalette,
                               IlvPalette targetPalette,
                               Collection objects)

Fire an event when moving objects into a palette using drag and drop

Parameters:

sourcePalette - the palette where the moved objects come from

targetPalette - the palette where objects have been moved

objects - the objects that have been moved

Since:

JViews 8.1

See Also:

PaletteListener, PaletteEvent

fireObjectCopied

protected void fireObjectCopied(IlvPalette sourcePalette,
                                IlvPalette targetPalette,
                                Collection objects)

Fire an event when copying objects into a palette using drag and drop

Parameters:

sourcePalette - the palette where the moved objects come from

targetPalette - the palette where objects have been copied

objects - the objects that have been copied

Since:

JViews 8.1

See Also:

PaletteListener, PaletteEvent

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean multiselection)

Enabled or disabled multiselection in this palette viewer. By default multiselection is not enabled

Parameters:

multiselection - true to enable multiselection otherwise false.

Since:

JViews 8.1

convertValueToText

protected String convertValueToText(IlvPaletteBaseObject obj,
                                    boolean selected,
                                    boolean expanded,
                                    boolean leaf,
                                    int row,
                                    boolean hasFocus)

Returns the string representation of the value. The current implementation returns the name of the object with respect to the current locale.

Since:

JViews 8.8