ilog.views.dashboard

Class IlvDashboardAction

java.lang.Object

javax.swing.AbstractAction

ilog.views.util.swing.context.ComponentAction

ilog.views.diagrammer.application.IlvDiagrammerAction

ilog.views.dashboard.IlvDashboardAction

All Implemented Interfaces:

ActionListener, Serializable, Cloneable, EventListener, Action

public abstract class IlvDashboardAction
extends IlvDiagrammerAction

IlvDashboardAction is the base class for Swing Actions used to control and edit an IlvDashboardDiagram instance; it extends the IlvDiagrammerAction class.

Introducing Dashboards

A typical Dashboard Editor application uses the predefined actions provided in this class as static constants to provide standard functionality. For example, you use IlvDashboardAction to add open, save, and edit functionality to dashboard diagrams.

Example

The following code sample shows how to add a sendBackward action to a specific location in a Dashboard Editor toolbar.

  JPanel panel = new JPanel(new BorderLayout());
  JPanel panel1 = new JPanel(new IlvBetterFlowLayout(FlowLayout.LEADING, 0, 0));
  IlvDashboardEditBar editBar = new IlvDashboardEditBar();
  editBar.insertAction(IlvDashboardAction.sendBackward , 0);
  panel1.add(editBar);
  panel.add(panel1, BorderLayout.PAGE_START);
 

Layers

Dashboard diagrams organize symbols and background objects by placing them in multiple layers. Objects stored in a higher layer are displayed in front of objects in lower layers. A dashboard diagram object can only be contained in one layer at a time.

Functionality

The IlvDashboardAction class inherits the following capabilities from IlvDiagrammerAction in addition to standard Swing Action capabilities:

• It provides support for internationalization.
• It is routed automatically to the current dashboard component.
• It handles the selected state of the action.
• The behavior of each action can be modified by adding listeners to it.
• Diagrammer actions handle errors by extending the IlvDiagrammerAction.ErrorHandler interface. For more information, see IlvDiagrammerAction#setErrorHandler(ErrorHandler).

Since:

JViews 8.0

See Also:

IlvDiagrammerAction.ErrorHandler, IlvDiagrammerAction, IlvDiagrammerAction.setErrorHandler(ErrorHandler), IlvDashboardDiagram, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ilog.views.diagrammer.application.IlvDiagrammerAction

IlvDiagrammerAction.ErrorHandler, IlvDiagrammerAction.FileAction, IlvDiagrammerAction.Handler, IlvDiagrammerAction.StatusEvent, IlvDiagrammerAction.StatusListener, IlvDiagrammerAction.ToggleAction

Field Summary

Fields

Modifier and Type	Field and Description
static IlvDashboardAction	blinkingAllowed This action enables or disables blinking in the current view of the dashboard diagram.
static IlvDashboardAction	bringForward Shifts the selected object or objects up one layer in the dashboard diagram.
static IlvDashboardAction	bringToFront Brings the selected object or objects to the highest position in the dashboard diagram layers.
static IlvDashboardAction	clearMapping This action clears the parameter mappings of the selected symbols.
static IlvDashboardAction	close Closes the dashboard diagram.
static IlvDashboardAction	componentDirection Sets the base text direction of the diagram to be the same as the component orientation.
static IlvDashboardAction	contextualDirection Sets the base text direction of the diagram to contextual, meaning that the actual base text direction is determined from the text, if it contains at least one character with a strong left-to-right or right-to-left direction.
static IlvDashboardAction	defaultMappingEnabled This action enables or disables the default mapping of symbol parameters when you drag and drop a symbol.
static IlvDashboardAction	generalPathEnabled This action enables or disables the use of General Path objects when creating a background graphic object.
static IlvDashboardAction	importFile Imports a Perforce JViews background graphic file into the current dashboard diagram.
static IlvDashboardAction	inheritedDirection Sets the base text direction of the diagram to be inherited from the parent.
static IlvDashboardAction	layerPanel This action shows or hide the dashboard layer panel.
static IlvDashboardAction	leftToRightDirection Sets the base text direction of the diagram to left-to-right.
static IlvDashboardAction	linkIntermediatePointsAllowed This actions allows or disallows the link intermediate points to be inserted when creating a link.
static IlvDashboardAction	linkLayoutEnabled This action enables or disable the link layout.
static IlvDashboardAction	open Opens a dashboard diagram file.
static IlvDashboardAction	rightToLeftDirection Sets the base text direction of the diagram to right-to-left.
static IlvDashboardAction	save Saves the current dashboard diagram to an existing file.
static IlvDashboardAction	saveAs Saves the current dashboard diagram contents into a new dashboard file.
static IlvDashboardAction	sendBack Sends the selected objects to the bottom layer in the dashboard diagram.
static IlvDashboardAction	sendBackward Shifts the selected objects down one layer in the dashboard diagram.
static IlvDashboardAction	setDefaultMapping This action makes the default parameter mappings of the selected symbols.
static IlvDashboardAction	showHiddenObjects Sets the visible property of the selected Symbols to true.

Fields inherited from class ilog.views.diagrammer.application.IlvDiagrammerAction

_new, about, ABOUT_APPLICATION_NAME, alignBottom, alignHorizontalCenter, alignLeft, alignRight, alignTop, alignVerticalCenter, autoEditLabel, autoLabelLayout, autoLinkLayout, autoNodeLayout, callBuilder, clearPrintArea, copy, createLink, createNode, cut, delete, distributeHorizontally, distributeVertically, duplicate, editing, editLabel, exit, fitToContents, grid, gridSpacing, group, help, layoutAllNodes, layoutSelectedNodes, openStyleSheet, pageSetup, pan, paste, printPreview, printToBitmap, printWithDialog, printWithoutDialog, read, redo, refresh, resetZoom, resizing, select, selectAll, setPrintArea, stickyModes, undo, ungroup, zoom, zoomIn, zoomOut

Fields inherited from class ilog.views.util.swing.context.ComponentAction

hideToolbarButtonBordersOnOceanTheme

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvDashboardAction(String prefix) Constructs an IlvDashboardAction instance using the IlvDiagrammerAction prefix mechanism.
protected	IlvDashboardAction(String prefix, ResourceBundle bundle) Constructs an IlvDashboardAction instance using the IlvDiagrammerAction prefix mechanism for bundle.

Method Summary

Modifier and Type	Method and Description
protected ResourceBundle	getDefaultResourceBundle() Returns the default resource bundle.
protected static IlvDashboardEditor	getEditor(IlvDiagrammer diagrammer) Returns the IlvDashboardEditor instance attached to a given IlvDashboardDiagram object.

Methods inherited from class ilog.views.diagrammer.application.IlvDiagrammerAction

addActionToUpdate, addStatusListener, call, chooseFile, getActionFileChooser, getDefaultSelectedFile, getErrorHandler, getFileChooserDirectory, getString, isEnabled, isEnabled, isSelected, isSelected, perform, perform, removeActionToUpdate, removeStatusListener, setDefaultSelectedFile, setErrorHandler, setFileChooserDirectory, setHandler, update, update, updateActions

Methods inherited from class ilog.views.util.swing.context.ComponentAction

actionPerformed, addActionToUpdate, addPropertyChangeListener, addStatusListener, call, clone, createMenuItem, createToolBarButton, delayedUpdateActions, error, fireActionFinished, fireActionStarted, getActionErrorHandler, getPrefix, getResourceBundle, getSmallIconSize, init, isSelectable, isSelected, removeActions, removeActionToUpdate, removeStatusListener, setActionErrorHandler, setHandler, setSelected, setSmallIconSize, updateActions

Methods inherited from class javax.swing.AbstractAction

firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

importFile

public static IlvDashboardAction importFile

Imports a Perforce JViews background graphic file into the current dashboard diagram.

leftToRightDirection

public static IlvDashboardAction leftToRightDirection

Sets the base text direction of the diagram to left-to-right.

Since:

JViews 8.8

rightToLeftDirection

public static IlvDashboardAction rightToLeftDirection

Sets the base text direction of the diagram to right-to-left.

Since:

JViews 8.8

contextualDirection

public static IlvDashboardAction contextualDirection

Sets the base text direction of the diagram to contextual, meaning that the actual base text direction is determined from the text, if it 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.

Since:

JViews 8.8

componentDirection

public static IlvDashboardAction componentDirection

Sets the base text direction of the diagram to be the same as the component orientation.

Since:

JViews 8.8

inheritedDirection

public static IlvDashboardAction inheritedDirection

Sets the base text direction of the diagram to be inherited from the parent.

Since:

JViews 8.8

bringToFront

public static IlvDashboardAction bringToFront

Brings the selected object or objects to the highest position in the dashboard diagram layers.

See Also:

Layers

bringForward

public static IlvDashboardAction bringForward

Shifts the selected object or objects up one layer in the dashboard diagram.

See Also:

Layers

sendBackward

public static IlvDashboardAction sendBackward

Shifts the selected objects down one layer in the dashboard diagram.

See Also:

Layers

sendBack

public static IlvDashboardAction sendBack

Sends the selected objects to the bottom layer in the dashboard diagram.

See Also:

Layers

blinkingAllowed

public static IlvDashboardAction blinkingAllowed

This action enables or disables blinking in the current view of the dashboard diagram.

Since:

JViews 8.5

generalPathEnabled

public static IlvDashboardAction generalPathEnabled

This action enables or disables the use of General Path objects when creating a background graphic object. A general path object lets you use enhanced graphic attributes such as gradients.

See Also:

IlvDashboardEditor.isGeneralPathEnabled()

linkLayoutEnabled

public static IlvDashboardAction linkLayoutEnabled

This action enables or disable the link layout.

Since:

JViews 8.1

See Also:

IlvDashboardDiagram.setLinkLayoutEnabled(boolean)

linkIntermediatePointsAllowed

public static IlvDashboardAction linkIntermediatePointsAllowed

This actions allows or disallows the link intermediate points to be inserted when creating a link.

Since:

JViews 8.7

See Also:

IlvDashboardLinkManager.setIntermediatePointsModeAllowed(boolean), IlvDashboardLinkManager.isIntermediatePointsModeAllowed()

defaultMappingEnabled

public static IlvDashboardAction defaultMappingEnabled

This action enables or disables the default mapping of symbol parameters when you drag and drop a symbol.

When default mapping is enabled, symbol parameters are automatically mapped to Styling Data Model(SDM) object properties.

showHiddenObjects

public static IlvDashboardAction showHiddenObjects

Sets the visible property of the selected Symbols to true.

Note: symbols with their visible property set to false can not be seen in the dashboard diagram.

saveAs

public static IlvDashboardAction saveAs

Saves the current dashboard diagram contents into a new dashboard file.

See Also:

Input and Output

save

public static IlvDashboardAction save

Saves the current dashboard diagram to an existing file.

See Also:

Input and Output

open

public static IlvDashboardAction open

Opens a dashboard diagram file.

close

public static IlvDashboardAction close

Closes the dashboard diagram.

Since:

JViews 8.1

layerPanel

public static IlvDashboardAction layerPanel

This action shows or hide the dashboard layer panel.

See Also:

IlvDashboardLayerPanel

clearMapping

public static IlvDashboardAction clearMapping

This action clears the parameter mappings of the selected symbols.

setDefaultMapping

public static IlvDashboardAction setDefaultMapping

This action makes the default parameter mappings of the selected symbols.

Constructor Detail

IlvDashboardAction

protected IlvDashboardAction(String prefix)

Constructs an IlvDashboardAction instance using the IlvDiagrammerAction prefix mechanism.

Parameters:

prefix - The prefix key for an action. For example, "Dashboard.Action.SaveAs".

See Also:

IlvDiagrammerAction, IlvDashboardAction(String, ResourceBundle)

IlvDashboardAction

protected IlvDashboardAction(String prefix,
                             ResourceBundle bundle)

Constructs an IlvDashboardAction instance using the IlvDiagrammerAction prefix mechanism for bundle.

Parameters:

prefix - The prefix key for an action. For example, "Dashboard.Action.SaveAs".

bundle - The resource bundle used to retrieve the action properties. Set to null to use the default resource bundle.

Method Detail

getEditor

protected static IlvDashboardEditor getEditor(IlvDiagrammer diagrammer)

Returns the IlvDashboardEditor instance attached to a given IlvDashboardDiagram object.

Parameters:

diagrammer - The IlvDashboardDiagram instance whose dashboard editor you wish to retrieve.

Returns:

The IlvDashboardEditor instance attached to a given IlvDashboardDiagram object.

getDefaultResourceBundle

protected ResourceBundle getDefaultResourceBundle()

Returns the default resource bundle.

Overrides:

getDefaultResourceBundle in class IlvDiagrammerAction

Returns:

The default resource bundle.