ilog.views.symbology.palettes.swing

Class IlvPaletteManagerComboboxViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.symbology.palettes.swing.IlvPaletteManagerComboboxViewer

All Implemented Interfaces:

IlvPaletteManagerViewer, ImageObserver, MenuContainer, Serializable, Accessible

public class IlvPaletteManagerComboboxViewer
extends JPanel
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. There are two main components in this GUI:

• A combo box that contains the list of palettes provided by the palette manager. User choose the palette he wants to display in this combo box.
• A palette viewer (IlvPaletteTreeViewer), displaying the selected palette.

Since:

JViews 8.0

See Also:

Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
IlvPaletteManagerComboboxViewer(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.
IlvPaletteViewer	getPaletteViewer() Returns the palette viewer associated with this GUI.
IlvPalette	getSelectedPalette() Returns the current selected palette.
IlvPaletteSymbol	getSelectedSymbol() Returns the symbol selected in the current palette.
boolean	isMultiSelectionEnabled() Indicates if multiple selection is enabled in palette trees in this viewer.
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	setMultiSelectionEnabled(boolean multiselection) Enabled or disabled multiselection in palette trees.
void	setPaletteManager(IlvPaletteManager paletteManager) Sets the new palette manager for this viewer.
void	setPaletteViewerVisisble(boolean visible) Sets the visibility of the palette viewer
void	setSearchToolVisisble(boolean visible) Sets the visibility of the search tool

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, 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, 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, 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

Constructor Detail

IlvPaletteManagerComboboxViewer

public IlvPaletteManagerComboboxViewer(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

getComponent

public JComponent getComponent()

Returns the main component of the viewer. In this case it is a JPanel containing all GUI parts of the viewer. To get the palette viewer that displays selected palette, use getPaletteViewer

Specified by:

getComponent in interface IlvPaletteManagerViewer

See Also:

getPaletteViewer()

getPaletteViewer

public IlvPaletteViewer getPaletteViewer()

Returns the palette viewer associated with this GUI.

getPaletteManager

public IlvPaletteManager getPaletteManager()

Returns the palette manager associated with this viewer.

Specified by:

getPaletteManager in interface IlvPaletteManagerViewer

setPaletteManager

public void setPaletteManager(IlvPaletteManager paletteManager)

Sets the new palette manager for this viewer. It updates the list of available palettes in order to let user to choose among them later.

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.

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 symbol selected in the current palette.

Specified by:

getSelectedSymbol in interface IlvPaletteManagerViewer

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

setSearchToolVisisble

public void setSearchToolVisisble(boolean visible)

Sets the visibility of the search tool

Parameters:

visible - true to enabled visibility

setPaletteViewerVisisble

public void setPaletteViewerVisisble(boolean visible)

Sets the visibility of the palette viewer

Parameters:

visible - true to enabled visibility

select

public void select(IlvPalette palette)

Selects a palette in the viewer.

Specified by:

select in interface IlvPaletteManagerViewer

Parameters:

palette - The palette to select

setMultiSelectionEnabled

public void setMultiSelectionEnabled(boolean multiselection)

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

Parameters:

multiselection - true to enable multiselection otherwise false.

Since:

JViews 8.1

isMultiSelectionEnabled

public boolean isMultiSelectionEnabled()

Indicates if multiple selection is enabled in palette trees in this viewer.

Returns:

boolean true if multiselection is enabled

Since:

JViews 8.1