org.apache.batik.ext.awt.image.renderable
Interface ClipRable

All Superinterfaces:

Filter, java.awt.image.renderable.RenderableImage

All Known Implementing Classes:

ClipRable8Bit

public interface ClipRable

extends Filter

Implements a clip operation. This is similar to the mask operation except it uses a '1 bit' mask (it's normally anti-aliased, but shouldn't have any fluctions in side the outline of the shape.).

Fields inherited from interface java.awt.image.renderable.RenderableImage

HINTS_OBSERVED

Method Summary

java.awt.Shape	getClipPath() Returns the Shape that the Clip will use to define the clip path.
Filter	getSource() This returns the current image being clipped by the clip node.
void	setClipPath(java.awt.Shape clipPath) Set the clip path to use.
void	setSource(Filter src) The source to be clipped by the outline of the clip node.

Methods inherited from interface org.apache.batik.ext.awt.image.renderable.Filter

getBounds2D, getDependencyRegion, getDirtyRegion, getTimeStamp

Methods inherited from interface java.awt.image.renderable.RenderableImage

createDefaultRendering, createRendering, createScaledRendering, getHeight, getMinX, getMinY, getProperty, getPropertyNames, getSources, getWidth, isDynamic

Method Detail

setSource

public void setSource(Filter src)

The source to be clipped by the outline of the clip node.

Parameters:

src - The Image to be clipped.

getSource

public Filter getSource()

This returns the current image being clipped by the clip node.

setClipPath

public void setClipPath(java.awt.Shape clipPath)

Set the clip path to use. The path will be filled with opaque white, to define the the clipping mask.

Parameters:

clipPath - The clip path to use

getClipPath

public java.awt.Shape getClipPath()

Returns the Shape that the Clip will use to define the clip path.

Returns:

The shape that defines the clip path.