com.tensegrity.gui.swing.document
Class DockMDIComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.tensegrity.gui.swing.document.DockMDIComponent

All Implemented Interfaces:

javax.accessibility.Accessible, Evaluable, java.awt.image.ImageObserver, MDIComponent, java.awt.MenuContainer, Observable, java.io.Serializable, SwingMDIComponent, ViewListener

public class DockMDIComponent

extends javax.swing.JPanel

implements SwingMDIComponent, Evaluable, ViewListener

This class implements a SwingMDIComponent with docking functionality. The terminology used for the DockMDIComponent is as follows:

• View - A window that wraps a skeleton container (also referred to as a container view).
• Tab or TabPane - A single tabpane inside the DockMDIComponent.
• Screen Layout - A certain layout of tabpanes and container views.

A DockMDIComponent manages the two skeleton item types Document and Container. A Document is added by invoking one of the addDocument methods. A Container is added by first invoking the registerContainerView(String, Container, Icon, JMenuItem) method to register the container as a view and then subsequently invoking showContainerView(String, String[]) to display a previously registered container.

With this class you have the ability to configure a screen layout. This process is limited, however, to the screen layout for the views - currently there is no notion of supporting or persisting documents in a screen layout.

The process of configuring a screen layout is done as follows:

1. Registering a container view
2. Display the container view inside a given tab.

The splitpane is made up of a tree with splits as inner nodes and tabpanes as leaves. This tree is set up in different ways in the method resetScreenLayout(int). Tabs are assigned symbolic names which are used when calling method showContainerView(String, String[]).

Two standard screen layouts are provided. To override those subclass DOCKMdiComponent and override onScreenLayout0() and onScreenLayout1().

Views inside the screen layout can be further customized after reset by means of the hooks onScreenLayoutInit0() and onScreenLayoutInit1().

Version:

$Id: DockMDIComponent.java,v 1.40 2006/05/08 11:18:43 BurkhardWick Exp $

Author:

Stepan Rutz

See Also:

Serialized Form

Nested Class Summary

static class	DockMDIComponent.ConfigNode
static class	DockMDIComponent.SplitConfigNode
static class	DockMDIComponent.TabConfigNode
static class	DockMDIComponent.ViewConfig View config root class.

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

static java.lang.Object

EDITOR_TAG Tag for identifying editor entries.

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

DockMDIComponent(java.util.List initialdocuments, MenuTool menutool, Command closeDocumentCommand, UIManager uimanager)
Constructs a new DockMDIComponent.

Method Summary

void	addDocument(Document document) Adds the given Document to the container.
void	addDocumentListener(DocumentListener listener) Adds a document listener.
void	addObserver(Observer o) Adds an observer to the internally managed list of observers of this observable.
void	applyEvList() Tells the component to apply its UIItemEvaluationList.
void	applyViewConfig(View view, DockMDIComponent.ViewConfig viewconfig) Applies a given DockMDIComponent.ViewConfig memento object to the given View.
void	clearChanged() Sets the state to unchanged.
void	deleteObserver(Observer o) Deletes an observer from the internally managed list of observers of this observable.
void	deleteObservers() Deletes all of the observers registered with this observable.
void	fireDocumentDataChanged(Document document) Fires the document data changed event from the outside world.
Document	getActiveDocument() Returns the active document.
int	getDocumentCount() Returns the number of currently open documents.
java.util.List	getDocuments() Returns a List containing all active documents.
TabEntry	getEntryForComponent(javax.swing.JComponent component) Returns the TabEntry for the given component.
TabEntry	getEntryForDocument(Document document) Returns the TabEntry for the given Document.
javax.swing.JComponent	getJComponent() Returns the JComponent subclass that is the MDI container.
MenuTool	getMenuTool() Returns the MenuTool of this MDIComponent.
Observable	getObservable() Returns the Observable instance.
java.util.Collection	getObservers() Returns a collection of the observers currently registered with this observable.
TabEntry	getRegisteredEntry(java.lang.String name)
javax.swing.JSplitPane[]	getSplitpanes() Returns the splitpanes (legacy method, to be removed).
View	getView() Returns the View of this instance.
TabPane	getViewByName(java.lang.String name) Returns the view for the given name or null if it is not found.
void	indicateModifiedDocument(Document document) The mdi component shall indicate visually that the given document was modified.
void	indicateUnmodifiedDocument(Document document) The mdi component shall indicate visually that the given document was not modified.
void	installEvList() Tells the component to setup its internal state.
void	killEmptyWindows() Kills all empty windows (tabpanes).
void	notifyObservers() Performs a notify on all registered observers, if the state has changed since the last notification.
void	notifyObservers(java.lang.Object arg) Performs a notify on all registered observers, if the state has changed since the last notification.
void	onScreenLayout0() Hook method to adjust screen-layout 0.
void	onScreenLayout1() Hook method to adjust screen-layout 0.
void	onScreenLayoutInit0() Hook method to adjust views after screen-layout 0 is initialized.
void	onScreenLayoutInit1() Hook method to adjust views after screen-layout 1 is initialized.
void	postReset()
void	postValidate() Invoked by the framework after the MDIComponent was shown on the screen.
void	recordEntryIndex(TabPane tabpane, TabEntry entry)
DockMDIComponent.ViewConfig	recordViewConfig(View view) Records the state of a View and returns it in a memento object.
void	recoverView(java.lang.String name, java.lang.String[] preftabnames, boolean defaultTabPane)
void	registerContainerView(java.lang.String name, Container container, javax.swing.Icon icon, javax.swing.JMenuItem menuitem) Registers a view for a specific container.
void	rehashNamesFromContainers() Rebuilds the entry names from the container names.
void	removeActiveDocument() Closes the active document.
void	removeDocument(Document document) Closes the given document and removes it from the mdi container.
void	removeDocumentListener(DocumentListener listener) Removes a document listener.
void	renameDocument(Document document, java.lang.String name) Renames a document.
void	resetScreenLayout(int i) Resets the screen-layout with the given index.
void	restoreEditors(TabEntry[] editors) Internal helper, restores editors.
void	setActiveDocument(Document document) Sets the active document.
void	setChanged() Sets the state to changed.
void	setDocumentListener(DocumentListener documentlistener) Sets a single document listener.
void	setEditorBackground(javax.swing.Icon icon) Sets a background icon for all editor-panes.
void	setObservable(Observable observable) Sets an observable.
void	setSplitPanes(javax.swing.JSplitPane[] splitpanes) Sets the splitpanes (legacy method, to be removed).
void	showContainerView(java.lang.String name, java.lang.String[] preftabnames) Displays the view for the given name in the preferred tabpane.
void	showContainerView(java.lang.String name, java.lang.String[] preftabnames, boolean defaultTabPane) Displays the view for the given name in the preferred tabpane.
void	viewChanged(ViewEvent event) Invoked when the view has changed.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

Field Detail

EDITOR_TAG

public static final java.lang.Object EDITOR_TAG

Tag for identifying editor entries.

Constructor Detail

DockMDIComponent

public DockMDIComponent(java.util.List initialdocuments,
                        MenuTool menutool,
                        Command closeDocumentCommand,
                        UIManager uimanager)

Constructs a new DockMDIComponent.

Parameters:

initialdocuments - list of initial documents, null is allowed here.

menutool - the MenuTool reference.

closeDocumentCommand - the close-command to invoke prior to closing documents.

uimanager - the UIManager reference used for i18n.

Method Detail

getJComponent

public javax.swing.JComponent getJComponent()

Description copied from interface: SwingMDIComponent

Returns the JComponent subclass that is the MDI container.

Specified by:

getJComponent in interface SwingMDIComponent

Returns:

the JComponent subclass that is the MDI container.

applyEvList

public void applyEvList()

Description copied from interface: Evaluable

Tells the component to apply its UIItemEvaluationList.

Specified by:

applyEvList in interface Evaluable

installEvList

public void installEvList()

Description copied from interface: Evaluable

Tells the component to setup its internal state.

Specified by:

installEvList in interface Evaluable

addDocumentListener

public void addDocumentListener(DocumentListener listener)

Description copied from interface: MDIComponent

Adds a document listener.

Specified by:

addDocumentListener in interface MDIComponent

Parameters:

listener - the documentlistener to add.

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

Description copied from interface: MDIComponent

Removes a document listener.

Specified by:

removeDocumentListener in interface MDIComponent

Parameters:

listener - the documentlistener to remove.

setDocumentListener

public void setDocumentListener(DocumentListener documentlistener)

Description copied from interface: MDIComponent

Sets a single document listener. Use with caution.

Specified by:

setDocumentListener in interface MDIComponent

Parameters:

documentlistener - the documentlistener to set.

fireDocumentDataChanged

public void fireDocumentDataChanged(Document document)

Description copied from interface: MDIComponent

Fires the document data changed event from the outside world.

Specified by:

fireDocumentDataChanged in interface MDIComponent

Parameters:

document - the document whose data has changed.

getDocumentCount

public int getDocumentCount()

Description copied from interface: MDIComponent

Returns the number of currently open documents.

Specified by:

getDocumentCount in interface MDIComponent

Returns:

the number of currently open documents.

getDocuments

public java.util.List getDocuments()

Description copied from interface: MDIComponent

Returns a List containing all active documents.

Specified by:

getDocuments in interface MDIComponent

Returns:

the list of currently active documents.

addDocument

public void addDocument(Document document)

Description copied from interface: MDIComponent

Adds the given Document to the container.

Specified by:

addDocument in interface MDIComponent

Parameters:

document - the document to add to the container.

removeDocument

public void removeDocument(Document document)

Description copied from interface: MDIComponent

Closes the given document and removes it from the mdi container.

Specified by:

removeDocument in interface MDIComponent

Parameters:

document - the document to close and remove.

getActiveDocument

public Document getActiveDocument()

Description copied from interface: MDIComponent

Returns the active document.

Specified by:

getActiveDocument in interface MDIComponent

Returns:

the active document.

setActiveDocument

public void setActiveDocument(Document document)

Description copied from interface: MDIComponent

Sets the active document. The given document must be in the container.

Specified by:

setActiveDocument in interface MDIComponent

Parameters:

document - the document to activate.

removeActiveDocument

public void removeActiveDocument()

Description copied from interface: MDIComponent

Closes the active document.

Specified by:

removeActiveDocument in interface MDIComponent

renameDocument

public void renameDocument(Document document,
                           java.lang.String name)

Description copied from interface: MDIComponent

Renames a document.

Specified by:

renameDocument in interface MDIComponent

Parameters:

document - the document to rename.

name - the new name for the document.

indicateModifiedDocument

public void indicateModifiedDocument(Document document)

Description copied from interface: MDIComponent

The mdi component shall indicate visually that the given document was modified. This is needed by application that likes to visually point out that a document was modified and thus may require saving before the application is exited.

Specified by:

indicateModifiedDocument in interface MDIComponent

Parameters:

document - the modified document.

indicateUnmodifiedDocument

public void indicateUnmodifiedDocument(Document document)

Description copied from interface: MDIComponent

The mdi component shall indicate visually that the given document was not modified.

Specified by:

indicateUnmodifiedDocument in interface MDIComponent

Parameters:

document - the unmodified document.

postValidate

public void postValidate()

Description copied from interface: MDIComponent

Invoked by the framework after the MDIComponent was shown on the screen. This is a callback and the application that uses the MDIComponent is responsible for invoking this method at the specified moments in time.

Specified by:

postValidate in interface MDIComponent

getObservable

public Observable getObservable()

Description copied from interface: MDIComponent

Returns the Observable instance. Useful if current MDIComponent gives away responsibility for them.

Specified by:

getObservable in interface MDIComponent

Returns:

the observable of this mdi component.

addObserver

public void addObserver(Observer o)

Description copied from interface: Observable

Adds an observer to the internally managed list of observers of this observable.

Specified by:

addObserver in interface Observable

Parameters:

o - the observer to add to the internal list.

deleteObserver

public void deleteObserver(Observer o)

Description copied from interface: Observable

Deletes an observer from the internally managed list of observers of this observable.

Specified by:

deleteObserver in interface Observable

Parameters:

o - the observer to delete from the internal list.

notifyObservers

public void notifyObservers()

Description copied from interface: Observable

Performs a notify on all registered observers, if the state has changed since the last notification.

Specified by:

notifyObservers in interface Observable

See Also:

Observable.setChanged()

notifyObservers

public void notifyObservers(java.lang.Object arg)

Description copied from interface: Observable

Performs a notify on all registered observers, if the state has changed since the last notification.

Specified by:

notifyObservers in interface Observable

Parameters:

arg - additional argument to pass to the observers.

See Also:

Observable.setChanged()

setObservable

public void setObservable(Observable observable)

Description copied from interface: MDIComponent

Sets an observable. Useful during switch of MDIComponents.

Specified by:

setObservable in interface MDIComponent

Parameters:

observable - the observable to set for the mdi component.

setChanged

public void setChanged()

Description copied from interface: Observable

Sets the state to changed. Affects the next notification.

Specified by:

setChanged in interface Observable

clearChanged

public void clearChanged()

Description copied from interface: Observable

Sets the state to unchanged. Affects the next notification.

Specified by:

clearChanged in interface Observable

getObservers

public java.util.Collection getObservers()

Description copied from interface: Observable

Returns a collection of the observers currently registered with this observable.

Specified by:

getObservers in interface Observable

Returns:

collection of the observers.

deleteObservers

public void deleteObservers()

Description copied from interface: Observable

Deletes all of the observers registered with this observable.

Specified by:

deleteObservers in interface Observable

viewChanged

public void viewChanged(ViewEvent event)

Description copied from interface: ViewListener

Invoked when the view has changed.

Specified by:

viewChanged in interface ViewListener

Parameters:

event - the view-change event information.

setSplitPanes

public void setSplitPanes(javax.swing.JSplitPane[] splitpanes)

Sets the splitpanes (legacy method, to be removed).

Parameters:

splitpanes - the splitpanes.

getSplitpanes

public javax.swing.JSplitPane[] getSplitpanes()

Returns the splitpanes (legacy method, to be removed).

Returns:

the splitpanes (legacy method, to be removed).

getMenuTool

public final MenuTool getMenuTool()

Returns the MenuTool of this MDIComponent.

Returns:

the MenuTool of this MDIComponent.

getEntryForDocument

public final TabEntry getEntryForDocument(Document document)

Returns the TabEntry for the given Document. This method is docking-framework related only. Not to be used by clients directly.

Parameters:

document - the document to look up.

Returns:

the TabEntry for the given document or null.

getEntryForComponent

public final TabEntry getEntryForComponent(javax.swing.JComponent component)

Returns the TabEntry for the given component. This method is docking-framework related only. Not to be used by clients directly.

Parameters:

component - the component to look up.

Returns:

the TabEntry for the given component or null.

resetScreenLayout

public final void resetScreenLayout(int i)

Resets the screen-layout with the given index.

Parameters:

i - the index of the screen-layout to reset.

onScreenLayout0

public void onScreenLayout0()

Hook method to adjust screen-layout 0.

onScreenLayoutInit0

public void onScreenLayoutInit0()

Hook method to adjust views after screen-layout 0 is initialized.

onScreenLayout1

public void onScreenLayout1()

Hook method to adjust screen-layout 0.

onScreenLayoutInit1

public void onScreenLayoutInit1()

Hook method to adjust views after screen-layout 1 is initialized.

restoreEditors

public final void restoreEditors(TabEntry[] editors)

Internal helper, restores editors.

Parameters:

editors - the editors to restore.

getViewByName

public final TabPane getViewByName(java.lang.String name)

Returns the view for the given name or null if it is not found.

Parameters:

name - the view-name.

Returns:

the view for the given name or null.

killEmptyWindows

public final void killEmptyWindows()

Kills all empty windows (tabpanes).

registerContainerView

public final void registerContainerView(java.lang.String name,
                                        Container container,
                                        javax.swing.Icon icon,
                                        javax.swing.JMenuItem menuitem)

Registers a view for a specific container.

Parameters:

name - the name of the view.

container - the Container to place inside the view.

icon - the icon of the view.

menuitem - optional menuitem

getRegisteredEntry

public TabEntry getRegisteredEntry(java.lang.String name)

showContainerView

public final void showContainerView(java.lang.String name,
                                    java.lang.String[] preftabnames)

Displays the view for the given name in the preferred tabpane. If the view is already sble nothing will happen. If the view is not visible and its preferred tabpane does not exist if will be shown in the first available tabpane.

Parameters:

name - the name of the view to display.

showContainerView

public final void showContainerView(java.lang.String name,
                                    java.lang.String[] preftabnames,
                                    boolean defaultTabPane)

Displays the view for the given name in the preferred tabpane. If the view is already visible nothing will happen. If the view is not visible and its preferred tabpane does not exist if will be shown in the first available tabpane.

Parameters:

name - the name of the view to display.

preftabnames - the preferred tabpanes indexed by the current screen-layout.

defaultTabPane - whether to apply additional magic to recreate the desired tabpane or whether to use the first available one.

rehashNamesFromContainers

public final void rehashNamesFromContainers()

Rebuilds the entry names from the container names. This method is called after a language switch has taken place or after containers have changed their names. After calling this method changes are reflected in the tabentries as well.

getView

public final View getView()

Returns the View of this instance. This method is docking-framework related only. Not to be used by clients directly.

Returns:

the View of this instance.

setEditorBackground

public final void setEditorBackground(javax.swing.Icon icon)

Sets a background icon for all editor-panes.

Parameters:

icon - the icon to show as the background.

recordViewConfig

public DockMDIComponent.ViewConfig recordViewConfig(View view)

Records the state of a View and returns it in a memento object.

Parameters:

view - the View whose state is to be recorded.

Returns:

the view-config.

applyViewConfig

public final void applyViewConfig(View view,
                                  DockMDIComponent.ViewConfig viewconfig)

Applies a given DockMDIComponent.ViewConfig memento object to the given View.

Parameters:

view - the View to apply the memento to.

viewconfig - the DockMDIComponent.ViewConfig memento object.

postReset

public void postReset()

recoverView

public void recoverView(java.lang.String name,
                        java.lang.String[] preftabnames,
                        boolean defaultTabPane)

recordEntryIndex

public void recordEntryIndex(TabPane tabpane,
                             TabEntry entry)