Class SubstanceCoreUtilities
java.lang.Object
org.pushingpixels.substance.internal.utils.SubstanceCoreUtilities
Various utility functions. This class is for internal use only.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionstatic BufferedImage
blendImagesHorizontal
(BufferedImage imageLeft, BufferedImage imageRight, double start, double end) Blends two images along X-axis.static BufferedImage
blendImagesVertical
(BufferedImage imageTop, BufferedImage imageBottom, double start, double end) Blends two images along Y-axis.static boolean
canReplaceChildBackgroundColor
(Color background) static String
clipString
(FontMetrics metrics, int availableWidth, String fullText) Clips string based on specified font metrics and available width (in pixels).static BufferedImage
Creates a compatible image (for efficient processing and drawing).static Icon
getArrowIcon
(AbstractButton button, int orientation) Returns the arrow icon.static Icon
getArrowIcon
(JComponent comp, TransitionAwareIcon.TransitionAwareUIDelegate transitionAwareUIDelegate, int orientation) Returns the arrow icon.static BufferedImage
getBlankImage
(int width, int height) Retrieves transparent image of specified dimension.static VolatileImage
getBlankVolatileImage
(int width, int height) Retrieves transparent image of specified dimension.static SubstanceBorderPainter
getBorderPainter
(Component comp) Returns the border painter for the specified component.static SubstanceButtonShaper
getButtonShaper
(Component comp) Returns the button shaper of the specified button.static ClassLoader
Returns the class loader for loading the resource files.static int
getCloseButtonSize
(JTabbedPane tabbedPane, int tabIndex) Returns the size of the close button for a tab in the specified tabbed pane.static double
Returns the colorization factor for the specified component.static Object
Returns the popup prototype display value for the specified combo box.getContentBorderKind
(JTabbedPane tabbedPane) Returns the content border kind of the specified tabbed pane.static int
Returns the number of echo characters per each password chanaracter.static SubstanceFillPainter
getFillPainter
(Component comp) Returns the fill painter of the specified component.static SubstanceConstants.FocusKind
getFocusKind
(Component component) Returns the focus ring kind of the specified component.static HashMapKey
getHashKey
(Object... objects) Returns a hash key for the specified parameters.static Container
Given a component, returns the parent for computing theSubstanceDecorationPainter
.static String
getHierarchy
(Component comp) Returns the component hierarchy.static void
getHierarchy
(Component comp, StringBuffer buffer, int level) Computes the component hierarchy.static SubstanceBorderPainter
Returns the highlight border painter for the specified component.static Icon
Returns an icon pointed to by the specified string.Returns the global menu gutter fill kind.static SubstanceColorScheme
getOptionPaneColorScheme
(int messageType, SubstanceColorScheme mainScheme) Returns the color scheme for the icon of option panes with the specified message type.static Icon
getOriginalIcon
(AbstractButton b, Icon defaultIcon) static int
getPopupFlyoutOrientation
(JComboBox combobox) Returns the popup flyout orientation for the specified combobox.static int
getPopupParentIndexOf
(Component comp, Component[] popups) Gets a component and a list of popups and returns the index of the popup that is a parent of the specified component.static ResourceBundle
getResourceBundle
(JComponent jcomp) Returns the resource bundle for the specified component.static BufferedImage
getScaledIconImage
(List<Image> imageList, int width, int height) ScansimageList
for best-looking image of specified dimensions.getScrollPaneButtonsPolicyKind
(JScrollBar scrollBar) Returns the scroll bar buttons kind of the specified scroll bar.static Set<SubstanceConstants.Side>
getSides
(JComponent component, String propertyName) Returns the set of sides registered on the specified button.static SubstanceSkin
Returns the skin of the specified component.static TabCloseCallback
getTabCloseCallback
(MouseEvent me, JTabbedPane tabbedPane, int tabIndex) Returns the callback to be called upon tab closing (using the tab close button).static JTextComponent
static org.pushingpixels.trident.swing.SwingRepaintCallback
getTextComponentRepaintCallback
(JTextComponent textComponent) static Icon
getThemedIcon
(Component comp, Icon orig) static Icon
getThemedIcon
(JTabbedPane tab, int tabIndex, Icon orig) static JComponent
getTitlePane
(JRootPane rootPane) Returns the title pane of the specified root pane.static float
getToolbarButtonCornerRadius
(JComponent button, Insets insets) Returns the corner radius of the specified toolbar button.static String
getVmParameter
(String parameterName) Retrieves a single parameter from the VM flags.static boolean
hasCloseButton
(JTabbedPane tabbedPane, int tabIndex) Checks whether the specified tab has a close button.static boolean
hasFlatAppearance
(Component comp, boolean defaultValue) Checks whether the specified component is flat.static boolean
hasFlatAppearance
(AbstractButton button) Computes whether the specified button has flat appearance.static boolean
hasIcon
(AbstractButton button) Checks whether the specified button has associated icon.static boolean
hasNoMinSizeProperty
(AbstractButton button) Checks whether the specified button should have minimal size.static boolean
hasText
(AbstractButton button) Checks whether the specified button has associated text.static boolean
isButtonNeverPainted
(JComponent button) Checks whether the specified button never paints its background.static boolean
isComboBoxButton
(AbstractButton button) Checks and answers if the specified button is in a combo box.static boolean
static boolean
isInternalFrameModified
(JInternalFrame internalFrame) Retrieves themodified
state for the specified internal frame.static boolean
static boolean
static boolean
static boolean
isRootPaneModified
(JRootPane rootPane) Retrieves themodified
state for the specified root pane.static boolean
static boolean
isScrollBarButton
(AbstractButton button) Checks and answers if the specified button is in a scroll bar.static boolean
isScrollButton
(JComponent comp) Checks answers if the specified component is a button in a scroll control, such as scroll bar or tabbed pane (as tab scroller).static boolean
static boolean
isSpinnerButton
(AbstractButton button) Checks and answers if the specified button is in a spinner.static boolean
isTabModified
(Component tabComponent) Retrieves themodified
state for the specified component in a tabbed pane.static boolean
Returns indication whether the specified button is a close button on some title pane.static boolean
isToolBarButton
(JComponent component) Checks and answers if the specified button is in a toolbar.static void
makeNonOpaque
(Component comp, Map<Component, Boolean> opacitySnapshot) Makes the specified component and all its descendants non-opaque.static void
paintFocus
(Graphics g, Component mainComp, Component focusedComp, TransitionAwareUI transitionAwareUI, Shape focusShape, Rectangle textRect, float maxAlphaCoef, int extraPadding) Paints the focus ring on the specified component.static boolean
static boolean
static void
restoreOpaque
(Component comp, Map<Component, Boolean> opacitySnapshot) Restores the opacity of the specified component and all its descendants.static BufferedImage
softClip
(int width, int height, BufferedImage source, Shape clipShape) Creates a soft-clipped image.static void
Stops all Substance threads.static void
Tests UI threading violations on creating the specified component.static void
Tests UI threading violations on changing the state the specified component.static void
Tests UI threading violations on closing the specified window.static boolean
toAnimateCloseIconOfModifiedTab
(JTabbedPane tabbedPane, int tabIndex) Checks whether the specified tab should show modified animation only on its close button.static boolean
toDrawWatermark
(Component component) Returns indication whether the watermark should be drawn on the specified component.static boolean
toShowExtraWidgets
(Component component) Checks whether the specified component has extra Substance-specific UI elements.static void
traceSubstanceApiUsage
(Component comp, String message) static void
uninstallMenu
(JMenuItem menuItem) Uninstalls the specified menu item.static boolean
Checks whether the specified component will show scheme-colorized icon in the default state.
-
Field Details
-
IS_COVERED_BY_LIGHTWEIGHT_POPUPS
Client property name for marking components covered by lightweight popups. This is tracking the fix for issue 297. The client property value should be an instance ofBoolean
.- See Also:
-
TEXT_COMPONENT_AWARE
- See Also:
-
reallyThrow
public static final boolean reallyThrow -
reallyPrint
public static final boolean reallyPrint
-
-
Method Details
-
clipString
Clips string based on specified font metrics and available width (in pixels). Returns the clipped string, which contains the beginning and the end of the input string separated by ellipses (...) in case the string is too long to fit into the specified width, and the origianl string otherwise.- Parameters:
metrics
- Font metrics.availableWidth
- Available width in pixels.fullText
- String to clip.- Returns:
- The clipped string, which contains the beginning and the end of the input string separated by ellipses (...) in case the string is too long to fit into the specified width, and the origianl string otherwise.
-
hasIcon
Checks whether the specified button has associated icon.- Parameters:
button
- Button.- Returns:
- If the button has associated icon,
true
is returned, otherwisefalse
.
-
hasText
Checks whether the specified button has associated text.- Parameters:
button
- Button.- Returns:
- If the button has associated text,
true
is returned, otherwisefalse
.
-
isComboBoxButton
Checks and answers if the specified button is in a combo box.- Parameters:
button
- the button to check- Returns:
true
if in combo box,false
otherwise
-
isScrollBarButton
Checks and answers if the specified button is in a scroll bar.- Parameters:
button
- the button to check- Returns:
true
if in scroll bar,false
otherwise
-
isSpinnerButton
Checks and answers if the specified button is in a spinner.- Parameters:
button
- the button to check- Returns:
true
if in spinner,false
otherwise
-
isToolBarButton
Checks and answers if the specified button is in a toolbar.- Parameters:
component
- the button to check- Returns:
true
if in toolbar,false
otherwise
-
isScrollButton
Checks answers if the specified component is a button in a scroll control, such as scroll bar or tabbed pane (as tab scroller).- Parameters:
comp
- The component to check- Returns:
true
if the specified component is a button in a scroll control,false
otherwise
-
isButtonNeverPainted
Checks whether the specified button never paints its background.- Parameters:
button
- Button.- Returns:
true
if the specified button never paints its background,false
otherwise.- See Also:
-
getFocusKind
Returns the focus ring kind of the specified component.- Parameters:
component
- Component.- Returns:
- The focus ring kind of the specified component.
- See Also:
-
toDrawWatermark
Returns indication whether the watermark should be drawn on the specified component.- Parameters:
component
- Component.- Returns:
true
if the watermark should be drawn on the specified component,false
otherwise.- See Also:
-
getButtonShaper
Returns the button shaper of the specified button.- Parameters:
comp
- The button.- Returns:
- The button shaper of the specified button.
- See Also:
-
getFillPainter
Returns the fill painter of the specified component.- Parameters:
comp
- Component.- Returns:
- The fill painter of the specified component.
- See Also:
-
isTabModified
Retrieves themodified
state for the specified component in a tabbed pane.- Parameters:
tabComponent
- The associated tab component.- Returns:
true
if the specified component in a tabbed pane is marked as modified,false
otherwise.- See Also:
-
isRootPaneModified
Retrieves themodified
state for the specified root pane.- Parameters:
rootPane
- The root pane.- Returns:
true
if the specified root pane is marked as modified,false
otherwise.- See Also:
-
isInternalFrameModified
Retrieves themodified
state for the specified internal frame.- Parameters:
internalFrame
- The internal frame.- Returns:
true
if the specified internal frame is marked as modified,false
otherwise.- See Also:
-
isRootPaneAutoDeactivate
-
isPaintRootPaneActivated
-
isSecondaryWindow
-
isRoundedCorners
-
hasCloseButton
Checks whether the specified tab has a close button.- Parameters:
tabbedPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
true
if the specified tab has a close button,false
otherwise.- See Also:
-
getCloseButtonSize
Returns the size of the close button for a tab in the specified tabbed pane.- Parameters:
tabbedPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
- The size of the close button for a tab in the specified tabbed pane.
-
getContentBorderKind
public static SubstanceConstants.TabContentPaneBorderKind getContentBorderKind(JTabbedPane tabbedPane) Returns the content border kind of the specified tabbed pane.- Parameters:
tabbedPane
- Tabbed pane.- Returns:
- Content border kind of the specified tabbed pane.
- See Also:
-
toAnimateCloseIconOfModifiedTab
Checks whether the specified tab should show modified animation only on its close button.- Parameters:
tabbedPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
true
if the specified tab should show modified animation only on its close button,false
otherwise.- See Also:
-
getBlankImage
Retrieves transparent image of specified dimension.- Parameters:
width
- Image width.height
- Image height.- Returns:
- Transparent image of specified dimension.
-
getBlankVolatileImage
Retrieves transparent image of specified dimension.- Parameters:
width
- Image width.height
- Image height.- Returns:
- Transparent image of specified dimension.
-
hasNoMinSizeProperty
Checks whether the specified button should have minimal size.- Parameters:
button
- Button.- Returns:
false
if the specified button should have minimal size,true
otherwise.- See Also:
-
hasFlatAppearance
Checks whether the specified component is flat.- Parameters:
comp
- Component.defaultValue
- The value to return if there is noSubstanceLookAndFeel.FLAT_PROPERTY
defined on button hierarchy orUIManager
.- Returns:
false
if the specified button is flat,true
otherwise.- See Also:
-
hasFlatAppearance
Computes whether the specified button has flat appearance.- Parameters:
button
- Button.- Returns:
true
if the button has flat appearance,false
otherwise.
-
getPopupFlyoutOrientation
Returns the popup flyout orientation for the specified combobox.- Parameters:
combobox
- Combobox.- Returns:
- The popup flyout orientation for the specified combobox.
- See Also:
-
makeNonOpaque
Makes the specified component and all its descendants non-opaque.- Parameters:
comp
- Component.opacitySnapshot
- The "snapshot" map that will contain the original opacity status of the specified component and all its descendants.
-
restoreOpaque
Restores the opacity of the specified component and all its descendants.- Parameters:
comp
- Component.opacitySnapshot
- The "snapshot" map that contains the original opacity status of the specified component and all its descendants.
-
createCompatibleImage
Creates a compatible image (for efficient processing and drawing).- Parameters:
image
- The original image.- Returns:
- Compatible version of the original image.
-
useThemedDefaultIcon
Checks whether the specified component will show scheme-colorized icon in the default state.- Parameters:
comp
- Component.- Returns:
true
if the specified component will show scheme-colorized icon in the default state,false
otherwise.- See Also:
-
getTabCloseCallback
public static TabCloseCallback getTabCloseCallback(MouseEvent me, JTabbedPane tabbedPane, int tabIndex) Returns the callback to be called upon tab closing (using the tab close button).- Parameters:
me
- Mouse event.tabbedPane
- Tabbed pane.tabIndex
- Tab index.- Returns:
- Callback to be called upon tab closing (using the tab close button).
- See Also:
-
blendImagesVertical
public static BufferedImage blendImagesVertical(BufferedImage imageTop, BufferedImage imageBottom, double start, double end) Blends two images along Y-axis.- Parameters:
imageTop
- The left image.imageBottom
- The right image.start
- Relative start of the blend area (in 0.0-1.0 range).end
- Relative end of the blend area (in 0.0-1.0 range).- Returns:
- Blended image.
-
blendImagesHorizontal
public static BufferedImage blendImagesHorizontal(BufferedImage imageLeft, BufferedImage imageRight, double start, double end) Blends two images along X-axis.- Parameters:
imageLeft
- The left image.imageRight
- The right image.start
- Relative start of the blend area (in 0.0-1.0 range).end
- Relative end of the blend area (in 0.0-1.0 range).- Returns:
- Blended image.
-
getOptionPaneColorScheme
public static SubstanceColorScheme getOptionPaneColorScheme(int messageType, SubstanceColorScheme mainScheme) Returns the color scheme for the icon of option panes with the specified message type.- Parameters:
messageType
- Option pane message type.mainScheme
- Main color scheme.- Returns:
- Color scheme for the icon of option panes with the specified message type.
-
getComboPopupPrototypeDisplayValue
Returns the popup prototype display value for the specified combo box. This value is used to compute the width of the combo popup.- Parameters:
combo
- Combo box.- Returns:
- The popup prototype display value for the specified combo box.
- See Also:
-
getScrollPaneButtonsPolicyKind
public static SubstanceConstants.ScrollPaneButtonPolicyKind getScrollPaneButtonsPolicyKind(JScrollBar scrollBar) Returns the scroll bar buttons kind of the specified scroll bar.- Parameters:
scrollBar
- Scroll bar.- Returns:
- The scroll bar buttons kind of the specified scroll bar.
- See Also:
-
getSides
Returns the set of sides registered on the specified button.- Parameters:
component
- Button.propertyName
- Client property name for retrieving the registered sides.- Returns:
- Set of sides registered on the specified button.
-
getToolbarButtonCornerRadius
Returns the corner radius of the specified toolbar button.- Parameters:
button
- Toolbar button.insets
- Button insets.- Returns:
- Corner radius of the specified toolbar button.
- See Also:
-
getEchoPerChar
Returns the number of echo characters per each password chanaracter.- Parameters:
jpf
- Password field.- Returns:
- The number of echo characters per each password chanaracter.
- See Also:
-
softClip
Creates a soft-clipped image. Code taken from here. -
toShowExtraWidgets
Checks whether the specified component has extra Substance-specific UI elements.- Parameters:
component
- Component.- Returns:
true
if the specified component has extra Substance-specific UI elements,false
otherwise.- See Also:
-
getThemedIcon
-
getThemedIcon
-
getOriginalIcon
-
getMenuGutterFillKind
Returns the global menu gutter fill kind.- Returns:
- The global menu gutter fill kind.
- See Also:
-
getHeaderParent
Given a component, returns the parent for computing theSubstanceDecorationPainter
.- Parameters:
c
- Component.- Returns:
- The parent for computing the
SubstanceDecorationPainter
.
-
paintFocus
public static void paintFocus(Graphics g, Component mainComp, Component focusedComp, TransitionAwareUI transitionAwareUI, Shape focusShape, Rectangle textRect, float maxAlphaCoef, int extraPadding) Paints the focus ring on the specified component.- Parameters:
g
- Graphics context.mainComp
- The main component for the focus painting.focusedComp
- The actual component that has the focus. For example, the main component can be aJSpinner
, while the focused component is a text field inside the the spinner editor.focusShape
- Focus shape. May benull
- in this case, the bounds ofmainComp
will be used.textRect
- Text rectangle (if relevant).maxAlphaCoef
- Maximum alhpa coefficient for painting the focus. Values lower than 1.0 will result in a translucent focus ring (can be used to paint a focus ring that doesn't draw too much attention away from the content, for example on text components).extraPadding
- Extra padding between the component bounds and the focus ring painting.
-
isTitleCloseButton
Returns indication whether the specified button is a close button on some title pane.- Parameters:
ab
- Button.- Returns:
true
if the specified button is a close button on some title pane,false
otherwise.
-
uninstallMenu
Uninstalls the specified menu item.- Parameters:
menuItem
- Menu item.
-
getIcon
Returns an icon pointed to by the specified string.- Parameters:
iconResource
- Resource location string.- Returns:
- Icon.
-
getClassLoaderForResources
Returns the class loader for loading the resource files. It is a fix by Dag Joar and Christian Schlichtherle for application running with -Xbootclasspath VM flag. In this case, the using MyClass.class.getClassLoader() would return null, but the context class loader will function properly that classes will be properly loaded regardless of whether the lib is added to the system class path, the extension class path and regardless of the class loader architecture set up by some frameworks.- Returns:
- The class loader for loading the resource files.
-
isCoveredByLightweightPopups
-
getPopupParentIndexOf
Gets a component and a list of popups and returns the index of the popup that is a parent of the specified component. Is used to track issue 297 and prevent visual artifacts.- Parameters:
comp
- Component.popups
- List of popups.- Returns:
- Index of the popup which is component's parent if any, or the popup list length otherwise.
-
getResourceBundle
Returns the resource bundle for the specified component.- Parameters:
jcomp
- Component.- Returns:
- Resource bundle for the specified component.
-
getBorderPainter
Returns the border painter for the specified component.- Parameters:
comp
- Component.- Returns:
- Border painter for the specified component.
- See Also:
-
getHighlightBorderPainter
Returns the highlight border painter for the specified component.- Parameters:
comp
- Component.- Returns:
- Highlight border painter for the specified component.
- See Also:
-
getHierarchy
Returns the component hierarchy.- Parameters:
comp
- Component.- Returns:
- Component hierarchy string.
-
getHierarchy
Computes the component hierarchy.- Parameters:
comp
- Component.buffer
- Hierarchy representation buffer.level
- Hierarchy level.
-
getTitlePane
Returns the title pane of the specified root pane.- Parameters:
rootPane
- Root pane.- Returns:
- The title pane of the specified root pane.
-
getArrowIcon
Returns the arrow icon.- Parameters:
button
- Button.orientation
- Arrow orientation.- Returns:
- Arrow icon.
-
getArrowIcon
public static Icon getArrowIcon(JComponent comp, TransitionAwareIcon.TransitionAwareUIDelegate transitionAwareUIDelegate, int orientation) Returns the arrow icon.- Parameters:
comp
- Component.orientation
- Arrow orientation.- Returns:
- Arrow icon.
-
getColorizationFactor
Returns the colorization factor for the specified component.- Parameters:
c
- Component.- Returns:
- The colorization factor for the specified component.
- See Also:
-
getSkin
Returns the skin of the specified component.- Parameters:
c
- Component.- Returns:
- The skin of the specified component.
- See Also:
-
getHashKey
Returns a hash key for the specified parameters.- Parameters:
objects
- Key components.- Returns:
- Hash key.
-
stopThreads
public static void stopThreads()Stops all Substance threads. Improper use may result in UI artifacts and runtime exceptions. -
getVmParameter
Retrieves a single parameter from the VM flags.- Parameters:
parameterName
- Parameter name.- Returns:
- Parameter value.
-
reallyPrintThreadingExceptions
public static boolean reallyPrintThreadingExceptions() -
reallyThrowThreadingExceptions
public static boolean reallyThrowThreadingExceptions() -
testComponentCreationThreadingViolation
Tests UI threading violations on creating the specified component.- Parameters:
comp
- Component.- Throws:
UiThreadingViolationException
- If the component is created off Event Dispatch Thread.
-
testComponentStateChangeThreadingViolation
Tests UI threading violations on changing the state the specified component.- Parameters:
comp
- Component.- Throws:
UiThreadingViolationException
- If the component is changing state off Event Dispatch Thread.
-
testWindowCloseThreadingViolation
Tests UI threading violations on closing the specified window.- Parameters:
w
- Window.- Throws:
UiThreadingViolationException
- If the window is closed off Event Dispatch Thread.
-
traceSubstanceApiUsage
-
getScaledIconImage
ScansimageList
for best-looking image of specified dimensions. Image can be scaled and/or padded with transparency. -
canReplaceChildBackgroundColor
-
getTextComponentForTransitions
-
getTextComponentRepaintCallback
public static org.pushingpixels.trident.swing.SwingRepaintCallback getTextComponentRepaintCallback(JTextComponent textComponent) -
isOpaque
-