pub.vlsolutions.swing.docking.ui

Class DockingUISettings

java.lang.Object

pub.vlsolutions.swing.docking.ui.DockingUISettings

public class DockingUISettings
extends java.lang.Object

Central class to manage Look and feel settings for the docking framework.

There are two ways of modifying the look and feel of the docking framework :

• provide a subclass of DockingUISettings and override the installXXX methods
• directly put UI properties (UIManager.put(key,value)) awaited by the desktop UI delegates. Those are described below.

UI property	type	effect
DockView.singleDockableBorder	Border	border used when the DockView is docked alone (not in a tab)
DockView.tabbedDockableBorder	Border	border used when the DockView is contained in a tabbed pane
DockView.maximizedDockableBorder	Border	border used when the DockView is maxmized
AutoHideButtonUI	class name	UI delegate for the AutoHideButton
AutoHideButtonPanelUI	class name	UI delegate for the AutoHideButtonPanel
AutoHideExpandPanelUI	class name	UI delegate for the AutoHideExpandPanel
AutoHideButton.expandBorderTop	Border	Border of the autohide button when it is on top of the desktop
AutoHideButton.expandBorderBottom	Border	Border of the autohide button when it is at bottom of the desktop
AutoHideButton.expandBorderLeft	Border	Border of the autohide button when it is on the left of the desktop
AutoHideButton.expandBorderRight	Border	Border of the autohide button when it is on the right of the desktop
AutoHideButtonPanel.topBorder	Border	Border of the AutoHideButtonPanel when it is on top of the desktop
AutoHideButtonPanel.bottomBorder	Border	Border of the AutoHideButtonPanel when it is at bottom of the desktop
AutoHideButtonPanel.leftBorder	Border	Border of the AutoHideButtonPanel when it is on the left of the desktop
AutoHideButtonPanel.rightBorder	Border	Border of the AutoHideButtonPanel when it is on the right of the desktop
DockViewUI	class name	UI delegate for DockView
DetachedDockViewUI	class name	UI delegate for DetachedDockView
DockViewTitleBarUI	class name	UI delegate for DockViewTitleBar
DockViewTitleBar.height	int	Height of the title bars. If set to 0, then every title bar will compute its preferred size (based on fonts and icons)
DockViewTitleBar.closeButtonText	String	Text of the close button
DockViewTitleBar.minimizeButtonText	String	Text of the minimize (hide) button
DockViewTitleBar.maximizeButtonText	String	Text of the maximize button
DockViewTitleBar.restoreButtonText	String	Text of the restore button(opposite of maximize)
DockViewTitleBar.floatButtonText	String	Text of the float button (detach)
DockViewTitleBar.attachButtonText	String	Text of the attach button(opposite of float)
DockViewTitleBar.titleFont	Font	Font used by the title bar
DockViewTitleBar.isCloseButtonDisplayed	boolean	display or not the close button in the title bar (still accessible from pop-up menu)
DockViewTitleBar.isHideButtonDisplayed	boolean	display or not the hide button in the title bar
DockViewTitleBar.isDockButtonDisplayed	boolean	display or not the dock button in the title bar
DockViewTitleBar.isMaximizeButtonDisplayed	boolean	display or not the maximize button in the title bar
DockViewTitleBar.isRestoreButtonDisplayed	boolean	display or not the restore button in the title bar
DockViewTitleBar.isFloatButtonDisplayed	boolean	display or not the float button in the title bar
DockViewTitleBar.isAttachButtonDisplayed	boolean	display or not the attach button in the title bar
DockViewTitleBar.border	Border	Border of the title bar
DockingSplitPaneUI	class name	UI delegate for SplitContainer component
SplitContainer.dividerSize	int	Divider size of the split panes
TabbedDockableContainer.tabPlacement	int (SwingConstants.TOP / BOTTOM)	Global tab style
DockTabbedPane.closeButtonText	String	Text for the close button in tab
DockTabbedPane.minimizeButtonText	String	Text for the minimize button in tab
DockTabbedPane.restoreButtonText	String	Text for the restore button in tab
DockTabbedPane.maximizeButtonText	String	Text for the maximize button in tab
DockTabbedPane.floatButtonText	String	Text for the float button in tab
DockTabbedPane.attachButtonText	String	Text for the attach button in tab (when floating)
TabbedContainer.requestFocusOnTabSelection	boolean	Automatically puts focus on the selected tabbed component (default false)
TabbedPane.otherIconsGap	int	Gap between text and close icon in closeable tab
TabbedPane.inBetweenOtherIconsGap	int	Gap between two icons
DockViewTitleBar.close	Icon	Icon for the close button
DockViewTitleBar.close.rollover	Icon	Icon for the close button
DockViewTitleBar.close.pressed	Icon	Icon for the close button
DockViewTitleBar.dock	Icon	Icon for the dock button
DockViewTitleBar.dock.rollover	Icon	Icon for the dock button
DockViewTitleBar.dock.pressed	Icon	Icon for the dock button
DockViewTitleBar.hide	Icon	Icon for the hide button
DockViewTitleBar.hide.rollover	Icon	Icon for the hide button
DockViewTitleBar.hide.pressed	Icon	Icon for the hide button
DockViewTitleBar.maximize	Icon	Icon for the maximize button
DockViewTitleBar.maximize.rollover	Icon	Icon for the maximize button
DockViewTitleBar.maximize.pressed	Icon	Icon for the maximize button
DockViewTitleBar.restore	Icon	Icon for the restore button
DockViewTitleBar.restore.rollover	Icon	Icon for the restore button
DockViewTitleBar.restore.pressed	Icon	Icon for the restore button
DockViewTitleBar.float	Icon	Icon for the float button
DockViewTitleBar.float.rollover	Icon	Icon for the float button
DockViewTitleBar.float.pressed	Icon	Icon for the float button
DockViewTitleBar.attach	Icon	Icon for the attach button
DockViewTitleBar.attach.rollover	Icon	Icon for the attach button
DockViewTitleBar.attach.pressed	Icon	Icon for the attach button
DockViewTitleBar.menu.close	Icon	Icon for the close button, in pop-up menu
DockViewTitleBar.menu.hide	Icon	Icon for the hide button, in pop-up menu
DockViewTitleBar.menu.maximize	Icon	Icon for the maximize button, in pop-up menu
DockViewTitleBar.menu.restore	Icon	Icon for the restore button, in pop-up menu
DockViewTitleBar.menu.dock	Icon	Icon for the dock button, in pop-up menu
DockViewTitleBar.menu.float	Icon	Icon for the float button, in pop-up menu
DockViewTitleBar.menu.attach	Icon	Icon for the attach button, in pop-up menu
DockTabbedPane.close	Icon	Icon for the close button, in tabs
DockTabbedPane.close.rollover	Icon	Icon for the close button, in tabs
DockTabbedPane.close.pressed	Icon	Icon for the close button, in tabs
DockTabbedPane.menu.close	Icon	Icon for the close button, in tab pop-up menu
DockTabbedPane.menu.hide	Icon	Icon for the hide button, in tab pop-up menu
DockTabbedPane.menu.maximize	Icon	Icon for the maximize button, in tab pop-up menu
DockTabbedPane.menu.float	Icon	Icon for the float button, in tab pop-up menu
DockTabbedPane.menu.attach	Icon	Icon for the attach button, in tab pop-up menu (when floating)
DockTabbedPane.menu.closeAll	Icon	Icon for the "close all" button, in tab pop-up menu
DockTabbedPane.menu.closeAllOther	Icon	Icon for the "close all other" button, in tab pop-up menu
DockingDesktop.closeActionAccelerator	KeyStroke	KeyStroke for close action (on selected dockable)
DockingDesktop.maximizeActionAccelerator	KeyStroke	KeyStroke for maximize/restore action (on selected dockable)
DockingDesktop.dockActionAccelerator	KeyStroke	KeyStroke for hide/dock action (on selected dockable)
DockingDesktop.floatActionAccelerator	KeyStroke	KeyStroke for float/attach action (on selected dockable)
DockingDesktop.notificationColor	Color	blinking color for notifications
DockingDesktop.notificationBlinkCount	int	maximum number of blinking for notifications
DragControler.stopDragCursor"	Image	Cursor image used when a drag and drop move is not allowed
DragControler.detachCursor"	Image	Cursor image used when a drag and drop move will detach the dockable
DragControler.dragCursor"	Image	Cursor image used when a drag and drop move is allowed(not leading to a detached dockable)
DragControler.swapDragCursor	Image	Cursor image used when doing a drag and drop with Ctrl key (hot swap)
DragControler.isDragAndDropEnabled	Boolean	Global switch to turn on/off drag and drop support in vldocking (default set to true)
DragControler.paintBackgroundUnderDragRect	Boolean	Global switch to turn on/off background painting under drag shapes (which can be slow on some linux distributions) (default set to true)
ToolBarGripperUI	class name	UI delegate for the toolbar "gripper"
ToolBarPanel.topBorder	Border	Border used when a toolbar in on the top of a container
ToolBarPanel.leftBorder	Border	Border used when a toolbar in on the left of a container
ToolBarPanel.bottomBorder	Border	Border used when a toolbar in at the bottom of a container
ToolBarPanel.rightBorder	Border	Border used when a toolbar in on the right of a container
FloatingDialog.dialogBorder	Border	Border used for the FloatingDialog
FloatingDialog.titleBorder	Border	Border used for the title (drag header) of the FloatingDialog
FloatingContainer.followParentWindow	Boolean	if true, the floating dialogs will follow the movements of their parent window on screen
FloatingContainer.paintDragShape	Boolean	if true, a drag outline shape will follow the mouse when dragging

Author:

Lilian Chamontin, VLSolutions

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isSettingsInstalled Field for installing settings only once

Constructor Summary

Constructors

Constructor and Description
DockingUISettings()

Method Summary

Methods

Modifier and Type	Method and Description
static DockingUISettings	getInstance() returns the singleton instance used to store and install UI settings for the framework
void	installAccelerators() installs the eyboard shortcuts
void	installAutoHideSettings() installs the autohide related properties
void	installBorderSettings() installs the borders
void	installBorderSettingsOrg() installs the borders
void	installCloseableTabs() installs the closable tabs properties
void	installDesktopSettings() installs the DockinDesktop related properties
void	installDockViewSettings() installs the DockView related properties
void	installDockViewTitleBarSettings() installs the DockVieTitleBar related properties
void	installFloatingSettings() installs the FloatingDialog related properties
void	installIcons() installs icons used by the framework
void	installSplitContainerSettings() installs the splitpanes related properties
void	installTabbedContainerSettings() installs the tabbed pane related properties
void	installToolBarSettings() installs the toolbar related properties
void	installUI() Installs the UI settings.
static void	setInstance(DockingUISettings newInstance) Allows replacement of the settings instance (used to override global look and feel settings of the framework.
void	updateUI() Allows updating of the ui after a look and feel change.

Methods inherited from class java.lang.Object

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

Field Detail

isSettingsInstalled

protected boolean isSettingsInstalled

Field for installing settings only once

Constructor Detail

DockingUISettings

public DockingUISettings()

Method Detail

getInstance

public static DockingUISettings getInstance()

returns the singleton instance used to store and install UI settings for the framework

setInstance

public static void setInstance(DockingUISettings newInstance)

Allows replacement of the settings instance (used to override global look and feel settings of the framework.

This method must be called before DockingDesktop is referenced, as the settings are statically installed at that moment.

installUI

public void installUI()

Installs the UI settings. This is executed only once, and automatically called at DockingDesktop class loading in case it was not called by the application.

updateUI

public void updateUI()

Allows updating of the ui after a look and feel change.

The Docking framework uses references of UI elements from this class to install its UI according to the look and feel. When Laf is changed, and before calling SwingUtilities.updateComponentTreeUI(topLevelComponent), invoke updateUI() in order to reset everything.

Calling this method after SwingUtilities.updateComponentTreeUI(topLevelComponent) is unspecified (some things will be updated, others not).

installBorderSettings

public void installBorderSettings()

installs the borders

installBorderSettingsOrg

public void installBorderSettingsOrg()

installs the borders

installAutoHideSettings

public void installAutoHideSettings()

installs the autohide related properties

installDockViewSettings

public void installDockViewSettings()

installs the DockView related properties

installDockViewTitleBarSettings

public void installDockViewTitleBarSettings()

installs the DockVieTitleBar related properties

installSplitContainerSettings

public void installSplitContainerSettings()

installs the splitpanes related properties

installTabbedContainerSettings

public void installTabbedContainerSettings()

installs the tabbed pane related properties

installCloseableTabs

public void installCloseableTabs()

installs the closable tabs properties

installIcons

public void installIcons()

installs icons used by the framework

installAccelerators

public void installAccelerators()

installs the eyboard shortcuts

installDesktopSettings

public void installDesktopSettings()

installs the DockinDesktop related properties

installFloatingSettings

public void installFloatingSettings()

installs the FloatingDialog related properties

installToolBarSettings

public void installToolBarSettings()

installs the toolbar related properties