icy.util

Class GraphicsUtil

java.lang.Object

icy.util.GraphicsUtil

public class GraphicsUtil
extends java.lang.Object

Graphics utilities class.

Author:

Stephane

Constructor Summary

Constructors

Constructor and Description
GraphicsUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	drawCenteredString(java.awt.Graphics g, java.lang.String text, int x, int y, boolean shadow) Draw a horizontal and vertical centered text on specified position.
static void	drawHCenteredString(java.awt.Graphics g, java.lang.String text, int x, int y, boolean shadow) Draw a horizontal centered text on specified position.
static void	drawHint(java.awt.Graphics2D g, java.lang.String text, int x, int y, java.awt.Color bgColor, java.awt.Color textColor) Draw multi line Hint type text in the specified Graphics context at the specified location.
static void	drawPathIterator(java.awt.geom.PathIterator path, java.awt.Graphics2D g) Draw the specified PathIterator in the specified Graphics2D context
static void	drawString(java.awt.Graphics g, java.lang.String text, int x, int y, boolean shadow) Draw a text in the specified Graphics context and at the specified position.
static float	getAlpha(java.awt.Graphics2D g)
static java.awt.Point	getBestPosition(java.awt.Point origin, java.awt.Dimension dim, java.awt.Rectangle region) Returns the best position to draw specified box in specified region with initial desired position.
static java.awt.Point	getBestPosition(java.awt.Point origin, java.awt.Dimension dim, java.awt.Rectangle region, int xSpace, int ySpace) Returns the best position to draw specified box in specified region with initial desired position.
static java.awt.Point	getBestPosition(java.awt.Point origin, java.awt.Dimension dim, java.awt.Rectangle region, int xSpace, int ySpace, boolean top, boolean left) Returns the best position to draw specified box in specified region with initial desired position.
static java.awt.Rectangle	getBounds(java.awt.Point origin, java.awt.Dimension dim, boolean top, boolean left) Returns the bounds to draw specified box dimension at specified position.
static java.awt.Rectangle	getBounds(java.awt.Point origin, java.awt.Dimension dim, int xSpace, int ySpace, boolean top, boolean left) Returns the bounds to draw specified box dimension at specified position.
static java.awt.Rectangle	getHintBounds(java.awt.Graphics2D g, java.lang.String text, int x, int y) Returns the bounds to draw a Hint type text in the specified Graphics context at the specified location.
static java.awt.Dimension	getHintSize(java.awt.Graphics2D g, java.lang.String text) Returns the size to draw a Hint type text in the specified Graphics context.
static java.awt.geom.Rectangle2D	getStringBounds(java.awt.Component c, java.lang.String text) Return bounds to draw specified string in the specified component.
static java.awt.geom.Rectangle2D	getStringBounds(java.awt.Graphics g, java.awt.Font f, java.lang.String text) Returns bounds to draw specified string in the specified Graphics context with specified font.
static java.awt.geom.Rectangle2D	getStringBounds(java.awt.Graphics g, java.lang.String text) Return bounds to draw specified string in the specified Graphics context with current font.
static boolean	isVisible(java.awt.Graphics g, java.awt.Rectangle region) Returns true if the specified region is visible in the specified Graphics object.
static boolean	isVisible(java.awt.Graphics g, java.awt.geom.Rectangle2D region) Returns true if the specified region is visible in the specified Graphics object.
static java.lang.String	limitStringFor(java.awt.Component c, java.lang.String text, int width) Limit the single line string so it fits in the specified component width.
static void	mixAlpha(java.awt.Graphics2D g, float factor)
static float	mixAlpha(java.awt.Graphics2D g, int rule, float factor)
static void	paintIcyBackGround(java.awt.Component component, java.awt.Graphics g) Draw ICY style background on the specified Graphics object with specified component dimension.
static void	paintIcyBackGround(java.awt.Image image) Draw ICY style background in the specified Image
static void	paintIcyBackGround(int width, int height, java.awt.Graphics g) Draw ICY style background on the specified Graphics object with specified dimension.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicsUtil

public GraphicsUtil()

Method Detail

getAlpha

public static float getAlpha(java.awt.Graphics2D g)

mixAlpha

public static void mixAlpha(java.awt.Graphics2D g,
            float factor)

mixAlpha

public static float mixAlpha(java.awt.Graphics2D g,
             int rule,
             float factor)

paintIcyBackGround

public static void paintIcyBackGround(int width,
                      int height,
                      java.awt.Graphics g)

Draw ICY style background on the specified Graphics object with specified dimension.

paintIcyBackGround

public static void paintIcyBackGround(java.awt.Component component,
                      java.awt.Graphics g)

Draw ICY style background on the specified Graphics object with specified component dimension.

paintIcyBackGround

public static void paintIcyBackGround(java.awt.Image image)

Draw ICY style background in the specified Image

isVisible

public static boolean isVisible(java.awt.Graphics g,
                java.awt.Rectangle region)

Returns true if the specified region is visible in the specified Graphics object.
Internally use the Graphics clip area to determine if region is visible.

isVisible

public static boolean isVisible(java.awt.Graphics g,
                java.awt.geom.Rectangle2D region)

Returns true if the specified region is visible in the specified Graphics object.
Internally use the Graphics clip area to determine if region is visible.

getStringBounds

public static java.awt.geom.Rectangle2D getStringBounds(java.awt.Graphics g,
                                        java.awt.Font f,
                                        java.lang.String text)

Returns bounds to draw specified string in the specified Graphics context with specified font.
This function handle multi lines string ('\n' character used a line separator).

limitStringFor

public static java.lang.String limitStringFor(java.awt.Component c,
                              java.lang.String text,
                              int width)

Limit the single line string so it fits in the specified component width.

getStringBounds

public static java.awt.geom.Rectangle2D getStringBounds(java.awt.Component c,
                                        java.lang.String text)

Return bounds to draw specified string in the specified component.
This function handle multi lines string ('\n' character used a line separator).

getStringBounds

public static java.awt.geom.Rectangle2D getStringBounds(java.awt.Graphics g,
                                        java.lang.String text)

Return bounds to draw specified string in the specified Graphics context with current font.
This function handle multi lines string ('\n' character used a line separator).

drawString

public static void drawString(java.awt.Graphics g,
              java.lang.String text,
              int x,
              int y,
              boolean shadow)

Draw a text in the specified Graphics context and at the specified position.
This function handles multi lines string ('\n' character used a line separator).

drawHCenteredString

public static void drawHCenteredString(java.awt.Graphics g,
                       java.lang.String text,
                       int x,
                       int y,
                       boolean shadow)

Draw a horizontal centered text on specified position. This function handle multi lines string ('\n' character used a line separator).

drawCenteredString

public static void drawCenteredString(java.awt.Graphics g,
                      java.lang.String text,
                      int x,
                      int y,
                      boolean shadow)

Draw a horizontal and vertical centered text on specified position. This function handle multi lines string ('\n' character used a line separator).

getHintSize

public static java.awt.Dimension getHintSize(java.awt.Graphics2D g,
                             java.lang.String text)

Returns the size to draw a Hint type text in the specified Graphics context.

getHintBounds

public static java.awt.Rectangle getHintBounds(java.awt.Graphics2D g,
                               java.lang.String text,
                               int x,
                               int y)

Returns the bounds to draw a Hint type text in the specified Graphics context
at the specified location.

drawHint

public static void drawHint(java.awt.Graphics2D g,
            java.lang.String text,
            int x,
            int y,
            java.awt.Color bgColor,
            java.awt.Color textColor)

Draw multi line Hint type text in the specified Graphics context
at the specified location.

getBounds

public static java.awt.Rectangle getBounds(java.awt.Point origin,
                           java.awt.Dimension dim,
                           int xSpace,
                           int ySpace,
                           boolean top,
                           boolean left)

Returns the bounds to draw specified box dimension at specified position.
By default the draw process is done from specified position to right/bottom.

Parameters:

origin - the initial desired position we want to draw the box.

dim - box dimension

xSpace - horizontal space between the position and box

ySpace - vertical space between the position and box

top - box is at top of position

left - box is at left of position

getBounds

public static java.awt.Rectangle getBounds(java.awt.Point origin,
                           java.awt.Dimension dim,
                           boolean top,
                           boolean left)

Returns the bounds to draw specified box dimension at specified position. By default the draw process is done from specified position to right/bottom.

Parameters:

origin - the initial desired position we want to draw the box.

dim - box dimension

top - box is at top of position

left - box is at left of position

getBestPosition

public static java.awt.Point getBestPosition(java.awt.Point origin,
                             java.awt.Dimension dim,
                             java.awt.Rectangle region,
                             int xSpace,
                             int ySpace,
                             boolean top,
                             boolean left)

Returns the best position to draw specified box in specified region with initial desired position.

Parameters:

origin - the initial desired position we want to draw the box.

dim - box dimension

region - the rectangle defining the region where we want to draw

xSpace - horizontal space between the position and box

ySpace - vertical space between the position and box

top - by default box is at top of position

left - by default box is at left of position

getBestPosition

public static java.awt.Point getBestPosition(java.awt.Point origin,
                             java.awt.Dimension dim,
                             java.awt.Rectangle region,
                             int xSpace,
                             int ySpace)

Returns the best position to draw specified box in specified region with initial desired position.

Parameters:

origin - the initial desired position we want to draw the box.

dim - box dimension

region - the rectangle defining the region where we want to draw

xSpace - horizontal space between the position and box

ySpace - vertical space between the position and box

getBestPosition

public static java.awt.Point getBestPosition(java.awt.Point origin,
                             java.awt.Dimension dim,
                             java.awt.Rectangle region)

Returns the best position to draw specified box in specified region with initial desired position.

Parameters:

origin - the initial desired position we want to draw the box.

dim - box dimension

region - the rectangle defining the region where we want to draw

drawPathIterator

public static void drawPathIterator(java.awt.geom.PathIterator path,
                    java.awt.Graphics2D g)

Draw the specified PathIterator in the specified Graphics2D context