KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > fo > XMLElement


1 /*
2  * $Id: XMLElement.java,v 1.1.2.4 2003/04/11 00:24:37 pietsch Exp $
3  * ============================================================================
4  * The Apache Software License, Version 1.1
5  * ============================================================================
6  *
7  * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without modifica-
10  * tion, are permitted provided that the following conditions are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright notice,
13  * this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright notice,
16  * this list of conditions and the following disclaimer in the documentation
17  * and/or other materials provided with the distribution.
18  *
19  * 3. The end-user documentation included with the redistribution, if any, must
20  * include the following acknowledgment: "This product includes software
21  * developed by the Apache Software Foundation (http://www.apache.org/)."
22  * Alternately, this acknowledgment may appear in the software itself, if
23  * and wherever such third-party acknowledgments normally appear.
24  *
25  * 4. The names "FOP" and "Apache Software Foundation" must not be used to
26  * endorse or promote products derived from this software without prior
27  * written permission. For written permission, please contact
28  * apache@apache.org.
29  *
30  * 5. Products derived from this software may not be called "Apache", nor may
31  * "Apache" appear in their name, without prior written permission of the
32  * Apache Software Foundation.
33  *
34  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
35  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
36  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
37  * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
38  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
39  * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
40  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
41  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
42  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
43  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44  * ============================================================================
45  *
46  * This software consists of voluntary contributions made by many individuals
47  * on behalf of the Apache Software Foundation and was originally created by
48  * James Tauber <jtauber@jtauber.com>. For more information on the Apache
49  * Software Foundation, please see <http://www.apache.org/>.
50  */
51 package org.apache.fop.fo;
52
53 // FOP
54 import org.apache.fop.layout.Area;
55 import org.apache.fop.layout.inline.*;
56 import org.apache.fop.apps.FOPException;
57
58 /**
59  * class representing svg:svg pseudo flow object.
60  */
61 public class XMLElement extends XMLObj {
62     String JavaDoc namespace = "";
63
64     /**
65      * inner class for making XML objects.
66      */
67     public static class Maker extends FObj.Maker {
68         String JavaDoc tag;
69
70         Maker(String JavaDoc t) {
71             tag = t;
72         }
73
74         /**
75          * make an XML object.
76          *
77          * @param parent the parent formatting object
78          * @param propertyList the explicit properties of this object
79          *
80          * @return the XML object
81          */
82         public FObj make(FObj parent, PropertyList propertyList,
83                          String JavaDoc systemId, int line, int column)
84             throws FOPException {
85             return new XMLElement(parent, propertyList, tag,
86                                   systemId, line, column);
87         }
88     }
89
90     /**
91      * returns the maker for this object.
92      *
93      * @return the maker for XML objects
94      */
95     public static FObj.Maker maker(String JavaDoc tag) {
96         return new XMLElement.Maker(tag);
97     }
98
99     /**
100      * constructs an XML object (called by Maker).
101      *
102      * @param parent the parent formatting object
103      * @param propertyList the explicit properties of this object
104      */
105     public XMLElement(FObj parent, PropertyList propertyList, String JavaDoc tag,
106                       String JavaDoc systemId, int line, int column) {
107         super(parent, propertyList, tag, systemId, line, column);
108         init();
109     }
110
111     public String JavaDoc getName() {
112         return tagName;
113     }
114
115     /**
116      * layout this formatting object.
117      *
118      * @param area the area to layout the object into
119      *
120      * @return the status of the layout
121      */
122     public int layout(final Area area) throws FOPException {
123
124         if (!(area instanceof ForeignObjectArea)) {
125             // this is an error
126 throw new FOPException("XML not in fo:instream-foreign-object",
127                                    systemId, line, column);
128         }
129
130         /* return status */
131         return Status.OK;
132     }
133
134     private void init() {
135         createBasicDocument();
136     }
137
138     public String JavaDoc getNameSpace() {
139         return namespace;
140     }
141 }
142
Popular Tags