Eclipse Draw2d
2.1

org.eclipse.draw2d
Class FigureUtilities

java.lang.Object
  |
  +--org.eclipse.draw2d.FigureUtilities

public class FigureUtilities
extends Object

Provides miscellaneous Figure operations.


Constructor Summary
FigureUtilities()
           
 
Method Summary
static Color darker(Color color)
          Returns a new Color the same as the passed color in a darker hue.
static FontMetrics getFontMetrics(Font f)
          Returns the FontMetrics associated with the passed Font.
protected static GC getGC()
          Returns the GC used for various utilities.
protected static Point getStringDimension(String s, Font f)
          Returns the dimensions of the String s using the font f.
static Dimension getStringExtents(String s, Font f)
          Returns the Dimensions of s in Font f.
protected static Point getTextDimension(String s, Font f)
          Returns the dimensions of the String s using the font f.
static Dimension getTextExtents(String text, Font f)
          Returns the Dimensions of the given text, converting newlines and tabs appropriately.
static void getTextExtents(String s, Font f, Dimension result)
          Returns the Dimensions of the given text, converting newlines and tabs appropriately.
static int getTextWidth(String s, Font f)
          Returns the width of s in Font f.
static Color lighter(Color rgb)
          Returns a Color the same as the passed color in a lighter hue.
static Shape makeGhostShape(Shape s)
          Produces a ghosting effect on the shape s.
static Color mixColors(Color c1, Color c2)
          Mixes the passed Colors and returns the resulting Color.
static void paintEtchedBorder(Graphics g, Rectangle r)
          Paints a border with an etching effect, having a shadow of a darker version of g's background color, and a highlight a lighter version of g's background color.
static void paintEtchedBorder(Graphics g, Rectangle r, Color shadow, Color highlight)
          Paints a border with an etching effect, having a shadow of Color shadow and highlight of Color highlight.
protected static void setFont(Font f)
          Sets Font to passed value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FigureUtilities

public FigureUtilities()
Method Detail

darker

public static Color darker(Color color)
Returns a new Color the same as the passed color in a darker hue.

Parameters:
color - the color to darken
Returns:
the darkened color
Since:
2.0

getFontMetrics

public static FontMetrics getFontMetrics(Font f)
Returns the FontMetrics associated with the passed Font.

Parameters:
f - the font
Returns:
the FontMetrics for the given font
Since:
2.0
See Also:
GC.getFontMetrics()

getGC

protected static GC getGC()
Returns the GC used for various utilities.

Returns:
the GC

getTextDimension

protected static Point getTextDimension(String s,
                                        Font f)
Returns the dimensions of the String s using the font f. Tab expansion and carriage return processing are performed.

Parameters:
s - the string
f - the font
Returns:
the text's dimensions
See Also:
GC.textExtent(String)

getStringDimension

protected static Point getStringDimension(String s,
                                          Font f)
Returns the dimensions of the String s using the font f. No tab expansion or carriage return processing will be performed.

Parameters:
s - the string
f - the font
Returns:
the string's dimensions
See Also:
GC.stringExtent(java.lang.String)

getTextExtents

public static Dimension getTextExtents(String text,
                                       Font f)
Returns the Dimensions of the given text, converting newlines and tabs appropriately.

Parameters:
text - the text
f - the font
Returns:
the dimensions of the given text
Since:
2.0

getStringExtents

public static Dimension getStringExtents(String s,
                                         Font f)
Returns the Dimensions of s in Font f.

Parameters:
s - the string
f - the font
Returns:
the dimensions of the given string
Since:
2.0

getTextExtents

public static void getTextExtents(String s,
                                  Font f,
                                  Dimension result)
Returns the Dimensions of the given text, converting newlines and tabs appropriately.

Parameters:
s - the string
f - the font
result - the Dimension that will contain the result of this calculation
Since:
2.0

getTextWidth

public static int getTextWidth(String s,
                               Font f)
Returns the width of s in Font f.

Parameters:
s - the string
f - the font
Returns:
the width
Since:
2.0

lighter

public static Color lighter(Color rgb)
Returns a Color the same as the passed color in a lighter hue.

Parameters:
rgb - the color
Returns:
the lighter color
Since:
2.0

makeGhostShape

public static Shape makeGhostShape(Shape s)
Produces a ghosting effect on the shape s.

Parameters:
s - the shape
Returns:
the ghosted shape
Since:
2.0

mixColors

public static Color mixColors(Color c1,
                              Color c2)
Mixes the passed Colors and returns the resulting Color.

Parameters:
c1 - the first color
c2 - the second color
Returns:
the new color
Since:
2.0

paintEtchedBorder

public static void paintEtchedBorder(Graphics g,
                                     Rectangle r,
                                     Color shadow,
                                     Color highlight)
Paints a border with an etching effect, having a shadow of Color shadow and highlight of Color highlight.

Parameters:
g - the graphics object
r - the bounds of the border
shadow - the shadow color
highlight - the highlight color
Since:
2.0

paintEtchedBorder

public static void paintEtchedBorder(Graphics g,
                                     Rectangle r)
Paints a border with an etching effect, having a shadow of a darker version of g's background color, and a highlight a lighter version of g's background color.

Parameters:
g - the graphics object
r - the bounds of the border
Since:
2.0

setFont

protected static void setFont(Font f)
Sets Font to passed value.

Parameters:
f - the new font
Since:
2.0

Eclipse Draw2d
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.