oracle.javatools.ui

Class StringUtils

java.lang.Object

oracle.javatools.ui.StringUtils

public final class StringUtils
extends java.lang.Object

Helper methods for Strings.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	clipString(javax.swing.JComponent c, java.awt.FontMetrics fm, java.lang.String string, int availTextWidth, int clipLocation) Clips the passed in String to the space provided.
static java.lang.String	layoutCompoundLabel(javax.swing.JComponent c, java.awt.FontMetrics fm, java.lang.String text, javax.swing.Icon icon, int verticalAlignment, int horizontalAlignment, int verticalTextPosition, int horizontalTextPosition, java.awt.Rectangle viewR, java.awt.Rectangle iconR, java.awt.Rectangle textR, int textIconGap, int ellipsesLocation) Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string.

Methods inherited from class java.lang.Object

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

Method Detail

layoutCompoundLabel

public static java.lang.String layoutCompoundLabel(javax.swing.JComponent c,
                                   java.awt.FontMetrics fm,
                                   java.lang.String text,
                                   javax.swing.Icon icon,
                                   int verticalAlignment,
                                   int horizontalAlignment,
                                   int verticalTextPosition,
                                   int horizontalTextPosition,
                                   java.awt.Rectangle viewR,
                                   java.awt.Rectangle iconR,
                                   java.awt.Rectangle textR,
                                   int textIconGap,
                                   int ellipsesLocation)

Compute and return the location of the icons origin, the location of origin of the text baseline, and a possibly clipped version of the compound labels string. Locations are computed relative to the viewR rectangle. This layoutCompoundLabel() does not know how to handle LEADING/TRAILING values in horizontalTextPosition (they will default to RIGHT) and in horizontalAlignment (they will default to CENTER). Use the other version of layoutCompoundLabel() instead.

This method differs from the one in SwingUtilities as it offers a location for the string to clip at: LEADING, CENTER, TRAILING.

Parameters:

ellipsesLocation - Where clipping will occur: SwingConstants.LEADING, TRAILING, CENTER

See Also:

SwingUtilities.layoutCompoundLabelImpl(javax.swing.JComponent, java.awt.FontMetrics, java.lang.String, javax.swing.Icon, int, int, int, int, java.awt.Rectangle, java.awt.Rectangle, java.awt.Rectangle, int)

clipString

public static java.lang.String clipString(javax.swing.JComponent c,
                          java.awt.FontMetrics fm,
                          java.lang.String string,
                          int availTextWidth,
                          int clipLocation)

Clips the passed in String to the space provided. NOTE: this assumes the string does not fit in the available space.

This method differs from the one in SwingUtilities2 as it offers a location for the string to clip at: LEADING, CENTER, TRAILING.

Parameters:

c - JComponent that will display the string, may be null

fm - FontMetrics used to measure the String width

string - String to display

availTextWidth - Amount of space that the string can be drawn in

clipLocation - where the string will clip: SwingConstants.LEADING/CENTER/TRAILING

Returns:

Clipped string that can fit in the provided space.

See Also:

SwingUtilities2.clipString(javax.swing.JComponent, java.awt.FontMetrics, java.lang.String, int)