org.jopendocument.dom.text.Heading Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jOpenDocument Show documentation

jOpenDocument is a free library for developers looking to use Open Document files without OpenOffice.org.

The newest version!

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2008-2013 jOpenDocument, by ILM Informatique. All rights reserved.
 * 
 * The contents of this file are subject to the terms of the GNU
 * General Public License Version 3 only ("GPL").  
 * You may not use this file except in compliance with the License. 
 * You can obtain a copy of the License at http://www.gnu.org/licenses/gpl-3.0.html
 * See the License for the specific language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each file.
 * 
 */

package org.jopendocument.dom.text;

import org.jopendocument.dom.StyleProperties;
import org.jopendocument.dom.XMLVersion;

import org.jdom.Element;

/**
 * A text heading, defining the chapter structure. See §4.1 of the OpenDocument specification.
 */
public class Heading extends Paragraph {

    static Element createEmpty(XMLVersion ns) {
        // have to add level since it's required by OpenDocument-strict-schema-v1.1.rng
        return new Element("h", ns.getTEXT()).setAttribute("outline-level", "1", ns.getTEXT());
    }

    public Heading(String text) {
        this();
        addContent(text);
    }

    public Heading() {
        super(createEmpty(XMLVersion.getDefault()));
    }

    public final int getLevel() {
        final String attr = this.getElement().getAttributeValue("outline-level", this.getElement().getNamespace());
        // see 4.1.1
        return StyleProperties.parseInt(attr, 1);
    }

    public final void setLevel(int level) {
        if (level < 1)
            throw new IllegalArgumentException(level + " < 1");
        this.getElement().setAttribute("outline-level", level + "", this.getElement().getNamespace());
    }
}