TexturePaint (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.awt
class TexturePaint

java.lang.Object
  java.awt.TexturePaint

All Implemented Interfaces:: Paint

Most common ways to construct:

BufferedImage bi = …;
Rectangle r = …;

TexturePaint tp = new TexturePaint(bi, r);

Based on 20 examples

BufferedImage fBufImage = …;
Rectangle2D tr = …;

TexturePaint tp = new TexturePaint(fBufImage, tr);

Based on 17 examples

public class TexturePaint
extends Object
implements Paint

The TexturePaint class provides a way to fill a {@link Shape} with a texture that is specified as a {@link BufferedImage}. The size of the BufferedImage object should be small because the BufferedImage data is copied by the TexturePaint object. At construction time, the texture is anchored to the upper left corner of a {@link Rectangle2D} that is specified in user space. Texture is computed for locations in the device space by conceptually replicating the specified Rectangle2D infinitely in all directions in user space and mapping the BufferedImage to each replicated Rectangle2D.

Constructor Summary
`TexturePaint(BufferedImage txtr, Rectangle2D anchor)` Constructs a `TexturePaint` object.

Method Summary
`PaintContext`	`createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints)` Creates and returns a context used to generate the color pattern.
`Rectangle2D`	`getAnchorRect()` Returns a copy of the anchor rectangle which positions and sizes the textured image.
`BufferedImage`	`getImage()` Returns the `BufferedImage` texture used to fill the shapes.
`int`	`getTransparency()` Returns the transparency mode for this `TexturePaint`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

TexturePaint

public TexturePaint(BufferedImage txtr,
                    Rectangle2D anchor)

Constructs a TexturePaint object.

Parameters:: txtr - the BufferedImage object with the texture used for painting; anchor - the Rectangle2D in user space used to anchor and replicate the texture

Method Detail

createContext

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

Creates and returns a context used to generate the color pattern.

Parameters:: cm - the {@link 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 {@link AffineTransform} from user space into device space; hints - a {@link RenderingHints} object that can be used to specify how the pattern is ultimately rendered
Returns:: the {@link PaintContext} used for generating color patterns.

getAnchorRect

public Rectangle2D getAnchorRect()

Returns a copy of the anchor rectangle which positions and sizes the textured image.

Returns:: the Rectangle2D used to anchor and size this TexturePaint.

getImage

public BufferedImage getImage()

Returns the BufferedImage texture used to fill the shapes.

Returns:: a BufferedImage.

getTransparency

public int getTransparency()

Returns the transparency mode for this TexturePaint.

Returns:: the transparency mode for this TexturePaint as an integer value.