KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > lowagie > text > MarkedObject


1 /*
2  * $Id: MarkedObject.java 2748 2007-05-12 15:11:48Z blowagie $
3  * $Name$
4  *
5  * Copyright 2007 by Bruno Lowagie.
6  *
7  * The contents of this file are subject to the Mozilla Public License Version 1.1
8  * (the "License"); you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS" basis,
12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13  * for the specific language governing rights and limitations under the License.
14  *
15  * The Original Code is 'iText, a free JAVA-PDF library'.
16  *
17  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
18  * the Initial Developer are Copyright (C) 1999-2007 by Bruno Lowagie.
19  * All Rights Reserved.
20  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
21  * are Copyright (C) 2000-2007 by Paulo Soares. All Rights Reserved.
22  *
23  * Contributor(s): all the names of the contributors are added in the source code
24  * where applicable.
25  *
26  * Alternatively, the contents of this file may be used under the terms of the
27  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
28  * provisions of LGPL are applicable instead of those above. If you wish to
29  * allow use of your version of this file only under the terms of the LGPL
30  * License and not to allow others to use your version of this file under
31  * the MPL, indicate your decision by deleting the provisions above and
32  * replace them with the notice and other provisions required by the LGPL.
33  * If you do not delete the provisions above, a recipient may use your version
34  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
35  *
36  * This library is free software; you can redistribute it and/or modify it
37  * under the terms of the MPL as stated above or under the terms of the GNU
38  * Library General Public License as published by the Free Software Foundation;
39  * either version 2 of the License, or any later version.
40  *
41  * This library is distributed in the hope that it will be useful, but WITHOUT
42  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
43  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
44  * details.
45  *
46  * If you didn't download this code from the following link, you should check if
47  * you aren't using an obsolete version:
48  * http://www.lowagie.com/iText/
49  */
50
51 package com.lowagie.text;
52
53 import java.util.ArrayList JavaDoc;
54 import java.util.Properties JavaDoc;
55
56 /**
57  * Wrapper that allows to add properties to 'basic building block' objects.
58  * Before iText 1.5 every 'basic building block' implemented the MarkupAttributes interface.
59  * By setting attributes, you could add markup to the corresponding XML and/or HTML tag.
60  * This functionality was hardly used by anyone, so it was removed, and replaced by
61  * the MarkedObject functionality.
62  */
63
64 public class MarkedObject implements Element {
65
66     /** The element that is wrapped in a MarkedObject. */
67     protected Element element;
68
69     /** Contains extra markupAttributes */
70     protected Properties JavaDoc markupAttributes = new Properties JavaDoc();
71         
72     /**
73      * This constructor is for internal use only.
74      */
75     protected MarkedObject() {
76         element = null;
77     }
78     
79     /**
80      * Creates a MarkedObject.
81      */
82     public MarkedObject(Element element) {
83         this.element = element;
84     }
85     
86     /**
87      * Gets all the chunks in this element.
88      *
89      * @return an <CODE>ArrayList</CODE>
90      */
91     public ArrayList JavaDoc getChunks() {
92         return element.getChunks();
93     }
94
95     /**
96      * Processes the element by adding it (or the different parts) to an
97      * <CODE>ElementListener</CODE>.
98      *
99      * @param listener an <CODE>ElementListener</CODE>
100      * @return <CODE>true</CODE> if the element was processed successfully
101      */
102     public boolean process(ElementListener listener) {
103         try {
104             return listener.add(element);
105         }
106         catch(DocumentException de) {
107             return false;
108         }
109     }
110     
111     /**
112      * Gets the type of the text element.
113      *
114      * @return a type
115      */
116     public int type() {
117         return MARKED;
118     }
119
120     /**
121      * Getter for the markup attributes.
122      * @return the markupAttributes
123      */
124     public Properties JavaDoc getMarkupAttributes() {
125         return markupAttributes;
126     }
127     
128     /**
129      * Adds one markup attribute.
130      */
131     public void setMarkupAttribute(String JavaDoc key, String JavaDoc value) {
132         markupAttributes.setProperty(key, value);
133     }
134
135 }
Popular Tags