KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jcckit > graphic > ClippingShape


1 /*
2  * Copyright 2003-2004, Franz-Josef Elmer, All rights reserved
3  *
4  * This library is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License as published by
6  * the Free Software Foundation; either version 2.1 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU Lesser General Public License for more details
13  * (http://www.gnu.org/copyleft/lesser.html).
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  */
19 package jcckit.graphic;
20
21 /**
22  * Defining a clipping shape applied to all {@link GraphicalElement
23  * GraphicalElements} of a {@link GraphicalComposite}.
24  *
25  * @author Franz-Josef Elmer
26  */
27 public interface ClippingShape {
28   /**
29    * Returns <tt>true</tt> if the specified point is inside this
30    * clipping shape.
31    */
32   public boolean isInside(GraphPoint point);
33
34   /**
35    * Returns the bounding box of this clipping shape.
36    * This method will be used by renderers who supports only
37    * rectangular clipping shapes.
38    */
39   public ClippingRectangle getBoundingBox();
40   
41   /**
42    * Returns a basic graphical element (such as {@link Rectangle}
43    * or {@link Polygon}) which may be used by renderers to
44    * define the clipping shape for the output device.
45    */
46   public BasicGraphicalElement getGraphicalElement();
47 }
48
Popular Tags