KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > batik > dom > svg > SVGSVGContext


1 /*
2
3    Copyright 2004 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
19 package org.apache.batik.dom.svg;
20
21 import java.util.List JavaDoc;
22
23 import org.w3c.dom.svg.SVGRect;
24 import org.w3c.dom.Element JavaDoc;
25
26 /**
27  * Context class for svg:svg elements.
28  *
29  * Eventually this interface will likely have a number of other
30  * methods but for now it will have methods to do intersection
31  * and enclosure checking.
32  *
33  * @author <a HREF="mailto:deweese@apache.org">deweese</a>
34  * @version $Id: SVGSVGContext.java,v 1.3 2005/03/27 08:58:32 cam Exp $
35  */
36 public interface SVGSVGContext extends SVGContext {
37
38     /**
39      * Returns a List of all the DOM elements that intersect
40      * <tt>svgRect</tt> that are below <tt>end</tt> in the
41      * rendering order.
42      */
43     public List JavaDoc getIntersectionList(SVGRect svgRect, Element JavaDoc end);
44
45     /**
46      * Returns a List of all the DOM elements that are encosed in
47      * <tt>svgRect</tt> that are below <tt>end</tt> in the
48      * rendering order.
49      */
50     public List JavaDoc getEnclosureList (SVGRect rect, Element JavaDoc end );
51
52     /**
53      * Returns true if the given DOM element intersects
54      * <tt>svgRect</tt>.
55      */
56     public boolean checkIntersection (Element JavaDoc element, SVGRect rect );
57
58     /**
59      * Returns true if the given DOM element is enclosed in the
60      * <tt>svgRect</tt>.
61      */
62     public boolean checkEnclosure (Element JavaDoc element, SVGRect rect );
63
64     /**
65      * Used to inform the user agent that the text selection should be
66      * cleared.
67      */
68     public void deselectAll();
69
70 };
71
Popular Tags