com.itextpdf.styledxmlparser.node.IElementNode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of styled-xml-parser Show documentation
Styled XML parser is used by iText modules to parse HTML and XML
There is a newer version: 9.0.0
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2020 iText Group NV
    Authors: Bruno Lowagie, Paulo Soares, et al.
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License version 3
    as published by the Free Software Foundation with the addition of the
    following permission added to Section 15 as permitted in Section 7(a):
    FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
    ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
    OF THIRD PARTY RIGHTS
    
    This program 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 Affero General Public License for more details.
    You should have received a copy of the GNU Affero General Public License
    along with this program; if not, see http://www.gnu.org/licenses or write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA, 02110-1301 USA, or download the license from the following URL:
    http://itextpdf.com/terms-of-use/
    
    The interactive user interfaces in modified source and object code versions
    of this program must display Appropriate Legal Notices, as required under
    Section 5 of the GNU Affero General Public License.
    
    In accordance with Section 7(b) of the GNU Affero General Public License,
    a covered work must retain the producer line in every PDF that is created
    or manipulated using iText.
    
    You can be released from the requirements of the license by purchasing
    a commercial license. Buying such a license is mandatory as soon as you
    develop commercial activities involving the iText software without
    disclosing the source code of your own applications.
    These activities include: offering paid services to customers as an ASP,
    serving PDFs on the fly in a web application, shipping iText with a closed
    source product.
    
    For more information, please contact iText Software Corp. at this
    address: [email protected]
 */
package com.itextpdf.styledxmlparser.node;

import java.util.List;
import java.util.Map;

/**
 * Interface for node classes that have a parent and children, and for which
 * styles can be defined; each of these nodes can also have a name and attributes.
 */
public interface IElementNode extends INode, IStylesContainer {

    /**
     * Gets the name of the element node.
     *
     * @return the string
     */
    String name();

    /**
     * Gets the attributes.
     *
     * @return the attributes
     */
    IAttributes getAttributes();

    /**
     * Gets an attribute.
     *
     * @param key the key of the attribute we want to get
     * @return the value of the attribute
     */
    String getAttribute(String key);

    /**
     * Gets additional styles, more specifically styles that affect an element
     * based on its position in the HTML DOM, e.g. cell borders that are set
     * due to the parent table "border" attribute, or styles from "col" tags
     * that affect table elements, or blocks horizontal alignment that is
     * the result of parent's "align" attribute.
     *
     * @return the additional html styles
     */
    List> getAdditionalHtmlStyles();

    /**
     * Adds additional HTML styles.
     *
     * @param styles the styles
     */
    void addAdditionalHtmlStyles(Map styles);

    /**
     * Gets the language.
     *
     * @return the language value
     */
    String getLang();
}