ilog.views.symbology.palettes.swing

Interface IlvPaletteViewer

All Known Implementing Classes:

IlvPaletteDockTreeViewer, IlvPaletteToolbarViewer, IlvPaletteTreeViewer

public interface IlvPaletteViewer

Interface implemented by classes which are palette viewer; classes creating JComponent to display palette's content. A palette viewer is linked to a palette and creates Swing component(s) that will be able to display the content of the palette. It returns a main Swing component (getComponent()) that can be added into the GUI of the application.

Since:

JViews 8.0

Method Summary

Modifier and Type	Method and Description
void	addPaletteViewerListener(PaletteViewerListener l) Adds a listener to track category or symbol selection in the viewer
JComponent	getComponent() Returns the Swing component used to display the content of the palette.
IlvPalette	getPalette() Returns the palette represented in this viewer
boolean	isEditable() Indicates if the viewer allows edition of palette
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	setPalette(IlvPalette palette) Sets the palette represented in this viewer.

Method Detail

setPalette

void setPalette(IlvPalette palette)

Sets the palette represented in this viewer.

Parameters:

palette - The palette to display.

getPalette

IlvPalette getPalette()

Returns the palette represented in this viewer

getComponent

JComponent getComponent()

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

addPaletteViewerListener

void addPaletteViewerListener(PaletteViewerListener l)

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

Parameters:

l - The listener to add

removePaletteViewerListener

void removePaletteViewerListener(PaletteViewerListener l)

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

Parameters:

l - The listener to remove

setEditable

void setEditable(boolean editable)

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

Parameters:

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

isEditable

boolean isEditable()

Indicates if the viewer allows edition of palette

Returns:

boolean true is the viewer is editable, otherwise false

select

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.

Parameters:

object - The palette object to select