ilog.views.dashboard

Class IlvDashboardPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.dashboard.IlvDashboardPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

IlvDashboardBackgroundBar, IlvDashboardLayerPanel, IlvDashboardPropertyPanel, IlvDashboardSymbolPalette

public class IlvDashboardPanel
extends JPanel

IlvDashboardPanel is an extension of the Swing JPanel class, it defines the base methods necessary for panels used by a Dashboard Editor application.

IlvDashboardPanel is never used on its own in a Dashboard Editor application. Subclasses such as IlvDashboardPropertyPanel are added to a IlvDashboardEditorFrame instance to display properties for symbols, links and background objects in a dashboard diagram.

The size and visibility of this panel is controlled using a IlvDashboardPanelManager instance.

Since:

JViews 8.0

See Also:

IlvDashboardPropertyPanel, IlvDashboardSymbolPalette, IlvDashboardEditorFrame, IlvDashboardPanelManager, 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

Modifier	Constructor and Description
protected	IlvDashboardPanel(IlvDashboardEditor editor, String id) Constructs a dashboard panel for a editor.

Method Summary

Modifier and Type	Method and Description
void	addNotify() Installs specialized internal listeners.
IlvDashboardDiagram	getDiagram() Returns the dashboard diagram currently being edited in the Dashboard Editor.
IlvDashboardEditor	getEditor() Returns the IlvDashboardEditor instance used to create this panel.
String	getID() Returns the ID of this IlvDashboardPanel instance.
IlvDashboardPanelManager	getPanelManager() Returns the panel manager used to control this panel.
void	removeNotify() Uninstalls specialized internal listeners.
void	setDiagram(IlvDashboardDiagram diagram) Sets the dashboard diagram currently being edited in the Dashboard Editor.
void	setID(String id) Sets a new ID of this IlvDashboardPanel instance.
void	setPanelManager(IlvDashboardPanelManager panelManager) Sets the panel manager used to control this panel.

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

Constructor Detail

IlvDashboardPanel

protected IlvDashboardPanel(IlvDashboardEditor editor,
                            String id)

Constructs a dashboard panel for a editor.

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

Parameters:

editor - The central component for your Dashboard Editor application.

id - A String containing an ID for a dashboard panel, for example "PropertyPanel".

Method Detail

getEditor

public IlvDashboardEditor getEditor()

Returns the IlvDashboardEditor instance used to create this panel.

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

Returns:

The IlvDashboardEditor instance used to create this panel.

getID

public String getID()

Returns the ID of this IlvDashboardPanel instance.

Returns:

The panel ID, for example "PropertyPanel".

setID

public void setID(String id)

Sets a new ID of this IlvDashboardPanel instance.

Parameters:

id - The new ID, for example "SymbolPalette".

getDiagram

public IlvDashboardDiagram getDiagram()

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

A standard Dashboard Editor application uses an IlvDashboardTabbedPane to contain the multiple IlvDashboardDiagram instances being edited by the user. Call setDiagram(IlvDashboardDiagram) to ensure that this method returns the IlvDashboardDiagram currently selected by the user.

Returns:

the dashboard diagram currently being edited.

See Also:

IlvDashboardTabbedPane, setDiagram(IlvDashboardDiagram)

addNotify

public void addNotify()

Installs specialized internal listeners.

Overrides:

addNotify in class JComponent

See Also:

ComponentContextListener, JComponent.addNotify()

removeNotify

public void removeNotify()

Uninstalls specialized internal listeners.

Overrides:

removeNotify in class JComponent

See Also:

ComponentContextListener, JComponent.removeNotify()

setDiagram

public void setDiagram(IlvDashboardDiagram diagram)

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

A standard Dashboard Editor application uses an IlvDashboardTabbedPane to contain the multiple IlvDashboardDiagram instances being edited by the user. Call setDiagram(IlvDashboardDiagram) to ensure that the panel displays information for the correct dashboard diagram.

Parameters:

diagram - The dashboard diagram currently being edited by the user.

getPanelManager

public IlvDashboardPanelManager getPanelManager()

Returns the panel manager used to control this panel.

An IlvDashboardPanelManager instance is used to control the size and visibility of an IlvDashboardPanel instance.

Returns:

The panel manager used to manage this panel.

See Also:

IlvDashboardPanelManager

setPanelManager

public void setPanelManager(IlvDashboardPanelManager panelManager)

Sets the panel manager used to control this panel.

An IlvDashboardPanelManager instance is used to control the size and visibility of an IlvDashboardPanel instance.

Parameters:

panelManager - The panel manager.

See Also:

IlvDashboardPanelManager