ilog.cpl
Class IlpEquipment

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by ilog.cpl.IlpEquipment
All Implemented Interfaces:
IlpStylable, IlpGraphicComponent, IlpInteractiveGraphicComponent, IlpObjectSelectionModel, IlvStylable, ImageObserver, MenuContainer, Serializable

public class IlpEquipment
extends JComponent
implements IlpInteractiveGraphicComponent

The equipment component, which serves as an aggregation of MVC components for displaying equipment objects, such as shelves, cards and ports.

It does not have independent functionality, but is convenient to use. It creates and connects all MVC components needed to display an equipment.

By default the equipment component creates the following elements:

An equipment component can be customized using cascading style sheets (CSS), thereby allowing the configuration of the view, the controller and the adapter elements. If nothing is defined, a default configuration is applied (see DefaultConfigurationFileName).

Since:
JTGO 3.0
See Also:
IlpDefaultDataSource, IlpViewRenderer, IlpToolBarRenderer, IlpInteractorRenderer, Serialized Form

Nested Class Summary
 
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
static String DefaultConfigurationFileName
          The file name of the default configuration.
 
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 ilog.cpl.css.IlpStylable
UPDATE_ALL_MASK, UPDATE_COMPONENT_MASK, UPDATE_NONE_MASK, UPDATE_OBJECTS_MASK
 
Fields inherited from interface ilog.views.util.styling.IlvStylable
APPLIED_RULE_MASK, BAD_CLASS_MASK, BAD_PROP_MASK, BAD_PROP_WITH_STACK_MASK, CREATED_MASK, DECL_MASK, DECL_VALUE_MASK, FAILED_CONVERSIONS_MASK, TIME_REPORT_MASK, WARNING_PROP_MASK
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
IlpEquipment()
          Creates an IlpEquipment with a default context and default equipment configuration.
IlpEquipment(IlpContext context)
          Creates an IlpEquipment based on a context with the default equipment configuration.
IlpEquipment(String configurationFileName)
          Creates an IlpEquipment with a configuration read from a CSS file.
IlpEquipment(String configurationFileName, IlpContext context)
          Creates an IlpEquipment with a configuration read from a CSS file.
IlpEquipment(URL configurationURL)
          Creates an IlpEquipment with a configuration read from a CSS file.
IlpEquipment(URL configurationURL, IlpContext context)
          Creates an IlpEquipment with a configuration read from a CSS file.
 
Method Summary
 void addBackground(URL backgroundURL)
          Adds a background on top of the other existing backgrounds.
 void addBackgroundURL(URL backgroundURL)
          Deprecated. Use instead addBackground(URL)
 void addPseudoClass(IlpObject bo, String pseudo)
          Adds a pseudoclass to the specified business object.
 void addRootObject(IlpRepresentationObject object)
          Adds a top-level object to the model.
 void addSelectionObject(IlpObject object)
          Adds the given IlpObject to the selection.
 void clearSelection()
          Clears the selection.
 void dispose()
          Cleans up the equipment, disconnects the component from the data source and drops references to objects to help garbage collection.
 void endChangingEquipmentModel()
          Deprecated. Please use IlpAbstractDataSource.endBatch() instead.
 void ensureAtCenter(IlpObject object)
          Scrolls the view in such a way that a given business object gets moved to the center of the view.
 void ensureAtCenter(IlpRepresentationObject object)
          Scrolls the view in such a way that a given representation object gets moved to the center of the view.
 void ensureVisible(IlpObject object)
          Scrolls the view in such a way that a given business object becomes visible.
 void ensureVisible(IlpRepresentationObject object)
          Scrolls the view in such a way that a given representation object becomes visible.
 void fitToContents()
          Modifies the zoom factor so that all objects are visible in the view.
 void fitToContents(Insets insets)
          Modifies the zoom factor so that all objects are visible in the view.
 IlpEquipmentAdapter getAdapter()
          Returns the adapter connected to the component or creates a new one.
 int getAutoLayoutIndex()
          Returns the index of the graph layout that should be executed automatically when the view contents change.
 List getBackgrounds()
          Returns the list of URL instances that represent the current backgrounds.
 IlpBackgroundSupport getBackgroundSupport()
          Returns the background support object currently in use.
 Collection getBackgroundURLs()
          Deprecated. Use instead List getBackgrounds()
 String getConfigurationFileName()
          Returns the name of the configuration file name.
 IlpContext getContext()
          Returns the context.
 IlpEquipmentController getController()
          Returns the encapsulated controller.
 IlpDataSource getDataSource()
          Returns the data source that feeds the equipment.
 IlpViewInteractor getDefaultViewInteractor()
          Returns the default view interactor.
 IlpFilter getFilter()
          Returns the filter used to filter business objects.
 IlvGraphLayout[] getGraphLayouts()
          Returns the list of graph layouts that have been configured to this view.
 IlvGraphLayout getGraphLayouts(int index)
          Returns the graph layout that is configured at the given index.
 IlpEquipmentHandler getHandler()
          Returns the handler for all controller operations.
 JScrollBar getHorizontalScrollBar()
          Returns the horizontal scroll bar that controls the viewport's horizontal view position.
 IlvLabelLayout getLabelLayout()
          Returns the label layout used in this equipment or null if there is no label layout.
 IlvGraphLayout getLinkLayout()
          Returns this view's graph layout for links.
 IlpManagerView getManagerView()
          Returns the main IlvManagerView displayed by this view.
 IlpMutableEquipmentModel getModel()
          Returns the encapsulated model.
 IlvGraphLayout getNodeLayout()
          Returns graph layout of nodes for this view.
 IlvJOverview getOverview()
          Returns the overview window, if it is currently visible.
 IlpPosition getPosition(IlpRepresentationObject object)
          Returns the current position or shape of an object.
 IlpPositionConverter getPositionConverter()
          Returns the position converter of the view.
 IlpPositionSource getPositionSource(IlpRepresentationObject object)
          Returns the source of the current position or shape of an object.
 IlpProject getProject()
          Returns the component project configuration.
 IlvJScrollManagerView getScrollView()
          Returns the scrollable view of this component.
 IlpObject getSelectedObject()
          Returns the first selected IlpObject from the collection of selected objects.
 Collection getSelectedObjects()
          Returns the set of selected IlpObjects.
 IlpEquipmentSelectionModel getSelectionModel()
          Returns the selection model.
 IlpStyle getStyle()
          Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism.
 IlpGraphicViewStyleManager getStyleManager()
          Deprecated. The Style API has been replaced by the Cascading Style Sheet mechanism. Please use the method setStyleSheets or getStyleSheets instead.
 int getStyleSheetDebugMask()
          Returns the current debug level.
 String[] getStyleSheets()
          Returns the cascading style sheets.
 String getStyleSheets(int index)
          Returns one of the cascading style sheets.
 JToolBar getToolBar()
          Returns the view's toolbar.
 JScrollBar getVerticalScrollBar()
          Returns the vertical scroll bar that controls the viewport's horizontal view position.
 IlpEquipmentView getView()
          Returns the encapsulated view.
 IlpViewInteractor getViewInteractor()
          Returns the interactor associated with the view.
 Collection getVisibleObjects()
          Returns an unmodifiable collection of the visible objects contained in the equipment.
 IlpZoomPolicy getZoomPolicy()
          Returns the zoom policy currently in use.
 boolean isHorizontalScrollBarVisible()
          Returns true if the horizontal scrollbar is visible.
 boolean isObjectSelected(IlpObject object)
          Returns true if the given IlpObject is selected, false otherwise.
 boolean isOverviewVisible()
          Returns true if the overview is currently visible.
 boolean isToolBarVisible()
          Tests if the toolbar is visible.
 boolean isVerticalScrollBarVisible()
          Returns true if the vertical scrollbar is visible.
 boolean isVisible(URL backgroundURL)
          Returns the visibility of a particular background.
 void loadConfiguration(String configurationFileName)
          Reads a configuration file and applies it to this equipment component.
 void loadConfiguration(URL configurationURL)
          Reads a configuration file and applies it to this equipment components.
 void refilter()
          Reapplies the current filter to the adapter objects.
 void reload(URL backgroundURL)
          Deprecated. Use instead reloadBackground(URL)
 void reloadAllBackgrounds()
          Deprecated. Use instead reloadBackgrounds()
 void reloadBackground(URL backgroundURL)
          Reloads a particular background.
 void reloadBackgrounds()
          Reloads all backgrounds.
 void removeAllBackgroundURLs()
          Deprecated. Use instead removeBackgrounds()
 void removeBackground(URL backgroundURL)
          Removes a background.
 void removeBackgrounds()
          Removes all backgrounds.
 void removeBackgroundURL(URL backgroundURL)
          Deprecated. Use instead removeBackground(URL)
 void removeObjectInteractors(IlpObject object)
          Remove all the interactors associated with the given object.
 void removeObjectInteractors(IlpRepresentationObject object)
          Removes all the interactors associated with the given object.
 void removePseudoClass(IlpObject bo, String pseudo)
          Removes a pseudoclass from the specified business object.
 void removeRootObject(IlpRepresentationObject object)
          Removes a top-level object from the model.
 void removeSelectionObject(IlpObject object)
          Removes the given IlpObject from the selection.
 void resetConfiguration()
          Applies the default configuration file to this equipment component.
 void selectAll()
          Puts all visible objects into the selection.
 void setAdapter(IlpEquipmentAdapter adapter)
          Sets the adapter that connects the equipment to the data source.
 void setAutoLayoutIndex(int index)
          Sets the index of the graph layout that should be executed automatically when the view contents change.
 void setBackgrounds(List backgroundURLs)
          Replaces the entire list of backgrounds.
 void setBackgroundURLs(URL[] backgroundURLs)
          Deprecated. Use instead setBackgrounds(List)
 void setConfigurationFileName(String configurationFileName)
          Reads a configuration file and applies it to this equipment component.
 void setController(IlpEquipmentController controller)
          Sets or replaces the encapsulated controller.
 void setDataSource(IlpDataSource dataSource)
          Sets the data source that feeds the equipment.
 void setDefaultViewInteractor(IlpViewInteractor interactor)
          Sets the default view interactor.
 void setFilter(IlpFilter filter)
          Sets the filter.
 void setGraphLayouts(IlvGraphLayout[] layouts)
          Changes the layouts that can be applied to this view.
 void setGraphLayouts(int index, IlvGraphLayout layout)
          Sets a new graph layout to this view.
 void setHandler(IlpEquipmentHandler handler)
          Sets the handler for all controller operations.
 void setHorizontalScrollBarVisible(boolean set)
          Shows or hides the horizontal scrollbar.
 void setLabelLayout(IlvLabelLayout layout)
          Sets the label layout in this equipment.
 void setLinkLayout(IlvGraphLayout layout)
          Changes the link layout of this view.
 void setModel(IlpMutableEquipmentModel model)
          Sets or replaces the encapsulated model.
 void setNodeLayout(IlvGraphLayout layout)
          Changes the node layout of this view.
 void setObjectInteractor(IlpObject object, IlpAttribute attribute, IlpObjectInteractor interactor)
          Sets the interactor associated with the given object and attribute.
 void setObjectInteractor(IlpObject object, IlpObjectInteractor interactor)
          Sets the interactor associated with the given object.
 void setObjectInteractor(IlpRepresentationObject object, IlpAttribute attribute, IlpObjectInteractor interactor)
          Sets the interactor associated with the given object and attribute.
 void setObjectInteractor(IlpRepresentationObject object, IlpObjectInteractor interactor)
          Sets the interactor associated with the given object.
 void setObjectInteractor(Object key, IlpObjectInteractor interactor)
          Sets the interactor associated with the given key.
 void setOverviewVisible(boolean visible)
          Makes the overview visible or invisible.
 void setPosition(IlpRepresentationObject object, IlpPosition position, IlpPositionSource source)
          Sets the current position or shape of an object.
 void setPositionConverter(IlpPositionConverter positionConverter)
          Changes the position converter of the view.
 void setProject(IlpProject proj)
          Sets the component project configuration.
 void setProject(URL projectURL)
          Sets a Equipment component project configuration.
 void setSelectedObject(IlpObject object)
          Sets the selected IlpObject.
 void setSelectedObjects(Collection objects)
          Sets the set of selected IlpObjects.
 void setSelectionModel(IlpEquipmentSelectionModel selectionModel)
          Sets the selection model.
 void setStyleSheetDebugMask(int mask)
          Sets the debug level while parsing the style sheets.
 void setStyleSheets(int index, String css)
          Changes one of the cascading style sheets.
 void setStyleSheets(int index, String css, int updateMask)
          Changes one of the cascading style sheets.
 void setStyleSheets(String[] css)
          Sets the cascading style sheets.
 void setStyleSheets(String[] css, int updateMask)
          Sets the cascading style sheets.
 void setToolBarVisible(boolean visible)
          Shows or hides the toolbar.
 void setVerticalScrollBarVisible(boolean set)
          Shows or hides the vertical scrollbar.
 void setView(IlpEquipmentView view)
          Sets or replaces the encapsulated view.
 void setViewInteractor(IlpViewInteractor interactor)
          Sets the interactor associated with the view.
 void setVisible(URL backgroundURL, boolean visible)
          Changes the visibility of a particular background.
 void setZoomPolicy(IlpZoomPolicy zoomPolicy)
          Sets the zoom policy.
 void startChangingEquipmentModel()
          Deprecated. Please use IlpAbstractDataSource.startBatch() instead.
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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,