WebRootPaneUI

java.lang.Object
- javax.swing.plaf.ComponentUI
- - javax.swing.plaf.RootPaneUI
  - - javax.swing.plaf.basic.BasicRootPaneUI
    - - com.alee.laf.rootpane.WebRootPaneUI

All Implemented Interfaces:

MarginSupport, PaddingSupport, ShapeProvider, Styleable, java.beans.PropertyChangeListener, java.util.EventListener, javax.swing.SwingConstants
```
public class WebRootPaneUI
extends javax.swing.plaf.basic.BasicRootPaneUI
implements Styleable, ShapeProvider, MarginSupport, PaddingSupport, javax.swing.SwingConstants
```
Custom UI for JRootPane component. This UI also includes custom frame and dialog decorations.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class WebRootPaneUI.TitleLabel
Custom decoration title label.

Nested Classes
Modifier and Type	Class and Description
`class`	`WebRootPaneUI.TitleLabel` Custom decoration title label.

Field Summary

Fields
Modifier and Type	Field and Description
`protected GroupPane`	`buttonsPanel`
`static javax.swing.ImageIcon`	`closeActiveIcon`
`protected WebButton`	`closeButton`
`static javax.swing.ImageIcon`	`closeIcon`
`protected java.awt.Dialog`	`dialog`
`protected boolean`	`displayCloseButton`
`protected boolean`	`displayMaximizeButton`
`protected boolean`	`displayMenuBar`
`protected boolean`	`displayMinimizeButton`
`protected boolean`	`displayTitleComponent`
`protected boolean`	`displayWindowButtons`
`protected java.lang.String`	`emptyTitleText`
`protected java.awt.Frame`	`frame`
`protected int`	`iconSize` Style settings.
`protected java.awt.LayoutManager`	`layoutManager`
`protected java.awt.Insets`	`margin` Runtime variables
`static javax.swing.ImageIcon`	`maximizeActiveIcon`
`protected WebButton`	`maximizeButton`
`static javax.swing.ImageIcon`	`maximizeIcon`
`static javax.swing.ImageIcon`	`minimizeActiveIcon`
`protected WebButton`	`minimizeButton`
`static javax.swing.ImageIcon`	`minimizeIcon` Root pane styling icons.
`protected java.awt.Insets`	`padding`
`protected IRootPanePainter`	`painter` Component painter.
`protected java.awt.LayoutManager`	`previousLayoutManager`
`protected java.beans.PropertyChangeListener`	`resizableChangeListener`
`static javax.swing.ImageIcon`	`restoreActiveIcon`
`static javax.swing.ImageIcon`	`restoreIcon`
`protected javax.swing.JRootPane`	`root`
`protected java.beans.PropertyChangeListener`	`titleChangeListener`
`protected javax.swing.JComponent`	`titleComponent` Additional components used be the UI.
`protected java.awt.Window`	`window`

Fields inherited from interface com.alee.managers.style.MarginSupport
EMPTY

Fields inherited from interface com.alee.managers.style.PaddingSupport
EMPTY

Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors
Constructor and Description

WebRootPaneUI()

Constructors
Constructor and Description
`WebRootPaneUI()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`close()` Closes the Window.
`protected javax.swing.JComponent`	`createDefaultTitleComponent()` Returns default window title component.
`static javax.swing.plaf.ComponentUI`	`createUI(javax.swing.JComponent c)` Returns an instance of the WebRootPaneUI for the specified component.
`protected javax.swing.ImageIcon`	`generateProperIcon(java.awt.Image image)` Returns generated window icon of suitable size.
`GroupPane`	`getButtonsPanel()` Returns window buttons panel.
`java.awt.Insets`	`getMargin()` Returns current margin.
`java.awt.Insets`	`getPadding()` Returns current padding.
`Painter`	`getPainter()` Returns root pane painter.
`java.awt.Dimension`	`getPreferredSize(javax.swing.JComponent c)`
`StyleId`	`getStyleId()` Returns component style ID.
`javax.swing.JComponent`	`getTitleComponent()` Returns window title component.
`protected javax.swing.ImageIcon`	`getWindowIcon()` Returns window icon of suitable size.
`protected java.lang.String`	`getWindowTitle()` Returns window title.
`protected void`	`iconify()` Iconifies the Frame.
`protected void`	`installDecorationComponents()` Installs decoration components.
`protected void`	`installLayout()` Installs appropriate layout manager.
`protected void`	`installListeners()` Installs listeners.
`protected void`	`installOpacity()` Installs window opacity.
`void`	`installUI(javax.swing.JComponent c)`
`protected void`	`installWindowDecorations()` Installs window decorations.
`boolean`	`isDecorated()` Returns whether or not this root pane uses custom decoration for its window.
`boolean`	`isDialog()` Returns whether or not this root pane is attached to dialog.
`boolean`	`isDisplayCloseButton()` Returns whether or not window close button should be displayed.
`boolean`	`isDisplayMaximizeButton()` Returns whether or not window maximize button should be displayed.
`boolean`	`isDisplayMenuBar()` Returns whether or not menu bar should be displayed.
`boolean`	`isDisplayMinimizeButton()` Returns whether or not window minimize button should be displayed.
`boolean`	`isDisplayTitleComponent()` Returns whether or not window title component should be displayed.
`boolean`	`isDisplayWindowButtons()` Returns whether or not window buttons should be displayed.
`boolean`	`isFrame()` Returns whether or not this root pane is attached to frame.
`boolean`	`isIconified()` Returns whether or not window this root pane is attached to is maximized.
`boolean`	`isMaximized()` Returns whether or not window this root pane is attached to is maximized.
`protected boolean`	`isResizable()` Returns whether or not window is resizable.
`protected void`	`maximize()` Maximizes the Frame.
`void`	`paint(java.awt.Graphics g, javax.swing.JComponent c)`
`void`	`propertyChange(java.beans.PropertyChangeEvent e)`
`java.awt.Shape`	`provideShape()` Returns component shape.
`protected void`	`restore()` Restores the Frame size.
`void`	`setDisplayCloseButton(boolean display)` Sets whether or not window close button should be displayed.
`void`	`setDisplayMaximizeButton(boolean display)` Sets whether or not window maximize button should be displayed.
`void`	`setDisplayMenuBar(boolean display)` Sets whether or not menu bar should be displayed.
`void`	`setDisplayMinimizeButton(boolean display)` Sets whether or not window minimize button should be displayed.
`void`	`setDisplayTitleComponent(boolean display)` Sets whether or not window title component should be displayed.
`void`	`setDisplayWindowButtons(boolean display)` Sets whether or not window buttons should be displayed.
`void`	`setMargin(java.awt.Insets margin)` Sets new margin.
`void`	`setPadding(java.awt.Insets padding)` Sets new padding.
`void`	`setPainter(Painter painter)` Sets root pane painter.
`StyleId`	`setStyleId(StyleId id)` Sets new component style ID.
`void`	`setTitleComponent(javax.swing.JComponent title)` Sets window title component.
`protected void`	`uninstallDecorationComponents()` Uninstalls decoration components.
`protected void`	`uninstallLayout()` Uninstalls layout manager.
`protected void`	`uninstallListeners()` Uninstalls listeners.
`protected void`	`uninstallOpacity()` Uninstalls window opacity.
`protected void`	`uninstallSettings()` Uninstalls settings used in runtime.
`void`	`uninstallUI(javax.swing.JComponent c)`
`protected void`	`uninstallWindowDecorations()` Uninstalls window decorations.
`protected void`	`updateButtons()` Updates displayed buttons
`protected void`	`updateWindowDecorations()` Updates window decorations.

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

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

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

- Field Detail
  - minimizeIcon
```
public static javax.swing.ImageIcon minimizeIcon
```
    Root pane styling icons.
  - minimizeActiveIcon
```
public static javax.swing.ImageIcon minimizeActiveIcon
```
  - maximizeIcon
```
public static javax.swing.ImageIcon maximizeIcon
```
  - maximizeActiveIcon
```
public static javax.swing.ImageIcon maximizeActiveIcon
```
  - restoreIcon
```
public static javax.swing.ImageIcon restoreIcon
```
  - restoreActiveIcon
```
public static javax.swing.ImageIcon restoreActiveIcon
```
  - closeIcon
```
public static javax.swing.ImageIcon closeIcon
```
  - closeActiveIcon
```
public static javax.swing.ImageIcon closeActiveIcon
```
  - iconSize
```
protected int iconSize
```
    Style settings.
  - emptyTitleText
```
protected java.lang.String emptyTitleText
```
  - displayTitleComponent
```
protected boolean displayTitleComponent
```
  - displayWindowButtons
```
protected boolean displayWindowButtons
```
  - displayMinimizeButton
```
protected boolean displayMinimizeButton
```
  - displayMaximizeButton
```
protected boolean displayMaximizeButton
```
  - displayCloseButton
```
protected boolean displayCloseButton
```
  - displayMenuBar
```
protected boolean displayMenuBar
```
  - painter
```
@DefaultPainter(value=RootPanePainter.class)
protected IRootPanePainter painter
```
    Component painter.
  - titleComponent
```
protected javax.swing.JComponent titleComponent
```
    Additional components used be the UI.
  - buttonsPanel
```
protected GroupPane buttonsPanel
```
  - minimizeButton
```
protected WebButton minimizeButton
```
  - maximizeButton
```
protected WebButton maximizeButton
```
  - closeButton
```
protected WebButton closeButton
```
  - margin
```
protected java.awt.Insets margin
```
    Runtime variables
  - padding
```
protected java.awt.Insets padding
```
  - root
```
protected javax.swing.JRootPane root
```
  - window
```
protected java.awt.Window window
```
  - frame
```
protected java.awt.Frame frame
```
  - dialog
```
protected java.awt.Dialog dialog
```
  - previousLayoutManager
```
protected java.awt.LayoutManager previousLayoutManager
```
  - layoutManager
```
protected java.awt.LayoutManager layoutManager
```
  - titleChangeListener
```
protected java.beans.PropertyChangeListener titleChangeListener
```
  - resizableChangeListener
```
protected java.beans.PropertyChangeListener resizableChangeListener
```
- Constructor Detail
  - WebRootPaneUI
```
public WebRootPaneUI()
```
- Method Detail
  - createUI
```
public static javax.swing.plaf.ComponentUI createUI(javax.swing.JComponent c)
```
    Returns an instance of the WebRootPaneUI 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 WebRootPaneUI
  - installUI
```
public void installUI(javax.swing.JComponent c)
```
    Overrides:
    
    installUI in class javax.swing.plaf.basic.BasicRootPaneUI
  - uninstallUI
```
public void uninstallUI(javax.swing.JComponent c)
```
    Overrides:
    
    uninstallUI in class javax.swing.plaf.basic.BasicRootPaneUI
  - getStyleId
```
public StyleId getStyleId()
```
    Description copied from interface: Styleable
    
    Returns component style ID.
    
    Specified by:
    
    getStyleId in interface Styleable
    
    Returns:
    
    component style ID
  - setStyleId
```
public StyleId setStyleId(StyleId id)
```
    Description copied from interface: Styleable
    
    Sets new component style ID. If style for the specified ID cannot be found in skin then its default style will be used instead. This method forces component to instantly apply style with the specified ID to itself.
    
    Specified by:
    
    setStyleId in interface Styleable
    
    Parameters:
    
    id - custom component style ID
    
    Returns:
    
    previously used style ID
  - provideShape
```
public java.awt.Shape provideShape()
```
    Description copied from interface: ShapeProvider
    
    Returns component shape.
    
    Specified by:
    
    provideShape in interface ShapeProvider
    
    Returns:
    
    component shape
  - getMargin
```
public java.awt.Insets getMargin()
```
    Description copied from interface: MarginSupport
    
    Returns current margin. Might return null which is basically the same as an empty [0,0,0,0] margin.
    
    Specified by:
    
    getMargin in interface MarginSupport
    
    Returns:
    
    current margin
  - setMargin
```
public void setMargin(java.awt.Insets margin)
```
    Description copied from interface: MarginSupport
    
    Sets new margin. null can be provided to set an empty [0,0,0,0] margin.
    
    Specified by:
    
    setMargin in interface MarginSupport
    
    Parameters:
    
    margin - new margin
  - getPadding
```
public java.awt.Insets getPadding()
```
    Description copied from interface: PaddingSupport
    
    Returns current padding. Might return null which is basically the same as an empty [0,0,0,0] padding.
    
    Specified by:
    
    getPadding in interface PaddingSupport
    
    Returns:
    
    current padding
  - setPadding
```
public void setPadding(java.awt.Insets padding)
```
    Description copied from interface: PaddingSupport
    
    Sets new padding. null can be provided to set an empty [0,0,0,0] padding.
    
    Specified by:
    
    setPadding in interface PaddingSupport
    
    Parameters:
    
    padding - new padding
  - getPainter
```
public Painter getPainter()
```
    Returns root pane painter.
    
    Returns:
    
    root pane painter
  - setPainter
```
public void setPainter(Painter painter)
```
    Sets root pane painter. Pass null to remove root pane painter.
    
    Parameters:
    
    painter - new root pane painter
  - isDecorated
```
public boolean isDecorated()
```
    Returns whether or not this root pane uses custom decoration for its window.
    
    Returns:
    
    true if this root pane uses custom decoration for its window, false otherwise
  - getTitleComponent
```
public javax.swing.JComponent getTitleComponent()
```
    Returns window title component.
    
    Returns:
    
    window title component
  - setTitleComponent
```
public void setTitleComponent(javax.swing.JComponent title)
```
    Sets window title component.
    
    Parameters:
    
    title - new window title component
  - getButtonsPanel
```
public GroupPane getButtonsPanel()
```
    Returns window buttons panel.
    
    Returns:
    
    window buttons panel
  - isDisplayTitleComponent
```
public boolean isDisplayTitleComponent()
```
    Returns whether or not window title component should be displayed.
    
    Returns:
    
    true if window title component should be displayed, false otherwise
  - setDisplayTitleComponent
```
public void setDisplayTitleComponent(boolean display)
```
    Sets whether or not window title component should be displayed.
    
    Parameters:
    
    display - whether or not window title component should be displayed
  - isDisplayWindowButtons
```
public boolean isDisplayWindowButtons()
```
    Returns whether or not window buttons should be displayed.
    
    Returns:
    
    true if window buttons should be displayed, false otherwise
  - setDisplayWindowButtons
```
public void setDisplayWindowButtons(boolean display)
```
    Sets whether or not window buttons should be displayed.
    
    Parameters:
    
    display - whether or not window buttons should be displayed
  - isDisplayMinimizeButton
```
public boolean isDisplayMinimizeButton()
```
    Returns whether or not window minimize button should be displayed.
    
    Returns:
    
    true if window minimize button should be displayed, false otherwise
  - setDisplayMinimizeButton
```
public void setDisplayMinimizeButton(boolean display)
```
    Sets whether or not window minimize button should be displayed.
    
    Parameters:
    
    display - whether or not window minimize button should be displayed
  - isDisplayMaximizeButton
```
public boolean isDisplayMaximizeButton()
```
    Returns whether or not window maximize button should be displayed.
    
    Returns:
    
    true if window maximize button should be displayed, false otherwise
  - setDisplayMaximizeButton
```
public void setDisplayMaximizeButton(boolean display)
```
    Sets whether or not window maximize button should be displayed.
    
    Parameters:
    
    display - whether or not window maximize button should be displayed
  - isDisplayCloseButton
```
public boolean isDisplayCloseButton()
```
    Returns whether or not window close button should be displayed.
    
    Returns:
    
    true if window close button should be displayed, false otherwise
  - setDisplayCloseButton
```
public void setDisplayCloseButton(boolean display)
```
    Sets whether or not window close button should be displayed.
    
    Parameters:
    
    display - whether or not window close button should be displayed
  - isDisplayMenuBar
```
public boolean isDisplayMenuBar()
```
    Returns whether or not menu bar should be displayed.
    
    Returns:
    
    true if menu bar should be displayed, false otherwise
  - setDisplayMenuBar
```
public void setDisplayMenuBar(boolean display)
```
    Sets whether or not menu bar should be displayed.
    
    Parameters:
    
    display - whether or not menu bar should be displayed
  - propertyChange
```
public void propertyChange(java.beans.PropertyChangeEvent e)
```
    Specified by:
    
    propertyChange in interface java.beans.PropertyChangeListener
    
    Overrides:
    
    propertyChange in class javax.swing.plaf.basic.BasicRootPaneUI
  - updateWindowDecorations
```
protected void updateWindowDecorations()
```
    Updates window decorations.
  - installWindowDecorations
```
protected void installWindowDecorations()
```
    Installs window decorations.
  - uninstallWindowDecorations
```
protected void uninstallWindowDecorations()
```
    Uninstalls window decorations.
  - uninstallSettings
```
protected void uninstallSettings()
```
    Uninstalls settings used in runtime.
  - installListeners
```
protected void installListeners()
```
    Installs listeners.
  - uninstallListeners
```
protected void uninstallListeners()
```
    Uninstalls listeners.
  - installOpacity
```
protected void installOpacity()
```
    Installs window opacity.
  - uninstallOpacity
```
protected void uninstallOpacity()
```
    Uninstalls window opacity.
  - installLayout
```
protected void installLayout()
```
    Installs appropriate layout manager.
  - uninstallLayout
```
protected void uninstallLayout()
```
    Uninstalls layout manager.
  - installDecorationComponents
```
protected void installDecorationComponents()
```
    Installs decoration components.
  - uninstallDecorationComponents
```
protected void uninstallDecorationComponents()
```
    Uninstalls decoration components.
  - createDefaultTitleComponent
```
protected javax.swing.JComponent createDefaultTitleComponent()
```
    Returns default window title component.
    
    Returns:
    
    default window title component
  - updateButtons
```
protected void updateButtons()
```
    Updates displayed buttons
  - getWindowTitle
```
protected java.lang.String getWindowTitle()
```
    Returns window title.
    
    Returns:
    
    window title
  - getWindowIcon
```
protected javax.swing.ImageIcon getWindowIcon()
```
    Returns window icon of suitable size.
    
    Returns:
    
    window icon of suitable size
  - generateProperIcon
```
protected javax.swing.ImageIcon generateProperIcon(java.awt.Image image)
```
    Returns generated window icon of suitable size.
    
    Parameters:
    
    image - image used to generate icon of suitable size
    
    Returns:
    
    generated window icon of suitable size
  - close
```
protected void close()
```
    Closes the Window.
  - iconify
```
protected void iconify()
```
    Iconifies the Frame.
  - maximize
```
protected void maximize()
```
    Maximizes the Frame.
  - restore
```
protected void restore()
```
    Restores the Frame size.
  - isResizable
```
protected boolean isResizable()
```
    Returns whether or not window is resizable.
    
    Returns:
    
    true if window is resizable, false otherwise
  - isFrame
```
public boolean isFrame()
```
    Returns whether or not this root pane is attached to frame.
    
    Returns:
    
    true if this root pane is attached to frame, false otherwise
  - isIconified
```
public boolean isIconified()
```
    Returns whether or not window this root pane is attached to is maximized.
    
    Returns:
    
    true if window this root pane is attached to is maximized, false otherwise
  - isMaximized
```
public boolean isMaximized()
```
    Returns whether or not window this root pane is attached to is maximized.
    
    Returns:
    
    true if window this root pane is attached to is maximized, false otherwise
  - isDialog
```
public boolean isDialog()
```
    Returns whether or not this root pane is attached to dialog.
    
    Returns:
    
    true if this root pane is attached to dialog, false otherwise
  - paint
```
public void paint(java.awt.Graphics g,
                  javax.swing.JComponent c)
```
    Overrides:
    
    paint in class javax.swing.plaf.ComponentUI
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize(javax.swing.JComponent c)
```
    Overrides:
    
    getPreferredSize in class javax.swing.plaf.ComponentUI

Class WebRootPaneUI

Nested Class Summary

Field Summary

Fields inherited from interface com.alee.managers.style.MarginSupport

Fields inherited from interface com.alee.managers.style.PaddingSupport

Fields inherited from interface javax.swing.SwingConstants

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

minimizeIcon

minimizeActiveIcon

maximizeIcon

maximizeActiveIcon

restoreIcon

restoreActiveIcon

closeIcon

closeActiveIcon

iconSize

emptyTitleText

displayTitleComponent

displayWindowButtons

displayMinimizeButton

displayMaximizeButton

displayCloseButton

displayMenuBar

painter

titleComponent

buttonsPanel

minimizeButton

maximizeButton

closeButton

margin

padding

root

window

frame

dialog

previousLayoutManager

layoutManager

titleChangeListener

resizableChangeListener

Constructor Detail

WebRootPaneUI

Method Detail

createUI

installUI

uninstallUI

getStyleId

setStyleId

provideShape

getMargin

setMargin

getPadding

setPadding

getPainter

setPainter

isDecorated

getTitleComponent

setTitleComponent

getButtonsPanel

isDisplayTitleComponent

setDisplayTitleComponent

isDisplayWindowButtons

setDisplayWindowButtons

isDisplayMinimizeButton

setDisplayMinimizeButton

isDisplayMaximizeButton

setDisplayMaximizeButton

isDisplayCloseButton

setDisplayCloseButton

isDisplayMenuBar

setDisplayMenuBar

propertyChange

updateWindowDecorations

installWindowDecorations

uninstallWindowDecorations

uninstallSettings