001/* 002 * $Id: MarkedObject.java 4847 2011-05-05 19:46:13Z redlab_b $ 003 * 004 * This file is part of the iText (R) project. 005 * Copyright (c) 1998-2011 1T3XT BVBA 006 * Authors: Bruno Lowagie, Paulo Soares, et al. 007 * 008 * This program is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU Affero General Public License version 3 010 * as published by the Free Software Foundation with the addition of the 011 * following permission added to Section 15 as permitted in Section 7(a): 012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT, 013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS. 014 * 015 * This program is distributed in the hope that it will be useful, but 016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 017 * or FITNESS FOR A PARTICULAR PURPOSE. 018 * See the GNU Affero General Public License for more details. 019 * You should have received a copy of the GNU Affero General Public License 020 * along with this program; if not, see http://www.gnu.org/licenses or write to 021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 022 * Boston, MA, 02110-1301 USA, or download the license from the following URL: 023 * http://itextpdf.com/terms-of-use/ 024 * 025 * The interactive user interfaces in modified source and object code versions 026 * of this program must display Appropriate Legal Notices, as required under 027 * Section 5 of the GNU Affero General Public License. 028 * 029 * In accordance with Section 7(b) of the GNU Affero General Public License, 030 * a covered work must retain the producer line in every PDF that is created 031 * or manipulated using iText. 032 * 033 * You can be released from the requirements of the license by purchasing 034 * a commercial license. Buying such a license is mandatory as soon as you 035 * develop commercial activities involving the iText software without 036 * disclosing the source code of your own applications. 037 * These activities include: offering paid services to customers as an ASP, 038 * serving PDFs on the fly in a web application, shipping iText with a closed 039 * source product. 040 * 041 * For more information, please contact iText Software Corp. at this 042 * address: sales@itextpdf.com 043 */ 044package com.itextpdf.text; 045 046import java.util.List; 047import java.util.Properties; 048 049/** 050 * Wrapper that allows to add properties to 'basic building block' objects. 051 * Before iText 1.5 every 'basic building block' implemented the MarkupAttributes interface. 052 * By setting attributes, you could add markup to the corresponding XML and/or HTML tag. 053 * This functionality was hardly used by anyone, so it was removed, and replaced by 054 * the MarkedObject functionality. 055 */ 056 057public class MarkedObject implements Element { 058 059 /** The element that is wrapped in a MarkedObject. */ 060 protected Element element; 061 062 /** Contains extra markupAttributes */ 063 protected Properties markupAttributes = new Properties(); 064 065 /** 066 * This constructor is for internal use only. 067 */ 068 protected MarkedObject() { 069 element = null; 070 } 071 072 /** 073 * Creates a MarkedObject. 074 * @param element the element 075 */ 076 public MarkedObject(final Element element) { 077 this.element = element; 078 } 079 080 /** 081 * Gets all the chunks in this element. 082 * 083 * @return an <CODE>ArrayList</CODE> 084 */ 085 public List<Chunk> getChunks() { 086 return element.getChunks(); 087 } 088 089 /** 090 * Processes the element by adding it (or the different parts) to an 091 * <CODE>ElementListener</CODE>. 092 * 093 * @param listener an <CODE>ElementListener</CODE> 094 * @return <CODE>true</CODE> if the element was processed successfully 095 */ 096 public boolean process(final ElementListener listener) { 097 try { 098 return listener.add(element); 099 } 100 catch(DocumentException de) { 101 return false; 102 } 103 } 104 105 /** 106 * Gets the type of the text element. 107 * 108 * @return a type 109 */ 110 public int type() { 111 return MARKED; 112 } 113 114 /** 115 * @see com.itextpdf.text.Element#isContent() 116 * @since iText 2.0.8 117 */ 118 public boolean isContent() { 119 return true; 120 } 121 122 /** 123 * @see com.itextpdf.text.Element#isNestable() 124 * @since iText 2.0.8 125 */ 126 public boolean isNestable() { 127 return true; 128 } 129 130 /** 131 * Getter for the markup attributes. 132 * @return the markupAttributes 133 */ 134 public Properties getMarkupAttributes() { 135 return markupAttributes; 136 } 137 138 /** 139 * Adds one markup attribute. 140 * @param key markup key 141 * @param value markup value 142 */ 143 public void setMarkupAttribute(final String key, final String value) { 144 markupAttributes.setProperty(key, value); 145 } 146 147}