Ilt2DPalette (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.tgo.grprim.Ilt2DPalette

All Implemented Interfaces:

IltPalette
```
public class Ilt2DPalette
extends Object
implements IltPalette
```
This class defines a collection of graphics parameters, called palette, used for drawing 2-dimensional areas.
It consists of:
- A fill style. For filling an entire area using either a solid color, a texture and gradients. By default, the fill style uses the pattern information.
- A fill pattern, defines the pattern used to fill the shape of the object. This property is here only for compatibility with previous versions. The preferred way to use a pattern is to define a texture, such as those in IlvPattern.
- A fill texture, defines the texture used to fill the shape of the object.
- A fill start, defines the position where the gradient starts.
- A fill end, defines the position where the gradient ends.
- A fill gradient angle, defines the angle (in degrees) of the gradient. For a linear gradient, an angle of 0 means that the gradient goes from left to right (that is, the first color is on the left, and the second color on the right); an angle of 45 means that the gradient goes from the bottom to the top, and so on. For a radial gradient, the angle specifies the position of the center of the gradient relative to the center of the shape. Any angle between 0 and 360 can be used.
- A foreground color, considered as the first color in case of gradient fill styles.
- A background color, considered as a second color in case of gradient fill styles.
See Also:

IltGraphicUtil

Constructor Summary

Constructors
Constructor and Description
`Ilt2DPalette()` Creates an empty palette.
`Ilt2DPalette(Color colour)` Creates a new mono-color 2D palette.
`Ilt2DPalette(Color foreground, Color background, IltPattern pattern)` Creates a new 2D palette.
`Ilt2DPalette(Color foreground, Color background, Image fillTexture)` Creates a new 2D palette using a texture.
`Ilt2DPalette(int fillStyle, Color fillColor1, Color fillColor2, float fillStart, float fillEnd, float fillAngle)` Creates a new 2D palette.
`Ilt2DPalette(int fillStyle, Color fillColor1, Color fillColor2, float fillStart, float fillEnd, float fillAngle, IltPattern pattern, Image fillTexture)` Creates a new 2D palette.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Compares two objects.
`Color`	`getBackground()` Returns the background color.
`Ilt2DPalette`	`getCurrentPalette()`
`Color`	`getForeground()` Returns the foreground color.
`Paint`	`getPaint()` Returns the paint object that should be used to fill an object shape.
`int`	`getStyle()` Returns the style used to fill the shape.
`int`	`hashCode()` Returns a hash code value for the object.
`static Ilt2DPalette`	`New2DPalette(Color foreground, Color background, Image fillTexture)` Creates a new 2D palette using a texture.
`static Ilt2DPalette`	`New2DPalette(IlPattern pattern, Color foreground, Color background)` Deprecated. Please use a constructor that accepts `IltPattern` instead of `IlPattern`.
`static Ilt2DPalette`	`New2DPalette(IltPattern pattern, Color foreground, Color background)` Creates a new 2D palette.
`static Ilt2DPalette`	`New2DPalette(int fillStyle, Color fillColor1, Color fillColor2, float fillStart, float fillEnd, float fillAngle)` Creates a new 2D palette.
`static Ilt2DPalette`	`NewSimple2DPalette(Color colour)` Creates a new mono-color 2D palette.
`void`	`setForeground(Color foreground)` Sets the foreground color.
`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
  - Ilt2DPalette
```
public Ilt2DPalette()
```
    Creates an empty palette.
  - Ilt2DPalette
```
public Ilt2DPalette(Color colour)
```
    Creates a new mono-color 2D palette.
    
    Parameters:
    
    colour - Foreground color used to fill an object using a solid fill style.
  - Ilt2DPalette
```
public Ilt2DPalette(Color foreground,
                    Color background,
                    Image fillTexture)
```
    Creates a new 2D palette using a texture.
    
    Parameters:
    
    foreground - Foreground color
    
    background - Background color
    
    fillTexture - Texture that will be used to fill an object shape.
  - Ilt2DPalette
```
public Ilt2DPalette(Color foreground,
                    Color background,
                    IltPattern pattern)
```
    Creates a new 2D palette.
    
    Parameters:
    
    pattern - A fill pattern. For filling an entire area with a single color, use IltPattern.Solid.
    
    foreground - A foreground color.
    
    background - A background color. This may be null; in this case the pattern will be transparent.
  - Ilt2DPalette
```
public Ilt2DPalette(int fillStyle,
                    Color fillColor1,
                    Color fillColor2,
                    float fillStart,
                    float fillEnd,
                    float fillAngle)
```
    Creates a new 2D palette.
    
    Parameters:
    
    fillStyle - A fill style, either no fill, solid color, linear gradient or radial gradient
    
    fillColor1 - A foreground color
    
    fillColor2 - A background color
    
    fillStart - Position where the gradient starts
    
    fillEnd - Position where the gradient ends
    
    fillAngle - Angle (in degrees) of the gradient
  - Ilt2DPalette
```
public Ilt2DPalette(int fillStyle,
                    Color fillColor1,
                    Color fillColor2,
                    float fillStart,
                    float fillEnd,
                    float fillAngle,
                    IltPattern pattern,
                    Image fillTexture)
```
    Creates a new 2D palette.
    
    Parameters:
    
    fillStyle - A fill style, either no fill, solid color, linear gradient or radial gradient
    
    fillColor1 - A foreground color
    
    fillColor2 - A background color
    
    fillStart - Position where the gradient starts
    
    fillEnd - Position where the gradient ends
    
    fillAngle - Angle (in degrees) of the gradient
    
    pattern - Fill pattern
    
    fillTexture - Fill texture
- Method Detail
  - getStyle
```
public int getStyle()
```
    Returns the style used to fill the shape.
    
    Returns:
    
    One of IlFillStyle.NO_FILL, IlFillStyle.SOLID_COLOR, IlFillStyle.LINEAR_GRADIENT, IlFillStyle.RADIAL_GRADIENT, or IlFillStyle.TEXTURE or IlFillStyle.PATTERN.
  - setForeground
```
public void setForeground(Color foreground)
```
    Sets the foreground color.
    
    Internal: do not use!
  - getForeground
```
public Color getForeground()
```
    Returns the foreground color.
  - getBackground
```
public Color getBackground()
```
    Returns the background color.
  - getPaint
```
public Paint getPaint()
```
    Returns the paint object that should be used to fill an object shape.
  - getCurrentPalette
```
public Ilt2DPalette 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
  - NewSimple2DPalette
```
public static Ilt2DPalette NewSimple2DPalette(Color colour)
```
    Creates a new mono-color 2D palette.
  - New2DPalette
```
@Deprecated
public static Ilt2DPalette New2DPalette(IlPattern pattern,
                                                    Color foreground,
                                                    Color background)
```
    Deprecated. Please use a constructor that accepts IltPattern instead of IlPattern.
    
    Creates a new 2D palette.
    
    Parameters:
    
    pattern - A fill pattern. For filling an entire area with a single color, use IltPattern.Solid.
    
    foreground - A foreground color.
    
    background - A background color. This may be null; in this case the pattern will be transparent.
    
    Deprecated Since:
    
    JTGO 4.0
  - New2DPalette
```
public static Ilt2DPalette New2DPalette(IltPattern pattern,
                                        Color foreground,
                                        Color background)
```
    Creates a new 2D palette.
    
    Parameters:
    
    pattern - A fill pattern. For filling an entire area with a single color, use IltPattern.Solid.
    
    foreground - A foreground color.
    
    background - A background color. This may be null; in this case the pattern will be transparent.
    
    Since:
    
    JTGO 4.0
  - New2DPalette
```
public static Ilt2DPalette New2DPalette(Color foreground,
                                        Color background,
                                        Image fillTexture)
```
    Creates a new 2D palette using a texture.
    
    Parameters:
    
    foreground - foreground color
    
    background - background color
    
    fillTexture - texture that will be used to fill an object shape.
    
    Since:
    
    JTGO 4.0
  - New2DPalette
```
public static Ilt2DPalette New2DPalette(int fillStyle,
                                        Color fillColor1,
                                        Color fillColor2,
                                        float fillStart,
                                        float fillEnd,
                                        float fillAngle)
```
    Creates a new 2D palette.
    
    Parameters:
    
    fillStyle - A fill style, either no fill, solid color, linear gradient or radial gradient
    
    fillColor1 - A first fill color
    
    fillColor2 - A second fill color, to be used in case of gradient styles
    
    fillStart - Position where the gradient starts
    
    fillEnd - Position where the gradient ends
    
    fillAngle - Angle (in degrees) of the gradient
    
    Since:
    
    JTGO 4.0

Class Ilt2DPalette

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ilt2DPalette

Ilt2DPalette

Ilt2DPalette

Ilt2DPalette

Ilt2DPalette

Ilt2DPalette

Method Detail

getStyle

setForeground

getForeground

getBackground

getPaint

getCurrentPalette

toString

equals

hashCode

NewSimple2DPalette

New2DPalette

New2DPalette

New2DPalette

New2DPalette