ilog.views.sdm.graphic

Class IlvPaint

java.lang.Object

ilog.views.sdm.graphic.IlvPaint

All Implemented Interfaces:

IlvPersistentObject, Paint, Transparency, Serializable

public class IlvPaint
extends Object
implements Paint, IlvPersistentObject

A java.awt.Paint implementation that is bean compliant. It can be used in SDM to create a Paint object used in many IlvGraphics. The default value is Color.black.

Here is an example of use in SDM. It creates a gradient paint from blue to yellow, with anchor points at (0,10) and (10,10):

 #paintGradient {
         class           : 'ilog.views.sdm.graphic.IlvPaint';
         gradientColor1  : blue ;
         gradientColor2  : yellow ;
        gradientAnchors : 0,10,10,10;
        cyclic          : false;
 }
 

Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

Constructors

Constructor and Description
IlvPaint() Bean constructor.
IlvPaint(IlvInputStream stream) Reads the object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
PaintContext	createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints) Implementation of the Paint interface.
Color	getColor() Returns the paint color.
float[]	getGradientAnchors() Returns the anchor coordinates.
Color	getGradientColor1() Returns one of the gradient colors.
Color	getGradientColor2() Returns one of the gradient colors.
IlvTexture	getTexture() Returns the texture paint.
int	getTransparency() Implementation of the Transparency interface.
boolean	isCyclic() Returns the cyclic value for gradient paint.
void	setColor(Color color) Sets the Paint implementation to java.awt.Color.
void	setCyclic(boolean cyclic) Sets the Paint implementation to java.awt.GradientPaint.
void	setGradientAnchors(float[] gradientAnchors) Sets the Paint implementation to java.awt.GradientPaint.
void	setGradientColor1(Color gradientColor) Sets the Paint implementation to java.awt.GradientPaint.
void	setGradientColor2(Color gradientColor) Sets the Paint implementation to java.awt.GradientPaint.
void	setTexture(IlvTexture paint) Sets the Paint implementation to IlvTexture.
void	write(IlvOutputStream stream) Writes the object to an IlvOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvPaint

public IlvPaint()

Bean constructor.

IlvPaint

public IlvPaint(IlvInputStream stream)
         throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

createContext

public PaintContext createContext(ColorModel cm,
                                  Rectangle deviceBounds,
                                  Rectangle2D userBounds,
                                  AffineTransform xform,
                                  RenderingHints hints)

Implementation of the Paint interface.

Specified by:

createContext in interface Paint

Parameters:

cm - The java.awt.image.ColorModel that receives the Paint data. This is used only as a hint.

deviceBounds - The device space bounding box of the graphics primitive being rendered.

userBounds - The user space bounding box of the graphics primitive being rendered.

xform - The java.awt.geom.AffineTransform from user space into device space.

hints - The hint that the context object uses to choose between rendering alternatives.

Returns:

The java.awt.PaintContext for generating color patterns.

See Also:

PaintContext

getTransparency

public int getTransparency()

Implementation of the Transparency interface.

Specified by:

getTransparency in interface Transparency

setColor

public void setColor(Color color)

Sets the Paint implementation to java.awt.Color.

Parameters:

color - The color.

getColor

public Color getColor()

Returns the paint color.

Returns:

The current color, or null if the Paint implementation is not a color.

setGradientAnchors

public void setGradientAnchors(float[] gradientAnchors)

Sets the Paint implementation to java.awt.GradientPaint.

Parameters:

gradientAnchors - Contains x1, y1, x2, and y2, the four coordinates of the two points anchoring the gradient pattern.

getGradientAnchors

public float[] getGradientAnchors()

Returns the anchor coordinates.

Returns:

The current anchors, or null if the Paint implementation is not a GradientPaint.

setGradientColor1

public void setGradientColor1(Color gradientColor)

Sets the Paint implementation to java.awt.GradientPaint.

Parameters:

gradientColor - The first of the two colors used to define the gradient.

getGradientColor1

public Color getGradientColor1()

Returns one of the gradient colors.

Returns:

The first of the two gradient colors, or null if the Paint implementation is not a GradientPaint.

setGradientColor2

public void setGradientColor2(Color gradientColor)

Sets the Paint implementation to java.awt.GradientPaint.

Parameters:

gradientColor - The second of the two colors used to define the gradient.

getGradientColor2

public Color getGradientColor2()

Returns one of the gradient colors.

Returns:

The second of the two gradient colors, or null if the Paint implementation is not a GradientPaint.

setCyclic

public void setCyclic(boolean cyclic)

Sets the Paint implementation to java.awt.GradientPaint.

Parameters:

cyclic - The cyclic argument of the gradient paint. The default is true.

isCyclic

public boolean isCyclic()

Returns the cyclic value for gradient paint.

Returns:

current The cyclic value.

setTexture

public void setTexture(IlvTexture paint)

Sets the Paint implementation to IlvTexture.

Parameters:

paint - The new texture.

getTexture

public IlvTexture getTexture()

Returns the texture paint.

Returns:

The IlvTexture if the current paint implementation is IlvTexture, and null otherwise.

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - The output stream.

Throws:

IOException - thrown when an exception occurs during the write operation for this object.