ilog.tgo.grprim

Class IltPattern

java.lang.Object

ilog.tgo.grprim.IltPattern

All Implemented Interfaces:

IlPattern, Serializable

Direct Known Subclasses:

IltPattern.PatternWrapper, IltPattern.Solid

public abstract class IltPattern
extends Object
implements IlPattern

This class describes a pattern with which a 2D area can be filled.

When an area is drawn, the pattern is drawn in the foreground color, and the remainder of the area is drawn in the background color. If the background color is null, it means transparency.

The predefined patterns are defined by class IlvPattern, it is also possible to create customized patterns using the CSS function pattern as follows:

  aPattern : '@|pattern("Grid", 3, 2)';
  bPattern : '@|pattern("SkewGrid", 2, 2)';
  cPattern : '@|pattern("Dots")';
  dPattern : '@|pattern("ThinHatching")';
  ePattern : '@|pattern("LIGHT_VERTICAL")';
 

See IltPatternFunction for more details.

To create customized patterns, the method getPaint must be implemented to return the corresponding instance of Paint that will be used for fill operations. For backward compatibility, methods NewGridPattern and NewSkewGridPattern are still available through the API.

See Also:

IltPatternFunction, Ilt2DPalette, IlvPattern, Paint, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IltPattern.PatternWrapper Auxiliary class which converts from IlPattern to IltPattern.
static class	IltPattern.Solid Deprecated. Please set the fillStyle CSS property to be SOLID instead of PATTERN.

Field Summary

Fields

Modifier and Type	Field and Description
static IltPattern	Solid Deprecated. Please set the fillStyle CSS property to be SOLID instead of PATTERN.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltPattern()
protected	IltPattern(int type, int arg1, int arg2)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares two objects.
void	fillPolygon(Graphics g, AffineTransform t, IlIntPolygon polygon, Color foreground, Color background) Fills a polygon.
void	fillRect(Graphics g, AffineTransform t, int x1, int y1, int x2, int y2, Color foreground, Color background) Fills a rectangle with corners (x1,y1) and (x2,y2).
abstract Paint	getPaint(Color foreground, Color background) This method returns an instance of Paint interface that should be used to fill a 2D area with the specified pattern.
int	hashCode() Returns a hash code value for the object.
static IltPattern	NewGridPattern(int xPeriod, int yPeriod) This creates a new pattern, parallel to the x axis and the y axis.
static IltPattern	NewSkewGridPattern(int uPeriod, int vPeriod) This creates a new pattern, parallel to the diagonals (i.e. the bisectors between the x axis and the y axis).
static IltPattern	NewViewsPattern(int type, int arg1, int arg2) This creates a new pattern based on IlvPattern.

Methods inherited from class java.lang.Object

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

Field Detail

Solid

@Deprecated
public static IltPattern Solid

Deprecated. Please set the fillStyle CSS property to be SOLID instead of PATTERN.

This pattern always fills the entire 2D area with the foreground color. The background color is ignored.

Deprecated Since:

JTGO 4.0

Constructor Detail

IltPattern

protected IltPattern()

IltPattern

protected IltPattern(int type,
                     int arg1,
                     int arg2)

Method Detail

equals

public boolean equals(Object o)

Compares two objects.

Overrides:

equals in class Object

Parameters:

o - The object to compare to

Returns:

true if the object is the same as this object false otherwise

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

Returns:

The hash code for this object

fillRect

public void fillRect(Graphics g,
                     AffineTransform t,
                     int x1,
                     int y1,
                     int x2,
                     int y2,
                     Color foreground,
                     Color background)

Description copied from interface: IlPattern

Fills a rectangle with corners (x₁,y₁) and (x₂,y₂). The arguments must satisfy x₁ <= x₂ and y₁ <= y₂.

Specified by:

fillRect in interface IlPattern

Parameters:

g - The Graphics where the pattern will be drawn.

t - The transformer of the view, normally null.

Note: It is assumed that t has already been applied to x₁, y₁, x₂, y₂.

x1 - The upper left corner of the rectangle.

y1 - The upper left corner of the rectangle.

x2 - The lower left corner of the rectangle.

y2 - The lower left corner of the rectangle.

foreground - The foreground color.

background - The background color, or null.

Internal: do not use!

fillPolygon

public void fillPolygon(Graphics g,
                        AffineTransform t,
                        IlIntPolygon polygon,
                        Color foreground,
                        Color background)

Description copied from interface: IlPattern

Fills a polygon.

Specified by:

fillPolygon in interface IlPattern

Parameters:

g - The Graphics where the pattern will be drawn.

t - The transformer of the view, normally null.

Note: It is assumed that t has already been applied to x₁, y₁, x₂, y₂.

polygon - The polygon to be filled.

foreground - The foreground color.

background - The background color, or null.

Internal: do not use!

getPaint

public abstract Paint getPaint(Color foreground,
                               Color background)

This method returns an instance of Paint interface that should be used to fill a 2D area with the specified pattern.

Parameters:

foreground - The foreground color to be used to draw the pattern.

background - The background color of the pattern to be used.

Returns:

An instance of Paint interface to be used to fill a 2D area.

Since:

JTGO 4.0

NewViewsPattern

public static IltPattern NewViewsPattern(int type,
                                         int arg1,
                                         int arg2)

This creates a new pattern based on IlvPattern. The two arguments arg1 and arg2 have been added to address support call 1-43367250 (performance on remote XWindows).

Parameters:

type - One of the types available in IlvPattern, or a solid pattern, if it is unable to match the given type with the ones in IlvPattern.

arg1 - The argument1 used for legacy pattern, it has been introduced in TGO 4.5 to address support call 1-43367250 (performance on remote XWindows)

arg2 - The argument2 used for legacy pattern, it has been introduced in TGO 4.5 to address support call 1-43367250 (performance on remote XWindows)

Since:

JTGO 4.0

See Also:

IlvPattern

Internal: do not use!

NewGridPattern

public static IltPattern NewGridPattern(int xPeriod,
                                        int yPeriod)

This creates a new pattern, parallel to the x axis and the y axis.

Parameters:

xPeriod - Horizontal distance between two dots (1 means continuous horizontal hatching)

yPeriod - Vertical distance between two dots (1 means continuous vertical hatching)

NewSkewGridPattern

public static IltPattern NewSkewGridPattern(int uPeriod,
                                            int vPeriod)

This creates a new pattern, parallel to the diagonals (i.e. the bisectors between the x axis and the y axis).

Parameters:

uPeriod - The pattern is translation invariant w.r.t. the vector (uPeriod/2,uPeriod/2). 2 means continuous diagonal hatching.

vPeriod - The pattern is translation invariant w.r.t. the vector (vPeriod/2,-vPeriod/2). 2 means continuous anti-diagonal hatching.

Note: The pattern's "area" is uPeriod*vPeriod/2. Either uPeriod or vPeriod has to be even.