/*
 * Copyright 2002 by Matt Benson.
 *
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * (the "License"); you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the License.
 *
 * The Original Code is 'iText, a free JAVA-PDF library'.
 *
 * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
 * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
 * All Rights Reserved.
 * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
 * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
 *
 * Contributor(s): all the names of the contributors are added in the source code
 * where applicable.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
 * provisions of LGPL are applicable instead of those above.  If you wish to
 * allow use of your version of this file only under the terms of the LGPL
 * License and not to allow others to use your version of this file under
 * the MPL, indicate your decision by deleting the provisions above and
 * replace them with the notice and other provisions required by the LGPL.
 * If you do not delete the provisions above, a recipient may use your version
 * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the MPL as stated above or under the terms of the GNU
 * Library General Public License as published by the Free Software Foundation;
 * either version 2 of the License, or any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
 * details.
 *
 * If you didn't download this code from the following link, you should check if
 * you aren't using an obsolete version:
 * http://www.lowagie.com/iText/
 */

package com.lowagie.text;


import java.util.Set;
import java.util.Properties;


/**
 * Defines the interface for an <CODE>Element</CODE> with markup attributes--
 * that is, random String-to-String properties for representation in markup
 * languages such as HTML and XML.
 *
 * @author <a href="mailto:orangeherbert@users.sourceforge.net">Matt Benson</a>
 */
public interface MarkupAttributes extends com.lowagie.text.Element {
    
/**
 * Sets the specified attribute.
 *
 * @param name    <CODE>String</CODE> attribute name.
 * @param value   <CODE>String</CODE> attribute value.
 */
    public void setMarkupAttribute(String name, String value);
    
/**
 * Sets the markupAttributes.
 *
 * @param   markupAttributes    a <CODE>Properties</CODE>-object containing markupattributes 
 */
    public void setMarkupAttributes(Properties markupAttributes);
    
/**
 * Returns the value of the specified attribute.
 *
 * @param name   <CODE>String</CODE> attribute name.
 * @return <CODE>String</CODE>.
 */
    public String getMarkupAttribute(String name);
    
/**
 * Returns a <CODE>Set</CODE> of <CODE>String</CODE> attribute names for the
 * <CODE>MarkupAttributes</CODE> implementor.
 *
 * @return <CODE>Set</CODE>.
 */
    public Set getMarkupAttributeNames();
    
/**
 * Return a <CODE>Properties</CODE>-object containing all the markupAttributes.
 *
 * @return <CODE>Properties</CODE>
 */
    public Properties getMarkupAttributes();
    
}