KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * Copyright 2002 by Matt Benson.
3  *
4  * The contents of this file are subject to the Mozilla Public License Version 1.1
5  * (the "License"); you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at http://www.mozilla.org/MPL/
7  *
8  * Software distributed under the License is distributed on an "AS IS" basis,
9  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
10  * for the specific language governing rights and limitations under the License.
11  *
12  * The Original Code is 'iText, a free JAVA-PDF library'.
13  *
14  * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
15  * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
16  * All Rights Reserved.
17  * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
18  * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
19  *
20  * Contributor(s): all the names of the contributors are added in the source code
21  * where applicable.
22  *
23  * Alternatively, the contents of this file may be used under the terms of the
24  * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
25  * provisions of LGPL are applicable instead of those above. If you wish to
26  * allow use of your version of this file only under the terms of the LGPL
27  * License and not to allow others to use your version of this file under
28  * the MPL, indicate your decision by deleting the provisions above and
29  * replace them with the notice and other provisions required by the LGPL.
30  * If you do not delete the provisions above, a recipient may use your version
31  * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
32  *
33  * This library is free software; you can redistribute it and/or modify it
34  * under the terms of the MPL as stated above or under the terms of the GNU
35  * Library General Public License as published by the Free Software Foundation;
36  * either version 2 of the License, or any later version.
37  *
38  * This library is distributed in the hope that it will be useful, but WITHOUT
39  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
40  * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
41  * details.
42  *
43  * If you didn't download this code from the following link, you should check if
44  * you aren't using an obsolete version:
45  * http://www.lowagie.com/iText/
46  */
47
48 package com.lowagie.text;
49
50
51 import java.util.Set;
52 import java.util.Properties;
53
54
55 /**
56  * Defines the interface for an <CODE>Element</CODE> with markup attributes--
57  * that is, random String-to-String properties for representation in markup
58  * languages such as HTML and XML.
59  *
60  * @author <a HREF="mailto:orangeherbert@users.sourceforge.net">Matt Benson</a>
61  */
62 public interface MarkupAttributes extends com.lowagie.text.Element {
63     
64 /**
65  * Sets the specified attribute.
66  *
67  * @param name <CODE>String</CODE> attribute name.
68  * @param value <CODE>String</CODE> attribute value.
69  */
70     public void setMarkupAttribute(String name, String value);
71     
72 /**
73  * Sets the markupAttributes.
74  *
75  * @param markupAttributes a <CODE>Properties</CODE>-object containing markupattributes
76  */
77     public void setMarkupAttributes(Properties markupAttributes);
78     
79 /**
80  * Returns the value of the specified attribute.
81  *
82  * @param name <CODE>String</CODE> attribute name.
83  * @return <CODE>String</CODE>.
84  */
85     public String getMarkupAttribute(String name);
86     
87 /**
88  * Returns a <CODE>Set</CODE> of <CODE>String</CODE> attribute names for the
89  * <CODE>MarkupAttributes</CODE> implementor.
90  *
91  * @return <CODE>Set</CODE>.
92  */
93     public Set getMarkupAttributeNames();
94     
95 /**
96  * Return a <CODE>Properties</CODE>-object containing all the markupAttributes.
97  *
98  * @return <CODE>Properties</CODE>
99  */
100     public Properties getMarkupAttributes();
101     
102 }
Popular Tags