pub.vlsolutions.swing.docking

Class DockViewAsTab

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

pub.vlsolutions.swing.docking.DockView

pub.vlsolutions.swing.docking.DockViewAsTab

All Implemented Interfaces:

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

Direct Known Subclasses:

MaximizedDockViewAsTab

public class DockViewAsTab
extends DockView
implements SingleDockableContainer

This component is used to display single dockables like if they were in a tabbed pane.

Please note this component is still in its early stages and might change in future releases.

To use it, just install the TabFactory as DockableContainerFactory

Since:

2.1.3

Author:

Lilian Chamontin, VLSolutions

See Also:

TabFactory, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DockViewAsTab.TabHeader

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

Fields

Modifier and Type	Field and Description
protected javax.swing.AbstractAction	closeAction
protected SmartIconJButton	closeSmartIcon
protected javax.swing.AbstractAction	floatAction
protected SmartIconJButton	floatSmartIcon
protected javax.swing.AbstractAction	hideAction
protected SmartIconJButton	hideSmartIcon
protected boolean	isAttachButtonDisplayed
protected boolean	isCloseButtonDisplayed
protected boolean	isDockButtonDisplayed
protected boolean	isFloatButtonDisplayed
protected boolean	isHideButtonDisplayed
protected boolean	isMaximizeButtonDisplayed
protected boolean	isRestoreButtonDisplayed
protected javax.swing.AbstractAction	maximizeAction
protected SmartIconJButton	maximizeSmartIcon
protected JTabbedPaneSmartIcon	smartIcon smart icon used to display the title
protected DockViewAsTab.TabHeader	tabHeader The tab container in which the components are added
protected JTabbedPaneSmartIconManager	tpManager smart icon manager

Fields inherited from class pub.vlsolutions.swing.docking.DockView

desktop, dockable, lastDropGeneralPath, lastDropShape, title

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

Constructors

Constructor and Description
DockViewAsTab(Dockable dockable)

Method Summary

Methods

Modifier and Type	Method and Description
void	closePopUp() This method is invoked to hide the pop-up that could still be visible (To avoid a visible pop-up for an invisible component)
protected void	configureCloseButton()
protected void	configureFloatButton()
protected void	configureHideButton()
protected void	configureMaximizeButton()
protected DockViewAsTab.TabHeader	createTabHeader()
java.lang.String	getUIClassID()
protected void	initAutoHidePopUp(javax.swing.JPopupMenu popup)
protected void	initDockedPopUp(javax.swing.JPopupMenu popup)
protected void	initFloatingPopUp(javax.swing.JPopupMenu popup) Init the popup displayed as the title bar contextual menu
protected void	initMaximizedPopUp(javax.swing.JPopupMenu popup) Init the popup displayed as the title bar contextual menu
void	installDocking(DockingDesktop desktop) Invoked once after creation, in order to let this component register its DockableDragSources to the DockingDesktop, and have a reference of this Desktop.
protected void	maximizeAction()
void	resetTabIcons()
void	setDockable(Dockable d) Adds the dockable's component to this DockView.
void	setDockableAsTab(Dockable d)
void	uninstallDocking(DockingDesktop desktop) Called once, when the dockablecontainer is no longer used by the desktop, in order to releases resources and listeners taken on installDocking().

Methods inherited from class pub.vlsolutions.swing.docking.DockView

buildPathForTab, getDockable, getTitleBar, processDockableDrag, processDockableDrop, scanDrop, toString

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface pub.vlsolutions.swing.docking.SingleDockableContainer

getDockable

Field Detail

tabHeader

protected DockViewAsTab.TabHeader tabHeader

The tab container in which the components are added

tpManager

protected JTabbedPaneSmartIconManager tpManager

smart icon manager

smartIcon

protected JTabbedPaneSmartIcon smartIcon

smart icon used to display the title

closeAction

protected javax.swing.AbstractAction closeAction

closeSmartIcon

protected SmartIconJButton closeSmartIcon

maximizeAction

protected javax.swing.AbstractAction maximizeAction

maximizeSmartIcon

protected SmartIconJButton maximizeSmartIcon

hideAction

protected javax.swing.AbstractAction hideAction

hideSmartIcon

protected SmartIconJButton hideSmartIcon

floatAction

protected javax.swing.AbstractAction floatAction

floatSmartIcon

protected SmartIconJButton floatSmartIcon

isCloseButtonDisplayed

protected boolean isCloseButtonDisplayed

isHideButtonDisplayed

protected boolean isHideButtonDisplayed

isDockButtonDisplayed

protected boolean isDockButtonDisplayed

isMaximizeButtonDisplayed

protected boolean isMaximizeButtonDisplayed

isRestoreButtonDisplayed

protected boolean isRestoreButtonDisplayed

isFloatButtonDisplayed

protected boolean isFloatButtonDisplayed

isAttachButtonDisplayed

protected boolean isAttachButtonDisplayed

Constructor Detail

DockViewAsTab

public DockViewAsTab(Dockable dockable)

Method Detail

initMaximizedPopUp

protected void initMaximizedPopUp(javax.swing.JPopupMenu popup)

Init the popup displayed as the title bar contextual menu

initAutoHidePopUp

protected void initAutoHidePopUp(javax.swing.JPopupMenu popup)

initDockedPopUp

protected void initDockedPopUp(javax.swing.JPopupMenu popup)

initFloatingPopUp

protected void initFloatingPopUp(javax.swing.JPopupMenu popup)

Init the popup displayed as the title bar contextual menu

closePopUp

public void closePopUp()

This method is invoked to hide the pop-up that could still be visible (To avoid a visible pop-up for an invisible component)

maximizeAction

protected void maximizeAction()

configureFloatButton

protected void configureFloatButton()

configureMaximizeButton

protected void configureMaximizeButton()

configureHideButton

protected void configureHideButton()

configureCloseButton

protected void configureCloseButton()

setDockable

public void setDockable(Dockable d)

Description copied from class: DockView

Adds the dockable's component to this DockView.

Overrides:

setDockable in class DockView

Parameters:

d - the user dockable

setDockableAsTab

public void setDockableAsTab(Dockable d)

resetTabIcons

public void resetTabIcons()

installDocking

public void installDocking(DockingDesktop desktop)

Invoked once after creation, in order to let this component register its DockableDragSources to the DockingDesktop, and have a reference of this Desktop.

basic implementation use a single DragSource, and thus calls desk.installDockableDragSource(dragSource).

Specified by:

installDocking in interface DockableContainer

Overrides:

installDocking in class DockView

uninstallDocking

public void uninstallDocking(DockingDesktop desktop)

Called once, when the dockablecontainer is no longer used by the desktop, in order to releases resources and listeners taken on installDocking().

Specified by:

uninstallDocking in interface DockableContainer

Overrides:

uninstallDocking in class DockView

getUIClassID

public java.lang.String getUIClassID()

Description copied from class: DockView

Overrides:

getUIClassID in class DockView

createTabHeader

protected DockViewAsTab.TabHeader createTabHeader()