Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jvnet.substance.utils
Class SubstanceTextUtilities

    java.lang.Object
      org.jvnet.substance.utils.SubstanceTextUtilities

    public class SubstanceTextUtilities

extends java.lang.Object

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

Author:
  Kirill Grouchnikov

Constructor Summary
`SubstanceTextUtilities()`

Method Summary
`static java.awt.Color` | `getForegroundColor(javax.swing.JComponent component, java.lang.String text, ComponentState state, ComponentState prevState, float textAlpha)` Returns the foreground color for the specified component.
`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, ComponentState prevState, 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` | `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`

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,
                                 ComponentState prevState,
                                 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.
    `prevState` - Component previous state.
    `textAlpha` - Alpha channel for painting the text.

### getForegroundColor

    public static java.awt.Color getForegroundColor(javax.swing.JComponent component,
                                                    java.lang.String text,
                                                    ComponentState state,
                                                    ComponentState prevState,
                                                    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.
    `prevState` - Component previous 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.

### 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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD