IlvDashboardDiagram (Rogue Wave JViews 9.1 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - ilog.views.diagrammer.IlvDiagrammer
      - ilog.views.dashboard.IlvDashboardDiagram

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Iterable<IlvDashboardSymbol>
```
public class IlvDashboardDiagram
extends IlvDiagrammer
implements Iterable<IlvDashboardSymbol>
```
IlvDashboardDiagram is used to store and manipulate IlvDashboardSymbol and IlvGraphic objects displayed using an IlvDashboardEditor instance. IlvDashboardDiagram is an extension of IlvDiagrammer.
Introducing Dashboards
The purpose of an IlvDashboardDiagram instance is to organize, edit, and save JViews symbols and graphic objects. Symbols are represented by one or more IlvDashboardSymbol instances. Background images are represented by standard graphic objects. That is, instances of IlvGraphic and its subclasses. Symbols and graphic objects can be added, removed, grouped, distributed and aligned in a dashboard diagram either programmatically or by using the user interface.
A dashboard diagram is used to display business or system critical information visually.
IlvDashboardDiagram is a front-end that gives access to the functionality provided by the underlying JViews packages: the Graphic Framework, the Stylable Data Mapper (SDM), and the Graph Layout package. These underlying packages can be accessed directly if you need to use advanced features contained in the packages or extend the dashboard diagram component.

Example
The following code example shows how to create a simple Dashboard Editor application using IlvDashboardDiagram.
```
 public class DashEditorExample extends JFrame
 {

   private IlvDashboardEditor dashEd;
   private IlvDashboardEditBar editToolBar;
   private IlvDashboardSymbolPalette palettePanel;
   private IlvDashboardDiagram dashDiag;

   public DashEditorExample(String[] args)
   {
     // Set up the application frame.
     super("Basic Diagrammer Application");
     setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
     setLocation(100, 100);
     setSize(700, 700);

     // Create the editor with a single diagram.
     dashEd = new IlvDashboardEditor();
     dashEd.init(args);

     IlvDashboardTabbedPane tabPane = new IlvDashboardTabbedPane(dashEd);
     dashEd.setDashboardContainer(tabPane);
     // Add the Edit toolbar.
     editToolBar = new IlvDashboardEditBar();
     // Add the Symbol palette
     palettePanel = new IlvDashboardSymbolPalette(dashEd);

     // Add the Dashboard components into the JFrame
     getContentPane().setLayout(new BorderLayout());
     getContentPane().add(tabPane, BorderLayout.CENTER);
     getContentPane().add(editToolBar, BorderLayout.NORTH);
     getContentPane().add(palettePanel, BorderLayout.LINE_END);


     dashEd.loadPalette("ilog/views/palettes/controls/");
     dashEd.loadPalette("ilog/views/palettes/shared/");
     dashEd.run();
   }

   public static void main(String[] args) {
     DashEditorExample basicEditor = new DashEditorExample(args);
     basicEditor.setVisible(true);
   }
 }
 
```
Events
IlvDashboardDiagram is a JavaBean. That is, all communication in this class is achieved by firing events using the IlvDashboardAction class. IlvDashboardAction is a base class for Swing Actions that act on an IlvDashboardDiagram object. It contains a set of predefined actions that call the main IlvDashboardDiagram methods. For example, a save action in IlvDashboardEditBar fires an IlvDashboardAction.save event, which in turn calls IlvDashboardDiagram.writeDashboard(URL).
Input and Output
Dashboard diagrams are saved in Rogue Wave JViews dashboard (.idbd) files. These files are XML structures containing the metadata necessary to render a dashboard. Dashboard diagrams are saved by calling writeDashboard(URL) and opened by calling readDashboard(URL url).
Note: Before opening a dashboard file, the palette containing the symbols contained in the dashboard must be loaded. This is done by calling IlvDashboardEditor.loadPalette from the IlvDashboardEditor instance stored inside your IlvDashboardDiagram instance.
Rendering
Dashboard rendering is controlled using the styling and data mapping (SDM) package. These classes are usually used internally by a IlvDashboardDiagram instance. To extend IlvDashboardDiagram functionality you may need to use these classes directly. The main entry point to the package is the ilog.views.sdm.IlvSDMEngine class.
Since:

JViews 8.0

See Also:

IlvDashboardSymbol, IlvDashboardEditorFrame, IlvDashboardAction, IlvDashboardEditBar, IlvDashboardAction, IlvSDMEngine, Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class ilog.views.diagrammer.IlvDiagrammer
  IlvDiagrammer.PrinterExceptionHandler
- 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
`IlvDashboardDiagram(IlvDashboardContext context)` Constructs an `IlvDashboardDiagram` instance using an `IlvDashboardContext` instance.
`IlvDashboardDiagram(IlvDashboardContext context, IlvSDMView view)` Constructs an `IlvDashboardDiagram` instance using a specific `IlvDashboardContext` and an `IlvSDMView`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addStyleSheet(URL url)` This method is not supported by `IlvDashboardDiagram`.
`void`	`addSymbol(IlvDashboardSymbol symbol)` Adds a new `IlvDashboardSymbol` instance to this dashboard diagram.
`void`	`addSymbolParameterListener(IlvDashboardSymbolParameterListener listener)` Adds a symbol parameter listener that will be notified when the value or the mapping of a symbol parameter is changed.
`void`	`addUndoableEdit(UndoableEdit edit)` Add the last user action to the list of edits that can be undone and redone for this dashboard diagram.
`void`	`alignBottom()` Aligns the currently selected objects along the bottom axis of their bounding boxes.
`void`	`alignHorizontalCenter()` Aligns the currently selected objects along the horizontal center of their bounding boxes.
`void`	`alignLeft()` Aligns the currently selected objects along the left side of their bounding boxes.
`void`	`alignRight()` Aligns the currently selected objects along the right side of their bounding boxes.
`void`	`alignTop()` Aligns the currently selected objects along the top of their bounding boxes.
`void`	`alignVerticalCenter()` Aligns the currently selected objects along the vertical center of their bounding boxes.
`boolean`	`canAlign()` Tests if the symbols and background objects currently selected by the user can be aligned.
`boolean`	`canDistribute()` Tests if a geometric space distribution can be applied to symbols and background object currently selected by the user.
`boolean`	`canEdit()` Tests if at the dashboard diagram is editable.
`boolean`	`canGroup()` Tests if the objects currently selected can be grouped.
`boolean`	`canPaste()` Tests if dashboard diagram data is present on the clipboard.
`boolean`	`canRedo()` Tests if their are significant changes to the dashboard diagram that have been undone.
`boolean`	`canSelect()` Tests if this dashboard diagram is empty.
`boolean`	`canUndo()` Tests the dashboard diagram to see if significant edits have been done by the user.
`boolean`	`canUngroup()` Tests to see if the currently selected objects contain a grouped background object.
`void`	`clear()` Deletes all symbols and background objects contained in this dashboard diagram.
`void`	`copy()` Copies the symbols and background objects currently selected by the user to the clipboard.
`void`	`cut()` Cuts the symbols and background objects currently selected by the user and saves them to the clipboard.
`void`	`delete()` Deletes the symbols and/or background object currently selected by the user in the dashboard diagram.
`void`	`distributeHorizontally()` Distributes the currently selected objects horizontally.
`void`	`distributeVertically()` Distributes the currently selected objects vertically.
`void`	`duplicate()` Duplicates the symbols and background objects currently selected by the user.
`void`	`fireSymbolParameterChanged(IlvDashboardSymbol symbol, IlvDashboardSymbol.Parameter parameter, Object oldValue, Object newValue, String oldMapping, String newMapping)` This method calls the `parameterChanged` method of all symbol parameter listeners of this dashboard diagram.
`IlvDashboardGraphicIterator`	`getBackgroundGraphics()` Returns all background graphic objects contained in this dashboard diagram.
`int`	`getBaseTextDirection()` Returns the global base direction of text in the diagram.
`IlvDashboardContext`	`getContext()` Returns the `IlvDashboardContext` instance used by the dashboard diagram instance.
`IlvDashboardSymbol`	`getGraphicSymbol(IlvGraphic graphic)` Returns the symbol corresponding to `graphic`.
`IlvDashboardSymbol`	`getObjectSymbol(Object modelObject)` Returns the symbol corresponding to `modelObject`.
`IlvManagerPrintingController`	`getPrintingController()` Returns the printing controller that handles all the printing-related tasks for this diagram component.
`IlvDashboardSymbolIterator`	`getSelectedSymbols()` Returns an iterator to run over the collection of symbols currently selected in this dashboard diagram.
`IlvDashboardKeySelectManager`	`getSelectManager()` Returns the selection manager used by this dashboard diagram.
`ArrayList<Object>`	`getSerializableProperties()`
`IlvDashboardSymbol`	`getSymbol(String id)` Returns the symbol whose ID corresponds to `id`.
`int`	`getSymbolIndex(IlvDashboardSymbol symbol)` Returns the index of the symbol in the dashboard diagram list.
`IlvDashboardSymbolIterator`	`getSymbols()` Deprecated. You should use `iterator()` instead.
`URL`	`getURL()` Returns the URL of this dashboard diagram.
`void`	`group()` Groups the background graphic objects currently selected by the user.
`boolean`	`hasSelectedSymbols()` Tests if at least a symbol in this dashboard diagram is selected.
`boolean`	`isBackgroundObject(IlvGraphic graphic)` Tests if `graphic` is a background object.
`boolean`	`isContained(IlvDashboardSymbol symbol)` Tests if the given symbol is contained in this dashboard diagram.
`boolean`	`isEmpty()` Tests if the dashboard diagram is empty.
`boolean`	`isLinkLayoutEnabled()` Tests if link layout is enabled.
`boolean`	`isModified()` Tests if this dashboard diagram is modified.
`boolean`	`isUndoingEnabled()` Tests if the undo mechanism of this dashboard diagram is enabled.
`protected boolean`	`isValidDocument(Document document)` Tests if `document` is a valid dashboard diagram document.
`Iterator<IlvDashboardSymbol>`	`iterator()` This method implements the `Iterable` interface.
`void`	`paste()` Pastes symbols and background object from the clipboard to the dashboard diagram.
`void`	`prepareForEditing()`
`void`	`readBackground(InputStream inputStream)` Imports background objects into the dashboard diagram from `inputStream`.
`void`	`readBinary(InputStream in)` Reads the dashboard binary format contents from an input stream.
`void`	`readBinary(URL url)` Reads a dashboard from a binary file.
`void`	`readDashboard(Document document, boolean selection, double dx, double dy)` Reads the dashboard diagram contents from `document`.
`void`	`readDashboard(URL url)` Read the dashboard diagram XML format file from `url`.
`void`	`redo()` Redoes the the last significant change previously undone by the user.
`void`	`removeSymbol(IlvDashboardSymbol symbol)` Removes `symbol` from this dashboard diagram.
`void`	`removeSymbolParameterListener(IlvDashboardSymbolParameterListener listener)` Removes a symbol parameter listener previously added.
`void`	`selectAll()` Selects all the symbols and background object in the diagram.
`void`	`setBaseTextDirection(int btd)` Changes the global base direction of text in the diagram.
`void`	`setCompoundEditMode(boolean flag)`
`void`	`setEditingAllowed(boolean editingAllowed)` Sets whether symbols and background images contained in this dashboard diagram may be modified.
`void`	`setLinkLayoutEnabled(boolean enabled)` Enables or disables the Link Layout.
`void`	`setModified(boolean modified)` Sets the modified flag of the dashboard diagram.
`void`	`setProject(IlvDiagrammerProject project)` Loads a JViews Diagrammer project into this dashboard diagram.
`void`	`setQuadtreeEnabled(boolean enabled)` Enables or disables the use of quadtree in the layers.
`void`	`setSelectManager(IlvDashboardKeySelectManager focusManager)` Sets the selection manager to be used for this dashboard diagram.
`void`	`setSerializableProperties(ArrayList<Object> properties)`
`void`	`setSymbolIndex(IlvDashboardSymbol symbol, int index)` Sets a new index of the given symbol in the dashboard diagram list.
`void`	`setUndoingEnabled(boolean enabled)` Enables or disables the undo mechanism of this dashboard diagram.
`void`	`setURL(URL url)`
`void`	`undo()` Undoes the last significant change to the Dashboard Document.
`void`	`ungroup()` Ungroups the background objects currently selected by the user.
`void`	`writeBackground(OutputStream outputStream)` Writes all background graphic objects in the dashboard diagram to the given `outputStream` in Rogue Wave JViews (.IVL) format.
`void`	`writeBackgroundFile(String file)` Writes all background graphic objects in the dashboard diagram to `file` in Rogue Wave JViews (.IVL) format.
`void`	`writeBinary(OutputStream out)` Writes the contents of the dashboard in binary format to an output stream.
`void`	`writeBinary(URL url)` Writes the contents of the dashboard in binary format to a URL.
`void`	`writeDashboard(URL url)` Writes the dashboard diagram contents in XML format to `url`.
`void`	`writeDashboardFiles()`
`void`	`writeData()` Writes the diagram to the current data source.
`void`	`writeDataFile(URL url)` Writes the current diagram to the specified data URL.
`void`	`writeProjectFile(URL projectURL)` Writes the diagrammer project file to the specified URL.

Methods inherited from class ilog.views.diagrammer.IlvDiagrammer
addObject, assignProject, canPrint, canResetZoom, canZoomIn, canZoomOut, clearAdjusting, clearPrintArea, createGroupParent, createLink, createNode, createScrollComponent, createXMLDataSource, deselectAll, fitToContents, fitToContents, getAllObjects, getChildren, getCurrentDiagrammer, getDataFile, getDataSource, getDefaultStyleSheet, getEditLabelInteractor, getEngine, getGrid, getID, getMaximumZoom, getMinimumZoom, getObject, getObjectProperty, getObjects, getPalette, getPanInteractor, getParent, getProject, getScrollComponent, getSelectedObjects, getSelectInteractor, getSourceNode, getStyleSheet, getStyleSheets, getTag, getTargetNode, getUndoManager, getView, getZoomFactor, getZoomInteractor, hasFrameOrDialogAncestor, isAdjusting, isAutoEditLabel, isAutomaticCurrentDiagrammer, isAutomaticLabelLayout, isAutomaticLinkLayout, isAutomaticNodeLayout, isEditable, isEditingAllowed, isEditLabelMode, isGridVisible, isLabelLayoutAvailable, isLink, isLinkLayoutAvailable, isNodeLayoutAvailable, isPanMode, isResizingAllowed, isScrollable, isSelected, isSelectMode, isStickyModes, isStyleApplicationComponents, isZoomMode, layoutAllNodes, layoutLabels, layoutLinks, layoutSelectedNodes, pageSetup, print, printPreview, printToBitmap, processServerAction, refresh, removeObject, removeStyleSheet, resetZoom, scrollToObject, setAdjusting, setAllSelectedObjects, setAsRoot, setAutoEditLabel, setAutomaticCurrentDiagrammer, setAutomaticLabelLayout, setAutomaticLinkLayout, setAutomaticNodeLayout, setBaseTextDirection, setCurrentDiagrammer, setCurrentDiagrammer, setDataFile, setDataSource, setEditLabelInteractor, setEditLabelMode, setGrid, setGridVisible, setGroupParent, setID, setMaximumZoom, setMinimumZoom, setObjectProperty, setPalette, setPanInteractor, setPanMode, setPrintArea, setPrintingController, setProject, setResizingAllowed, setScrollable, setSelected, setSelectInteractor, setSelectMode, setSourceNode, setStickyModes, setStyleApplicationComponents, setStyleSheet, setTargetNode, setZoomFactor, setZoomInteractor, setZoomMode, writeDataFile, zoomIn, zoomOut

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - IlvDashboardDiagram
```
public IlvDashboardDiagram(IlvDashboardContext context)
```
    Constructs an IlvDashboardDiagram instance using an IlvDashboardContext instance.
    IlvDashboardContext contains the information necessary for an IlvDashboardDiagram instance to function correctly. It includes the following data:
    - The URL to the default style sheet used for rendering dashboard diagrams.
    - The palette manager.
    - The mapping between symbols and the SDK engine.
    - Logging information.
    For this class to function properly it needs to be placed in a containment hierarchy whose root is a top-level Swing container.
    Parameters:
    
    context - The dashboard context used to created this dashboard diagram.
    
    See Also:
    
    Initiate an IlvDashboardDiagram instance.
  - IlvDashboardDiagram
```
public IlvDashboardDiagram(IlvDashboardContext context,
                           IlvSDMView view)
```
    Constructs an IlvDashboardDiagram instance using a specific IlvDashboardContext and an IlvSDMView.
    An IlvSDMView instance connects to and controls the IlvSDMEngine used to render the dashboard diagram.
    
    Parameters:
    
    context - The specific context used to create this dashboard diagram.
    
    view - The SDM view
    
    See Also:
    
    IlvDashboardDiagram(IlvDashboardContext)
- Method Detail
  - getContext
```
public IlvDashboardContext getContext()
```
    Returns the IlvDashboardContext instance used by the dashboard diagram instance.
    
    Returns:
    
    The IlvDashboardContext instance used bye the dashboard diagram instance.
    
    See Also:
    
    Initiate an IlvDashboardDiagram instance, IlvDashboardDiagram(IlvDashboardContext)
  - setQuadtreeEnabled
```
public void setQuadtreeEnabled(boolean enabled)
```
    Enables or disables the use of quadtree in the layers. By default, this is disabled.
    
    Parameters:
    
    enabled - If true the use of the quadtree is enabled.
  - prepareForEditing
```
public void prepareForEditing()
```
    Internal: do not use!
    
    Prepares this dashboard diagram for an editing context.
  - canEdit
```
public boolean canEdit()
```
    Tests if at the dashboard diagram is editable.
    
    Overrides:
    
    canEdit in class IlvDiagrammer
    
    Returns:
    
    true if at least one object in the dashboard diagram has been selected by the user.
    
    See Also:
    
    Events
  - delete
```
public void delete()
```
    Deletes the symbols and/or background object currently selected by the user in the dashboard diagram.
    
    Overrides:
    
    delete in class IlvDiagrammer
    
    See Also:
    
    dashboard diagram Events, IlvDashboardEditBar, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - cut
```
public void cut()
```
    Cuts the symbols and background objects currently selected by the user and saves them to the clipboard.
    
    Overrides:
    
    cut in class IlvDiagrammer
    
    See Also:
    
    dashboard diagram Events, IlvDashboardEditBar, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - copy
```
public void copy()
```
    Copies the symbols and background objects currently selected by the user to the clipboard.
    
    Overrides:
    
    copy in class IlvDiagrammer
    
    See Also:
    
    Events, IlvDashboardEditBar, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - paste
```
public void paste()
```
    Pastes symbols and background object from the clipboard to the dashboard diagram.
    
    Overrides:
    
    paste in class IlvDiagrammer
    
    See Also:
    
    IlvDashboardEditBar, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - canPaste
```
public boolean canPaste()
```
    Tests if dashboard diagram data is present on the clipboard.
    
    Overrides:
    
    canPaste in class IlvDiagrammer
    
    Returns:
    
    true if data has been copied to the clipboard using the cut or copy methods.
    
    See Also:
    
    paste(), copy(), cut(), Dashboard Diagram Events, IlvDashboardEditBar, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - duplicate
```
public void duplicate()
```
    Duplicates the symbols and background objects currently selected by the user.
    Duplicated objects are painted on a higher layer than the selected objects and displaced to the bottom left.
    
    Overrides:
    
    duplicate in class IlvDiagrammer
    
    See Also:
    
    dashboard diagram Events, IlvDashboardEditBar, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - selectAll
```
public void selectAll()
```
    Selects all the symbols and background object in the diagram.
    
    Overrides:
    
    selectAll in class IlvDiagrammer
    
    See Also:
    
    dashboard diagram Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - canSelect
```
public boolean canSelect()
```
    Tests if this dashboard diagram is empty.
    
    Overrides:
    
    canSelect in class IlvDiagrammer
    
    Returns:
    
    true if this dashboard diagram contains at least one symbol or background object.
    
    See Also:
    
    selectAll()
  - canGroup
```
public boolean canGroup()
```
    Tests if the objects currently selected can be grouped.
    Note: The group operation can only be applied to background objects.
    
    Overrides:
    
    canGroup in class IlvDiagrammer
    
    Returns:
    
    true if at least one background object is currently selected by the user.
    
    See Also:
    
    IlvDiagrammer.canGroup()
  - group
```
public void group()
```
    Groups the background graphic objects currently selected by the user.
    
    Overrides:
    
    group in class IlvDiagrammer
    
    See Also:
    
    Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - canUngroup
```
public boolean canUngroup()
```
    Tests to see if the currently selected objects contain a grouped background object.
    Note: The group operation can only be applied to background objects.
    
    Overrides:
    
    canUngroup in class IlvDiagrammer
    
    Returns:
    
    true if background objects currently selected by the user contain at least one grouped object.
    
    See Also:
    
    group(), canGroup(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - ungroup
```
public void ungroup()
```
    Ungroups the background objects currently selected by the user.
    This action is applicable to IlvGraphicSet instances.
    
    Note: The group operation can only be applied to background objects.
    
    Overrides:
    
    ungroup in class IlvDiagrammer
    
    See Also:
    
    canUngroup(), group(), canGroup(), IlvGraphicSet, Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - canAlign
```
public boolean canAlign()
```
    Tests if the symbols and background objects currently selected by the user can be aligned.
    
    Overrides:
    
    canAlign in class IlvDiagrammer
    
    Returns:
    
    true if at least two objects are currently selected.
    
    See Also:
    
    Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - canDistribute
```
public boolean canDistribute()
```
    Tests if a geometric space distribution can be applied to symbols and background object currently selected by the user.
    
    Overrides:
    
    canDistribute in class IlvDiagrammer
    
    Returns:
    
    true if at least three objects are currently selected.
    
    See Also:
    
    Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - alignBottom
```
public void alignBottom()
```
    Aligns the currently selected objects along the bottom axis of their bounding boxes.
    The bounding box for a graphic object is the smallest rectangle containing the entire area of the object.
    
    Overrides:
    
    alignBottom in class IlvDiagrammer
    
    See Also:
    
    canAlign(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - alignHorizontalCenter
```
public void alignHorizontalCenter()
```
    Aligns the currently selected objects along the horizontal center of their bounding boxes.
    The bounding box for a graphic object is the smallest rectangle containing the entire area of the object.
    
    Overrides:
    
    alignHorizontalCenter in class IlvDiagrammer
    
    See Also:
    
    canAlign(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - alignLeft
```
public void alignLeft()
```
    Aligns the currently selected objects along the left side of their bounding boxes.
    The bounding box for a graphic object is the smallest rectangle containing the entire area of the object.
    
    Overrides:
    
    alignLeft in class IlvDiagrammer
    
    See Also:
    
    canAlign(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - alignRight
```
public void alignRight()
```
    Aligns the currently selected objects along the right side of their bounding boxes.
    The bounding box for a graphic object is the smallest rectangle containing the entire area of the object.
    
    Overrides:
    
    alignRight in class IlvDiagrammer
    
    See Also:
    
    canAlign(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - alignTop
```
public void alignTop()
```
    Aligns the currently selected objects along the top of their bounding boxes.
    The bounding box for a graphic object is the smallest rectangle containing the entire area of the object.
    
    Overrides:
    
    alignTop in class IlvDiagrammer
    
    See Also:
    
    canAlign(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - alignVerticalCenter
```
public void alignVerticalCenter()
```
    Aligns the currently selected objects along the vertical center of their bounding boxes.
    The bounding box for a graphic object is the smallest rectangle containing the entire area of the object.
    
    Overrides:
    
    alignVerticalCenter in class IlvDiagrammer
    
    See Also:
    
    canAlign(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - distributeHorizontally
```
public void distributeHorizontally()
```
    Distributes the currently selected objects horizontally.
    
    Overrides:
    
    distributeHorizontally in class IlvDiagrammer
    
    See Also:
    
    canDistribute(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - distributeVertically
```
public void distributeVertically()
```
    Distributes the currently selected objects vertically.
    
    Overrides:
    
    distributeVertically in class IlvDiagrammer
    
    See Also:
    
    canDistribute(), Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - getBackgroundGraphics
```
public IlvDashboardGraphicIterator getBackgroundGraphics()
```
    Returns all background graphic objects contained in this dashboard diagram.
    
    Returns:
    
    A graphic iterator containing all background graphic objects contained in this dashboard diagram.
  - writeDataFile
```
public void writeDataFile(URL url)
                   throws IlvDiagrammerException
```
    Description copied from class: IlvDiagrammer
    
    Writes the current diagram to the specified data URL.
    If the current data source is an XML data source, the data source will be modified to point to the new URL, and the data in the diagram component will be written to the new file. Otherwise, the data source of the diagram component will be replaced by an XML data source pointing to the specified URL.
    
    Overrides:
    
    writeDataFile in class IlvDiagrammer
    
    Parameters:
    
    url - The URL to write the data to.
    
    Throws:
    
    IlvDiagrammerException - If any other exception occurred while writing the diagram.
    
    Internal: do not use!
  - writeData
```
public void writeData()
               throws IlvDiagrammerException
```
    Description copied from class: IlvDiagrammer
    
    Writes the diagram to the current data source. If the diagram was loaded through a project file, the project description is also saved.
    
    Overrides:
    
    writeData in class IlvDiagrammer
    
    Throws:
    
    IlvDiagrammerException - If any other exception occurred while writing the diagram.
    
    See Also:
    
    IlvDiagrammer.setDataFile(java.net.URL), IlvDiagrammer.setProject(IlvDiagrammerProject)
    
    Internal: do not use!
  - writeDashboardFiles
```
public void writeDashboardFiles()
```
    Internal: do not use!
  - writeBackgroundFile
```
public void writeBackgroundFile(String file)
```
    Writes all background graphic objects in the dashboard diagram to file in Rogue Wave JViews (.IVL) format.
    
    Parameters:
    
    file - The name of the output file.
    
    See Also:
    
    writeBackground(OutputStream)
  - writeBackground
```
public void writeBackground(OutputStream outputStream)
```
    Writes all background graphic objects in the dashboard diagram to the given outputStream in Rogue Wave JViews (.IVL) format.
    
    Parameters:
    
    outputStream - The OutputStream to write the background objects to.
    
    See Also:
    
    writeBackgroundFile(String)
  - readBackground
```
public void readBackground(InputStream inputStream)
```
    Imports background objects into the dashboard diagram from inputStream.
    
    Parameters:
    
    inputStream - The InputStream containing the background objects.
    
    See Also:
    
    Events, IlvDashboardMenuBar, IlvDiagrammerMenuBar, IlvDashboardAction, IlvDiagrammerAction
  - writeProjectFile
```
public void writeProjectFile(URL projectURL)
                      throws IlvDiagrammerException
```
    Description copied from class: IlvDiagrammer
    
    Writes the diagrammer project file to the specified URL.
    
    Overrides:
    
    writeProjectFile in class IlvDiagrammer
    
    Parameters:
    
    projectURL - the project URL.
    
    Throws:
    
    IlvDiagrammerException - If exception occurred while writing the diagram.
    
    Internal: do not use!
  - setProject
```
public void setProject(IlvDiagrammerProject project)
                throws IOException,
                       IlvDiagrammerException
```
    Loads a JViews Diagrammer project into this dashboard diagram.
    
    Overrides:
    
    setProject in class IlvDiagrammer
    
    Parameters:
    
    project - An IlvDiagrammerProject containing a logical data source and a style sheet.
    
    Throws:
    
    IOException - if there is a problem reading project.
    
    IlvDiagrammerException - if there is a problem rendering the dashboard diagram.
    
    See Also:
    
    IlvDiagrammerProject
  - isEmpty
```
public boolean isEmpty()
```
    Tests if the dashboard diagram is empty.
    
    Overrides:
    
    isEmpty in class IlvDiagrammer
    
    Returns:
    
    true if this dashboard diagram contains no symbols or background objects.
  - setModified
```
public void setModified(boolean modified)
```
    Sets the modified flag of the dashboard diagram.
    
    Overrides:
    
    setModified in class IlvDiagrammer
    
    Parameters:
    
    modified - Set to true to indicate that the dashboard diagram has changed.
    
    See Also:
    
    Events
  - isModified
```
public boolean isModified()
```
    Tests if this dashboard diagram is modified.
    
    Overrides:
    
    isModified in class IlvDiagrammer
    
    Returns:
    
    true if the dashboard diagram has been modified.
  - isBackgroundObject
```
public boolean isBackgroundObject(IlvGraphic graphic)
```
    Tests if graphic is a background object.
    
    Parameters:
    
    graphic - The graphic object to test.
    
    Returns:
    
    true if graphic is a background object in this dashboard diagram.
  - addSymbol
```
public void addSymbol(IlvDashboardSymbol symbol)
```
    Adds a new IlvDashboardSymbol instance to this dashboard diagram.
    
    Parameters:
    
    symbol - The symbol to be added to the diagram.
  - removeSymbol
```
public void removeSymbol(IlvDashboardSymbol symbol)
```
    Removes symbol from this dashboard diagram.
    
    Parameters:
    
    symbol - The symbol to be removed from this dashboard diagram.
  - getObjectSymbol
```
public IlvDashboardSymbol getObjectSymbol(Object modelObject)
```
    Returns the symbol corresponding to modelObject.
    
    Parameters:
    
    modelObject - An object in the SDM Model.
    
    Returns:
    
    The symbol corresponding to modelObject. Returns null if no corresponding symbol exists in the Dashboard Diagram.
    
    See Also:
    
    The SDM Engine
  - getGraphicSymbol
```
public IlvDashboardSymbol getGraphicSymbol(IlvGraphic graphic)
```
    Returns the symbol corresponding to graphic.
    
    Parameters:
    
    graphic - The graphic object whose symbol you wish to retrieve.
    
    Returns:
    
    The symbol corresponding to graphic. Returns null if no corresponding symbol exists in the dashboard diagram.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    getObjectSymbol(Object)
  - hasSelectedSymbols
```
public boolean hasSelectedSymbols()
```
    Tests if at least a symbol in this dashboard diagram is selected.
    
    Returns:
    
    true if one or more symbols are selected.
  - getSelectedSymbols
```
public IlvDashboardSymbolIterator getSelectedSymbols()
```
    Returns an iterator to run over the collection of symbols currently selected in this dashboard diagram.
    
    Returns:
    
    A symbol iterator with the currently selected symbols.
  - getSymbol
```
public IlvDashboardSymbol getSymbol(String id)
```
    Returns the symbol whose ID corresponds to id.
    
    Parameters:
    
    id - The id of the symbol to be returned.
    
    Returns:
    
    The symbol matching id or null if it does not exist in this dashboard diagram instance.
  - getURL
```
public URL getURL()
```
    Returns the URL of this dashboard diagram.
    
    Returns:
    
    The URL of this dashboard diagram.
  - setURL
```
public void setURL(URL url)
```
    Parameters:
    
    url - The url of the dashboard diagram.
    
    Internal: do not use!
  - writeDashboard
```
public void writeDashboard(URL url)
                    throws IlvDiagrammerException
```
    Writes the dashboard diagram contents in XML format to url.
    
    Parameters:
    
    url - The URL to which the dashboard diagram contents will be written.
    
    Throws:
    
    IlvDiagrammerException - when this dashboard diagram cannot be written to url.
  - readDashboard
```
public void readDashboard(URL url)
                   throws IlvDiagrammerException
```
    Read the dashboard diagram XML format file from url.
    
    Parameters:
    
    url - The URL from which the dashboard diagram contents are loaded.
    
    Throws:
    
    IlvDiagrammerException - when this dashboard diagram cannot be loaded from url.
    
    See Also:
    
    dashboard diagram Files, readDashboard(Document, boolean, double, double)
  - readBinary
```
public void readBinary(URL url)
                throws IOException,
                       IlvDashboardException,
                       ClassNotFoundException
```
    Reads a dashboard from a binary file.
    
    Parameters:
    
    url - The URL from which the dashboard contents are loaded.
    
    Throws:
    
    IOException - If there is a problem reading from url.
    
    IlvDashboardException - If there is a problem reading from url.
    
    ClassNotFoundException - If there is a problem reading from url.
    
    Since:
    
    JViews 8.1
  - readBinary
```
public void readBinary(InputStream in)
                throws IOException,
                       IlvDashboardException,
                       ClassNotFoundException
```
    Reads the dashboard binary format contents from an input stream.
    
    Parameters:
    
    in - The input stream from which the dashboard contents are loaded.
    
    Throws:
    
    IOException - if there is a problem reading in.
    
    IlvDashboardException - if there is a problem reading in.
    
    ClassNotFoundException - if there is a problem reading in.
    
    Since:
    
    JViews 8.1
  - writeBinary
```
public void writeBinary(URL url)
                 throws IOException
```
    Writes the contents of the dashboard in binary format to a URL.
    
    Parameters:
    
    url - The URL of the output binary format file to which the dashboard contents are written.
    
    Throws:
    
    IOException
    
    Since:
    
    JViews 8.1
  - writeBinary
```
public void writeBinary(OutputStream out)
                 throws IOException
```
    Writes the contents of the dashboard in binary format to an output stream.
    
    Parameters:
    
    out - The output stream to which the dashboard contents will be written.
    
    Throws:
    
    IOException
    
    Since:
    
    JViews 8.1
  - readDashboard
```
public void readDashboard(Document document,
                          boolean selection,
                          double dx,
                          double dy)
                   throws IlvDiagrammerException
```
    Reads the dashboard diagram contents from document. The contents of document are added to the existing background objects and symbols in this dashboard diagram.
    Note: The IDs of the symbols loaded by this method may be changed automatically if they are already used.
    
    Parameters:
    
    document - A valid dashboard diagram document.
    
    selection - Set to true so the new objects loaded into the dashboard diagram are selected.
    
    dx - The horizontal offset for the loaded objects.
    
    dy - The vertical offset for the loaded objects.
    
    Throws:
    
    IlvDiagrammerException - When the dashboard document cannot be read.
  - isValidDocument
```
protected boolean isValidDocument(Document document)
```
    Tests if document is a valid dashboard diagram document.
    
    Parameters:
    
    document - The document to test.
    
    Returns:
    
    true if the root element of document shows it to be a dashboard diagram file. This method does not validate the XML contained in document.
    
    See Also:
    
    dashboard diagram Files.
  - isUndoingEnabled
```
public boolean isUndoingEnabled()
```
    Tests if the undo mechanism of this dashboard diagram is enabled.
    
    Returns:
    
    true if the undo mechanism for this dashboard diagram is enabled.
    
    See Also:
    
    setUndoingEnabled(boolean)
  - setUndoingEnabled
```
public void setUndoingEnabled(boolean enabled)
```
    Enables or disables the undo mechanism of this dashboard diagram.
    
    Parameters:
    
    enabled - Set to true to enabled the undo mechanism of this dashboard diagram.
  - addUndoableEdit
```
public void addUndoableEdit(UndoableEdit edit)
```
    Add the last user action to the list of edits that can be undone and redone for this dashboard diagram.
    
    Parameters:
    
    edit - An edit to the dashboard diagram that may be undone and redone using the undo mechanism.
  - setCompoundEditMode
```
public void setCompoundEditMode(boolean flag)
```
    Parameters:
    
    flag -
    
    Internal: do not use!
  - canUndo
```
public boolean canUndo()
```
    Tests the dashboard diagram to see if significant edits have been done by the user.
    
    Overrides:
    
    canUndo in class IlvDiagrammer
    
    Returns:
    
    true if their are significant changes to be undone.
  - undo
```
public void undo()
```
    Undoes the last significant change to the Dashboard Document.
    
    Overrides:
    
    undo in class IlvDiagrammer
    
    See Also:
    
    canUndo(), canRedo(), redo()
  - canRedo
```
public boolean canRedo()
```
    Tests if their are significant changes to the dashboard diagram that have been undone.
    
    Overrides:
    
    canRedo in class IlvDiagrammer
    
    Returns:
    
    true if changes to the dashboard diagram have been undone and can be redone.
    
    See Also:
    
    redo(), canUndo(), undo()
  - redo
```
public void redo()
```
    Redoes the the last significant change previously undone by the user.
    
    Overrides:
    
    redo in class IlvDiagrammer
    
    See Also:
    
    canRedo(), canUndo(), undo()
  - setSelectManager
```
public void setSelectManager(IlvDashboardKeySelectManager focusManager)
```
    Sets the selection manager to be used for this dashboard diagram.
    A selection manager is used to follow the symbols selected by the user in a dashboard diagram.
    
    Parameters:
    
    focusManager - The selection manager to be set for this dashboard diagram.
    
    See Also:
    
    getSelectManager()
  - getSelectManager
```
public IlvDashboardKeySelectManager getSelectManager()
```
    Returns the selection manager used by this dashboard diagram.
    A selection manager is used to trace the symbols selected by the user in a dashboard diagram.
    
    Returns:
    
    The selection manager used by this dashboard diagram.
    
    See Also:
    
    setSelectManager(IlvDashboardKeySelectManager)
  - clear
```
public void clear()
```
    Deletes all symbols and background objects contained in this dashboard diagram.
  - setEditingAllowed
```
public void setEditingAllowed(boolean editingAllowed)
```
    Sets whether symbols and background images contained in this dashboard diagram may be modified.
    Allows or forbids modifying (move, cut, copy, paste,) of the objects in the dashboard diagram.
    
    Overrides:
    
    setEditingAllowed in class IlvDiagrammer
    
    Parameters:
    
    editingAllowed - Set to true so symbols, background images and links contained in the dashboard diagram may be edited.
    
    See Also:
    
    IlvDiagrammer.setEditingAllowed(boolean)
  - isContained
```
public boolean isContained(IlvDashboardSymbol symbol)
```
    Tests if the given symbol is contained in this dashboard diagram.
    
    Parameters:
    
    symbol - The symbol to test.
    
    Returns:
    
    true if the symbol is contained in this dashboard diagram.
  - getSymbolIndex
```
public int getSymbolIndex(IlvDashboardSymbol symbol)
```
    Returns the index of the symbol in the dashboard diagram list.
    
    Parameters:
    
    symbol - The symbol to locate.
    
    Returns:
    
    The index of the given symbol.
    
    Internal: do not use!
  - setSymbolIndex
```
public void setSymbolIndex(IlvDashboardSymbol symbol,
                           int index)
```
    Sets a new index of the given symbol in the dashboard diagram list.
    
    Parameters:
    
    symbol - The symbol of which the index is to be changed.
    
    index - The new index of the given symbol.
    
    Internal: do not use!
  - addSymbolParameterListener
```
public void addSymbolParameterListener(IlvDashboardSymbolParameterListener listener)
```
    Adds a symbol parameter listener that will be notified when the value or the mapping of a symbol parameter is changed.
    
    Parameters:
    
    listener - The symbol parameter listener.
    
    See Also:
    
    removeSymbolParameterListener(IlvDashboardSymbolParameterListener), IlvDashboardSymbolParameterListener, IlvDashboardSymbolParameterEvent
  - removeSymbolParameterListener
```
public void removeSymbolParameterListener(IlvDashboardSymbolParameterListener listener)
```
    Removes a symbol parameter listener previously added.
    
    Parameters:
    
    listener - The symbol parameter listener to be removed.
    
    See Also:
    
    addSymbolParameterListener(IlvDashboardSymbolParameterListener)
  - fireSymbolParameterChanged
```
public void fireSymbolParameterChanged(IlvDashboardSymbol symbol,
                                       IlvDashboardSymbol.Parameter parameter,
                                       Object oldValue,
                                       Object newValue,
                                       String oldMapping,
                                       String newMapping)
```
    This method calls the parameterChanged method of all symbol parameter listeners of this dashboard diagram.
    
    Parameters:
    
    symbol - The symbol owning the modified parameter.
    
    parameter - The symbol parameter that has been changed.
    
    oldValue - The symbol parameter old value.
    
    newValue - The symbol parameter new value.
    
    oldMapping - The symbol parameter old mapping.
    
    newMapping - The symbol parameter new mapping.
  - getPrintingController
```
public IlvManagerPrintingController getPrintingController()
```
    Returns the printing controller that handles all the printing-related tasks for this diagram component.
    Typical applications do not need to access the printing controller directly, since all the printing tasks are handled automatically by the methods IlvDiagrammer.print(boolean, boolean, ilog.views.diagrammer.IlvDiagrammer.PrinterExceptionHandler), IlvDiagrammer.pageSetup() and so on. You need to access the printing controller only if you want to customize the printing process.
    
    Overrides:
    
    getPrintingController in class IlvDiagrammer
    
    Returns:
    
    printing controller
    
    See Also:
    
    IlvDiagrammer.print(boolean, boolean, ilog.views.diagrammer.IlvDiagrammer.PrinterExceptionHandler), IlvDiagrammer.pageSetup(), IlvDiagrammer.printPreview(), IlvDiagrammer.setPrintArea(), IlvDiagrammer.clearPrintArea(), IlvDiagrammer.printToBitmap(java.io.File)
  - setBaseTextDirection
```
public void setBaseTextDirection(int btd)
```
    Changes the global base direction of text in the diagram. The possible choices are:
    - IlvBidiUtil.COMPONENT_DIRECTION: the base text direction is the same as the component orientation. This is the default.
    - IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
    - IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
    - IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation.
    Overrides:
    
    setBaseTextDirection in class IlvDiagrammer
    
    Parameters:
    
    btd - The base text direction.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    getBaseTextDirection()
  - getBaseTextDirection
```
public int getBaseTextDirection()
```
    Returns the global base direction of text in the diagram. The possible return values are:
    - IlvBidiUtil.COMPONENT_DIRECTION: the base text direction is the same as the component orientation. This is the default.
    - IlvBidiUtil.LEFT_TO_RIGHT: the base text direction is left-to-right.
    - IlvBidiUtil.RIGHT_TO_LEFT: the base text direction is right-to-left.
    - IlvBidiUtil.CONTEXTUAL_DIRECTION: the base test direction is determined from the text that is displayed according to the standard Bidi algorithm, if the text contains at least one character with a strong left-to-right or right-to-left direction. If the text doesn't contain any character with a strong direction, the real text direction is determined from the current component orientation.
    Overrides:
    
    getBaseTextDirection in class IlvDiagrammer
    
    Returns:
    
    The base text direction.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    setBaseTextDirection(int)
  - isLinkLayoutEnabled
```
public boolean isLinkLayoutEnabled()
```
    Tests if link layout is enabled.
    
    Returns:
    
    If the Link Layout is enabled, true is returned.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setLinkLayoutEnabled(boolean)
  - setLinkLayoutEnabled
```
public void setLinkLayoutEnabled(boolean enabled)
```
    Enables or disables the Link Layout.
    When link layout is enabled, all the existing intermediate link points are replaced by ones specified by the link layout algorithm. When link layout is disabled, the intermediate link points installed by the existing link layout are kept.
    
    Parameters:
    
    enabled - Set to true to enable link layout.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    isLinkLayoutEnabled()
  - getSerializableProperties
```
public ArrayList<Object> getSerializableProperties()
```
    Internal: do not use!
  - setSerializableProperties
```
public void setSerializableProperties(ArrayList<Object> properties)
```
    Internal: do not use!
  - getSymbols
```
@Deprecated
public IlvDashboardSymbolIterator getSymbols()
```
    Deprecated. You should use iterator() instead.
    
    Returns all symbols contained in this dashboard diagram.
    
    Returns:
    
    An Iterator used to scan through all symbols contained in this dashboard diagram
  - iterator
```
public Iterator<IlvDashboardSymbol> iterator()
```
    This method implements the Iterable interface.
    
    Specified by:
    
    iterator in interface Iterable<IlvDashboardSymbol>
    
    Returns:
    
    An Iterator used to scan through all symbols contained in this dashboard diagram.
    
    Since:
    
    JViews 8.5
  - addStyleSheet
```
public void addStyleSheet(URL url)
                   throws IOException,
                          IlvDiagrammerException
```
    This method is not supported by IlvDashboardDiagram. In an IlvDashboardDiagram object, CSS rules are internally created and managed by the dashboard diagram. User rules are not allowed. If you attempt to add a style sheet to this object an UnsupportedOperationException exception is raised.
    
    Overrides:
    
    addStyleSheet in class IlvDiagrammer
    
    Parameters:
    
    url - The URL of the new style sheet.
    
    Throws:
    
    UnsupportedOperationException - if you call this method on an IlvDashboardDiagram object.
    
    IOException - If an I/O error occurred while reading the style sheet.
    
    IlvDiagrammerException - If an error occurred while processing the style sheet.
    
    Since:
    
    JViews 8.8

Class IlvDashboardDiagram

Introducing Dashboards

Example

Events

Input and Output

Rendering

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.diagrammer.IlvDiagrammer

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

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class ilog.views.diagrammer.IlvDiagrammer

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

IlvDashboardDiagram

IlvDashboardDiagram

Method Detail

getContext

setQuadtreeEnabled

prepareForEditing

canEdit

delete

cut

copy

paste

canPaste

duplicate

selectAll

canSelect

canGroup

group

canUngroup

ungroup

canAlign

canDistribute

alignBottom

alignHorizontalCenter

alignLeft

alignRight

alignTop

alignVerticalCenter

distributeHorizontally

distributeVertically

getBackgroundGraphics

writeDataFile

writeData

writeDashboardFiles

writeBackgroundFile

writeBackground

readBackground

writeProjectFile

setProject

isEmpty

setModified

isModified

isBackgroundObject

addSymbol

removeSymbol

getObjectSymbol

getGraphicSymbol

hasSelectedSymbols

getSelectedSymbols

getSymbol

getURL

setURL

writeDashboard

readDashboard

readBinary

readBinary

writeBinary