com.alee.extended.dock

Class WebDockableFrameUI<C extends WebDockableFrame>

java.lang.Object

javax.swing.plaf.ComponentUI

com.alee.extended.dock.WDockableFrameUI<C>

com.alee.extended.dock.WebDockableFrameUI<C>

Type Parameters:

C - component type

All Implemented Interfaces:

WebUI<C>, PropertyChangeListener, EventListener

public class WebDockableFrameUI<C extends WebDockableFrame>
extends WDockableFrameUI<C>
implements PropertyChangeListener

Custom UI for WebDockableFrame component.

Author:

Mikle Garin

See Also:

How to use WebDockablePane, WebDockablePane

Field Summary

Fields

Modifier and Type	Field and Description
protected WebPanel	buttonsPanel
protected WebButton	closeButton
protected ComponentMoveBehavior	dialogMoveBehavior
protected WebButton	dockButton
protected WebButton	floatButton
protected DefaultFocusTracker	focusTracker Listeners.
protected WebButton	maximizeButton
protected WebButton	minimizeButton
protected SidebarButton	sidebarButton Additional components used be the UI.
protected WebStyledLabel	titleLabel
protected WebPanel	titlePanel

Fields inherited from class com.alee.extended.dock.WDockableFrameUI

frame

Constructor Summary

Constructors

Constructor and Description
WebDockableFrameUI()

Method Summary

Modifier and Type	Method and Description
boolean	contains(JComponent c, int x, int y)
static ComponentUI	createUI(JComponent c) Returns an instance of the WebDockableFrameUI for the specified component.
int	getBaseline(JComponent c, int width, int height)
Component.BaselineResizeBehavior	getBaselineResizeBehavior(JComponent c)
Dimension	getMinimumDialogSize() Returns minimum frame dialog size.
Dimension	getPreferredSize(JComponent c)
SidebarButton	getSidebarButton() Returns SidebarButton for WebDockableFrame represented by this UI.
protected void	installActions() Installs actions for UI elements.
protected void	installComponents() Installs frame decoration elements.
void	installUI(JComponent c) Configures the specified component appropriate for the look and feel.
void	paint(Graphics g, JComponent c)
void	propertyChange(PropertyChangeEvent evt)
protected void	requestFocusInFrame() Requests focus for frame content if possible.
protected void	uninstallActions() Uninstalls actions from UI elements.
protected void	uninstallComponents() Uninstalls frame decoration elements.
void	uninstallUI(JComponent c) Reverses configuration which was done on the specified component during installUI.
protected void	updateCloseButton() Updates close button state.
protected void	updateFloatButton() Updates float button state.
protected void	updateMaximizeButton() Updates maximize button state.

Methods inherited from class com.alee.extended.dock.WDockableFrameUI

getPropertyPrefix, installDefaults, installListeners, uninstallDefaults, uninstallListeners

Methods inherited from class javax.swing.plaf.ComponentUI

getAccessibleChild, getAccessibleChildrenCount, getMaximumSize, getMinimumSize, update

Methods inherited from class java.lang.Object

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

Field Detail

focusTracker

protected transient DefaultFocusTracker focusTracker

Listeners.

dialogMoveBehavior

protected transient ComponentMoveBehavior dialogMoveBehavior

sidebarButton

protected transient SidebarButton sidebarButton

Additional components used be the UI.

titlePanel

protected transient WebPanel titlePanel

titleLabel

protected transient WebStyledLabel titleLabel

buttonsPanel

protected transient WebPanel buttonsPanel

dockButton

protected transient WebButton dockButton

minimizeButton

protected transient WebButton minimizeButton

floatButton

protected transient WebButton floatButton

maximizeButton

protected transient WebButton maximizeButton

closeButton

protected transient WebButton closeButton

Constructor Detail

WebDockableFrameUI

public WebDockableFrameUI()

Method Detail

createUI

@NotNull
public static ComponentUI createUI(@NotNull
                                            JComponent c)

Returns an instance of the WebDockableFrameUI for the specified component. This tricky method is used by UIManager to create component UIs when needed.

Parameters:

c - component that will use UI instance

Returns:

instance of the WebDockableFrameUI

installUI

public void installUI(@NotNull
                      JComponent c)

Description copied from interface: WebUI

Configures the specified component appropriate for the look and feel. This method is invoked when the ComponentUI instance is being installed as the UI delegate on the specified component. This method should completely configure the component for the look and feel, including the following:

1. Install any default property values for color, fonts, borders, icons, opacity, etc. on the component. Whenever possible, property values initialized by the client program should not be overridden.
2. Install a LayoutManager on the component if necessary.
3. Create/add any required sub-components to the component.
4. Create/install event listeners on the component.
5. Create/install a PropertyChangeListener on the component in order to detect and respond to component property changes appropriately.
6. Install keyboard UI (mnemonics, traversal, etc.) on the component.
7. Initialize any appropriate instance data.

Specified by:

installUI in interface WebUI<C extends WebDockableFrame>

Overrides:

installUI in class WDockableFrameUI<C extends WebDockableFrame>

Parameters:

c - the component where this UI delegate is being installed

See Also:

ComponentUI.installUI(JComponent), WebUI.uninstallUI(javax.swing.JComponent), JComponent.setUI(javax.swing.plaf.ComponentUI), JComponent.updateUI()

uninstallUI

public void uninstallUI(@NotNull
                        JComponent c)

Description copied from interface: WebUI

Reverses configuration which was done on the specified component during installUI. This method is invoked when this UIComponent instance is being removed as the UI delegate for the specified component. This method should undo the configuration performed in installUI, being careful to leave the JComponent instance in a clean state (no extraneous listeners, look-and-feel-specific property objects, etc.). This should include the following:

1. Remove any UI-set borders from the component.
2. Remove any UI-set layout managers on the component.
3. Remove any UI-added sub-components from the component.
4. Remove any UI-added event/property listeners from the component.
5. Remove any UI-installed keyboard UI from the component.
6. Nullify any allocated instance data objects to allow for GC.

Specified by:

uninstallUI in interface WebUI<C extends WebDockableFrame>

Overrides:

uninstallUI in class WDockableFrameUI<C extends WebDockableFrame>

Parameters:

c - the component from which this UI delegate is being removed; this argument is often ignored, but might be used if the UI object is stateless and shared by multiple components

See Also:

ComponentUI.uninstallUI(JComponent), WebUI.installUI(javax.swing.JComponent), JComponent.updateUI()

installComponents

protected void installComponents()

Installs frame decoration elements.

uninstallComponents

protected void uninstallComponents()

Uninstalls frame decoration elements.

installActions

protected void installActions()

Installs actions for UI elements.

uninstallActions

protected void uninstallActions()

Uninstalls actions from UI elements.

propertyChange

public void propertyChange(@NotNull
                           PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

updateFloatButton

protected void updateFloatButton()

Updates float button state.

updateMaximizeButton

protected void updateMaximizeButton()

Updates maximize button state.

updateCloseButton

protected void updateCloseButton()

Updates close button state.

getMinimumDialogSize

@NotNull
public Dimension getMinimumDialogSize()

Description copied from class: WDockableFrameUI

Returns minimum frame dialog size.

Specified by:

getMinimumDialogSize in class WDockableFrameUI<C extends WebDockableFrame>

Returns:

minimum frame dialog size

requestFocusInFrame

protected void requestFocusInFrame()

Requests focus for frame content if possible.

getSidebarButton

@NotNull
public SidebarButton getSidebarButton()

Description copied from class: WDockableFrameUI

Returns SidebarButton for WebDockableFrame represented by this UI.

Specified by:

getSidebarButton in class WDockableFrameUI<C extends WebDockableFrame>

Returns:

SidebarButton for WebDockableFrame represented by this UI

contains

public boolean contains(@NotNull
                        JComponent c,
                        int x,
                        int y)

Overrides:

contains in class ComponentUI

getBaseline

public int getBaseline(@NotNull
                       JComponent c,
                       int width,
                       int height)

Overrides:

getBaseline in class ComponentUI

getBaselineResizeBehavior

@NotNull
public Component.BaselineResizeBehavior getBaselineResizeBehavior(@NotNull
                                                                           JComponent c)

Overrides:

getBaselineResizeBehavior in class ComponentUI

paint

public void paint(@NotNull
                  Graphics g,
                  @NotNull
                  JComponent c)

Overrides:

paint in class ComponentUI

getPreferredSize

@Nullable
public Dimension getPreferredSize(@NotNull
                                            JComponent c)

Overrides:

getPreferredSize in class ComponentUI