Module jEdit

Package org.gjt.sp.jedit.gui

Class DockableWindowManagerImpl

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gjt.sp.jedit.gui.DockableWindowManager

org.gjt.sp.jedit.gui.DockableWindowManagerImpl

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class DockableWindowManagerImpl
extends DockableWindowManager

Manages dockable windows for a single View. Concrete implementation of a Dockable Window Manager. Aka the "classic" docking framework.

Since:

jEdit 4.3pre16

Version:

$Id$

Author:

Slava Pestov, Shlomy Reinstein

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DockableWindowManagerImpl.DockableWindowConfig

Nested classes/interfaces inherited from class org.gjt.sp.jedit.gui.DockableWindowManager

DockableWindowManager.DockingArea, DockableWindowManager.DockingLayout

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

JPanel.AccessibleJPanel

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.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
Stack<String>	showStack

Fields inherited from class org.gjt.sp.jedit.gui.DockableWindowManager

BOTTOM, factory, FLOATING, LEFT, RIGHT, TOP, view

Fields inherited from class javax.swing.JComponent

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

accessibleContext, 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

Constructors

Constructor	Description
DockableWindowManagerImpl(View view, DockableWindowFactory factory, View.ViewConfig config)	Creates a new dockable window manager.

Method Summary

Modifier and Type	Method	Description
void	close()	Called when the view is being closed.
void	closeCurrentArea()	Closes the most recently focused dockable.
JPopupMenu	createPopupMenu(DockableWindowContainer container, String dockable, boolean clone)
void	disposeDockableWindow(String name)	Completely dispose of a dockable - called when a plugin is unloaded, to remove all references to the its dockables.
JComponent	floatDockableWindow(String name)	Opens a new instance of the specified dockable window in a floating container.
PanelWindowContainer	getBottomDockingArea()
JComponent	getDockable(String name)	Returns the specified dockable window.
DockableWindowManager.DockingLayout	getDockingLayout(View.ViewConfig config)
PanelWindowContainer	getLeftDockingArea()
PanelWindowContainer	getRightDockingArea()
PanelWindowContainer	getTopDockingArea()
void	handleDockableWindowUpdate(DockableWindowUpdate msg)
void	handlePluginUpdate(PluginUpdate pmsg)
void	handlePropertiesChanged(PropertiesChanged msg)
void	hideDockableWindow(String name)	Hides the specified dockable window.
void	init()	Initialises dockable window manager.
boolean	isDockableWindowDocked(String name)	Returns if the specified dockable window is docked into the view.
boolean	isDockableWindowVisible(String name)	Returns if the specified dockable window is visible.
void	paintChildren(Graphics g)
protected void	propertiesChanged()
void	setDockingLayout(DockableWindowManager.DockingLayout docking)
void	setMainPanel(JPanel panel)
void	showDockableWindow(String name)	Opens the specified dockable window.

Methods inherited from class org.gjt.sp.jedit.gui.DockableWindowManager

addDockableWindow, applyAlternateLayout, applyDockingLayout, closeListener, createDockable, dockableLoaded, dockableTitleChanged, dockingPositionChanged, focusDockable, getAlternateLayoutProp, getDockablePosition, getDockableTitle, getDockableWindow, getDockableWindowPluginName, getLongTitlePropertyName, getRegisteredDockableWindows, getView, longTitle, removeDockableWindow, setDockableTitle, shortTitle, toggleDockableWindow, toggleDockAreas, willToggleHide

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintComponent, 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, 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

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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Details

showStack

public Stack<String> showStack

Constructor Details

DockableWindowManagerImpl

public DockableWindowManagerImpl(View view,
 DockableWindowFactory factory,
 View.ViewConfig config)

Creates a new dockable window manager.

Parameters:

view - The view

factory - A DockableWindowFactory, usually DockableWindowFactory.getInstance().

config - A docking configuration

Since:

jEdit 2.6pre3

Method Details

setDockingLayout

public void setDockingLayout(DockableWindowManager.DockingLayout docking)

Overrides:

setDockingLayout in class DockableWindowManager

getDockingLayout

public DockableWindowManager.DockingLayout getDockingLayout(View.ViewConfig config)

Specified by:

getDockingLayout in class DockableWindowManager

setMainPanel

public void setMainPanel(JPanel panel)

Specified by:

setMainPanel in class DockableWindowManager

init

public void init()

Initialises dockable window manager. Do not call this method directly.

Overrides:

init in class DockableWindowManager

floatDockableWindow

public JComponent floatDockableWindow(String name)

Opens a new instance of the specified dockable window in a floating container.

Specified by:

floatDockableWindow in class DockableWindowManager

Parameters:

name - The dockable window name

Returns:

The new dockable window instance

Since:

jEdit 4.1pre2

showDockableWindow

public void showDockableWindow(String name)

Opens the specified dockable window.

Specified by:

showDockableWindow in class DockableWindowManager

Parameters:

name - The dockable window name

Since:

jEdit 2.6pre3

hideDockableWindow

public void hideDockableWindow(String name)

Hides the specified dockable window.

Specified by:

hideDockableWindow in class DockableWindowManager

Parameters:

name - The dockable window name

Since:

jEdit 2.6pre3

getDockable

public JComponent getDockable(String name)

Returns the specified dockable window. Note that this method will return null if the dockable has not been added yet. Make sure you call DockableWindowManager.addDockableWindow(String) first. For historical reasons, this does the same thing as DockableWindowManager.getDockableWindow(String).

Overrides:

getDockable in class DockableWindowManager

Parameters:

name - The name of the dockable window

Since:

jEdit 4.0pre1

isDockableWindowVisible

public boolean isDockableWindowVisible(String name)

Returns if the specified dockable window is visible.

Specified by:

isDockableWindowVisible in class DockableWindowManager

Parameters:

name - The dockable window name

isDockableWindowDocked

public boolean isDockableWindowDocked(String name)

Returns if the specified dockable window is docked into the view.

Specified by:

isDockableWindowDocked in class DockableWindowManager

Parameters:

name - The dockable's name

Since:

jEdit 4.0pre2

closeCurrentArea

public void closeCurrentArea()

Closes the most recently focused dockable.

Specified by:

closeCurrentArea in class DockableWindowManager

Since:

jEdit 4.1pre3

close

public void close()

Called when the view is being closed.

Overrides:

close in class DockableWindowManager

Since:

jEdit 2.6pre3

getTopDockingArea

public PanelWindowContainer getTopDockingArea()

Specified by:

getTopDockingArea in class DockableWindowManager

getLeftDockingArea

public PanelWindowContainer getLeftDockingArea()

Specified by:

getLeftDockingArea in class DockableWindowManager

getBottomDockingArea

public PanelWindowContainer getBottomDockingArea()

Specified by:

getBottomDockingArea in class DockableWindowManager

getRightDockingArea

public PanelWindowContainer getRightDockingArea()

Specified by:

getRightDockingArea in class DockableWindowManager

createPopupMenu

public JPopupMenu createPopupMenu(DockableWindowContainer container,
 String dockable,
 boolean clone)

paintChildren

public void paintChildren(Graphics g)

Overrides:

paintChildren in class JComponent

handleDockableWindowUpdate

public void handleDockableWindowUpdate(DockableWindowUpdate msg)

Overrides:

handleDockableWindowUpdate in class DockableWindowManager

handlePropertiesChanged

public void handlePropertiesChanged(PropertiesChanged msg)

Overrides:

handlePropertiesChanged in class DockableWindowManager

handlePluginUpdate

public void handlePluginUpdate(PluginUpdate pmsg)

Overrides:

handlePluginUpdate in class DockableWindowManager

propertiesChanged

protected void propertiesChanged()

Overrides:

propertiesChanged in class DockableWindowManager

disposeDockableWindow

public void disposeDockableWindow(String name)

Description copied from class: DockableWindowManager

Completely dispose of a dockable - called when a plugin is unloaded, to remove all references to the its dockables.

Specified by:

disposeDockableWindow in class DockableWindowManager