ilog.views.dashboard

Class IlvDashboardBackgroundBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ilog.views.dashboard.IlvDashboardPanel

ilog.views.dashboard.IlvDashboardBackgroundBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class IlvDashboardBackgroundBar
extends IlvDashboardPanel

IlvDashboardBackgroundBar is a Java Swing component that lets a user create and edit background objects in a dashboard diagram.

Background Actions

IlvDashboardBackgroundBar is a toolbar that you attached to a IlvDashboardDiagram component. It contains buttons linked to IlvDashboardAction instances. These Java Actions provide a set functionality for this toolbar. Examples of these actions are Add Rectangle and Choose Foreground Color.

Note: Unlike IlvDiagrammerEditBar, IlvDiagrammerToolBar does not inherit from IlvDiagrammerToolBar. To customize the contents of this toolbar call getToolBar() and edit the IlvDiagrammerToolBar instance that is returned.

Example

The following code sample shows how to add an IlvDashboardBackgroundBar to a standard JPanel in a Dashboard Editor application.

  private IlvDashboardEditor dashEd;
  ...
  JPanel panel = new JPanel(new BorderLayout());
  JPanel panel1 = new JPanel(new BorderLayout());
  editToolBar = new IlvDashboardEditBar();
  final IlvDashboardBackgroundBar backgroundBar = new IlvDashboardBackgroundBar(dashEd);
  panel1.add(editToolBar, BorderLayout.LINE_START);
  panel1.add(backgroundBar, BorderLayout.LINE_END);
  panel.add(panel1, BorderLayout.PAGE_START);
  ...
  getContentPane().add(panel, BorderLayout.PAGE_START);
 

Since:

JViews 8.0

See Also:

IlvDiagrammerToolBar, Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
Action	arcAction Create an Arc object in the current dashboard diagram.
Action	arrowPolylineAction Create an arrow polyline object object in the current dashboard diagram.
Action	closedSplineAction Create a closed spline object in the current dashboard diagram.
Action	ellipseAction Create an ellipse object in the current dashboard diagram.
Action	iconAction Insert an icon in the current dashboard diagram.
static String	ID
Action	labelAction Create a new label in the current dashboard diagram.
Action	lineAction Create a line object in the current dashboard diagram.
Action	polygonAction Create a polygon object in the current dashboard diagram.
Action	polylineAction Create a polyline object object in the current dashboard diagram.
Action	rectangleAction Create a rectangle object in the current dashboard diagram.
Action	reliefLabelAction Create a relief label object in the current dashboard diagram.
Action	reliefRectangleAction Create a relief rectangle object in the current dashboard diagram.
Action	roundRectangleAction Create a round rectangle object in the current dashboard diagram.
Action	shadowLabelAction Create a shadow label object in the current dashboard diagram.
Action	shadowRectangleAction Create a shadow rectangle object in the current dashboard diagram.
Action	splineAction Create a spline object in the current dashboard diagram.
Action	textAction Create a new text object in the current dashboard diagram.

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
IlvDashboardBackgroundBar(IlvDashboardEditor editor) Creates a new IlvDashboardBackgroundBar object using the editor for this dashboard application.

Method Summary

Modifier and Type	Method and Description
void	addObjectPropertyChangeListener(PropertyChangeListener listener) Adds a property change listener that will be invoked when a background object property is changed by a component of this dashboard background tool bar.
Cursor	getInteractorCursor() Returns the Cursor used by the interactors.
Color	getPaletteBackground() Returns the background color used for objects created using this toolbar instance.
Font	getPaletteFont() Returns the Font used in text labels created using this toolbar instance.
Color	getPaletteForeground() Returns the foreground color used for background objects created using this toolbar instance.
Action[]	getPredefinedActions() Returns the predefined Actions included in the toolbar.
IlvDiagrammerToolBar	getToolBar() Returns the IlvDiagrammerToolBar instance used by this IlvDashboardBackgroundBar instance.
void	removeObjectPropertyChangeListener(PropertyChangeListener listener) Removes a property change listener previously added by calling the addObjectPropertyChangeListener(PropertyChangeListener) function.
void	setInteractorCursor(Cursor aCursor) Sets the Cursor used by the interactors.
void	setPaletteBackground(Color color) Sets the background color used for objects created using this toolbar instance.
void	setPaletteFont(Font font) Sets the Font to be used when text labels are created using this toolbar instance.
void	setPaletteForeground(Color color) Sets the foreground color used for background objects created using this toolbar instance.

Methods inherited from class ilog.views.dashboard.IlvDashboardPanel

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

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Internal: do not use!

labelAction

public Action labelAction

Create a new label in the current dashboard diagram.

See Also:

Background Actions

textAction

public Action textAction

Create a new text object in the current dashboard diagram.

See Also:

Background Actions

lineAction

public Action lineAction

Create a line object in the current dashboard diagram.

See Also:

Background Actions

polylineAction

public Action polylineAction

Create a polyline object object in the current dashboard diagram.

See Also:

Background Actions

arrowPolylineAction

public Action arrowPolylineAction

Create an arrow polyline object object in the current dashboard diagram.

See Also:

Background Actions

polygonAction

public Action polygonAction

Create a polygon object in the current dashboard diagram.

See Also:

Background Actions

splineAction

public Action splineAction

Create a spline object in the current dashboard diagram.

See Also:

Background Actions

closedSplineAction

public Action closedSplineAction

Create a closed spline object in the current dashboard diagram.

See Also:

Background Actions

rectangleAction

public Action rectangleAction

Create a rectangle object in the current dashboard diagram.

See Also:

Background Actions

roundRectangleAction

public Action roundRectangleAction

Create a round rectangle object in the current dashboard diagram.

See Also:

Background Actions

reliefRectangleAction

public Action reliefRectangleAction

Create a relief rectangle object in the current dashboard diagram.

See Also:

Background Actions

reliefLabelAction

public Action reliefLabelAction

Create a relief label object in the current dashboard diagram.

See Also:

Background Actions

shadowRectangleAction

public Action shadowRectangleAction

Create a shadow rectangle object in the current dashboard diagram.

See Also:

Background Actions

shadowLabelAction

public Action shadowLabelAction

Create a shadow label object in the current dashboard diagram.

See Also:

Background Actions

ellipseAction

public Action ellipseAction

Create an ellipse object in the current dashboard diagram.

See Also:

Background Actions

arcAction

public Action arcAction

Create an Arc object in the current dashboard diagram.

See Also:

Background Actions

iconAction

public Action iconAction

Insert an icon in the current dashboard diagram.

See Also:

Background Actions

Constructor Detail

IlvDashboardBackgroundBar

public IlvDashboardBackgroundBar(IlvDashboardEditor editor)

Creates a new IlvDashboardBackgroundBar object using the editor for this dashboard application. The editor object passed to this IlvDashboardBackgroundBar instance is the central point in a Dashboard Editor. It is used to access common components and global properties in your Dashboard Editor application.

Parameters:

editor - The IlvDashboardEditor instance used to coordinate your Dashboard Editor application.

See Also:

Example

Method Detail

getToolBar

public IlvDiagrammerToolBar getToolBar()

Returns the IlvDiagrammerToolBar instance used by this IlvDashboardBackgroundBar instance.

Unlike IlvDiagrammerEditBar, IlvDiagrammerToolBar does not inherit from IlvDiagrammerToolBar. You customize the contents of this toolbar by editing the IlvDiagrammerToolBar instance returned by this function.

 public Action labelAction;
 public Action lineAction;
 IlvDashboardBackgroundBar backgroundBar = new IlvDashboardBackgroundBar(dashEd);
 
 //Set all actions in the toolbar
 //Make an array of actions
 Action[] preDefActs = new Action[] {
    labelAction,
    lineAction};
 //Initialize the Actions to be added to the toolbar
 ...
 IlvDiagrammerToolBar tb = backgroundBar.getToolBar();
 tb.setActions(preDefActs);
 
 //Add a single action to the toolbar
 //Create a single Action
 Action myCustomizedAction = new Action();
 //Initialize the Actions to be added to the toolbar
 ..
 //Add the Action to the toolbar
 tb.addAction(myCustomizedAction);
 

Returns:

The toolbar used by this component.

See Also:

IlvDiagrammerToolBar, Background Actions

getPredefinedActions

public Action[] getPredefinedActions()

Returns the predefined Actions included in the toolbar.

Call initializeActions() to instantiate the Action instances returned before invoking this method.

Returns:

An array of Action instances.

getPaletteFont

public Font getPaletteFont()

Returns the Font used in text labels created using this toolbar instance.

Returns:

The Font used by default in text labels.

See Also:

setPaletteFont(Font)

setPaletteFont

public void setPaletteFont(Font font)

Sets the Font to be used when text labels are created using this toolbar instance.

If you do not set the palette font, text labels are created using the default Java font. That is, Dialog 12pt.

Parameters:

font - The new default Font style for text labels.

getPaletteForeground

public Color getPaletteForeground()

Returns the foreground color used for background objects created using this toolbar instance.

Returns:

The foreground color used for new background objects.

setPaletteForeground

public void setPaletteForeground(Color color)

Sets the foreground color used for background objects created using this toolbar instance.

Parameters:

color - The new foreground color to be used for background objects.

getPaletteBackground

public Color getPaletteBackground()

Returns the background color used for objects created using this toolbar instance.

Returns:

The background color used for new objects.

setPaletteBackground

public void setPaletteBackground(Color color)

Sets the background color used for objects created using this toolbar instance.

Parameters:

color - The new color to be used for background objects.

getInteractorCursor

public Cursor getInteractorCursor()

Returns the Cursor used by the interactors.

Returns:

The Cursor used by the interactors.

setInteractorCursor

public void setInteractorCursor(Cursor aCursor)

Sets the Cursor used by the interactors.

Parameters:

aCursor - The Cursor to be used by the interactors.

addObjectPropertyChangeListener

public void addObjectPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener that will be invoked when a background object property is changed by a component of this dashboard background tool bar.

Parameters:

listener -

See Also:

removeObjectPropertyChangeListener(PropertyChangeListener)

Internal: do not use!

removeObjectPropertyChangeListener

public void removeObjectPropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener previously added by calling the addObjectPropertyChangeListener(PropertyChangeListener) function.

Parameters:

listener - The listener to be removed.

See Also:

addObjectPropertyChangeListener(PropertyChangeListener)

Internal: do not use!