org.pushingpixels.substance.internal.utils
Class SubstanceTextUtilities

java.lang.Object
  org.pushingpixels.substance.internal.utils.SubstanceTextUtilities

public class SubstanceTextUtilities
extends java.lang.Object

Text-related utilities. This class if for internal use only.

Field Summary

static java.lang.String

ENFORCE_FG_COLOR

Constructor Summary

SubstanceTextUtilities()

Method Summary

static java.awt.Color	getForegroundColor(javax.swing.JComponent component, java.lang.String text, ComponentState state, float textAlpha) Returns the foreground color for the specified component.
static java.awt.Color	getForegroundColor(javax.swing.JComponent component, java.lang.String text, StateTransitionTracker.ModelStateInfo modelStateInfo, float textAlpha) Returns the foreground color for the specified component.
static java.awt.Color	getMenuComponentForegroundColor(java.awt.Component menuComponent, java.lang.String text, StateTransitionTracker.ModelStateInfo modelStateInfo, float textAlpha) Returns the foreground color for the specified menu component.
static java.awt.Color	getTextBackgroundFillColor(javax.swing.JComponent comp)
static void	paintMenuItemText(java.awt.Graphics g, javax.swing.JMenuItem menuItem, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex, StateTransitionTracker.ModelStateInfo modelStateInfo, float textAlpha)
static void	paintText(java.awt.Graphics g, javax.swing.AbstractButton button, javax.swing.ButtonModel model, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex) Paints the text of the specified button.
static void	paintText(java.awt.Graphics g, javax.swing.AbstractButton button, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex) Paints the text of the specified button.
static void	paintText(java.awt.Graphics g, javax.swing.JComponent component, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex, ComponentState state, float textAlpha) Paints the specified text.
static void	paintText(java.awt.Graphics g, javax.swing.JComponent comp, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex, java.awt.Font font, java.awt.Color color, java.awt.Rectangle clip) Paints the specified text.
static void	paintText(java.awt.Graphics g, javax.swing.JComponent component, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex, StateTransitionTracker.ModelStateInfo modelStateInfo, float textAlpha)
static void	paintTextCompBackground(java.awt.Graphics g, javax.swing.JComponent comp) Paints background of the specified text component.
static void	paintTextWithDropShadow(javax.swing.JComponent c, java.awt.Graphics g, java.awt.Color foregroundColor, java.lang.String text, int width, int height, int xOffset, int yOffset) Paints text with drop shadow.
static void	paintVerticalText(java.awt.Graphics g, javax.swing.JComponent comp, java.awt.Rectangle textRect, java.lang.String text, int mnemonicIndex, java.awt.Font font, java.awt.Color color, java.awt.Rectangle clip, boolean isFromBottomToTop) Paints the specified vertical text.

Methods inherited from class java.lang.Object

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

Field Detail

ENFORCE_FG_COLOR

public static final java.lang.String ENFORCE_FG_COLOR

See Also:

Constant Field Values

Constructor Detail

SubstanceTextUtilities

public SubstanceTextUtilities()

Method Detail

paintTextWithDropShadow

public static void paintTextWithDropShadow(javax.swing.JComponent c,
                                           java.awt.Graphics g,
                                           java.awt.Color foregroundColor,
                                           java.lang.String text,
                                           int width,
                                           int height,
                                           int xOffset,
                                           int yOffset)

Paints text with drop shadow.

Parameters:

c - Component.

g - Graphics context.

foregroundColor - Foreground color.

text - Text to paint.

width - Text rectangle width.

height - Text rectangle height.

xOffset - Text rectangle X offset.

yOffset - Text rectangle Y offset.

paintText

public static void paintText(java.awt.Graphics g,
                             javax.swing.JComponent comp,
                             java.awt.Rectangle textRect,
                             java.lang.String text,
                             int mnemonicIndex,
                             java.awt.Font font,
                             java.awt.Color color,
                             java.awt.Rectangle clip)

Paints the specified text.

Parameters:

g - Graphics context.

comp - Component.

textRect - Text rectangle.

text - Text to paint.

mnemonicIndex - Mnemonic index.

font - Font to use.

color - Color to use.

clip - Optional clip. Can be null.

paintVerticalText

public static void paintVerticalText(java.awt.Graphics g,
                                     javax.swing.JComponent comp,
                                     java.awt.Rectangle textRect,
                                     java.lang.String text,
                                     int mnemonicIndex,
                                     java.awt.Font font,
                                     java.awt.Color color,
                                     java.awt.Rectangle clip,
                                     boolean isFromBottomToTop)

Paints the specified vertical text.

Parameters:

g - Graphics context.

comp - Component.

textRect - Text rectangle.

text - Text to paint.

mnemonicIndex - Mnemonic index.

font - Font to use.

color - Color to use.

clip - Optional clip. Can be null.

isFromBottomToTop - If true, the text will be painted from bottom to top, otherwise the text will be painted from top to bottom.

paintText

public static void paintText(java.awt.Graphics g,
                             javax.swing.AbstractButton button,
                             java.awt.Rectangle textRect,
                             java.lang.String text,
                             int mnemonicIndex)

Paints the text of the specified button.

Parameters:

g - Graphic context.

button - Button

textRect - Text rectangle

text - Text to paint

mnemonicIndex - Mnemonic index.

paintText

public static void paintText(java.awt.Graphics g,
                             javax.swing.AbstractButton button,
                             javax.swing.ButtonModel model,
                             java.awt.Rectangle textRect,
                             java.lang.String text,
                             int mnemonicIndex)

Paints the text of the specified button.

Parameters:

g - Graphic context.

button - Button

model - Button model.

textRect - Text rectangle

text - Text to paint

mnemonicIndex - Mnemonic index.

paintText

public static void paintText(java.awt.Graphics g,
                             javax.swing.JComponent component,
                             java.awt.Rectangle textRect,
                             java.lang.String text,
                             int mnemonicIndex,
                             ComponentState state,
                             float textAlpha)

Paints the specified text.

Parameters:

g - Graphics context.

component - Component.

textRect - Text rectangle.

text - Text to paint.

mnemonicIndex - Mnemonic index.

state - Component state.

textAlpha - Alpha channel for painting the text.

paintText

public static void paintText(java.awt.Graphics g,
                             javax.swing.JComponent component,
                             java.awt.Rectangle textRect,
                             java.lang.String text,
                             int mnemonicIndex,
                             StateTransitionTracker.ModelStateInfo modelStateInfo,
                             float textAlpha)

paintMenuItemText

public static void paintMenuItemText(java.awt.Graphics g,
                                     javax.swing.JMenuItem menuItem,
                                     java.awt.Rectangle textRect,
                                     java.lang.String text,
                                     int mnemonicIndex,
                                     StateTransitionTracker.ModelStateInfo modelStateInfo,
                                     float textAlpha)

getForegroundColor

public static java.awt.Color getForegroundColor(javax.swing.JComponent component,
                                                java.lang.String text,
                                                ComponentState state,
                                                float textAlpha)

Returns the foreground color for the specified component.

Parameters:

component - Component.

text - Text. If empty or null, the result is null.

state - Component state.

textAlpha - Alpha channel for painting the text. If value is less than 1.0, the result is an opaque color which is an interpolation between the "real" foreground color and the background color of the component. This is done to ensure that native text rasterization will be performed on 6u10+ on Windows.

Returns:

The foreground color for the specified component.

getForegroundColor

public static java.awt.Color getForegroundColor(javax.swing.JComponent component,
                                                java.lang.String text,
                                                StateTransitionTracker.ModelStateInfo modelStateInfo,
                                                float textAlpha)

Returns the foreground color for the specified component.

Parameters:

component - Component.

text - Text. If empty or null, the result is null.

textAlpha - Alpha channel for painting the text. If value is less than 1.0, the result is an opaque color which is an interpolation between the "real" foreground color and the background color of the component. This is done to ensure that native text rasterization will be performed on 6u10 on Windows.

Returns:

The foreground color for the specified component.

getMenuComponentForegroundColor

public static java.awt.Color getMenuComponentForegroundColor(java.awt.Component menuComponent,
                                                             java.lang.String text,
                                                             StateTransitionTracker.ModelStateInfo modelStateInfo,
                                                             float textAlpha)

Returns the foreground color for the specified menu component.

Parameters:

menuComponent - Menu component.

text - Text. If empty or null, the result is null.

modelStateInfo - Model state info for the specified component.

textAlpha - Alpha channel for painting the text. If value is less than 1.0, the result is an opaque color which is an interpolation between the "real" foreground color and the background color of the component. This is done to ensure that native text rasterization will be performed on 6u10 on Windows.

Returns:

The foreground color for the specified component.

paintTextCompBackground

public static void paintTextCompBackground(java.awt.Graphics g,
                                           javax.swing.JComponent comp)

Paints background of the specified text component.

Parameters:

g - Graphics context.

comp - Component.

getTextBackgroundFillColor

public static java.awt.Color getTextBackgroundFillColor(javax.swing.JComponent comp)