001: /*
002: * $Id: MarkedObject.java 2748 2007-05-12 15:11:48Z blowagie $
003: * $Name$
004: *
005: * Copyright 2007 by Bruno Lowagie.
006: *
007: * The contents of this file are subject to the Mozilla Public License Version 1.1
008: * (the "License"); you may not use this file except in compliance with the License.
009: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
010: *
011: * Software distributed under the License is distributed on an "AS IS" basis,
012: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
013: * for the specific language governing rights and limitations under the License.
014: *
015: * The Original Code is 'iText, a free JAVA-PDF library'.
016: *
017: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
018: * the Initial Developer are Copyright (C) 1999-2007 by Bruno Lowagie.
019: * All Rights Reserved.
020: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
021: * are Copyright (C) 2000-2007 by Paulo Soares. All Rights Reserved.
022: *
023: * Contributor(s): all the names of the contributors are added in the source code
024: * where applicable.
025: *
026: * Alternatively, the contents of this file may be used under the terms of the
027: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
028: * provisions of LGPL are applicable instead of those above. If you wish to
029: * allow use of your version of this file only under the terms of the LGPL
030: * License and not to allow others to use your version of this file under
031: * the MPL, indicate your decision by deleting the provisions above and
032: * replace them with the notice and other provisions required by the LGPL.
033: * If you do not delete the provisions above, a recipient may use your version
034: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
035: *
036: * This library is free software; you can redistribute it and/or modify it
037: * under the terms of the MPL as stated above or under the terms of the GNU
038: * Library General Public License as published by the Free Software Foundation;
039: * either version 2 of the License, or any later version.
040: *
041: * This library is distributed in the hope that it will be useful, but WITHOUT
042: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
043: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
044: * details.
045: *
046: * If you didn't download this code from the following link, you should check if
047: * you aren't using an obsolete version:
048: * http://www.lowagie.com/iText/
049: */
050:
051: package com.lowagie.text;
052:
053: import java.util.ArrayList;
054: import java.util.Properties;
055:
056: /**
057: * Wrapper that allows to add properties to 'basic building block' objects.
058: * Before iText 1.5 every 'basic building block' implemented the MarkupAttributes interface.
059: * By setting attributes, you could add markup to the corresponding XML and/or HTML tag.
060: * This functionality was hardly used by anyone, so it was removed, and replaced by
061: * the MarkedObject functionality.
062: */
063:
064: public class MarkedObject implements Element {
065:
066: /** The element that is wrapped in a MarkedObject. */
067: protected Element element;
068:
069: /** Contains extra markupAttributes */
070: protected Properties markupAttributes = new Properties();
071:
072: /**
073: * This constructor is for internal use only.
074: */
075: protected MarkedObject() {
076: element = null;
077: }
078:
079: /**
080: * Creates a MarkedObject.
081: */
082: public MarkedObject(Element element) {
083: this .element = element;
084: }
085:
086: /**
087: * Gets all the chunks in this element.
088: *
089: * @return an <CODE>ArrayList</CODE>
090: */
091: public ArrayList getChunks() {
092: return element.getChunks();
093: }
094:
095: /**
096: * Processes the element by adding it (or the different parts) to an
097: * <CODE>ElementListener</CODE>.
098: *
099: * @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: } catch (DocumentException de) {
106: return false;
107: }
108: }
109:
110: /**
111: * Gets the type of the text element.
112: *
113: * @return a type
114: */
115: public int type() {
116: return MARKED;
117: }
118:
119: /**
120: * Getter for the markup attributes.
121: * @return the markupAttributes
122: */
123: public Properties getMarkupAttributes() {
124: return markupAttributes;
125: }
126:
127: /**
128: * Adds one markup attribute.
129: */
130: public void setMarkupAttribute(String key, String value) {
131: markupAttributes.setProperty(key, value);
132: }
133:
134: }
|