Package org.pushingpixels.substance.api

Class SubstanceCortex.RootPaneScope

java.lang.Object

org.pushingpixels.substance.api.SubstanceCortex.RootPaneScope

Enclosing class:

SubstanceCortex

public static final class SubstanceCortex.RootPaneScope
extends java.lang.Object

APIs in this scope apply to individual application JRootPanes.

Constructor Summary

Constructors

Constructor	Description
RootPaneScope()

Method Summary

Modifier and Type	Method	Description
static void	setContentsModified(javax.swing.JRootPane rootPane, java.lang.Boolean contentsModified)	Specifies that contents of a root pane have been modified and not saved.
static void	setSkin(javax.swing.JRootPane rootPane, SubstanceSkin skin)	Specifies a skin to be used on the specific root pane.

Methods inherited from class java.lang.Object

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

Constructor Detail

RootPaneScope

public RootPaneScope()

Method Detail

setSkin

public static void setSkin(javax.swing.JRootPane rootPane,
                           SubstanceSkin skin)

Specifies a skin to be used on the specific root pane. This will affect all the controls in that root pane. After calling this method, call SwingUtilities.updateComponentTreeUI(Component) on the matching window.

Parameters:

rootPane - Root pane.

skin - Skin to use on all the controls in the root pane.

See Also:

SubstanceCortex.GlobalScope.setSkin(String), SubstanceCortex.GlobalScope.setSkin(SubstanceSkin)

setContentsModified

public static void setContentsModified(javax.swing.JRootPane rootPane,
                                       java.lang.Boolean contentsModified)

Specifies that contents of a root pane have been modified and not saved. The close button of the title pane of the matching frame / dialog will be animated (in case that the frame / dialog have decorated title pane). In case the root pane belongs to a JInternalFrame and that frame is iconified (to a JInternalFrame.JDesktopIcon), the close button of the its desktop icon is animated as well.

The animation cycles between red, orange and yellow color schemes. The animation will be visible only when the mouse hovers over the close button of the matching container (frame, dialog, internal frame, desktop icon). The tooltip of the close button is changed as well to reflect that the container contents are marked as modified.

Parameters:

rootPane - Root pane.

contentsModified - If true, the close button of the title pane of the matching frame / dialog will be animated.

See Also:

SubstanceCortex.ComponentScope.setTabContentsModified(JComponent, Boolean)