KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > batik > ext > awt > image > renderable > ClipRable


1 /*
2
3    Copyright 2001 The Apache Software Foundation
4
5    Licensed under the Apache License, Version 2.0 (the "License");
6    you may not use this file except in compliance with the License.
7    You may obtain a copy of the License at
8
9        http://www.apache.org/licenses/LICENSE-2.0
10
11    Unless required by applicable law or agreed to in writing, software
12    distributed under the License is distributed on an "AS IS" BASIS,
13    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14    See the License for the specific language governing permissions and
15    limitations under the License.
16
17  */
18 package org.apache.batik.ext.awt.image.renderable;
19
20 import java.awt.Shape JavaDoc;
21
22 /**
23  * Implements a clip operation. This is similar to the mask operation
24  * except it uses a '1 bit' mask (it's normally anti-aliased, but
25  * shouldn't have any fluctions in side the outline of the shape.).
26  *
27  * @author <a HREF="mailto:Thomas.DeWeeese@Kodak.com">Thomas DeWeese</a>
28  * @version $Id: ClipRable.java,v 1.5 2005/03/27 08:58:33 cam Exp $ */
29 public interface ClipRable extends Filter {
30
31     /**
32      * Set the default behaviour of anti-aliased clipping.
33      * for this clip object.
34      */
35     public void setUseAntialiasedClip(boolean useAA);
36
37     /**
38      * Resturns true if the default behaviour should be to use
39      * anti-aliased clipping.
40      */
41     public boolean getUseAntialiasedClip();
42
43
44       /**
45        * The source to be clipped by the outline of the clip node.
46        * @param src The Image to be clipped.
47        */
48     public void setSource(Filter src);
49
50       /**
51        * This returns the current image being clipped by the clip node.
52        * @return The image to clip
53        */
54     public Filter getSource();
55
56     /**
57      * Set the clip path to use.
58      * The path will be filled with opaque white, to define the
59      * the clipping mask.
60      * @param clipPath The clip path to use
61      */
62     public void setClipPath(Shape JavaDoc clipPath);
63
64       /**
65        * Returns the Shape that the Clip will use to
66        * define the clip path.
67        * @return The shape that defines the clip path.
68        */
69     public Shape JavaDoc getClipPath();
70 }
71
Popular Tags