com.vlsolutions.swing.docking.ui

Class 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 :

UI propertytypeeffect
DockView.singleDockableBorderBorderborder used when the DockView is docked alone (not in a tab)
DockView.tabbedDockableBorderBorderborder used when the DockView is contained in a tabbed pane
DockView.maximizedDockableBorderBorderborder used when the DockView is maxmized
AutoHideButtonUIclass nameUI delegate for the AutoHideButton
AutoHideButtonPanelUIclass nameUI delegate for the AutoHideButtonPanel
AutoHideExpandPanelUIclass nameUI delegate for the AutoHideExpandPanel
AutoHideButton.expandBorderTopBorderBorder of the autohide button when it is on top of the desktop
AutoHideButton.expandBorderBottomBorderBorder of the autohide button when it is at bottom of the desktop
AutoHideButton.expandBorderLeftBorderBorder of the autohide button when it is on the left of the desktop
AutoHideButton.expandBorderRightBorderBorder of the autohide button when it is on the right of the desktop
AutoHideButtonPanel.topBorderBorderBorder of the AutoHideButtonPanel when it is on top of the desktop
AutoHideButtonPanel.bottomBorderBorderBorder of the AutoHideButtonPanel when it is at bottom of the desktop
AutoHideButtonPanel.leftBorderBorderBorder of the AutoHideButtonPanel when it is on the left of the desktop
AutoHideButtonPanel.rightBorderBorderBorder of the AutoHideButtonPanel when it is on the right of the desktop
DockViewUIclass nameUI delegate for DockView
DetachedDockViewUIclass nameUI delegate for DetachedDockView
DockViewTitleBarUIclass nameUI delegate for DockViewTitleBar
DockViewTitleBar.heightintHeight of the title bars
DockViewTitleBar.closeButtonTextStringText of the close button
DockViewTitleBar.minimizeButtonTextStringText of the minimize (hide) button
DockViewTitleBar.maximizeButtonTextStringText of the maximize button
DockViewTitleBar.restoreButtonTextStringText of the restore button(opposite of maximize)
DockViewTitleBar.floatButtonTextStringText of the float button (detach)
DockViewTitleBar.attachButtonTextStringText of the attach button(opposite of float)
DockViewTitleBar.titleFontFontFont used by the title bar
DockViewTitleBar.isCloseButtonDisplayedbooleandisplay or not the close button in the title bar (still accessible from pop-up menu)
DockViewTitleBar.isHideButtonDisplayedbooleandisplay or not the hide button in the title bar
DockViewTitleBar.isDockButtonDisplayedbooleandisplay or not the dock button in the title bar
DockViewTitleBar.isMaximizeButtonDisplayedbooleandisplay or not the maximize button in the title bar
DockViewTitleBar.isRestoreButtonDisplayedbooleandisplay or not the restore button in the title bar
DockViewTitleBar.isFloatButtonDisplayedbooleandisplay or not the float button in the title bar
DockViewTitleBar.isAttachButtonDisplayedbooleandisplay or not the attach button in the title bar
DockViewTitleBar.borderBorderBorder of the title bar
DockingSplitPaneUIclass nameUI delegate for SplitContainer component
SplitContainer.dividerSizeintDivider size of the split panes
TabbedDockableContainer.tabPlacementint (SwingConstants.TOP / BOTTOM)Global tab style
DockTabbedPane.closeButtonTextStringText for the close button in tab
DockTabbedPane.minimizeButtonTextStringText for the minimize button in tab
DockTabbedPane.restoreButtonTextStringText for the restore button in tab
DockTabbedPane.maximizeButtonTextStringText for the maximize button in tab
DockTabbedPane.floatButtonTextStringText for the float button in tab
DockTabbedPane.attachButtonTextStringText for the attach button in tab (when floating)
TabbedContainer.requestFocusOnTabSelectionbooleanAutomatically puts focus on the selected tabbed component (default false)
TabbedPane.otherIconsGapintGap between text and close icon in closeable tab
TabbedPane.inBetweenOtherIconsGapintGap between two icons
DockViewTitleBar.closeIconIcon for the close button
DockViewTitleBar.close.rolloverIconIcon for the close button
DockViewTitleBar.close.pressedIconIcon for the close button
DockViewTitleBar.dockIconIcon for the dock button
DockViewTitleBar.dock.rolloverIconIcon for the dock button
DockViewTitleBar.dock.pressedIconIcon for the dock button
DockViewTitleBar.hideIconIcon for the hide button
DockViewTitleBar.hide.rolloverIconIcon for the hide button
DockViewTitleBar.hide.pressedIconIcon for the hide button
DockViewTitleBar.maximizeIconIcon for the maximize button
DockViewTitleBar.maximize.rolloverIconIcon for the maximize button
DockViewTitleBar.maximize.pressedIconIcon for the maximize button
DockViewTitleBar.restoreIconIcon for the restore button
DockViewTitleBar.restore.rolloverIconIcon for the restore button
DockViewTitleBar.restore.pressedIconIcon for the restore button
DockViewTitleBar.floatIconIcon for the float button
DockViewTitleBar.float.rolloverIconIcon for the float button
DockViewTitleBar.float.pressedIconIcon for the float button
DockViewTitleBar.attachIconIcon for the attach button
DockViewTitleBar.attach.rolloverIconIcon for the attach button
DockViewTitleBar.attach.pressedIconIcon for the attach button
DockViewTitleBar.menu.closeIcon Icon for the close button, in pop-up menu
DockViewTitleBar.menu.hideIcon Icon for the hide button, in pop-up menu
DockViewTitleBar.menu.maximizeIcon Icon for the maximize button, in pop-up menu
DockViewTitleBar.menu.restoreIcon Icon for the restore button, in pop-up menu
DockViewTitleBar.menu.dockIcon Icon for the dock button, in pop-up menu
DockViewTitleBar.menu.floatIcon Icon for the float button, in pop-up menu
DockViewTitleBar.menu.attachIcon Icon for the attach button, in pop-up menu
DockTabbedPane.closeIcon Icon for the close button, in tabs
DockTabbedPane.close.rolloverIcon Icon for the close button, in tabs
DockTabbedPane.close.pressedIcon Icon for the close button, in tabs
DockTabbedPane.menu.closeIcon Icon for the close button, in tab pop-up menu
DockTabbedPane.menu.hideIcon Icon for the hide button, in tab pop-up menu
DockTabbedPane.menu.maximizeIcon Icon for the maximize button, in tab pop-up menu
DockTabbedPane.menu.floatIcon Icon for the float button, in tab pop-up menu
DockTabbedPane.menu.attachIcon Icon for the attach button, in tab pop-up menu (when floating)
DockTabbedPane.menu.closeAllIcon Icon for the "close all" button, in tab pop-up menu
DockTabbedPane.menu.closeAllOtherIcon Icon for the "close all other" button, in tab pop-up menu
DockingDesktop.closeActionAcceleratorKeyStrokeKeyStroke for close action (on selected dockable)
DockingDesktop.maximizeActionAcceleratorKeyStrokeKeyStroke for maximize/restore action (on selected dockable)
DockingDesktop.dockActionAcceleratorKeyStrokeKeyStroke for hide/dock action (on selected dockable)
DockingDesktop.floatActionAcceleratorKeyStrokeKeyStroke for float/attach action (on selected dockable)
DockingDesktop.notificationColorColorblinking color for notifications
DockingDesktop.notificationBlinkCountintmaximum number of blinking for notifications
DragControler.stopDragCursor"ImageCursor image used when a drag and drop move is not allowed
DragControler.detachCursor"ImageCursor image used when a drag and drop move will detach the dockable
DragControler.dragCursor"ImageCursor image used when a drag and drop move is allowed(not leading to a detached dockable)
DragControler.swapDragCursorImageCursor image used when doing a drag and drop with Ctrl key (hot swap)
DragControler.isDragAndDropEnabledBooleanGlobal switch to turn on/off drag and drop support in vldocking (default set to true)
DragControler.paintBackgroundUnderDragRectBooleanGlobal switch to turn on/off background painting under drag shapes (which can be slow on some linux distributions) (default set to true)
ToolBarGripperUIclass nameUI delegate for the toolbar "gripper"
ToolBarPanel.topBorderBorderBorder used when a toolbar in on the top of a container
ToolBarPanel.leftBorderBorderBorder used when a toolbar in on the left of a container
ToolBarPanel.bottomBorderBorderBorder used when a toolbar in at the bottom of a container
ToolBarPanel.rightBorderBorderBorder used when a toolbar in on the right of a container
FloatingDialog.dialogBorderBorderBorder used for the FloatingDialog
FloatingDialog.titleBorderBorderBorder used for the title (drag header) of the FloatingDialog
FloatingContainer.followParentWindowBooleanif true, the floating dialogs will follow the movements of their parent window on screen
FloatingContainer.paintDragShape Booleanif true, a drag outline shape will follow the mouse when dragging

Field Summary

protected boolean
isSettingsInstalled
Field for installing settings only once

Constructor Summary

DockingUISettings()

Method Summary

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
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.

Field Details

isSettingsInstalled

protected boolean isSettingsInstalled
Field for installing settings only once

Constructor Details

DockingUISettings

public DockingUISettings()

Method Details

getInstance

public static DockingUISettings getInstance()
returns the singleton instance used to store and install UI settings for the framework

installAccelerators

public void installAccelerators()
installs the eyboard shortcuts

installAutoHideSettings

public void installAutoHideSettings()
installs the autohide related properties

installBorderSettings

public void installBorderSettings()
installs the borders

installCloseableTabs

public void installCloseableTabs()
installs the closable tabs properties

installDesktopSettings

public void installDesktopSettings()
installs the DockinDesktop related properties

installDockViewSettings

public void installDockViewSettings()
installs the DockView related properties

installDockViewTitleBarSettings

public void installDockViewTitleBarSettings()
installs the DockVieTitleBar related properties

installFloatingSettings

public void installFloatingSettings()
installs the FloatingDialog related properties

installIcons

public void installIcons()
installs icons used by the framework

installSplitContainerSettings

public void installSplitContainerSettings()
installs the splitpanes related properties

installTabbedContainerSettings

public void installTabbedContainerSettings()
installs the tabbed pane related properties

installToolBarSettings

public void installToolBarSettings()
installs the toolbar related properties

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.

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.


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).


© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications