ilog.views.dashboard

Class IlvDashboardSymbolPalette

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.dashboard.IlvDashboardPanel

ilog.views.dashboard.IlvDashboardSymbolPalette

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class IlvDashboardSymbolPalette
extends IlvDashboardPanel

IlvDashboardSymbolPalette is used to display the symbol palettes that will be used by a Dashboard Editor application.

Overview

Symbol palettes are created using Symbol Editor. Dashboards are created in Dashboard Editor applications by editing background objects and imported symbols in an IlvDashboardDiagram instance. Symbol palettes are opened in an IlvDashboardSymbolPalette instance, the symbols they contain are dragged by the user into one or more IlvDashboardDiagram instances.

Example

The following code example shows how to add an IlvDashboardSymbolPalette to the right pane of a Dashboard Editor application:

 public class DashboardEditor extends IlvDashboardEditor {
   private IlvDashboardEditorFrame frame;
   private IlvDashboardSymbolPalette palettePanel;
   ...
   frame = getFrame(); 
   ...
  
   URL url = IlvDiagrammerOverview.class.getResource("images/overview.gif");
   ImageIcon icon = new ImageIcon(url);
   IlvDiagrammerOverview overview = new IlvDiagrammerOverview();
   IlvDashboardExpandablePane overviewFrame = new IlvDashboardExpandablePane("Overview", icon, overview);
  
   url = IlvDiagrammerPropertySheet.class.getResource("images/psheet.gif");
   icon = new ImageIcon(url);
   
   //Create a new symbol palette 
   palettePanel = new IlvDashboardSymbolPalette(this);
   IlvDashboardExpandablePane paletteFrame = 
              new IlvDashboardExpandablePane("Palette", icon, palettePanel);
   try {
     loadPalettes();
   } catch (Exception e) {
     e.printStackTrace();
   }
  
   IlvDashboardExpandableSplitPane split = new IlvDashboardExpandableSplitPane(overviewFrame, paletteFrame);
   split.setResizeWeight(0.75);
   split.setDividerLocation(150);
   return split;    
    ...
 

Since:

JViews 8.0

See Also:

IlvDashboardAction, IlvDashboardPropertyPanel, IlvDashboardEditorFrame, IlvDashboardDiagram, IlvDashboardEditor, IlvDashboardSymbol, IlvDashboardBackgroundBar, IlvDashboardEditBar, 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

Modifier and Type	Field and Description
static String	ID The symbol palette panel ID.

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
IlvDashboardSymbolPalette(IlvDashboardEditor editor) Constructs a symbol panel for a given IlvDashboardEditor instance.

Method Summary

Modifier and Type	Method and Description
void	addNotify() Installs internal listeners.
boolean	isClosable(IlvPalette palette) Tests if the palette can be closed by the user.
void	setClosable(IlvPalette palette, boolean closable) Specifies if palette can be closed by the user.
void	setDiagram(IlvDashboardDiagram diagram) Sets the dashboard diagram currently being edited in the Dashboard Editor.

Methods inherited from class ilog.views.dashboard.IlvDashboardPanel

getDiagram, getEditor, getID, getPanelManager, removeNotify, setID, setPanelManager

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, 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

Field Detail

ID

public static String ID

The symbol palette panel ID.

See Also:

IlvDashboardPanel.IlvDashboardPanel(IlvDashboardEditor, String)

Constructor Detail

IlvDashboardSymbolPalette

public IlvDashboardSymbolPalette(IlvDashboardEditor editor)

Constructs a symbol panel for a given IlvDashboardEditor instance.

IlvDashboardEditor is the central class in a Dashboard Editor application, it provides access to common Dashboard Editor components.

Parameters:

editor - The Dashboard Editor for which this Dashboard Symbol Palette is created.

See Also:

Example, Overview

Method Detail

addNotify

public void addNotify()

Installs internal listeners.

Overrides:

addNotify in class IlvDashboardPanel

See Also:

JComponent.addNotify()

setDiagram

public void setDiagram(IlvDashboardDiagram diagram)

Sets the dashboard diagram currently being edited in the Dashboard Editor.

Overrides:

setDiagram in class IlvDashboardPanel

Parameters:

diagram - The current dashboard diagram in Symbol Editor.

See Also:

IlvDashboardPanel.setDiagram(ilog.views.dashboard.IlvDashboardDiagram)

isClosable

public boolean isClosable(IlvPalette palette)

Tests if the palette can be closed by the user.

Parameters:

palette - The symbol palette to test.

Returns:

true if palette can be closed.

setClosable

public void setClosable(IlvPalette palette,
                        boolean closable)

Specifies if palette can be closed by the user.

Parameters:

palette - A symbol palette.

closable - Set to true so palette can be closed.