Package org.pushingpixels.substance.api

Class SubstanceCortex.ComponentScope

java.lang.Object

org.pushingpixels.substance.api.SubstanceCortex.ComponentScope

Enclosing class:

SubstanceCortex

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

APIs in this scope apply to individual application Components.

Constructor Summary

Constructors

Constructor	Description
ComponentScope()

Method Summary

Modifier and Type	Method	Description
static void	allowAnimations(java.awt.Component comp, SubstanceSlices.AnimationFacet animationFacet)	Allows animations of the specified facet on the specified control.
static void	disallowAnimations(java.awt.Component comp, SubstanceSlices.AnimationFacet animationFacet)	Disallows animations of the specified facet on the specified control.
static java.util.Set<BaseTabCloseListener>	getAllTabCloseListeners(javax.swing.JTabbedPane tabbedPane)	Returns all listeners registered on tab closing of the specified tabbed pane.
static SubstanceSkin	getCurrentSkin(java.awt.Component c)	Returns the current skin for the specified component.
static SubstanceSlices.DecorationAreaType	getImmediateDecorationType(java.awt.Component comp)	Returns the immediate decoration area type of the specified component.
static boolean	isAnimationAllowed(java.awt.Component comp, SubstanceSlices.AnimationFacet animationFacet)	Checks whether the specified animation facet is allowed on the specified component.
static void	registerTabCloseChangeListener(javax.swing.JTabbedPane tabbedPane, BaseTabCloseListener tabCloseListener)	Registers the specified listener on tab-close events on the specified tabbed pane.
static void	setAutomaticDragAndDropSupportPresence(javax.swing.JTree tree, java.lang.Boolean hasAutomaticDragAndDropSupport)	Specifies whether the tree should have automatic drag and drop support.
static void	setAutomaticScrollPresence(javax.swing.JScrollPane scrollPane, java.lang.Boolean hasAutomaticScroll)	Specifies whether the scroll pane should have have auto-scroll support invoked on mouse button click that triggers popups.
static void	setButtonOpenSide(javax.swing.JComponent comp, SubstanceSlices.Side openSide)	Specifies the open side for the specific button component.
static void	setButtonOpenSides(javax.swing.JComponent comp, java.util.Set<SubstanceSlices.Side> openSides)	Specifies the open sides for the specific button component.
static void	setButtonShaper(javax.swing.JComponent comp, SubstanceButtonShaper buttonShaper)	Specifies the button shaper to be used for the specific component.
static void	setButtonStraightSide(javax.swing.JComponent comp, SubstanceSlices.Side straightSide)	Specifies the straight side for the specific button component.
static void	setButtonStraightSides(javax.swing.JComponent comp, java.util.Set<SubstanceSlices.Side> straightSides)	Specifies the straight sides for the specific button component.
static void	setComboBoxPopupFlyoutOrientation(javax.swing.JComboBox comboBox, java.lang.Integer comboPopupFlyoutOrientation)	Specifies the combobox popup flyout orientation.
static void	setComboBoxPrototypeCallback(javax.swing.JComboBox comboBox, ComboPopupPrototypeCallback comboPopupPrototypeCallback)	Specifies the combobox popup prototype callback which is used to compute the width of the popup at runtime.
static void	setComboBoxPrototypeDisplayValue(javax.swing.JComboBox comboBox, java.lang.Object comboPopupPrototypeDisplayValue)	Specifies the combobox popup prototype display value which is used to compute the width of the popup at runtime.
static void	setFlipTextSelectionOnEscape(javax.swing.text.JTextComponent comp, java.lang.Boolean flipTextSelectionOnEscape)	Specifies whether the text component contents should flip selection on ESCAPE key press.
static void	setLockIconVisible(javax.swing.JComponent comp, java.lang.Boolean visible)	Specifies component-level visibility of the lock icon on the specific component.
static void	setNumberOfPasswordEchoesPerCharacter(javax.swing.JPasswordField passwordField, int echoCount)	Specifies the number of echo characters for each password character in the specific password field.
static void	setPasswordStrengthChecker(javax.swing.JPasswordField passwordField, PasswordStrengthChecker passwordStrengthChecker)	Specifies password strength checker for the specific password field.
static void	setRunModifiedAnimationOnTabCloseButton(javax.swing.JComponent tabComponent, java.lang.Boolean runModifiedAnimationOnTabCloseButton)	Specifies that only the close button of a marked-as-modified tab component should pulsate.
static void	setRunModifiedAnimationOnTabCloseButton(javax.swing.JTabbedPane tabbedPane, java.lang.Boolean runModifiedAnimationOnTabCloseButton)	Specifies that only the close button of a marked-as-modified tab components should pulsate.
static void	setTabCloseButtonsVisible(javax.swing.JTabbedPane tabbedPane, java.lang.Boolean tabCloseButtonsVisible)	Configures visibility of close buttons on all tabs in the specified tabbed pane.
static void	setTabCloseButtonVisible(javax.swing.JComponent tabComponent, java.lang.Boolean tabCloseButtonVisible)	Configures visibility of close button on the specified tab component.
static void	setTabCloseCallback(javax.swing.JComponent tabComponent, TabCloseCallback tabCloseCallback)	Configures the callback for deciding on the tab close type on the specified tab component.
static void	setTabCloseCallback(javax.swing.JTabbedPane tabbedPane, TabCloseCallback tabCloseCallback)	Configures the callback for deciding on the tab close type on all tabs in the specified tabbed pane.
static void	setTabContentPaneBorderKind(javax.swing.JTabbedPane tabbedPane, SubstanceSlices.TabContentPaneBorderKind tabContentPaneBorderKind)	Specifies the content pane border kind for the specified tabbed pane.
static void	setTabContentsModified(javax.swing.JComponent tabComponent, java.lang.Boolean contentsModified)	Specifies that contents of a tab component in JTabbedPane have been modified and not saved.
static void	setTextEditContextMenuPresence(javax.swing.text.JTextComponent comp, java.lang.Boolean hasEditContextMenu)	Specifies whether the text component should have the edit context menu (with Cut / Copy / Paste / ...
static void	setToolbarButtonCornerRadius(javax.swing.AbstractButton button, float toolbarButtonCornerRadius)	Specifies corner radius for the specific button.
static void	unregisterTabCloseChangeListener(javax.swing.JTabbedPane tabbedPane, BaseTabCloseListener tabCloseListener)	Unregisters the specified listener on tab-close events on the specified tabbed pane.

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentScope

public ComponentScope()

Method Detail

getCurrentSkin

public static SubstanceSkin getCurrentSkin(java.awt.Component c)

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

Parameters:

c - Component. May be null - in this case the global current Substance skin will be returned.

Returns:

Current skin for the specified component.

See Also:

SubstanceCortex.GlobalScope.getCurrentSkin()

registerTabCloseChangeListener

public static void registerTabCloseChangeListener(javax.swing.JTabbedPane tabbedPane,
                                                  BaseTabCloseListener tabCloseListener)

Registers the specified listener on tab-close events on the specified tabbed pane.

Parameters:

tabbedPane - Tabbed pane. Must be not null.

tabCloseListener - Listener to register.

See Also:

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

unregisterTabCloseChangeListener

public static void unregisterTabCloseChangeListener(javax.swing.JTabbedPane tabbedPane,
                                                    BaseTabCloseListener tabCloseListener)

Unregisters the specified listener on tab-close events on the specified tabbed pane.

Parameters:

tabbedPane - Tabbed pane. Must be not null.

tabCloseListener - Listener to unregister.

See Also:

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

getAllTabCloseListeners

public static java.util.Set<BaseTabCloseListener> getAllTabCloseListeners(javax.swing.JTabbedPane tabbedPane)

Returns all listeners registered on tab closing of the specified tabbed pane.

Parameters:

tabbedPane - A tabbed pane. Must be not null.

Returns:

All listeners registered on tab closing of the specified tabbed pane.

See Also:

registerTabCloseChangeListener(JTabbedPane, BaseTabCloseListener), unregisterTabCloseChangeListener(JTabbedPane, BaseTabCloseListener)

allowAnimations

public static void allowAnimations(java.awt.Component comp,
                                   SubstanceSlices.AnimationFacet animationFacet)

Allows animations of the specified facet on the specified control.

Parameters:

animationFacet - Animation facet to allow.

comp - Control for allowing the animation facet.

disallowAnimations

public static void disallowAnimations(java.awt.Component comp,
                                      SubstanceSlices.AnimationFacet animationFacet)

Disallows animations of the specified facet on the specified control.

Parameters:

animationFacet - Animation facet to disallow.

comp - Control for disallowing the animation facet.

isAnimationAllowed

public static boolean isAnimationAllowed(java.awt.Component comp,
                                         SubstanceSlices.AnimationFacet animationFacet)

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

Parameters:

animationFacet - Animation facet.

comp - Component.

Returns:

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

getImmediateDecorationType

public static SubstanceSlices.DecorationAreaType getImmediateDecorationType(java.awt.Component comp)

Returns the immediate decoration area type of the specified component. The component is checked for the registered decoration area type. If SubstanceCortex.ComponentOrParentChainScope.setDecorationType(JComponent, SubstanceSlices.DecorationAreaType) was not called on this component, this method returns null.

Parameters:

comp - Component.

Returns:

Immediate decoration area type of the component.

See Also:

SubstanceCortex.ComponentOrParentChainScope.setDecorationType(JComponent, SubstanceSlices.DecorationAreaType), SubstanceCortex.ComponentOrParentChainScope.getDecorationType(Component)

setLockIconVisible

public static void setLockIconVisible(javax.swing.JComponent comp,
                                      java.lang.Boolean visible)

Specifies component-level visibility of the lock icon on the specific component.

Parameters:

comp - Component.

visible - If true, the specific text component will show a lock icon when it is in non-editable mode. Pass null to reset to the default behavior.

See Also:

SubstanceCortex.GlobalScope.setLockIconVisible(Boolean)

setPasswordStrengthChecker

public static void setPasswordStrengthChecker(javax.swing.JPasswordField passwordField,
                                              PasswordStrengthChecker passwordStrengthChecker)

Specifies password strength checker for the specific password field.

Parameters:

passwordField - Password field.

passwordStrengthChecker - Password strength checker

setFlipTextSelectionOnEscape

public static void setFlipTextSelectionOnEscape(javax.swing.text.JTextComponent comp,
                                                java.lang.Boolean flipTextSelectionOnEscape)

Specifies whether the text component contents should flip selection on ESCAPE key press.

Parameters:

comp - Text component.

flipTextSelectionOnEscape - If true, the contents of the specified text component will flip selection on ESCAPE key press. Pass null to reset to the default behavior.

setTextEditContextMenuPresence

public static void setTextEditContextMenuPresence(javax.swing.text.JTextComponent comp,
                                                  java.lang.Boolean hasEditContextMenu)

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

Parameters:

comp - Text component.

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

See Also:

SubstanceCortex.GlobalScope.setTextEditContextMenuPresence(Boolean)

setAutomaticDragAndDropSupportPresence

public static void setAutomaticDragAndDropSupportPresence(javax.swing.JTree tree,
                                                          java.lang.Boolean hasAutomaticDragAndDropSupport)

Specifies whether the tree should have automatic drag and drop support.

Parameters:

tree - Tree component.

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

See Also:

SubstanceCortex.GlobalScope.setAutomaticDragAndDropSupportPresence(Boolean)

setAutomaticScrollPresence

public static void setAutomaticScrollPresence(javax.swing.JScrollPane scrollPane,
                                              java.lang.Boolean hasAutomaticScroll)

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

Parameters:

scrollPane - Scroll pane component.

hasAutomaticScroll - If true, the scroll pane 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.GlobalScope.setAutomaticScrollPresence(Boolean)

setButtonOpenSide

public static void setButtonOpenSide(javax.swing.JComponent comp,
                                     SubstanceSlices.Side openSide)

Specifies the open side for the specific button component. Note that the SubstanceButtonShaper implementations are not required to respect this call. The default StandardButtonShaper and ClassicButtonShaper respect this call.

Parameters:

comp - Component.

openSide - Open side.

See Also:

setButtonOpenSides(JComponent, Set), setButtonStraightSide(JComponent, org.pushingpixels.substance.api.SubstanceSlices.Side)

setButtonOpenSides

public static void setButtonOpenSides(javax.swing.JComponent comp,
                                      java.util.Set<SubstanceSlices.Side> openSides)

Specifies the open sides for the specific button component. Note that the SubstanceButtonShaper implementations are not required to respect this call. The default StandardButtonShaper and ClassicButtonShaper respect this call.

Parameters:

comp - Component.

openSides - Open sides.

See Also:

setButtonOpenSide(JComponent, org.pushingpixels.substance.api.SubstanceSlices.Side), setButtonStraightSides(JComponent, Set)

setButtonStraightSide

public static void setButtonStraightSide(javax.swing.JComponent comp,
                                         SubstanceSlices.Side straightSide)

Specifies the straight side for the specific button component. Note that the SubstanceButtonShaper implementations are not required to respect this call. The default StandardButtonShaper and ClassicButtonShaper respect this call.

Parameters:

comp - Component.

straightSide - Straight side.

See Also:

setButtonOpenSide(JComponent, org.pushingpixels.substance.api.SubstanceSlices.Side), setButtonStraightSides(JComponent, Set)

setButtonStraightSides

public static void setButtonStraightSides(javax.swing.JComponent comp,
                                          java.util.Set<SubstanceSlices.Side> straightSides)

Specifies the straight sides for the specific button component. Note that the SubstanceButtonShaper implementations are not required to respect this call. The default StandardButtonShaper and ClassicButtonShaper respect this call.

Parameters:

comp - Component.

straightSides - Straight sides.

See Also:

setButtonStraightSide(JComponent, org.pushingpixels.substance.api.SubstanceSlices.Side), setButtonOpenSides(JComponent, Set)

setToolbarButtonCornerRadius

public static void setToolbarButtonCornerRadius(javax.swing.AbstractButton button,
                                                float toolbarButtonCornerRadius)

Specifies corner radius for the specific button. Note that this only applies when the button is in a JToolBar.

Parameters:

button - Button.

toolbarButtonCornerRadius - Corner radius for the button when it is in a JToolBar.

See Also:

SubstanceCortex.ComponentOrParentChainScope.setToolbarButtonCornerRadius(JToolBar, float), SubstanceCortex.GlobalScope.setToolbarButtonCornerRadius(float)

setTabContentsModified

public static void setTabContentsModified(javax.swing.JComponent tabComponent,
                                          java.lang.Boolean contentsModified)

Specifies that contents of a tab component in JTabbedPane have been modified and not saved. setRunModifiedAnimationOnTabCloseButton(JComponent, Boolean), setRunModifiedAnimationOnTabCloseButton(JTabbedPane, Boolean) and SubstanceCortex.GlobalScope.setRunModifiedAnimationOnTabCloseButton(Boolean) APIs control whether the entire tab or its close button area is animated.

The animation cycles between red, orange and yellow color schemes. In most cases (all but tabs not marked with setRunModifiedAnimationOnTabCloseButton(JComponent, Boolean), setRunModifiedAnimationOnTabCloseButton(JTabbedPane, Boolean) and SubstanceCortex.GlobalScope.setRunModifiedAnimationOnTabCloseButton(Boolean) APIs), the animation will be visible only when the mouse hovers over the close button of the tab. The tooltip of the close button is changed as well to reflect that the container contents are marked as modified.

Parameters:

tabComponent - Tab component.

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

See Also:

SubstanceCortex.RootPaneScope.setContentsModified(JRootPane, Boolean)

setTabCloseButtonsVisible

public static void setTabCloseButtonsVisible(javax.swing.JTabbedPane tabbedPane,
                                             java.lang.Boolean tabCloseButtonsVisible)

Configures visibility of close buttons on all tabs in the specified tabbed pane.

Parameters:

tabbedPane - Tabbed pane.

tabCloseButtonsVisible - If true, all tabs in the tabbed pane will show close buttons.

See Also:

setTabCloseButtonVisible(JComponent, Boolean), SubstanceCortex.GlobalScope.setTabCloseButtonsVisible(Boolean)

setTabCloseButtonVisible

public static void setTabCloseButtonVisible(javax.swing.JComponent tabComponent,
                                            java.lang.Boolean tabCloseButtonVisible)

Configures visibility of close button on the specified tab component.

Parameters:

tabComponent - Tab component.

tabCloseButtonVisible - If true, the tab will show close button.

See Also:

setTabCloseButtonsVisible(JTabbedPane, Boolean), SubstanceCortex.GlobalScope.setTabCloseButtonsVisible(Boolean)

setTabCloseCallback

public static void setTabCloseCallback(javax.swing.JTabbedPane tabbedPane,
                                       TabCloseCallback tabCloseCallback)

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

Parameters:

tabbedPane - Tabbed pane.

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

See Also:

setTabCloseCallback(JComponent, TabCloseCallback), SubstanceCortex.GlobalScope.setTabCloseCallback(TabCloseCallback)

setTabCloseCallback

public static void setTabCloseCallback(javax.swing.JComponent tabComponent,
                                       TabCloseCallback tabCloseCallback)

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

Parameters:

tabComponent - Tab component.

tabCloseCallback - Callback for deciding on the tab close type on the tab component.

See Also:

setTabCloseCallback(JTabbedPane, TabCloseCallback), SubstanceCortex.GlobalScope.setTabCloseCallback(TabCloseCallback)

setRunModifiedAnimationOnTabCloseButton

public static void setRunModifiedAnimationOnTabCloseButton(javax.swing.JTabbedPane tabbedPane,
                                                           java.lang.Boolean runModifiedAnimationOnTabCloseButton)

Specifies that only the close button of a marked-as-modified tab components 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 setTabContentsModified(JComponent, Boolean).

Parameters:

tabbedPane - Tabbed pane.

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

See Also:

setRunModifiedAnimationOnTabCloseButton(JComponent, Boolean), SubstanceCortex.GlobalScope.setRunModifiedAnimationOnTabCloseButton(Boolean)

setRunModifiedAnimationOnTabCloseButton

public static void setRunModifiedAnimationOnTabCloseButton(javax.swing.JComponent tabComponent,
                                                           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 setTabContentsModified(JComponent, Boolean).

Parameters:

tabComponent - Tab component.

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

See Also:

setRunModifiedAnimationOnTabCloseButton(JTabbedPane, Boolean), SubstanceCortex.GlobalScope.setRunModifiedAnimationOnTabCloseButton(Boolean)

setTabContentPaneBorderKind

public static void setTabContentPaneBorderKind(javax.swing.JTabbedPane tabbedPane,
                                               SubstanceSlices.TabContentPaneBorderKind tabContentPaneBorderKind)

Specifies the content pane border kind for the specified tabbed pane.

Parameters:

tabbedPane - Tabbed pane.

tabContentPaneBorderKind - Content pane border kind for the specified tabbed pane.

See Also:

SubstanceCortex.GlobalScope.setTabContentPaneBorderKind(SubstanceSlices.TabContentPaneBorderKind)

setButtonShaper

public static void setButtonShaper(javax.swing.JComponent comp,
                                   SubstanceButtonShaper buttonShaper)

Specifies the button shaper to be used for the specific component.

Parameters:

comp - Component.

buttonShaper - Button shaper to be used for the component.

setNumberOfPasswordEchoesPerCharacter

public static void setNumberOfPasswordEchoesPerCharacter(javax.swing.JPasswordField passwordField,
                                                         int echoCount)

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

Parameters:

passwordField - Password field.

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

See Also:

SubstanceCortex.GlobalScope.setNumberOfPasswordEchoesPerCharacter(int)

setComboBoxPrototypeCallback

public static void setComboBoxPrototypeCallback(javax.swing.JComboBox comboBox,
                                                ComboPopupPrototypeCallback comboPopupPrototypeCallback)

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

Parameters:

comboBox - Combobox.

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

See Also:

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

setComboBoxPrototypeDisplayValue

public static void setComboBoxPrototypeDisplayValue(javax.swing.JComboBox comboBox,
                                                    java.lang.Object comboPopupPrototypeDisplayValue)

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

Parameters:

comboBox - Combobox.

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

See Also:

setComboBoxPrototypeCallback(JComboBox, ComboPopupPrototypeCallback), SubstanceCortex.GlobalScope.setComboBoxPrototypeCallback(ComboPopupPrototypeCallback)

setComboBoxPopupFlyoutOrientation

public static void setComboBoxPopupFlyoutOrientation(javax.swing.JComboBox comboBox,
                                                     java.lang.Integer 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:

comboBox - Combobox.

comboPopupFlyoutOrientation - Flyout orientation for combobox popup.

See Also:

SubstanceCortex.GlobalScope.setComboBoxPopupFlyoutOrientation(int)