StyleColumnsElement.java

/**
 * **********************************************************************
 *
 * <p>DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER
 *
 * <p>Copyright 2008, 2010 Oracle and/or its affiliates. All rights reserved.
 *
 * <p>Use is subject to license terms.
 *
 * <p>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
 *
 * <p>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.
 *
 * <p>See the License for the specific language governing permissions and limitations under the
 * License.
 *
 * <p>**********************************************************************
 */

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

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

/** 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 <code>StyleColumnsElement</code>
   *
   * @param ownerDoc The type is <code>OdfFileDom</code>
   */
  public StyleColumnsElement(OdfFileDom ownerDoc) {
    super(ownerDoc, ELEMENT_NAME);
  }

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

  /**
   * Receives the value of the ODFDOM attribute representation <code>FoColumnCountAttribute</code> ,
   * See {@odf.attribute fo:column-count}
   *
   * <p>Attribute is mandatory.
   *
   * @return - the <code>Integer</code> , the value or <code>null</code>, 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 <code>FoColumnCountAttribute</code> , See
   * {@odf.attribute fo:column-count}
   *
   * @param foColumnCountValue The type is <code>Integer</code>
   */
  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 <code>FoColumnGapAttribute</code> ,
   * See {@odf.attribute fo:column-gap}
   *
   * @return - the <code>String</code> , the value or <code>null</code>, 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 <code>FoColumnGapAttribute</code> , See
   * {@odf.attribute fo:column-gap}
   *
   * @param foColumnGapValue The type is <code>String</code>
   */
  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 <code>String</code> value of <code>StyleRelWidthAttribute</code>,
   *     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 <code>String</code> value of <code>StyleWidthAttribute</code>, 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);
    }
  }
}