IlvDashboardEditor (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.dashboard.IlvDashboardContext
- - ilog.views.dashboard.IlvDashboardEditor

All Implemented Interfaces:

Serializable
```
public class IlvDashboardEditor
extends IlvDashboardContext
```
IlvDashboardEditor is the core class for a Dashboard Editor application, it provides access to the common Dashboard Editor components and manages global properties. Subclassing IlvDashboardEditor lets you override some of the Dashboard Editor default behavior.
See the DashboardEditor demo application to see how IlvDashboardEditor is used as the central class for a Dashboard Editor application.

Note: IlvDashboardEditor is not a graphical component.

Since:

JViews 8.0

See Also:

IlvDashboardDiagram, IlvDashboardPropertyPanel, IlvDashboardSymbolPalette, IlvDashboardEditorFrame, IlvDashboardPanelManager, Serialized Form

Field Summary
- Fields inherited from class ilog.views.dashboard.IlvDashboardContext
  VERSION

Constructor Summary

Constructors
Constructor and Description
`IlvDashboardEditor()` Constructs a Dashboard Editor with the default resource bundle.
`IlvDashboardEditor(ResourceBundle bundle, String[] args)` Constructs an `IlvDashboardEditor` instance using the resource bundle `bundle` and command line arguments `args`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`canExit()` Tests if the Dashboard Editor application can exit.
`protected IlvDashboardDiagram`	`createDashboardDiagram()` Creates an instance of `IlvDashboardDiagram`
`protected IlvDashboardEditorFrame`	`createFrame()` Invoked by the `init(String[])` method to create the main frame window for a Dashboard Editor application.
`protected JMenuItem`	`createMenuItem(Action action)` Creates and returns a Swing menu item for the given `action`.
`protected void`	`dashboardAdded(IlvDashboardDiagram diagram)` Invoked when a new dashboard diagram has been added to the Dashboard Editor.
`protected void`	`dashboardRead(IlvDashboardDiagram diagram)` Invoked when a dashboard has read its contents.
`protected void`	`dashboardRemoved(IlvDashboardDiagram diagram)` Invoked when a dashboard diagram is removed from the Dashboard Editor.
`protected void`	`dashboardWritten(IlvDashboardDiagram diagram)` Invoked when a dashboard has saved its contents.
`void`	`exit()` Exits the Dashboard Editor application if `canExit()` returns `true`.
`IlvDashboardDiagram`	`getCurrentDashboardDiagram()` Returns the currently selected dashboard diagram in its dashboard container.
`IlvDashboardContainer`	`getDashboardContainer()` Returns the dashboard container for this Dashboard Editor instance.
`int`	`getDiagramCount()` Returns the number of the dashboard diagrams created with this `IlvDashboardEditor` instance.
`protected JPopupMenu`	`getDiagramPopupMenu()` Returns the dashboard diagram pop-up menu used when a dashboard implementation returns a pop-up menu providing access to a set of predefined JViews Diagrammer Swing actions.
`IlvDashboardDiagramIterator`	`getDiagrams()` Returns an iterator for the collection of all `IlvDashboardDiagram` objects in this Dashboard Editor application.
`Component`	`getDialogParent()` Returns the frame window for this `IlvDashboardEditor` instance.
`IlvDashboardEditManager`	`getEditManager()` Returns the edit manager of the Dashboard Editor.
`IlvDashboardEditorFrame`	`getFrame()` Returns the frame window for this Dashboard Editor application.
`IlvDashboardLinkManager`	`getLinkManager()` Returns the dashboard link manager.
`IlvDashboardPanel`	`getPanel(String id)` Returns the last dashboard panel created with the given `id`.
`IlvDashboardPreferences`	`getPreferences()` Gets an `IlvDashboardPreferences` object from the editor.
`IlvDashboardStatusViewer`	`getStatusViewer()` Returns the status viewer used by the graphical components in this Dashboard Editor application.
`void`	`init(String[] args)` Initializes the internal properties of the Dashboard Editor application.
`boolean`	`isGeneralPathEnabled()` Tests if the background graphic objects are created using general path objects instead of predefined `IlvGraphic` objects.
`protected Iterator<IlvPalette>`	`loadInitialPalettes()` Returns the URLs of the symbol palettes to load when the Dashboard Editor starts.
`void`	`run()` Starts the Dashboard Editor application by creating a new `IlvDashboardDiagram` instance.
`protected void`	`savePreferences()` Saves the preferences before terminating the session.
`void`	`setCurrentDashboardDiagram(IlvDashboardDiagram diagram)` Sets `diagram` as the currently active dashboard diagram in the dashboard container.
`void`	`setDashboardContainer(IlvDashboardContainer container)` Sets the dashboard container of this Dashboard Editor application.
`void`	`setEditManager(IlvDashboardEditManager editManager)` Sets the dashboard edit manager.
`void`	`setGeneralPathEnabled(boolean enabled)` Enables or disables the use of general path objects.
`void`	`setLinkManager(IlvDashboardLinkManager linkManager)` Sets the link manager.
`void`	`setPaletteViewer(IlvPaletteManagerViewer viewer)` Sets the palette manager viewer of the dashboard editor.
`void`	`setPreferences(IlvDashboardPreferences prefs)` Sets an `IlvDashboardPreferences` object to the editor.
`void`	`setStatusViewer(IlvDashboardStatusViewer statusViewer)` Sets a status viewer used by the graphical components in this Dashboard Editor application.
`void`	`showStatus(String message)` Shows a status message in this Dashboard Editor application.

Methods inherited from class ilog.views.dashboard.IlvDashboardContext
getLogger, getPaletteManager, getResourceBundle, getStyleSheetURL, isDefaultMappingEnabled, loadPalette, loadPalettes, logMessage, setDefaultMappingEnabled, setDialogParent, setStyleSheetURL

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvDashboardEditor
```
public IlvDashboardEditor()
```
    Constructs a Dashboard Editor with the default resource bundle.
  - IlvDashboardEditor
```
public IlvDashboardEditor(ResourceBundle bundle,
                          String[] args)
```
    Constructs an IlvDashboardEditor instance using the resource bundle bundle and command line arguments args.
    
    Parameters:
    
    bundle - Specific resources for this Dashboard Editor application.
    
    args - Command line arguments.
- Method Detail
  - createFrame
```
protected IlvDashboardEditorFrame createFrame()
```
    Invoked by the init(String[]) method to create the main frame window for a Dashboard Editor application.
    
    Returns:
    
    An IlvDashboardEditorFrame instance.
    
    See Also:
    
    init(String[])
  - getFrame
```
public IlvDashboardEditorFrame getFrame()
```
    Returns the frame window for this Dashboard Editor application.
    
    Returns:
    
    The frame window for this Dashboard Editor application.
  - getDialogParent
```
public Component getDialogParent()
```
    Returns the frame window for this IlvDashboardEditor instance.
    
    Overrides:
    
    getDialogParent in class IlvDashboardContext
    
    Returns:
    
    The frame window for this IlvDashboardEditor instance.
    
    See Also:
    
    getFrame(), IlvDashboardEditorFrame, IlvDashboardContext.getDialogParent()
  - getLinkManager
```
public IlvDashboardLinkManager getLinkManager()
```
    Returns the dashboard link manager.
    
    Returns:
    
    The dashboard link manager.
    
    Since:
    
    JViews 8.6
    
    See Also:
    
    IlvDashboardLinkManager
  - setLinkManager
```
public void setLinkManager(IlvDashboardLinkManager linkManager)
```
    Sets the link manager. This function lets you specify your own link manager.
    
    Parameters:
    
    linkManager - The link manager.
    
    Since:
    
    JViews 8.6
    
    See Also:
    
    IlvDashboardLinkManager.IlvDashboardLinkManager(IlvDashboardEditor)
  - getEditManager
```
public IlvDashboardEditManager getEditManager()
```
    Returns the edit manager of the Dashboard Editor.
    
    Returns:
    
    The edit manager.
    
    Since:
    
    JViews 8.6
    
    See Also:
    
    IlvDashboardEditManager
  - setEditManager
```
public void setEditManager(IlvDashboardEditManager editManager)
```
    Sets the dashboard edit manager. This function lets you specify your own edit manager.
    
    Parameters:
    
    editManager - The edit manager.
    
    Since:
    
    JViews 8.6
    
    See Also:
    
    IlvDashboardEditManager.IlvDashboardEditManager(IlvDashboardEditor)
  - init
```
public void init(String[] args)
```
    Initializes the internal properties of the Dashboard Editor application. This method installs the global listeners, and creates an IlvDashboardEditorFrame instance.
    
    Parameters:
    
    args - Command line arguments.
    
    See Also:
    
    IlvDashboardEditorFrame
  - run
```
public void run()
```
    Starts the Dashboard Editor application by creating a new IlvDashboardDiagram instance. Call this method after calling init(String[]).
    
    See Also:
    
    init(String[])
  - exit
```
public void exit()
```
    Exits the Dashboard Editor application if canExit() returns true.
    
    See Also:
    
    canExit()
  - savePreferences
```
protected void savePreferences()
```
    Saves the preferences before terminating the session.
    
    Since:
    
    JViews 8.5
  - canExit
```
protected boolean canExit()
```
    Tests if the Dashboard Editor application can exit. The default implementation only returns true if all IlvDashboardDiagram instances in this object can be closed.
    
    Returns:
    
    true if this Dashboard Editor application can exit.
    
    See Also:
    
    exit()
  - getDashboardContainer
```
public IlvDashboardContainer getDashboardContainer()
```
    Returns the dashboard container for this Dashboard Editor instance.
    
    Returns:
    
    The dashboard container for this Dashboard Editor instance.
  - setDashboardContainer
```
public void setDashboardContainer(IlvDashboardContainer container)
```
    Sets the dashboard container of this Dashboard Editor application.
    
    Parameters:
    
    container - The dashboard container.
  - createDashboardDiagram
```
protected IlvDashboardDiagram createDashboardDiagram()
```
    Creates an instance of IlvDashboardDiagram
    
    Returns:
    
    A new dashboard diagram.
    
    Since:
    
    JViews 8.6
  - getCurrentDashboardDiagram
```
public IlvDashboardDiagram getCurrentDashboardDiagram()
```
    Returns the currently selected dashboard diagram in its dashboard container.
    
    Returns:
    
    The currently selected dashboard diagram.
    
    See Also:
    
    IlvDashboardContainer.getSelectedDashboardDiagram()
  - setCurrentDashboardDiagram
```
public void setCurrentDashboardDiagram(IlvDashboardDiagram diagram)
```
    Sets diagram as the currently active dashboard diagram in the dashboard container.
    
    Parameters:
    
    diagram - The dashboard diagram to select.
    
    See Also:
    
    IlvDashboardContainer.setSelectedDashboardDiagram(IlvDashboardDiagram), IlvDashboardContainer
  - getDiagrams
```
public IlvDashboardDiagramIterator getDiagrams()
```
    Returns an iterator for the collection of all IlvDashboardDiagram objects in this Dashboard Editor application.
    
    Returns:
    
    An iterator for all IlvDashboardDiagram objects.
    
    See Also:
    
    IlvDashboardDiagram
  - getDiagramCount
```
public int getDiagramCount()
```
    Returns the number of the dashboard diagrams created with this IlvDashboardEditor instance.
    
    Returns:
    
    The number of dashboard diagrams.
  - setPaletteViewer
```
public void setPaletteViewer(IlvPaletteManagerViewer viewer)
```
    Sets the palette manager viewer of the dashboard editor.
    
    Parameters:
    
    viewer - The palette manager viewer.
    
    Internal: do not use!
  - isGeneralPathEnabled
```
public boolean isGeneralPathEnabled()
```
    Tests if the background graphic objects are created using general path objects instead of predefined IlvGraphic objects.
    A general path object enables you to use enhanced graphic attributes such as gradients.
    
    Returns:
    
    true if general path object use is enabled.
    
    See Also:
    
    setGeneralPathEnabled(boolean)
  - setGeneralPathEnabled
```
public void setGeneralPathEnabled(boolean enabled)
```
    Enables or disables the use of general path objects. A general path object enables you to use enhanced graphic attributes such as gradients.
    
    Parameters:
    
    enabled - Set to true to enable the use of general path objects.
    
    See Also:
    
    isGeneralPathEnabled()
  - setStatusViewer
```
public void setStatusViewer(IlvDashboardStatusViewer statusViewer)
```
    Sets a status viewer used by the graphical components in this Dashboard Editor application.
    
    Parameters:
    
    statusViewer - The status viewer that will display all the status messages.
    
    See Also:
    
    IlvDashboardDefaultStatusViewer, IlvDashboardStatusViewer, IlvDashboardEditorFrame
  - getStatusViewer
```
public IlvDashboardStatusViewer getStatusViewer()
```
    Returns the status viewer used by the graphical components in this Dashboard Editor application.
    
    Returns:
    
    The status viewer used by the graphical components in this Dashboard Editor application.
    
    See Also:
    
    IlvDashboardDefaultStatusViewer, IlvDashboardEditorFrame
  - showStatus
```
public void showStatus(String message)
```
    Shows a status message in this Dashboard Editor application.
    If no IlvDashboardDefaultStatusViewer has been added to this Dashboard Editor application, message cannot be displayed.
    
    Parameters:
    
    message - The message to be displayed in the status window.
    
    See Also:
    
    setStatusViewer(IlvDashboardStatusViewer), IlvDashboardDefaultStatusViewer, IlvDashboardStatusViewer, IlvDashboardEditorFrame
  - dashboardAdded
```
protected void dashboardAdded(IlvDashboardDiagram diagram)
```
    Invoked when a new dashboard diagram has been added to the Dashboard Editor.
    
    Parameters:
    
    diagram - The added dashboard diagram.
    
    Since:
    
    JViews 8.6
  - dashboardRead
```
protected void dashboardRead(IlvDashboardDiagram diagram)
```
    Invoked when a dashboard has read its contents.
    
    Parameters:
    
    diagram - The dashboard diagram.
    
    Since:
    
    JViews 8.6
  - dashboardWritten
```
protected void dashboardWritten(IlvDashboardDiagram diagram)
```
    Invoked when a dashboard has saved its contents.
    
    Parameters:
    
    diagram - The dashboard diagram.
    
    Since:
    
    JViews 8.6
  - dashboardRemoved
```
protected void dashboardRemoved(IlvDashboardDiagram diagram)
```
    Invoked when a dashboard diagram is removed from the Dashboard Editor.
    
    Parameters:
    
    diagram - The removed dashboard diagram.
    
    Since:
    
    JViews 8.6
  - getPanel
```
public IlvDashboardPanel getPanel(String id)
```
    Returns the last dashboard panel created with the given id.
    Note: If this Dashboard Editor contains more than one panel with id, this method returns the last panel added with this id
    
    Parameters:
    
    id - The ID of the panel.
    
    Returns:
    
    The panel that matches id or null if no panel exists with id.
    
    See Also:
    
    IlvDashboardPropertyPanel, IlvDashboardSymbolPalette, IlvDashboardEditorFrame, IlvDashboardPanelManager
  - setPreferences
```
public void setPreferences(IlvDashboardPreferences prefs)
```
    Sets an IlvDashboardPreferences object to the editor.
    
    Parameters:
    
    prefs - an implementation of the Dashboard Editor preferences.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    IlvDashboardPreferences, getPreferences()
  - getPreferences
```
public IlvDashboardPreferences getPreferences()
```
    Gets an IlvDashboardPreferences object from the editor.
    
    Returns:
    
    The IlvDashboardPeferences of the editor.
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    IlvDashboardPreferences, setPreferences(IlvDashboardPreferences)
  - getDiagramPopupMenu
```
protected JPopupMenu getDiagramPopupMenu()
```
    Returns the dashboard diagram pop-up menu used when a dashboard implementation returns a pop-up menu providing access to a set of predefined JViews Diagrammer Swing actions. You can override this method in your Dashboard Editor extension with actions of your choice. Use the createMenuItem(Action) function to create the menu items.
    
    Returns:
    
    The pop-up menu for the dashboard diagram in Selection mode.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    createMenuItem(Action)
  - createMenuItem
```
protected JMenuItem createMenuItem(Action action)
```
    Creates and returns a Swing menu item for the given action. Use this method to create a menu item for an IlvDiagrammerAction instance. Predefined listeners are added to the created menu item, and when applicable, a JCheckBoxMenuItem instance is created for selectable actions.
    
    Parameters:
    
    action - The Swing Action for which the returned menu item is created.
    
    Returns:
    
    The Swing menu item.
    
    Since:
    
    JViews 8.8
    
    See Also:
    
    getDiagramPopupMenu()
  - loadInitialPalettes
```
protected Iterator<IlvPalette> loadInitialPalettes()
                                            throws IOException
```
    Returns the URLs of the symbol palettes to load when the Dashboard Editor starts. The URLs of the palettes from the previous session are loaded by default. Override this method in a subclass when you want to customize the list of palettes to be loaded.
    
    Returns:
    
    The symbol palette URLs.
    
    Throws:
    
    IOException
    
    Since:
    
    JViews 8.8

Class IlvDashboardEditor

Field Summary

Fields inherited from class ilog.views.dashboard.IlvDashboardContext

Constructor Summary

Method Summary

Methods inherited from class ilog.views.dashboard.IlvDashboardContext

Methods inherited from class java.lang.Object

Constructor Detail

IlvDashboardEditor

IlvDashboardEditor

Method Detail

createFrame

getFrame

getDialogParent

getLinkManager

setLinkManager

getEditManager

setEditManager

init

run

exit

savePreferences

canExit

getDashboardContainer

setDashboardContainer

createDashboardDiagram

getCurrentDashboardDiagram

setCurrentDashboardDiagram

getDiagrams

getDiagramCount

setPaletteViewer

isGeneralPathEnabled

setGeneralPathEnabled

setStatusViewer

getStatusViewer

showStatus

dashboardAdded

dashboardRead

dashboardWritten

dashboardRemoved

getPanel

setPreferences

getPreferences

getDiagramPopupMenu

createMenuItem

loadInitialPalettes