Package org.pushingpixels.substance.api

Class SubstanceCortex.GlobalScope

java.lang.Object

org.pushingpixels.substance.api.SubstanceCortex.GlobalScope

Enclosing class:

SubstanceCortex

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

APIs in this scope apply to the global state of the application.

Constructor Summary

Constructors

Constructor	Description
GlobalScope()

Method Summary

Modifier and Type	Method	Description
static void	allowAnimations(SubstanceSlices.AnimationFacet animationFacet)	Allows animations of the specified facet on all controls.
static void	allowAnimations(SubstanceSlices.AnimationFacet animationFacet, java.lang.Class<?> clazz)	Allows animations of the specified facet on all controls of specified class.
static void	allowAnimations(SubstanceSlices.AnimationFacet animationFacet, java.lang.Class<?>[] clazz)	Allows animations of the specified facet on all controls of specified classes.
static org.pushingpixels.neon.api.icon.ResizableIcon	colorizeIcon(org.pushingpixels.neon.api.icon.ResizableIcon.Factory sourceFactory, SubstanceColorScheme colorScheme, float brightnessFactor)	Returns the colorized version of icon based off of the passed icon factory.
static org.pushingpixels.neon.api.icon.ResizableIconUIResource	colorizeIconAsUiResource(org.pushingpixels.neon.api.icon.ResizableIcon.Factory sourceFactory, SubstanceColorScheme colorScheme)	Returns the colorized version of icon based off of the passed icon factory.
static org.pushingpixels.neon.api.icon.ResizableIconUIResource	colorizeIconAsUiResource(org.pushingpixels.neon.api.icon.ResizableIcon.Factory sourceFactory, SubstanceColorScheme colorScheme, float brightnessFactor)	Returns the colorized version of icon based off of the passed icon factory.
static void	configureTitleContentGravity(SubstanceSlices.HorizontalGravity titleTextHorizontalGravity, SubstanceSlices.HorizontalGravity titleControlButtonGroupHorizontalGravity, SubstanceSlices.TitleIconHorizontalGravity titleIconHorizontalGravity)	Configures title pane content gravity for all decorated application windows.
static void	disallowAnimations(SubstanceSlices.AnimationFacet animationFacet)	Disallows animations of the specified facet on all controls.
static void	disallowAnimations(SubstanceSlices.AnimationFacet animationFacet, java.lang.Class<?> clazz)	Disallows animations of the specified facet on all controls of specified class.
static void	disallowAnimations(SubstanceSlices.AnimationFacet animationFacet, java.lang.Class<?>[] clazz)	Disallows animations of the specified facet on all controls of specified classes.
static java.util.Map<java.lang.String,SkinInfo>	getAllSkins()	Returns all available skins.
static java.util.Set<BaseTabCloseListener>	getAllTabCloseListeners()	Returns the set of all listeners registered on tab-close events on all tabbed panes.
static java.awt.image.BufferedImage	getBlankImage(double scaleFactor, int width, int height)
static SubstanceSlices.HorizontalGravity	getButtonBarGravity()	Returns the currently set button bar gravity for all containers that display grouped buttons, such as JOptionPanes, for example.
static SubstanceSlices.ButtonOrder	getButtonBarOrder()	Returns the currently set button order for all containers that display grouped buttons, such as JOptionPanes, for example.
static SubstanceSkin	getCurrentSkin()	Returns the current global skin.
static org.pushingpixels.neon.api.font.FontPolicy	getFontPolicy()	Looks up and retrieves the FontPolicy used by the Substance family.
static SubstanceIconPack	getIconPack()	Looks up and retrieves the SubstanceIconPack used by Substance.
static java.util.ResourceBundle	getLabelBundle()	Retrieves the current label bundle.
static java.util.ResourceBundle	getLabelBundle(java.util.Locale locale)	Retrieves the label bundle for the specified locale.
static java.lang.ClassLoader	getLabelBundleClassLoader()
static java.util.Set<SubstanceSlices.LocaleChangeListener>	getLocaleChangeListeners()	Returns all listeners registered on locale change.
static float	getMenuGutterFillAlpha()	Returns the menu gutter fill alpha.
static long	getTimelineDuration()
static SubstanceSlices.TitleIconHorizontalGravity	getTitleIconHorizontalGravity()	Returns the gravity for the icon in title panes of all decorated application windows.
static SubstanceSlices.HorizontalGravity	getTitleTextHorizontalGravity()	Returns the gravity for the title text in title panes of all decorated application windows.
static boolean	isAnimationAllowed(SubstanceSlices.AnimationFacet animationFacet)	Checks whether the specified animation facet is allowed on the specified component.
static void	registerComponentPlugin(SubstanceComponentPlugin componentPlugin)	Registers the specified component plugin.
static void	registerLocaleChangeListener(SubstanceSlices.LocaleChangeListener localeListener)	Registers a new listener on locale change.
static void	registerSkinChangeListener(SkinChangeListener skinChangeListener)	Registers a new listener on skin change.
static void	registerSkinPlugin(SubstanceSkinPlugin skinPlugin)	Registers the specified skin plugin.
static void	registerTabCloseChangeListener(BaseTabCloseListener tabCloseListener)	Registers the specified listener on tab-close events on all tabbed panes.
static void	registerWidget(java.lang.String widgetClassName, java.lang.Class<?> supportedClass, boolean isExact)
static void	resetLabelBundle()	Resets the current label bundle.
static void	setAutomaticDragAndDropSupportPresence(java.lang.Boolean hasAutomaticDragAndDropSupport)	Specifies whether trees should have should have automatic drag and drop support.
static void	setAutomaticScrollPresence(java.lang.Boolean hasAutomaticScroll)	Specifies whether scroll panes should have have auto-scroll support invoked on mouse button click that triggers popups.
static void	setBackgroundAppearanceStrategy(SubstanceSlices.BackgroundAppearanceStrategy backgroundAppearanceStrategy)	Specifies when components should draw their background.
static void	setButtonBarGravity(SubstanceSlices.HorizontalGravity buttonBarGravity)	Sets the button bar gravity for all containers that display grouped buttons, such as JOptionPanes, for example.
static void	setButtonBarOrder(SubstanceSlices.ButtonOrder buttonBarButtonOrder)	Sets the button order for all containers that display grouped buttons, such as JOptionPanes, for example.
static void	setButtonIgnoreMinimumSize(java.lang.Boolean buttonIgnoreMinimumSize)	Specifies whether buttons should ignore the default (minimum) dimension.
static void	setCapsLockIconVisible(java.lang.Boolean visible)	Specifies global visibility of the caps lock icon on password fields.
static void	setColorizationFactor(double colorizationFactor)	Specifies colorization amount applied to the background and foreground of the current color scheme and all control.
static void	setComboBoxPopupFlyoutOrientation(int comboPopupFlyoutOrientation)	Specifies the combobox popup flyout orientation.
static void	setComboBoxPrototypeCallback(ComboPopupPrototypeCallback comboPopupPrototypeCallback)	Specifies the combobox popup prototype callback which is used to compute the width of the popups at runtime.
static void	setComboBoxPrototypeDisplayValue(java.lang.Object comboPopupPrototypeDisplayValue)	Specifies the combobox popup prototype display value which is used to compute the width of the popups at runtime.
static void	setComponentPreviewPainter(PreviewPainter previewPainter)	Specifies global preview painter to be used for showing preview thumbnails.
static void	setExtraWidgetsPresence(java.lang.Boolean extraWidgetsPresence)	Specifies that extra UI elements (such as menu items in system menu or lock borders) should be shown.
static void	setFocusKind(SubstanceSlices.FocusKind focusKind)	Specifies the kind of focus indication to be used on application components.
static void	setFontPolicy(org.pushingpixels.neon.api.font.FontPolicy fontPolicy)	Sets the FontPolicy to be used with Substance family.
static void	setIconPack(SubstanceIconPack iconPack)	Sets the SubstanceIconPack to be used with Substance.
static void	setIconThemingStrategy(SubstanceSlices.IconThemingStrategy iconThemingStrategy)	Specifies how icons on controls such as buttons, toggle buttons, labels, tabs and menu items should match the color of the current color scheme when they are in default state.
static void	setLabelBundleClassLoader(java.lang.ClassLoader labelBundleClassLoader)	Sets the class loader for labelBundle.
static void	setLockIconVisible(java.lang.Boolean visible)	Specifies global visibility of the lock icon on non-editable text components.
static void	setMenuGutterFillAlpha(float menuGutterFillAlpha)	Specifies the menu gutter fill alpha.
static void	setNumberOfPasswordEchoesPerCharacter(int echoCount)	Specifies the number of echo characters for each password character in password fields.
static void	setRunModifiedAnimationOnTabCloseButton(java.lang.Boolean runModifiedAnimationOnTabCloseButton)	Specifies that only the close button of a marked-as-modified tab component should pulsate.
static void	setSelectTextOnFocus(java.lang.Boolean selectTextOnFocus)	Specifies whether the contents of text components should be selected on focus gain.
static boolean	setSkin(java.lang.String skinClassName)	Sets the specified skin.
static boolean	setSkin(SubstanceSkin newSkin)	Sets the specified skin.
static void	setTabCloseButtonsVisible(java.lang.Boolean tabCloseButtonsVisible)	Configures visibility of close buttons on tabbed pane tabs.
static void	setTabCloseCallback(TabCloseCallback tabCloseCallback)	Configures the callback for deciding on the tab close type on tabbed pane tabs.
static void	setTabContentPaneBorderKind(SubstanceSlices.TabContentPaneBorderKind tabContentPaneBorderKind)	Specifies the content pane border kind for tabbed panes.
static void	setTextEditContextMenuPresence(java.lang.Boolean hasEditContextMenu)	Specifies whether text components should have the edit context menu (with Cut / Copy / Paste / ...
static void	setTimelineDuration(long timelineDuration)
static void	setToolbarButtonCornerRadius(float toolbarButtonCornerRadius)	Specifies corner radius for all toolbar buttons.
static void	setTraceFilename(java.lang.String traceFilename)	Specifies the trace filename.
static void	setUseConstantThemesOnOptionPanes(java.lang.Boolean useConstantThemesOnOptionPanes)	Sets the new setting for the icons of the JOptionPanes created with predefined message types.
static void	setUseDefaultColorChooser()
static void	setWidgetVisible(boolean visible, SubstanceSlices.SubstanceWidgetType... substanceWidgets)	Sets the visibility of the specified widget kind(s).
static void	unregisterLocaleChangeListener(SubstanceSlices.LocaleChangeListener localeListener)	Unregisters a listener on locale change.
static void	unregisterSkinChangeListener(SkinChangeListener skinChangeListener)	Unregisters a listener on skin change.
static void	unregisterTabCloseChangeListener(BaseTabCloseListener tabCloseListener)	Unregisters the specified listener on tab-close events on all tabbed panes.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalScope

public GlobalScope()

Method Detail

setSkin

public static boolean setSkin(SubstanceSkin newSkin)

Sets the specified skin. If the current look-and-feel is not Substance, this method will create a new Substance look-and-feel based on the specified skin and set it on UIManager. This method does not require Substance to be the current look-and-feel. Calling this method will call SwingUtilities.updateComponentTreeUI(Component) on all open top-level windows.

Parameters:

newSkin - Skin to set.

Returns:

true if the specified skin has been set successfully, false otherwise.

Throws:

java.lang.IllegalStateException - When called outside the Event Dispatch Thread.

See Also:

registerSkinChangeListener(SkinChangeListener), unregisterSkinChangeListener(SkinChangeListener), setSkin(String), SubstanceCortex.RootPaneScope.setSkin(JRootPane, SubstanceSkin), SubstanceSkin.isValid()

setSkin

public static boolean setSkin(java.lang.String skinClassName)

Sets the specified skin. If the current look-and-feel is not Substance, this method will create a new Substance look-and-feel based on the specified skin and set it on UIManager. This method does not require Substance to be the current look-and-feel. Calling this method will call SwingUtilities.updateComponentTreeUI(Component) on all open top-level windows.

Parameters:

skinClassName - Skin to set.

Returns:

true if the specified skin has been set successfully, false otherwise.

Throws:

java.lang.IllegalStateException - When called outside the Event Dispatch Thread.

See Also:

setSkin(SubstanceSkin), registerSkinChangeListener(SkinChangeListener), unregisterSkinChangeListener(SkinChangeListener), setSkin(SubstanceSkin), SubstanceCortex.RootPaneScope.setSkin(JRootPane, SubstanceSkin), SubstanceSkin.isValid()

getCurrentSkin

public static SubstanceSkin getCurrentSkin()

Returns the current global skin. If the current look-and-feel is not Substance, this method returns null.

Returns:

Current global skin.

registerSkinChangeListener

public static void registerSkinChangeListener(SkinChangeListener skinChangeListener)

Registers a new listener on skin change.

Parameters:

skinChangeListener - New listener on skin change.

See Also:

setSkin(String), setSkin(SubstanceSkin), unregisterSkinChangeListener(SkinChangeListener)

unregisterSkinChangeListener

public static void unregisterSkinChangeListener(SkinChangeListener skinChangeListener)

Unregisters a listener on skin change.

Parameters:

skinChangeListener - The listener to unregister.

See Also:

setSkin(String), setSkin(SubstanceSkin), registerSkinChangeListener(SkinChangeListener)

getAllSkins

public static java.util.Map<java.lang.String,SkinInfo> getAllSkins()

Returns all available skins.

Returns:

All available skins. Key - skin display name, value - skin information.

registerComponentPlugin

public static void registerComponentPlugin(SubstanceComponentPlugin componentPlugin)

Registers the specified component plugin. It is recommended to call this method before setting Substance as the look-and-feel in your application initialization sequence. If this method is called after Substance has been set, you will need to call the setSkin(String) or setSkin(SubstanceSkin) APIs to reinitialize the Substance skin.

Parameters:

componentPlugin - Component plugin to register.

registerSkinPlugin

public static void registerSkinPlugin(SubstanceSkinPlugin skinPlugin)

Registers the specified skin plugin.

Parameters:

skinPlugin - Skin plugin to register.

registerWidget

public static void registerWidget(java.lang.String widgetClassName,
                                  java.lang.Class<?> supportedClass,
                                  boolean isExact)

setFontPolicy

public static void setFontPolicy(org.pushingpixels.neon.api.font.FontPolicy fontPolicy)

Sets the FontPolicy to be used with Substance family. If the specified policy is null, the default will be reset. This method does not require Substance to be the current look-and-feel, and will cause Substance to be set as the current application look-and-feel.

Parameters:

fontPolicy - The FontPolicy to be used with Substance family, or null to reset to the default

See Also:

getFontPolicy()

getFontPolicy

public static org.pushingpixels.neon.api.font.FontPolicy getFontPolicy()

Looks up and retrieves the FontPolicy used by the Substance family. If a FontPolicy has been set, it'll be returned. If no FontPolicy has been set, the default Substance font policy will be returned.

Returns:

the FontPolicy set for Substance, or the default Substance font policy.

See Also:

setFontPolicy(org.pushingpixels.neon.api.font.FontPolicy)

registerTabCloseChangeListener

public static void registerTabCloseChangeListener(BaseTabCloseListener tabCloseListener)

Registers the specified listener on tab-close events on all tabbed panes.

Parameters:

tabCloseListener - Listener to register.

See Also:

SubstanceCortex.ComponentScope.registerTabCloseChangeListener(JTabbedPane, BaseTabCloseListener), unregisterTabCloseChangeListener(BaseTabCloseListener), getAllTabCloseListeners()

unregisterTabCloseChangeListener

public static void unregisterTabCloseChangeListener(BaseTabCloseListener tabCloseListener)

Unregisters the specified listener on tab-close events on all tabbed panes.

Parameters:

tabCloseListener - Listener to unregister.

See Also:

SubstanceCortex.ComponentScope.unregisterTabCloseChangeListener(JTabbedPane, BaseTabCloseListener), registerTabCloseChangeListener(BaseTabCloseListener), getAllTabCloseListeners()

getAllTabCloseListeners

public static java.util.Set<BaseTabCloseListener> getAllTabCloseListeners()

Returns the set of all listeners registered on tab-close events on all tabbed panes.

Returns:

Set of all listeners registered on tab-close events on all tabbed panes.

See Also:

registerTabCloseChangeListener(BaseTabCloseListener), unregisterTabCloseChangeListener(BaseTabCloseListener)

setIconPack

public static void setIconPack(SubstanceIconPack iconPack)

Sets the SubstanceIconPack to be used with Substance.

Parameters:

iconPack - The SubstanceIconPack to be used with Substance.

See Also:

getIconPack()

getIconPack

public static SubstanceIconPack getIconPack()

Looks up and retrieves the SubstanceIconPack used by Substance.

Returns:

the SubstanceIconPack set for Substance.

See Also:

setIconPack(SubstanceIconPack)

allowAnimations

public static void allowAnimations(SubstanceSlices.AnimationFacet animationFacet)

Allows animations of the specified facet on all controls. Due to performance considerations, this API can only be used to control renderer-based components (tables, lists, trees) and custom Substance animations (focus loop, icon glow, etc).

Parameters:

animationFacet - Animation facet to allow.

allowAnimations

public static void allowAnimations(SubstanceSlices.AnimationFacet animationFacet,
                                   java.lang.Class<?> clazz)

Allows animations of the specified facet on all controls of specified class. Due to performance considerations, this API can only be used to control renderer-based components (tables, lists, trees) and custom Substance animations (focus loop, icon glow, etc).

Parameters:

animationFacet - Animation facet to allow.

clazz - Control class for allowing the animation facet.

allowAnimations

public static void allowAnimations(SubstanceSlices.AnimationFacet animationFacet,
                                   java.lang.Class<?>[] clazz)

Allows animations of the specified facet on all controls of specified classes. Due to performance considerations, this API can only be used to control renderer-based components (tables, lists, trees) and custom Substance animations (focus loop, icon glow, etc).

Parameters:

animationFacet - Animation facet to allow.

clazz - Control classes for allowing the animation facet.

disallowAnimations

public static void disallowAnimations(SubstanceSlices.AnimationFacet animationFacet)

Disallows animations of the specified facet on all controls. Due to performance considerations, this API can only be used to control renderer-based components (tables, lists, trees) and custom Substance animations (focus loop, icon glow, etc).

Parameters:

animationFacet - Animation facet to disallow.

disallowAnimations

public static void disallowAnimations(SubstanceSlices.AnimationFacet animationFacet,
                                      java.lang.Class<?> clazz)

Disallows animations of the specified facet on all controls of specified class. Due to performance considerations, this API can only be used to control renderer-based components (tables, lists, trees) and custom Substance animations (focus loop, icon glow, etc).

Parameters:

animationFacet - Animation facet to disallow.

clazz - Control class for disallowing the animation facet.

disallowAnimations

public static void disallowAnimations(SubstanceSlices.AnimationFacet animationFacet,
                                      java.lang.Class<?>[] clazz)

Disallows animations of the specified facet on all controls of specified classes. Due to performance considerations, this API can only be used to control renderer-based components (tables, lists, trees) and custom Substance animations (focus loop, icon glow, etc).

Parameters:

animationFacet - Animation facet to disallow.

clazz - Control classes for disallowing the animation facet.

isAnimationAllowed

public static boolean isAnimationAllowed(SubstanceSlices.AnimationFacet animationFacet)

Checks whether the specified animation facet is allowed on the specified component.

Parameters:

animationFacet - Animation facet.

Returns:

true if the specified animation facet is allowed globally, false otherwise.

setTimelineDuration

public static void setTimelineDuration(long timelineDuration)

getTimelineDuration

public static long getTimelineDuration()

registerLocaleChangeListener

public static void registerLocaleChangeListener(SubstanceSlices.LocaleChangeListener localeListener)

Registers a new listener on locale change.

Parameters:

localeListener - New listener on locale change.

unregisterLocaleChangeListener

public static void unregisterLocaleChangeListener(SubstanceSlices.LocaleChangeListener localeListener)

Unregisters a listener on locale change.

Parameters:

localeListener - The listener to unregister.

getLocaleChangeListeners

public static java.util.Set<SubstanceSlices.LocaleChangeListener> getLocaleChangeListeners()

Returns all listeners registered on locale change.

Returns:

All listeners registered on locale change.

getLabelBundle

public static java.util.ResourceBundle getLabelBundle()

Retrieves the current label bundle.

Returns:

The current label bundle.

See Also:

resetLabelBundle()

getLabelBundle

public static java.util.ResourceBundle getLabelBundle(java.util.Locale locale)

Retrieves the label bundle for the specified locale.

Parameters:

locale - Locale.

Returns:

The label bundle for the specified locale.

resetLabelBundle

public static void resetLabelBundle()

Resets the current label bundle. Useful when the application changes Locale at runtime.

See Also:

getLabelBundle()

setLabelBundleClassLoader

public static void setLabelBundleClassLoader(java.lang.ClassLoader labelBundleClassLoader)

Sets the class loader for labelBundle.

Parameters:

labelBundleClassLoader - Class loader for labelBundle.

getLabelBundleClassLoader

public static java.lang.ClassLoader getLabelBundleClassLoader()

setUseConstantThemesOnOptionPanes

public static void setUseConstantThemesOnOptionPanes(java.lang.Boolean useConstantThemesOnOptionPanes)

Sets the new setting for the icons of the JOptionPanes created with predefined message types. The default setting is true (use constant color scheme). To use color scheme-consistent coloring, call this method and pass false.

Parameters:

useConstantThemesOnOptionPanes - if true, the JOptionPanes created with predefined message types will use constant color schemes for the icons.

setIconThemingStrategy

public static void setIconThemingStrategy(SubstanceSlices.IconThemingStrategy iconThemingStrategy)

Specifies how icons on controls such as buttons, toggle buttons, labels, tabs and menu items should match the color of the current color scheme when they are in default state. The control is in default state when it's not pressed, not selected, not armed and not rolled over. By default, all controls show regular (full-color original) icons.

Parameters:

iconThemingStrategy - Icon theming strategy.

See Also:

SubstanceCortex.ComponentScope.setIconThemingStrategy(JComponent, IconThemingStrategy)

getButtonBarOrder

public static SubstanceSlices.ButtonOrder getButtonBarOrder()

Returns the currently set button order for all containers that display grouped buttons, such as JOptionPanes, for example.

Returns:

The currently set button order for all containers that display grouped buttons.

See Also:

setButtonBarOrder(SubstanceSlices.ButtonOrder)

setButtonBarOrder

public static void setButtonBarOrder(SubstanceSlices.ButtonOrder buttonBarButtonOrder)

Sets the button order for all containers that display grouped buttons, such as JOptionPanes, for example. The default order is SubstanceSlices.ButtonOrder.PLATFORM.

Parameters:

buttonBarButtonOrder - The new button order for all containers that display grouped buttons. The value cannot be null.

See Also:

getButtonBarOrder()

getButtonBarGravity

public static SubstanceSlices.HorizontalGravity getButtonBarGravity()

Returns the currently set button bar gravity for all containers that display grouped buttons, such as JOptionPanes, for example.

Returns:

The currently set button bar gravity for all containers that display grouped buttons.

See Also:

setButtonBarGravity(SubstanceSlices.HorizontalGravity)

setButtonBarGravity

public static void setButtonBarGravity(SubstanceSlices.HorizontalGravity buttonBarGravity)

Sets the button bar gravity for all containers that display grouped buttons, such as JOptionPanes, for example. The default gravity is SubstanceSlices.HorizontalGravity.PLATFORM.

Parameters:

buttonBarGravity - The new button alignment for all containers that display grouped buttons. The value cannot be null.

See Also:

getButtonBarGravity()

configureTitleContentGravity

public static void configureTitleContentGravity(SubstanceSlices.HorizontalGravity titleTextHorizontalGravity,
                                                SubstanceSlices.HorizontalGravity titleControlButtonGroupHorizontalGravity,
                                                SubstanceSlices.TitleIconHorizontalGravity titleIconHorizontalGravity)

Configures title pane content gravity for all decorated application windows. This will only apply if you are using JFrame.setDefaultLookAndFeelDecorated(boolean) and / or JDialog.setDefaultLookAndFeelDecorated(boolean) APIs with true. The default gravities are SubstanceSlices.HorizontalGravity.SWING_DEFAULT and SubstanceSlices.TitleIconHorizontalGravity.SWING_DEFAULT. Note that specific windows can have the horizontal gravity of control button group set to a different value with SubstanceCortex.WindowScope.extendContentIntoTitlePane(Window, org.pushingpixels.substance.api.SubstanceSlices.HorizontalGravity, org.pushingpixels.substance.api.SubstanceSlices.VerticalGravity) API.

Parameters:

titleTextHorizontalGravity - Horizontal gravity for the title text. The value cannot be null.

titleControlButtonGroupHorizontalGravity - Horizontal gravity for the control button group. The value cannot be null or SubstanceSlices.HorizontalGravity.CENTERED.

titleIconHorizontalGravity - Horizontal gravity for the icon. The value cannot be null.

See Also:

SubstanceCortex.WindowScope.extendContentIntoTitlePane(Window, org.pushingpixels.substance.api.SubstanceSlices.HorizontalGravity, org.pushingpixels.substance.api.SubstanceSlices.VerticalGravity), getTitleTextHorizontalGravity(), SubstanceCortex.WindowScope.getTitleControlButtonGroupHorizontalGravity(Window), getTitleIconHorizontalGravity(), JFrame.setDefaultLookAndFeelDecorated(boolean), JDialog.setDefaultLookAndFeelDecorated(boolean)

getTitleTextHorizontalGravity

public static SubstanceSlices.HorizontalGravity getTitleTextHorizontalGravity()

Returns the gravity for the title text in title panes of all decorated application windows.

Returns:

HorizontalGravity for the title text in title panes of all decorated application windows.

See Also:

configureTitleContentGravity(SubstanceSlices.HorizontalGravity, SubstanceSlices.HorizontalGravity, SubstanceSlices.TitleIconHorizontalGravity), SubstanceCortex.WindowScope.getTitleControlButtonGroupHorizontalGravity(Window), getTitleIconHorizontalGravity()

getTitleIconHorizontalGravity

public static SubstanceSlices.TitleIconHorizontalGravity getTitleIconHorizontalGravity()

Returns the gravity for the icon in title panes of all decorated application windows.

Returns:

Horizontal gravity for the icon in title panes of all decorated application windows.

See Also:

configureTitleContentGravity(SubstanceSlices.HorizontalGravity, SubstanceSlices.HorizontalGravity, SubstanceSlices.TitleIconHorizontalGravity), SubstanceCortex.WindowScope.getTitleControlButtonGroupHorizontalGravity(Window), getTitleIconHorizontalGravity()

setWidgetVisible

public static void setWidgetVisible(boolean visible,
                                    SubstanceSlices.SubstanceWidgetType... substanceWidgets)

Sets the visibility of the specified widget kind(s). This call applies to all root panes. This method should not be called from inside the initialization sequence of your window. If the specific widget needs to be visible when the window is shown, wrap the call with SwingUtilities.invokeLater(Runnable).

Parameters:

visible - Visibility indication.

substanceWidgets - Widget types.

setLockIconVisible

public static void setLockIconVisible(java.lang.Boolean visible)

Specifies global visibility of the lock icon on non-editable text components.

Parameters:

visible - If true, all non-editable text components not explicitly configured with SubstanceCortex.ComponentScope.setLockIconVisible(JComponent, Boolean) will show a lock icon. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentScope.setLockIconVisible(JComponent, Boolean), setExtraWidgetsPresence(Boolean), SubstanceCortex.ComponentOrParentChainScope.setExtraWidgetsPresence(JComponent, Boolean)

setCapsLockIconVisible

public static void setCapsLockIconVisible(java.lang.Boolean visible)

Specifies global visibility of the caps lock icon on password fields. Note that this functionality may not be supported on all platforms. See Toolkit.getLockingKeyState(int) documentation for more.

Parameters:

visible - If true, all password fields not explicitly configured with SubstanceCortex.ComponentScope.setCapsLockIconVisible(JPasswordField, Boolean) will show an indicator icon when they are focused and caps lock is on. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentScope.setCapsLockIconVisible(JPasswordField, Boolean), setExtraWidgetsPresence(Boolean), SubstanceCortex.ComponentOrParentChainScope.setExtraWidgetsPresence(JComponent, Boolean)

setComponentPreviewPainter

public static void setComponentPreviewPainter(PreviewPainter previewPainter)

Specifies global preview painter to be used for showing preview thumbnails. Default implementation is available in the DefaultPreviewPainter.

Parameters:

previewPainter - Global preview painter. Can be null.

See Also:

SubstanceCortex.ComponentOrParentScope.setComponentPreviewPainter(JComponent, PreviewPainter)

setSelectTextOnFocus

public static void setSelectTextOnFocus(java.lang.Boolean selectTextOnFocus)

Specifies whether the contents of text components should be selected on focus gain.

Parameters:

selectTextOnFocus - If true, the contents of text components will be selected on focus gain. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentOrParentChainScope.setSelectTextOnFocus(JComponent, Boolean)

setTextEditContextMenuPresence

public static void setTextEditContextMenuPresence(java.lang.Boolean hasEditContextMenu)

Specifies whether text components should have the edit context menu (with Cut / Copy / Paste / ... menu items)

Parameters:

hasEditContextMenu - If true, text components will have the edit context menu (with Cut / Copy / Paste / ... menu items). Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentScope.setTextEditContextMenuPresence(JTextComponent, Boolean)

setAutomaticDragAndDropSupportPresence

public static void setAutomaticDragAndDropSupportPresence(java.lang.Boolean hasAutomaticDragAndDropSupport)

Specifies whether trees should have should have automatic drag and drop support.

Parameters:

hasAutomaticDragAndDropSupport - If true, trees will have automatic drag and drop support. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentScope.setAutomaticDragAndDropSupportPresence(JTree, Boolean)

setAutomaticScrollPresence

public static void setAutomaticScrollPresence(java.lang.Boolean hasAutomaticScroll)

Specifies whether scroll panes should have have auto-scroll support invoked on mouse button click that triggers popups.

Parameters:

hasAutomaticScroll - If true, scroll panes will have have auto-scroll support invoked on mouse button click that triggers popups. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentScope.setAutomaticScrollPresence(JScrollPane, Boolean), setExtraWidgetsPresence(Boolean), SubstanceCortex.ComponentOrParentChainScope.setExtraWidgetsPresence(JComponent, Boolean)

setButtonIgnoreMinimumSize

public static void setButtonIgnoreMinimumSize(java.lang.Boolean buttonIgnoreMinimumSize)

Specifies whether buttons should ignore the default (minimum) dimension. Note that SubstanceButtonShaper implementations are not required to respect this call. The current implementations of the default PillButtonShaper and ClassicButtonShaper respect this setting.

Parameters:

buttonIgnoreMinimumSize - If true, buttons will ignore the default (minimum) size under button shapers that respect this setting. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentOrParentScope.setButtonIgnoreMinimumSize(JComponent, Boolean)

setBackgroundAppearanceStrategy

public static void setBackgroundAppearanceStrategy(SubstanceSlices.BackgroundAppearanceStrategy backgroundAppearanceStrategy)

Specifies when components should draw their background.

Parameters:

backgroundAppearanceStrategy - Background appearance strategy. Pass null to reset to the default behavior (to ALWAYS)

See Also:

SubstanceCortex.ComponentOrParentScope.setBackgroundAppearanceStrategy(JComponent, BackgroundAppearanceStrategy)

setToolbarButtonCornerRadius

public static void setToolbarButtonCornerRadius(float toolbarButtonCornerRadius)

Specifies corner radius for all toolbar buttons.

Parameters:

toolbarButtonCornerRadius - Corner radius for all toolbar buttons.

See Also:

SubstanceCortex.ComponentScope.setToolbarButtonCornerRadius(AbstractButton, float), SubstanceCortex.ComponentOrParentChainScope.setToolbarButtonCornerRadius(JToolBar, float)

setExtraWidgetsPresence

public static void setExtraWidgetsPresence(java.lang.Boolean extraWidgetsPresence)

Specifies that extra UI elements (such as menu items in system menu or lock borders) should be shown.

Parameters:

extraWidgetsPresence - If true, extra UI elements (such as menu items in system menu or lock borders) will be shown. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.ComponentOrParentChainScope.setExtraWidgetsPresence(JComponent, Boolean)

setColorizationFactor

public static void setColorizationFactor(double colorizationFactor)

Specifies colorization amount applied to the background and foreground of the current color scheme and all control. By default, when the application does not use any custom colors, all the controls are painted with the colors of the current color scheme / skin. The colors coming from the look-and-feel implement the marker UIResource interface which allows the UI delegates to differentiate between application-specific colors which are not changed, and the LAF-provide colors that are changed on LAF switch.

Calling this method installs the "smart colorization" mode which uses the colors of the current color scheme and the custom background / foreground colors (when installed by application) to colorize the relevant portions of the control. For example, on checkbox the custom background color will be used to colorize the check box itself, while the custom foreground color will be applied to the check box text and the check mark.

Value of 0.0 of colorization amount results in Substance completely ignoring the custom application background and foreground colors set on the components - no colorization. Values closer to 1.0 result in almost full usage of the custom application background and foreground colors set on the components. Note that in order to maintain the gradients (fill, border, etc), even value of 1.0 does not result in full custom color being applied to the relevant visuals of the control.

Calling this method applies colorization amount to all components that do not specify a custom value with SubstanceCortex.ComponentOrParentChainScope.setColorizationFactor(JComponent, double) calls.

The default colorization amount (when this method is not called at all) is 0.5. This means that applications that install custom background / foreground colors on their UI controls will see them colorized with 50% "strength", even without calling this method.

Parameters:

colorizationFactor - Colorization factor to apply to the component and its nested children.

See Also:

SubstanceCortex.ComponentOrParentChainScope.setColorizationFactor(JComponent, double)

setTabCloseButtonsVisible

public static void setTabCloseButtonsVisible(java.lang.Boolean tabCloseButtonsVisible)

Configures visibility of close buttons on tabbed pane tabs.

Parameters:

tabCloseButtonsVisible - If true, tabs in tabbed panes will show close buttons.

See Also:

SubstanceCortex.ComponentScope.setTabCloseButtonVisible(JComponent, Boolean), SubstanceCortex.ComponentScope.setTabCloseButtonsVisible(JTabbedPane, Boolean)

setTabCloseCallback

public static void setTabCloseCallback(TabCloseCallback tabCloseCallback)

Configures the callback for deciding on the tab close type on tabbed pane tabs. Note that this is only relevant for tabs configured with SubstanceCortex.ComponentScope.setTabCloseButtonVisible(JComponent, Boolean), SubstanceCortex.ComponentScope.setTabCloseButtonsVisible(JTabbedPane, Boolean) and setTabCloseButtonsVisible(Boolean) APIs.

Parameters:

tabCloseCallback - Callback for deciding on the tab close type on tabbed pane tabs.

See Also:

SubstanceCortex.ComponentScope.setTabCloseCallback(JComponent, TabCloseCallback), SubstanceCortex.ComponentScope.setTabCloseCallback(JTabbedPane, TabCloseCallback)

setRunModifiedAnimationOnTabCloseButton

public static void setRunModifiedAnimationOnTabCloseButton(java.lang.Boolean runModifiedAnimationOnTabCloseButton)

Specifies that only the close button of a marked-as-modified tab component should pulsate. By default, the animation on modified tabs is on the entire tab rectangle. Note that this is only relevant for tabs configured with SubstanceCortex.ComponentScope.setTabContentsModified(JComponent, Boolean)

Parameters:

runModifiedAnimationOnTabCloseButton - If true, the marked-as-modified animation will run only on the tab close button.

See Also:

SubstanceCortex.ComponentScope.setRunModifiedAnimationOnTabCloseButton(JTabbedPane, Boolean), SubstanceCortex.ComponentScope.setRunModifiedAnimationOnTabCloseButton(JComponent, Boolean)

setTabContentPaneBorderKind

public static void setTabContentPaneBorderKind(SubstanceSlices.TabContentPaneBorderKind tabContentPaneBorderKind)

Specifies the content pane border kind for tabbed panes.

Parameters:

tabContentPaneBorderKind - Content pane border kind for tabbed panes.

See Also:

SubstanceCortex.ComponentScope.setTabContentPaneBorderKind(JTabbedPane, SubstanceSlices.TabContentPaneBorderKind)

setNumberOfPasswordEchoesPerCharacter

public static void setNumberOfPasswordEchoesPerCharacter(int echoCount)

Specifies the number of echo characters for each password character in password fields.

Parameters:

echoCount - Number of echo characters for each password character in password fields.

See Also:

SubstanceCortex.ComponentScope.setNumberOfPasswordEchoesPerCharacter(JPasswordField, int)

setMenuGutterFillAlpha

public static void setMenuGutterFillAlpha(float menuGutterFillAlpha)

Specifies the menu gutter fill alpha. Menu gutter is the part of the menu where checkmarks and icons are painted. The current / default menu gutter fill alpha can be obtained by calling getMenuGutterFillAlpha().

Parameters:

menuGutterFillAlpha - Menu gutter fill alpha.

See Also:

getMenuGutterFillAlpha()

getMenuGutterFillAlpha

public static float getMenuGutterFillAlpha()

Returns the menu gutter fill alpha. Menu gutter is the part of the menu where checkmarks and icons are painted.

Returns:

Menu gutter fill alpha.

See Also:

setMenuGutterFillAlpha(float)

setTraceFilename

public static void setTraceFilename(java.lang.String traceFilename)

Specifies the trace filename. The trace file will contain output of the memory analyser which can be used to pinpoint the memory leaks.

Parameters:

traceFilename - Filename for tracing the memory allocations.

setFocusKind

public static void setFocusKind(SubstanceSlices.FocusKind focusKind)

Specifies the kind of focus indication to be used on application components.

Parameters:

focusKind - Kind of focus indication to be used on application components.

See Also:

SubstanceCortex.ComponentOrParentChainScope.setFocusKind(JComponent, SubstanceSlices.FocusKind)

setComboBoxPrototypeCallback

public static void setComboBoxPrototypeCallback(ComboPopupPrototypeCallback comboPopupPrototypeCallback)

Specifies the combobox popup prototype callback which is used to compute the width of the popups at runtime.

Parameters:

comboPopupPrototypeCallback - Popup prototype callback which is used to compute the width of the popups at runtime.

See Also:

SubstanceCortex.ComponentScope.setComboBoxPrototypeCallback(JComboBox, ComboPopupPrototypeCallback)

setComboBoxPrototypeDisplayValue

public static void setComboBoxPrototypeDisplayValue(java.lang.Object comboPopupPrototypeDisplayValue)

Specifies the combobox popup prototype display value which is used to compute the width of the popups at runtime.

Parameters:

comboPopupPrototypeDisplayValue - Popup prototype display value which is used to compute the width of the popups at runtime.

See Also:

SubstanceCortex.ComponentScope.setComboBoxPrototypeDisplayValue(JComboBox, Object), setComboBoxPrototypeCallback(ComboPopupPrototypeCallback)

setComboBoxPopupFlyoutOrientation

public static void setComboBoxPopupFlyoutOrientation(int comboPopupFlyoutOrientation)

Specifies the combobox popup flyout orientation. The value should be either null to reset to the default flyout orientation or one of the Integers below:

• The default SwingConstants.SOUTH - the popup is displayed directly below the combobox aligned to the left.
• SwingConstants.NORTH - the popup is displayed directly above the combobox aligned to the left.
• SwingConstants.EAST - the popup is displayed to the left of the combobox aligned to the top.
• SwingConstants.WEST - the popup is displayed to the right of the combobox aligned to the top.
• SwingConstants.CENTER - the popup is displayed centered vertically over the combobox aligned to the left.

Note that the combo arrow changes in accordance with the combo popup flyout orientation.

Parameters:

comboPopupFlyoutOrientation - Flyout orientation for combobox popups.

See Also:

SubstanceCortex.ComponentScope.setComboBoxPopupFlyoutOrientation(JComboBox, Integer)

getBlankImage

public static java.awt.image.BufferedImage getBlankImage(double scaleFactor,
                                                         int width,
                                                         int height)

colorizeIcon

public static org.pushingpixels.neon.api.icon.ResizableIcon colorizeIcon(org.pushingpixels.neon.api.icon.ResizableIcon.Factory sourceFactory,
                                                                         SubstanceColorScheme colorScheme,
                                                                         float brightnessFactor)

Returns the colorized version of icon based off of the passed icon factory.

Parameters:

sourceFactory - Source factory to be used to create the icon.

colorScheme - Color scheme for colorization.

brightnessFactor - Brightness factor for colorization.

Returns:

The colorized version of the icon.

See Also:

NeonCortex.colorizeIcon(ResizableIcon.Factory, Color), NeonCortex.colorizeIcon(ResizableIcon.Factory, Color, float)

colorizeIconAsUiResource

public static org.pushingpixels.neon.api.icon.ResizableIconUIResource colorizeIconAsUiResource(org.pushingpixels.neon.api.icon.ResizableIcon.Factory sourceFactory,
                                                                                               SubstanceColorScheme colorScheme,
                                                                                               float brightnessFactor)

Returns the colorized version of icon based off of the passed icon factory. The returned icon also implements the marker UIResource interface.

Parameters:

sourceFactory - Source factory to be used to create the icon.

colorScheme - Color scheme for colorization.

brightnessFactor - Brightness factor for colorization.

Returns:

The colorized version of the icon.

See Also:

NeonCortex.colorizeIconAsUiResource(ResizableIcon.Factory, Color), NeonCortex.colorizeIconAsUiResource(ResizableIcon.Factory, Color, float)

colorizeIconAsUiResource

public static org.pushingpixels.neon.api.icon.ResizableIconUIResource colorizeIconAsUiResource(org.pushingpixels.neon.api.icon.ResizableIcon.Factory sourceFactory,
                                                                                               SubstanceColorScheme colorScheme)

Returns the colorized version of icon based off of the passed icon factory. The returned icon also implements the marker UIResource interface.

Parameters:

sourceFactory - Source factory to be used to create the icon.

colorScheme - Color scheme for colorization.

Returns:

The colorized version of the icon.

See Also:

NeonCortex.colorizeIconAsUiResource(ResizableIcon.Factory, Color), NeonCortex.colorizeIconAsUiResource(ResizableIcon.Factory, Color, float)

setUseDefaultColorChooser

public static void setUseDefaultColorChooser()