com.tensegrity.gui.swing.document
Class PanelMDIComponent

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

All Implemented Interfaces:

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

public class PanelMDIComponent

extends javax.swing.JPanel

implements SwingMDIComponent, Evaluable, JPopupMenuSource

Tabbed-Pane MDI implemention. This class implements a multiple document interface in a tabbed-pane style.

Version:

$Id: PanelMDIComponent.java,v 1.10 2004/09/27 10:26:48 GillesIachelini Exp $

Author:

Stepan Rutz, Michael Kegel

See Also:

Serialized Form

Nested Class Summary

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

UIItemEvaluationList

uiItemEvList ItemList used to perform the language switch

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

PanelMDIComponent(java.util.List initialdocuments, MenuTool windowmenu, Command closeDocumentCommand, UIManager uimanager, DocumentDropContext opener)
Construct a tabbed-mdi pane with the given list of initial documents.

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	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	destroyPopupMenu()
static void	findSlidePanelsInComponentTree(java.awt.Component component, java.util.ArrayList slidepanels)
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.
DocumentListener	getDocumentListener()
java.util.List	getDocuments() Returns a List containing all active documents.
javax.swing.JComponent	getJComponent() Returns the JComponent subclass that is the MDI container.
Observable	getObservable() Returns the Observable instance.
java.util.Collection	getObservers() Returns a collection of the observers currently registered with this observable.
PopupMenuMarkup	getPopupMenu(java.lang.Object eventObject) Returns the current popup menu of the popup source.
javax.swing.JSplitPane[]	getSplitpanes()
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	init()
void	initPopupMenu()
void	installEvList() Tells the component to setup its internal state.
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	postValidate() Invoked by the framework after the MDIComponent was shown on the screen.
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	setActiveDocument(Document document) Sets the active document.
void	setChanged() Sets the state to changed.
void	setDocumentListener(DocumentListener documentlistener) Sets a single document listener.
void	setObservable(Observable observable) Sets an observable.
void	setSplitPanes(javax.swing.JSplitPane[] splitpanes)
void	setWindowMenu(MenuTool tool) TODO: comment.
void	updateUI() Custom ui update

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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

uiItemEvList

public UIItemEvaluationList uiItemEvList

ItemList used to perform the language switch

Constructor Detail

PanelMDIComponent

public PanelMDIComponent(java.util.List initialdocuments,
                         MenuTool windowmenu,
                         Command closeDocumentCommand,
                         UIManager uimanager,
                         DocumentDropContext opener)

Construct a tabbed-mdi pane with the given list of initial documents.

Method Detail

init

public void init()

initPopupMenu

public void initPopupMenu()

destroyPopupMenu

public void destroyPopupMenu()

getPopupMenu

public PopupMenuMarkup getPopupMenu(java.lang.Object eventObject)

Description copied from interface: JPopupMenuSource

Returns the current popup menu of the popup source.

Specified by:

getPopupMenu in interface JPopupMenuSource

Parameters:

eventObject - the mouse-event that triggered the request.

Returns:

the current popup menu of the popup source.

updateUI

public void updateUI()

Custom ui update

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.

getDocumentListener

public DocumentListener getDocumentListener()

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.

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.

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.

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.

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.

getActiveDocument

public Document getActiveDocument()

Description copied from interface: MDIComponent

Returns the active document.

Specified by:

getActiveDocument in interface MDIComponent

Returns:

the active document.

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.

setSplitPanes

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

getSplitpanes

public javax.swing.JSplitPane[] getSplitpanes()

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

findSlidePanelsInComponentTree

public static final void findSlidePanelsInComponentTree(java.awt.Component component,
                                                        java.util.ArrayList slidepanels)

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.

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.

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

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

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.

setWindowMenu

public void setWindowMenu(MenuTool tool)

TODO: comment. The method setWindowmenu

Parameters:

tool - void