SubstanceRootPaneUI (substance 7.3 API)

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.RootPaneUI
  - - javax.swing.plaf.basic.BasicRootPaneUI
    - - org.pushingpixels.substance.internal.ui.SubstanceRootPaneUI

All Implemented Interfaces:

PropertyChangeListener, EventListener
```
public class SubstanceRootPaneUI
extends BasicRootPaneUI
```
UI for root panes in Substance look and feel.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`protected class`	`SubstanceRootPaneUI.SubstanceRootLayout`	A custom layout manager that is responsible for the layout of layeredPane, glassPane, menuBar and titlePane, if one has been installed.

Field Summary

Fields
Modifier and Type	Field	Description
`protected GraphicsConfiguration`	`currentRootPaneGC`	The graphics configuration that contains the top-left corner of the window (fix for defect 213).
`protected JRootPane`	`root`	`JRootPane` providing the look and feel for.
`protected Window`	`substanceCurrentWindow`	The current window.
`protected HierarchyListener`	`substanceHierarchyListener`	Hierarchy listener to keep track of the associated top-level window.
`protected PropertyChangeListener`	`substancePropertyChangeListener`
`protected ComponentListener`	`substanceWindowComponentListener`	Component listener to keep track of the primary graphics configuration (for recomputing the maximized bounds) - fix for defect 213.
`protected WindowListener`	`substanceWindowListener`	Window listener that stops all Substance thread when the last frame is disposed.
`static ComponentListener`	`WINDOW_ROUNDER`

Constructor Summary

Constructors
Constructor Description

SubstanceRootPaneUI()

Constructors
Constructor	Description
`SubstanceRootPaneUI()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected LayoutManager`	`createLayoutManager()`	Returns a `LayoutManager` that will be set on the `JRootPane`.
`protected JComponent`	`createTitlePane(JRootPane root)`	Returns the `JComponent` to render the window decoration style.
`static ComponentUI`	`createUI(JComponent comp)`	Creates a UI for a `JRootPane`.
`protected JRootPane`	`getRootPane()`	Returns the `JRootPane` we're providing the look and feel for.
`JComponent`	`getTitlePane()`	Returns the `JComponent` rendering the title pane.
`static boolean`	`hasCustomSkinOnAtLeastOneRootPane()`
`void`	`installBorder(JRootPane root)`	Installs the appropriate `Border` onto the `JRootPane`.
`protected void`	`installDefaults(JRootPane c)`
`protected void`	`installListeners(JRootPane root)`
`void`	`installUI(JComponent c)`	Invokes supers implementation of `installUI` to install the necessary state onto the passed in `JRootPane` to render the metal look and feel implementation of `RootPaneUI`.
`void`	`propertyChange(PropertyChangeEvent e)`
`void`	`setMaximized()`	Sets maximized bounds according to the display screen insets.
`protected void`	`uninstallListeners(JRootPane root)`
`void`	`uninstallUI(JComponent c)`	Invokes supers implementation to uninstall any of its state.
`void`	`update(Graphics g, JComponent c)`

Methods inherited from class javax.swing.plaf.basic.BasicRootPaneUI
installComponents, installKeyboardActions, uninstallComponents, uninstallDefaults, uninstallKeyboardActions

Methods inherited from class javax.swing.plaf.ComponentUI
contains, getAccessibleChild, getAccessibleChildrenCount, getBaseline, getBaselineResizeBehavior, getMaximumSize, getMinimumSize, getPreferredSize, paint

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - root
```
protected JRootPane root
```
    JRootPane providing the look and feel for.
  - substanceWindowListener
```
protected WindowListener substanceWindowListener
```
    Window listener that stops all Substance thread when the last frame is disposed.
  - substanceCurrentWindow
```
protected Window substanceCurrentWindow
```
    The current window.
  - substanceHierarchyListener
```
protected HierarchyListener substanceHierarchyListener
```
    Hierarchy listener to keep track of the associated top-level window.
  - substanceWindowComponentListener
```
protected ComponentListener substanceWindowComponentListener
```
    Component listener to keep track of the primary graphics configuration (for recomputing the maximized bounds) - fix for defect 213.
  - currentRootPaneGC
```
protected GraphicsConfiguration currentRootPaneGC
```
    The graphics configuration that contains the top-left corner of the window (fix for defect 213).
  - substancePropertyChangeListener
```
protected PropertyChangeListener substancePropertyChangeListener
```
  - WINDOW_ROUNDER
```
public static ComponentListener WINDOW_ROUNDER
```
- Constructor Detail
  - SubstanceRootPaneUI
```
public SubstanceRootPaneUI()
```
- Method Detail
  - createUI
```
public static ComponentUI createUI(JComponent comp)
```
    Creates a UI for a JRootPane.
    
    Parameters:
    
    comp - the JRootPane the RootPaneUI will be created for
    
    Returns:
    
    the RootPaneUI implementation for the passed in JRootPane
  - installUI
```
public void installUI(JComponent c)
```
    Invokes supers implementation of installUI to install the necessary state onto the passed in JRootPane to render the metal look and feel implementation of RootPaneUI. If the windowDecorationStyle property of the JRootPane is other than JRootPane.NONE, this will add a custom Component to render the widgets to JRootPane, as well as installing a custom Border and LayoutManager on the JRootPane.
    
    Overrides:
    
    installUI in class BasicRootPaneUI
    
    Parameters:
    
    c - the JRootPane to install state onto
  - uninstallUI
```
public void uninstallUI(JComponent c)
```
    Invokes supers implementation to uninstall any of its state. This will also reset the LayoutManager of the JRootPane. If a Component has been added to the JRootPane to render the window decoration style, this method will remove it. Similarly, this will revert the Border and LayoutManager of the JRootPane to what it was before installUI was invoked.
    
    Overrides:
    
    uninstallUI in class BasicRootPaneUI
    
    Parameters:
    
    c - the JRootPane to uninstall state from
  - installBorder
```
public void installBorder(JRootPane root)
```
    Installs the appropriate Border onto the JRootPane.
    
    Parameters:
    
    root - Root pane.
  - installDefaults
```
protected void installDefaults(JRootPane c)
```
    Overrides:
    
    installDefaults in class BasicRootPaneUI
  - update
```
public void update(Graphics g,
                   JComponent c)
```
    Overrides:
    
    update in class ComponentUI
  - installListeners
```
protected void installListeners(JRootPane root)
```
    Overrides:
    
    installListeners in class BasicRootPaneUI
  - uninstallListeners
```
protected void uninstallListeners(JRootPane root)
```
    Overrides:
    
    uninstallListeners in class BasicRootPaneUI
  - createTitlePane
```
protected JComponent createTitlePane(JRootPane root)
```
    Returns the JComponent to render the window decoration style.
    
    Parameters:
    
    root - Root pane.
    
    Returns:
    
    The title pane component.
  - createLayoutManager
```
protected LayoutManager createLayoutManager()
```
    Returns a LayoutManager that will be set on the JRootPane.
    
    Returns:
    
    Layout manager.
  - setMaximized
```
public void setMaximized()
```
    Sets maximized bounds according to the display screen insets.
  - getTitlePane
```
public JComponent getTitlePane()
```
    Returns the JComponent rendering the title pane. If this returns null, it implies there is no need to render window decorations. This method is for internal use only.
    
    Returns:
    
    Title pane.
    
    See Also:
    
    setTitlePane(javax.swing.JRootPane, javax.swing.JComponent)
  - getRootPane
```
protected JRootPane getRootPane()
```
    Returns the JRootPane we're providing the look and feel for.
    
    Returns:
    
    The associated root pane.
  - propertyChange
```
public void propertyChange(PropertyChangeEvent e)
```
    Specified by:
    
    propertyChange in interface PropertyChangeListener
    
    Overrides:
    
    propertyChange in class BasicRootPaneUI
  - hasCustomSkinOnAtLeastOneRootPane
```
public static boolean hasCustomSkinOnAtLeastOneRootPane()
```

Class SubstanceRootPaneUI

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javax.swing.plaf.basic.BasicRootPaneUI

Methods inherited from class javax.swing.plaf.ComponentUI

Methods inherited from class java.lang.Object

Field Detail

root

substanceWindowListener

substanceCurrentWindow

substanceHierarchyListener

substanceWindowComponentListener

currentRootPaneGC

substancePropertyChangeListener

WINDOW_ROUNDER

Constructor Detail

SubstanceRootPaneUI

Method Detail

createUI

installUI

uninstallUI

installBorder

installDefaults

update

installListeners

uninstallListeners

createTitlePane

createLayoutManager

setMaximized

getTitlePane

getRootPane

propertyChange

hasCustomSkinOnAtLeastOneRootPane