ilog.cpl.graph.background.beans
Class IlpBackgroundPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  ilog.cpl.graph.background.beans.IlpBackgroundPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class IlpBackgroundPanel
extends JPanel

A panel that can be used to edit the background configuration for a given IlpNetwork or IlpEquipment.

It allows users to add, remove, and order backgrounds; allows users to also open and save background configurations.

The supported file types are:

• ivl
• ilv
• shp
• mif
• svg
• svgz
• gif
• png
• jpg
• jpeg

You can allow additional types of background files to be opened by setting the background extensions backgroundsList.

For more details on how to use this bean see the following section of the User's Manual: Graphic Components > Network Component > Network Component Services > Background Support

Since:

JViews 7.5

See Also:

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

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

IlpBackgroundPanel()
Creates an IlpBackgroundPanel that has the "Add Background" and "Remove Background" buttons that is associated with no view.

IlpBackgroundPanel(IlpGraphView view)
Creates an IlpBackgroundPanel that has the "Add Background" and "Remove Background" buttons.

IlpBackgroundPanel(IlpGraphView view, boolean showAddButton, boolean showRemoveButton)
Creates a IlpBackgroundPanel that may have the "Add Background" and "Remove Background" buttons enabled.

Method Summary

List	getBackgroundExtensions() Returns the background extensions that it makes visible when opening background files.
String	getDefaultDirectory() Returns the default directory where this panel looks or saves files.
boolean	getShowAddBackgroundButton() Returns whether the "Add Background" button is being shown.
boolean	getShowRemoveBackgroundButton() Returns whether the "Remove Background" button is being shown.
void	setBackgroundExtensions(List extensions) Sets the background extensions that it makes visible when opening background files.
void	setDefaultDirectory(String defaultDirectory) Sets the default directory where this panel looks or saves files.
void	setShowAddBackgroundButton(boolean showAddBackgroundButton) Sets whether the "Add Background" button will be shown.
void	setShowRemoveBackgroundButton(boolean showRemoveBackgroundButton) Sets whether the "Remove Background" button will be shown.
void	setView(IlpGraphView view) Associates this IlpBackgroundPanel with the provided graphView.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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

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, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

IlpBackgroundPanel

public IlpBackgroundPanel()

Creates an IlpBackgroundPanel that has the "Add Background" and "Remove Background" buttons that is associated with no view.

IlpBackgroundPanel

public IlpBackgroundPanel(IlpGraphView view)

Creates an IlpBackgroundPanel that has the "Add Background" and "Remove Background" buttons.

Parameters:

view - the IlpGraphView of interest.

IlpBackgroundPanel

public IlpBackgroundPanel(IlpGraphView view,
                          boolean showAddButton,
                          boolean showRemoveButton)

Creates a IlpBackgroundPanel that may have the "Add Background" and "Remove Background" buttons enabled.

Parameters:

view - the IlpGraphView of interest.

showAddButton - whether to show "Add Background" button.

showRemoveButton - whether to show "Remove Background" button.

Method Detail

setView

public void setView(IlpGraphView view)

Associates this IlpBackgroundPanel with the provided graphView.

If a null value is passed as the graphView, this IlpBackgroundPanel disengages the link for its previous IlpGraphView.

Parameters:

view - the IlpGraphView of interest.

getShowAddBackgroundButton

public boolean getShowAddBackgroundButton()

Returns whether the "Add Background" button is being shown.

Returns:

whether the "Add Background" button is being shown.

setShowAddBackgroundButton

public void setShowAddBackgroundButton(boolean showAddBackgroundButton)

Sets whether the "Add Background" button will be shown.

Parameters:

showAddBackgroundButton - whether the "Add Background" button will be shown.

getShowRemoveBackgroundButton

public boolean getShowRemoveBackgroundButton()

Returns whether the "Remove Background" button is being shown.

Returns:

whether the "Remove Background" button is being shown.

setShowRemoveBackgroundButton

public void setShowRemoveBackgroundButton(boolean showRemoveBackgroundButton)

Sets whether the "Remove Background" button will be shown.

Parameters:

showRemoveBackgroundButton - whether the "Remove Background" button will be shown.

getDefaultDirectory

public String getDefaultDirectory()

Returns the default directory where this panel looks or saves files.

Returns:

the default directory where this panel looks or saves files.

setDefaultDirectory

public void setDefaultDirectory(String defaultDirectory)

Sets the default directory where this panel looks or saves files.

Parameters:

defaultDirectory - the default directory where this panel looks or saves files.

getBackgroundExtensions

public List getBackgroundExtensions()

Returns the background extensions that it makes visible when opening background files.

Returns:

the background extensions that it makes visible when opening background files.

setBackgroundExtensions

public void setBackgroundExtensions(List extensions)

Sets the background extensions that it makes visible when opening background files.

Parameters:

extensions - a List with String instances in the form: "txt", "xml"