org.odftoolkit.odfdom.dom.element.style.StyleColumnsElement Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of odfdom-java Show documentation

ODFDOM is an OpenDocument Format (ODF) framework. Its purpose is to provide an easy common way to create, access and manipulate ODF files, without requiring detailed knowledge of the ODF specification. It is designed to provide the ODF developer community with an easy lightwork programming API portable to any object-oriented language. The current reference implementation is written in Java.

There is a newer version: 0.8.11-incubating

Show newest version

/************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * Use is subject to license terms.
 *
 * Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0. You can also
 * obtain a copy of the License at http://odftoolkit.org/docs/license.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ************************************************************************/

/*
 * This file is automatically generated.
 * Don't edit manually.
 */
package org.odftoolkit.odfdom.dom.element.style;

import org.odftoolkit.odfdom.pkg.OdfElement;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.attribute.fo.FoColumnCountAttribute;
import org.odftoolkit.odfdom.dom.attribute.fo.FoColumnGapAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element style:columns}.
 *
 */
public class StyleColumnsElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.STYLE, "columns");

	/**
	 * Create the instance of StyleColumnsElement
	 *
	 * @param  ownerDoc     The type is OdfFileDom
	 */
	public StyleColumnsElement(OdfFileDom ownerDoc) {
		super(ownerDoc, ELEMENT_NAME);
	}

	/**
	 * Get the element name
	 *
	 * @return  return   OdfName the name of element {@odf.element style:columns}.
	 */
	public OdfName getOdfName() {
		return ELEMENT_NAME;
	}

	/**
	 * Receives the value of the ODFDOM attribute representation FoColumnCountAttribute , See {@odf.attribute fo:column-count}
	 *
	 * Attribute is mandatory.
	 *
	 * @return - the Integer , the value or null, if the attribute is not set and no default value defined.
	 */
	public Integer getFoColumnCountAttribute() {
		FoColumnCountAttribute attr = (FoColumnCountAttribute) getOdfAttribute(OdfDocumentNamespace.FO, "column-count");
		if (attr != null) {
			return Integer.valueOf(attr.intValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation FoColumnCountAttribute , See {@odf.attribute fo:column-count}
	 *
	 * @param foColumnCountValue   The type is Integer
	 */
	public void setFoColumnCountAttribute(Integer foColumnCountValue) {
		FoColumnCountAttribute attr = new FoColumnCountAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setIntValue(foColumnCountValue.intValue());
	}

	/**
	 * Receives the value of the ODFDOM attribute representation FoColumnGapAttribute , See {@odf.attribute fo:column-gap}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getFoColumnGapAttribute() {
		FoColumnGapAttribute attr = (FoColumnGapAttribute) getOdfAttribute(OdfDocumentNamespace.FO, "column-gap");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation FoColumnGapAttribute , See {@odf.attribute fo:column-gap}
	 *
	 * @param foColumnGapValue   The type is String
	 */
	public void setFoColumnGapAttribute(String foColumnGapValue) {
		FoColumnGapAttribute attr = new FoColumnGapAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(foColumnGapValue);
	}

	/**
	 * Create child element {@odf.element style:column}.
	 *
	 * @param styleRelWidthValue  the String value of StyleRelWidthAttribute, see {@odf.attribute  style:rel-width} at specification
	 * Child element is new in Odf 1.2
	 *
	 * @return the element {@odf.element style:column}
	 */
	 public StyleColumnElement newStyleColumnElement(String styleRelWidthValue) {
		StyleColumnElement styleColumn = ((OdfFileDom) this.ownerDocument).newOdfElement(StyleColumnElement.class);
		styleColumn.setStyleRelWidthAttribute(styleRelWidthValue);
		this.appendChild(styleColumn);
		return styleColumn;
	}

	/**
	 * Create child element {@odf.element style:column-sep}.
	 *
	 * @param styleWidthValue  the String value of StyleWidthAttribute, see {@odf.attribute  style:width} at specification
	 * Child element is new in Odf 1.2
	 *
	 * @return the element {@odf.element style:column-sep}
	 */
	 public StyleColumnSepElement newStyleColumnSepElement(String styleWidthValue) {
		StyleColumnSepElement styleColumnSep = ((OdfFileDom) this.ownerDocument).newOdfElement(StyleColumnSepElement.class);
		styleColumnSep.setStyleWidthAttribute(styleWidthValue);
		this.appendChild(styleColumnSep);
		return styleColumnSep;
	}

	@Override
	public void accept(ElementVisitor visitor) {
		if (visitor instanceof DefaultElementVisitor) {
			DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
			defaultVisitor.visit(this);
		} else {
			visitor.visit(this);
		}
	}
}