ilog.tgo.grprim

Class Ilt1DPalette

java.lang.Object

ilog.tgo.grprim.Ilt1DPalette

All Implemented Interfaces:

IltPalette

public class Ilt1DPalette
extends Object
implements IltPalette

This class defines a collection of graphics parameters, called palette, used for drawing 1-dimensional objects, i.e. mainly lines.

It consists of:

• A line style. For drawing a line with a single color, use IltLineStyle.Solid.
• A foreground color.
• A background color. This may be null; in this case the line style will be transparent.

See Also:

IltGraphicUtil

Constructor Summary

Constructors

Constructor and Description
Ilt1DPalette(Color colour) Creates a new mono-color 1D palette.
Ilt1DPalette(IlLineStyle linestyle, Color foreground, Color background) Creates a new 1D palette.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares two objects.
Color	getBackground() Returns the background color.
Ilt1DPalette	getCurrentPalette()
Color	getForeground() Returns the foreground color.
IlLineStyle	getLineStyle() Returns the line style.
Stroke	getStroke(int cap, int join, double width) Returns the stroke properties according to this palette configuration.
int	hashCode() Returns a hash code value for the object.
boolean	isLineStyleSolid() Returns if the palette has a solid line style.
static Ilt1DPalette	New1DPalette(float[] dashes, Color foreground, Color background) Creates a new 1D palette.
static Ilt1DPalette	New1DPalette(IlLineStyle linestyle, Color foreground, Color background) Creates a new 1D palette.
static Ilt1DPalette	NewSimple1DPalette(Color colour) Creates a new mono-color 1D palette.
String	toString() Converts the object into a human-readable format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ilt1DPalette

public Ilt1DPalette(Color colour)

Creates a new mono-color 1D palette.

Parameters:

colour - Foreground color

Ilt1DPalette

public Ilt1DPalette(IlLineStyle linestyle,
                    Color foreground,
                    Color background)

Creates a new 1D palette.

Parameters:

linestyle - Line style used to draw the shape border

foreground - Foreground color

background - Background color

Method Detail

getStroke

public Stroke getStroke(int cap,
                        int join,
                        double width)

Returns the stroke properties according to this palette configuration.

isLineStyleSolid

public boolean isLineStyleSolid()

Returns if the palette has a solid line style.

Internal: do not use!

getLineStyle

public IlLineStyle getLineStyle()

Returns the line style.

Internal: do not use!

getForeground

public Color getForeground()

Returns the foreground color.

getBackground

public Color getBackground()

Returns the background color.

getCurrentPalette

public Ilt1DPalette getCurrentPalette()

Internal: do not use!

toString

public String toString()

Converts the object into a human-readable format.

Overrides:

toString in class Object

Returns:

The object in String format

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

New1DPalette

public static Ilt1DPalette New1DPalette(IlLineStyle linestyle,
                                        Color foreground,
                                        Color background)

Creates a new 1D palette.

New1DPalette

public static Ilt1DPalette New1DPalette(float[] dashes,
                                        Color foreground,
                                        Color background)

Creates a new 1D palette.

Parameters:

dashes - Line style used to draw the shape border

foreground - Foreground color

background - Background color

Since:

JTGO 4.0

NewSimple1DPalette

public static Ilt1DPalette NewSimple1DPalette(Color colour)

Creates a new mono-color 1D palette.