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

Interface ClipRable

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.).
Method Summary
ShapegetClipPath()
Returns the Shape that the Clip will use to define the clip path.
FiltergetSource()
This returns the current image being clipped by the clip node.
booleangetUseAntialiasedClip()
Resturns true if the default behaviour should be to use anti-aliased clipping.
voidsetClipPath(Shape clipPath)
Set the clip path to use.
voidsetSource(Filter src)
The source to be clipped by the outline of the clip node.
voidsetUseAntialiasedClip(boolean useAA)
Set the default behaviour of anti-aliased clipping. for this clip object.

Method Detail

getClipPath

public Shape getClipPath()
Returns the Shape that the Clip will use to define the clip path.

Returns: The shape that defines the clip path.

getSource

public Filter getSource()
This returns the current image being clipped by the clip node.

Returns: The image to clip

getUseAntialiasedClip

public boolean getUseAntialiasedClip()
Resturns true if the default behaviour should be to use anti-aliased clipping.

setClipPath

public void setClipPath(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

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.

setUseAntialiasedClip

public void setUseAntialiasedClip(boolean useAA)
Set the default behaviour of anti-aliased clipping. for this clip object.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.