org.eodisp.ui.common.base
Class EodispView

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.infonode.gui.panel.BaseContainer
                      net.infonode.gui.panel.BasePanel
                          net.infonode.docking.DockingWindow
                              net.infonode.docking.View
                                  org.eodisp.ui.common.base.EodispView

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

ExperimentControlView, MmFederatesView, RmCategoriesView, RmModelManagersView, RmSimManagersView, RmSomsView, SmDynamicView, SmErrorView, SmExperimentInfoView, SmExpTreeView, SMPropertySheetView

public abstract class EodispView
extends net.infonode.docking.View

An EodispView is the component that is responsible for visually showing the components to the user. An EodispView is embedded an EodispFrame. A view can only be embedded in one EodispFrame.

A view can be either active or not active. A non-active view does not have to be disposed. It can just be deactivated by the frame and set to active whenever it is needed. A view can be set active by either using the the #setActive() method or by using the org.eodisp.ui.common.base.EodispFrame#setActiveView(EodispView) method in an EodispFrame.

Every view must provide a title. This title will be displayed in the frame to show the content of the view. The title should be short and expressive.

According to the MVC (Mode-View-Controller) architecture, a view has a reference to its model. This is implemented in this base class. Apart from this, most of the methods are abstract and therefore left to concrete views to be implemented.

This class must be sub-classed by each view in the EODiSP framework to implement the abstract methods and to make use of the provided functionality.

Version:

$Id: EodispView.java 3485 2006-09-08 14:25:49Z eglimi $

Author:

eglimi

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

(package private) static org.apache.log4j.Logger

logger Log4J logger for this class

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

protected

EodispView() Default constructor.

Method Summary

abstract int	getId() Returns the String identifier for a view.
abstract java.awt.Component	getInternalComponent() Returns the component of this view.
EodispModel	getModel() Returns the model for this view.
abstract void	initializeComponents() Constructs and initializes all components that are included in this view.
void	setModel(EodispModel model) Sets the model for this view.
protected void	updateViewState() Many views include components such as lists, tables, etc.

Methods inherited from class net.infonode.docking.View

acceptInteriorDrop, createPropertyObject, doAcceptDrop, doRemoveWindow, doReplace, getChildWindow, getChildWindowCount, getComponent, getCustomTabComponents, getCustomTitleBarComponents, getIcon, getPropertyObject, getViewProperties, isFocusCycleRoot, needsTitleWindow, restoreFocus, rootChanged, setComponent, setFocused, toString, update, updateButtonVisibility, write, write

Methods inherited from class net.infonode.docking.DockingWindow

acceptChildDrop, acceptSplitDrop, acceptsSplitWith, addListener, addTabMouseButtonListener, addWindow, addWindowItem, afterWindowRemoved, beforeDrop, beginOptimize, beginUpdateModel, childInsideTab, childRemoved, cleanUpModel, clearChildrenFocus, clearFocus, close, closeWithAbort, createTabWindow, detach, dock, dockWithAbort, endOptimize, endUpdateModel, fireTitleChanged, fireViewFocusChanged, fireWindowHidden, fireWindowShown, getAncestors, getBestFittedWindow, getChildEdgeDepth, getChildWindowIndex, getContentWindow, getEdgeDepth, getLastFocusedChildWindow, getLocationWindow, getOptimizedWindow, getPopupMenuFactory, getPreferredFocusChild, getPreferredMinimizeDirection, getRootWindow, getTitle, getUpdateModel, getWindowItem, getWindowParent, getWindowProperties, hasParent, init, insideTab, internalClose, internalReplaceChildWindow, isChildShowingInRootWindow, isClosable, isDockable, isMaximizable, isMaximized, isMinimizable, isMinimized, isRestorable, isShowingInRootWindow, isUndockable, isUndocked, makeVisible, maximize, maximizeWithAbort, minimize, minimize, minimizeWithAbort, minimizeWithAbort, notifyListeners, oldRead, optimizeAfter, optimizeWindowLayout, readLocations, removeChildWindow, removeListener, removeTabMouseButtonListener, removeWindow, replaceChildWindow, restore, restoreWithAbort, setLastMinimizedDirection, setPopupMenuFactory, setPreferredMinimizeDirection, showChildWindow, showsWindowTitle, split, split, startDrag, storeAncestors, undock, undockWithAbort, updateWindowItem, updateWindowItems, writeLocations

Methods inherited from class net.infonode.gui.panel.BasePanel

setSouthComponent

Methods inherited from class net.infonode.gui.panel.BaseContainer

paintComponent, setBackground, setFont, setForeground, setOpaque, setUI

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, 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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, 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, 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, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

logger

static org.apache.log4j.Logger logger

Log4J logger for this class

Constructor Detail

EodispView

protected EodispView()

Default constructor.

Sets the frame to which this view is attached to null. This implies that the frame must be attached by either using the #attachFrame(EodispFrame) in this class or to use the EodispFrame#attachView(EodispView, boolean) in the frame, which will attach the view as well.

Method Detail

getId

public abstract int getId()

Returns the String identifier for a view. This identifier must never change.

Returns:

The static Id of the view

getInternalComponent

public abstract java.awt.Component getInternalComponent()

Returns the component of this view. This can be used to set the component of the content panel.

Returns:

The component which should be shown in the content panel.

initializeComponents

public abstract void initializeComponents()

Constructs and initializes all components that are included in this view. Must be implemented by the specific view.

setModel

public void setModel(EodispModel model)

Sets the model for this view.

Parameters:

model - The EodispModel.

getModel

public EodispModel getModel()

Returns the model for this view.

Returns:

The model or null, if the model is not set.

updateViewState

protected void updateViewState()

Many views include components such as lists, tables, etc. Often, these components need to be updated if a state changes. This method can instruct the view to save update itself. The view itself has to know what to do.

The default implementation ignores the request.

You do not need to call super.updateViewState() when overriding this method.