com.tensegrity.gui.swing.dock.core
Class View

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.tensegrity.gui.swing.dock.core.View

All Implemented Interfaces:

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

public final class View

extends javax.swing.JPanel

Docking framework.

Version:

$Id: View.java,v 1.11 2005/09/13 13:49:01 BurkhardWick Exp $

Author:

srutz

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

static int	SPLIT_BOTTOM Splitting directions.
static int	SPLIT_LEFT Splitting directions.
static int	SPLIT_RIGHT Splitting directions.
static int	SPLIT_TOP Splitting directions.

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

View()
Constructs a new View instance.

Method Summary

void	addListener(ViewListener listener) Adds a view-listener
void	addTabPane(TabPane tabpane, TabPane reftabpane, int splittype) Adds a new tabpane.
void	addTabPane(TabPane tabpane, TabPane reftabpane, int splittype, double factor) Adds a new tabpane.
void	deleteEmptyTabPanes(TabPane pane) Deletes empty tabpane.
TabPane	findTabPane(TabEntry entry) Finds a tabpane containing the given entry.
TabEntry[]	getAllTabEntries() Gets all tab-entries.
TabEntry[]	getAllTabEntriesEqualTo(java.lang.Object userObject) Gets all tab-entries whose user-object is equal to the given user-object
TabPane[]	getAllTabPanes() Returns all tabpanes.
TabPane[]	getAllTabPanes(int tabstyle) Returns all tabpanes of the given style.
FileOpenHandler	getFileOpenHandler()
TabPane	getMaximizedTabPane() Returns the maximized tabpane or null if minimized.
MultiSplitPane	getRootSplit() Returns the root-split.
ViewManager	getViewManager() Returns the current view-manager or null if none is set.
boolean	isMaximized() Querries maximized state of the view.
boolean	isSplitting() Returns true if splitting is currently in progress.
void	maximize(TabPane tabpane) Maximizes the given tabpane.
void	minimize() Minimizes the currently maximized tabpane (if any).
void	postInit() Must be invoked after view construction has completed.
void	removeListener(ViewListener listener) Removes a view-listener
void	setFileOpenHandler(FileOpenHandler fileopenhandler)
void	setFirstTabPane(TabPane tabpane) Sets the first toplevel tabpane.
void	setTheme(java.lang.String theme) Sets the theme of the view.
void	setViewManager(ViewManager viewManager) Sets the current view-manager.
void	updateUI()

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

SPLIT_LEFT

public static final int SPLIT_LEFT

Splitting directions.

See Also:

Constant Field Values

SPLIT_TOP

public static final int SPLIT_TOP

Splitting directions.

See Also:

Constant Field Values

SPLIT_RIGHT

public static final int SPLIT_RIGHT

Splitting directions.

See Also:

Constant Field Values

SPLIT_BOTTOM

public static final int SPLIT_BOTTOM

Splitting directions.

See Also:

Constant Field Values

Constructor Detail

View

public View()

Constructs a new View instance.

Method Detail

setTheme

public final void setTheme(java.lang.String theme)

Sets the theme of the view.

Parameters:

theme - the theme to set.

addListener

public void addListener(ViewListener listener)

Adds a view-listener

Parameters:

listener - the view-listener to add.

removeListener

public void removeListener(ViewListener listener)

Removes a view-listener

Parameters:

listener - the view-listener to remove.

getRootSplit

public MultiSplitPane getRootSplit()

Returns the root-split.

Returns:

the root-split.

isSplitting

public boolean isSplitting()

Returns true if splitting is currently in progress.

Returns:

true if splitting is currently in progress.

setFirstTabPane

public void setFirstTabPane(TabPane tabpane)

Sets the first toplevel tabpane.

Parameters:

tabpane - the toplevel tabpane to set.

addTabPane

public void addTabPane(TabPane tabpane,
                       TabPane reftabpane,
                       int splittype)

Adds a new tabpane.

Parameters:

tabpane - the tabpane to add.

reftabpane - the ref-tabpane to split.

splittype - the split-type (direction).

addTabPane

public void addTabPane(TabPane tabpane,
                       TabPane reftabpane,
                       int splittype,
                       double factor)

Adds a new tabpane.

Parameters:

tabpane - the tabpane to add.

reftabpane - the ref-tabpane to split.

splittype - the split-type (direction).

factor - the split-factor.

postInit

public final void postInit()

Must be invoked after view construction has completed.

isMaximized

public boolean isMaximized()

Querries maximized state of the view.

Returns:

true if the view is maximized.

getMaximizedTabPane

public TabPane getMaximizedTabPane()

Returns the maximized tabpane or null if minimized.

Returns:

the maximized tabpane or null if minimized.

setViewManager

public void setViewManager(ViewManager viewManager)

Sets the current view-manager.

Parameters:

viewManager - the current view-manager.

getViewManager

public final ViewManager getViewManager()

Returns the current view-manager or null if none is set.

Returns:

the current view-manager or null if none is set.

getAllTabPanes

public final TabPane[] getAllTabPanes()

Returns all tabpanes.

Returns:

all tabpanes.

getAllTabPanes

public final TabPane[] getAllTabPanes(int tabstyle)

Returns all tabpanes of the given style.

Parameters:

tabstyle - the tab-style to search for.

Returns:

all tabpanes of the given style.

getAllTabEntries

public final TabEntry[] getAllTabEntries()

Gets all tab-entries.

Returns:

all tab-entries.

getAllTabEntriesEqualTo

public final TabEntry[] getAllTabEntriesEqualTo(java.lang.Object userObject)

Gets all tab-entries whose user-object is equal to the given user-object

Parameters:

userObject - the userobject to compare to.

Returns:

all tab-entries equal to the user-object

findTabPane

public final TabPane findTabPane(TabEntry entry)

Finds a tabpane containing the given entry.

Parameters:

entry - the entry to look-for.

Returns:

the tabpane of the entry or null.

deleteEmptyTabPanes

public void deleteEmptyTabPanes(TabPane pane)

Deletes empty tabpane.

Parameters:

pane - the pane to delete if it is empty.

maximize

public void maximize(TabPane tabpane)

Maximizes the given tabpane.

Parameters:

tabpane - the tabpane to maximize.

minimize

public void minimize()

Minimizes the currently maximized tabpane (if any).

updateUI

public void updateUI()

getFileOpenHandler

public final FileOpenHandler getFileOpenHandler()

setFileOpenHandler

public final void setFileOpenHandler(FileOpenHandler fileopenhandler)