ilog.views.symbology.palettes.swing

Class IlvPaletteToolbarViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.symbology.palettes.swing.IlvPaletteToolbarViewer

All Implemented Interfaces:

IlvPaletteViewer, ImageObserver, MenuContainer, Serializable, Accessible

public class IlvPaletteToolbarViewer
extends JPanel
implements IlvPaletteViewer

This viewer displays the content of the first level of a palette: symbols directly children of root. It there is not enough space in the visible area to display all symbols, scrolling arrows are displayed to navigate forward or backward. It supports drag and drop of symbols. By default this viewer is not editable, meaning that drag-and-drop has no effect; to change this state use setEditable(true) The main component of this viewer is a JPanel containing sub components that display the symbols of the palettes and allow scrolling.

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
IlvPaletteToolbarViewer() Creates the viewer

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	fireCategorySelected(IlvPalette p, IlvPaletteCategory c) Do nothing because this viewer does not represent categories.
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
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.

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

IlvPaletteToolbarViewer

public IlvPaletteToolbarViewer()

Creates the viewer

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

fireSymbolSelected

protected void fireSymbolSelected(IlvPalette p,
                                  IlvPaletteSymbol s)

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

fireCategorySelected

protected void fireCategorySelected(IlvPalette p,
                                    IlvPaletteCategory c)

Do nothing because this viewer does not represent categories.

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