ilog.views.symbology.palettes.swing

Class IlvPaletteManagerTabbedViewer

java.lang.Object

ilog.views.symbology.palettes.swing.IlvPaletteManagerTabbedViewer

All Implemented Interfaces:

IlvPaletteManagerViewer

public class IlvPaletteManagerTabbedViewer
extends Object
implements IlvPaletteManagerViewer

This class provides a GUI to display and manage the palettes contained into a palette manager. The GUI is a set of components grouped in a JPanel. To add this GUI in you application you may get this component by calling the getComponent() method. The main component used to display palettes is a JTabbedPane which adds a tab for each palette; this tabbed pane is return by getTabbedPane().

Since:

JViews 8.0

Constructor Summary

Constructors

Constructor and Description
IlvPaletteManagerTabbedViewer(IlvPaletteManager paletteManager) Creates the viewer for the specified palette manager.

Method Summary

Modifier and Type	Method and Description
void	addPaletteViewerListener(PaletteViewerListener l) Adds a listener to track category or symbol selection in the viewer
protected void	fireCategoryDeselected(PaletteViewerEvent evt) Fires a PaletteViewerEvent to the registered listeners, indicating that a category has been deselected.
protected void	fireCategorySelected(PaletteViewerEvent evt) Fires a PaletteViewerEvent to the registered listeners, indicating that a category has been selected.
protected void	fireSymbolDeselected(PaletteViewerEvent evt) Fire a PaletteViewerEvent to the registered listeners, indicating that a symbol has been deselected.
protected void	fireSymbolSelected(PaletteViewerEvent evt) Fire a PaletteViewerEvent to the registered listeners, indicating that a symbol has been selected.
JComponent	getComponent() Returns the main component of the viewer.
IlvPaletteManager	getPaletteManager() Returns the palette manager associated with this viewer.
IlvPalette	getSelectedPalette() Returns the current selected palette
IlvPaletteSymbol	getSelectedSymbol() Returns the current selected symbol
JTabbedPane	getTabbedPane() Returns the JTabbedPane component used in this viewer to display the palette tree viewers.
boolean	isClosable(IlvPalette palette) Returns whether the tab corresponding to the specified palette can be closed by some user action
boolean	isEditable() Indicates if this viewer is editable or not.
void	removePaletteViewerListener(PaletteViewerListener l) Removes a listener used to track category or symbol selection in the viewer
void	select(IlvPalette palette) Selects a palette in the viewer.
void	select(IlvPaletteSymbol symbol) Select a symbol in the symbol viewer.
void	setClosable(IlvPalette palette, boolean closable) Sets whether the tab corresponding to the specified palette can be closed by some user action.
void	setEditable(boolean editable) Indicates if this viewer should be editable, it means that symbols and categories can be added, removed, moved by drag and drop.
void	setPaletteManager(IlvPaletteManager paletteManager) Sets the new palette manager for this viewer.
void	setSearchToolVisisble(boolean visible) Sets the visibility of the search tool

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPaletteManagerTabbedViewer

public IlvPaletteManagerTabbedViewer(IlvPaletteManager paletteManager)

Creates the viewer for the specified palette manager.

Parameters:

paletteManager - The palette manager that will be used to get palettes to display

Method Detail

addPaletteViewerListener

public void addPaletteViewerListener(PaletteViewerListener l)

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

Specified by:

addPaletteViewerListener in interface IlvPaletteManagerViewer

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 IlvPaletteManagerViewer

Parameters:

l - The listener to remove

fireCategorySelected

protected void fireCategorySelected(PaletteViewerEvent evt)

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

fireCategoryDeselected

protected void fireCategoryDeselected(PaletteViewerEvent evt)

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

Since:

JViews 8.1

fireSymbolSelected

protected void fireSymbolSelected(PaletteViewerEvent evt)

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

fireSymbolDeselected

protected void fireSymbolDeselected(PaletteViewerEvent evt)

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

Since:

JViews 8.1

getComponent

public JComponent getComponent()

Returns the main component of the viewer. In this case it is a JPanel containing GUI parts of the viewer. To get the component used to display the palettes, use getTabbedPane

Specified by:

getComponent in interface IlvPaletteManagerViewer

See Also:

getTabbedPane()

getPaletteManager

public IlvPaletteManager getPaletteManager()

Returns the palette manager associated with this viewer.

Specified by:

getPaletteManager in interface IlvPaletteManagerViewer

getTabbedPane

public JTabbedPane getTabbedPane()

Returns the JTabbedPane component used in this viewer to display the palette tree viewers.

setPaletteManager

public void setPaletteManager(IlvPaletteManager paletteManager)

Sets the new palette manager for this viewer. It updates the content of the tabbed pane to display a tab for each palette.

Specified by:

setPaletteManager in interface IlvPaletteManagerViewer

Parameters:

paletteManager - The new current palette manager.

select

public void select(IlvPaletteSymbol symbol)

Select a symbol in the symbol viewer. This will select the tab corresponding to the palette of the symbol, and will select the symbol into the palette viewer.

Specified by:

select in interface IlvPaletteManagerViewer

Parameters:

symbol - The symbol to select

getSelectedPalette

public IlvPalette getSelectedPalette()

Returns the current selected palette

Specified by:

getSelectedPalette in interface IlvPaletteManagerViewer

getSelectedSymbol

public IlvPaletteSymbol getSelectedSymbol()

Returns the current selected symbol

Specified by:

getSelectedSymbol in interface IlvPaletteManagerViewer

select

public void select(IlvPalette palette)

Selects a palette in the viewer.

Specified by:

select in interface IlvPaletteManagerViewer

Parameters:

palette - The palette to select

setSearchToolVisisble

public void setSearchToolVisisble(boolean visible)

Sets the visibility of the search tool

Parameters:

visible - true to enabled visibility

setClosable

public void setClosable(IlvPalette palette,
                        boolean closable)

Sets whether the tab corresponding to the specified palette can be closed by some user action.

Parameters:

palette - The palette

closable - a boolean value, where true means the tab can be closed

isClosable

public boolean isClosable(IlvPalette palette)

Returns whether the tab corresponding to the specified palette can be closed by some user action

Parameters:

palette - The palette

Returns:

true if the tab can be closed

isEditable

public boolean isEditable()

Indicates if this viewer is editable or not.

Returns:

boolean true if the viewer is editable

Since:

JViews 8.1

setEditable

public void setEditable(boolean editable)

Indicates if this viewer should be editable, it means that symbols and categories can be added, removed, moved by drag and drop. By default it is not editable.

Since:

JViews 8.1