org.odftoolkit.odfdom.dom.element.table.TableCellAddressElement 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: 1.0.0-BETA1

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.table;

import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.table.TableColumnAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableRowAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableTableAttribute;
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 table:cell-address}. */
public class TableCellAddressElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfDocumentNamespace.TABLE, "cell-address");

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

  /**
   * Get the element name
   *
   * @return return OdfName the name of element {@odf.element table:cell-address}.
   */
  public OdfName getOdfName() {
    return ELEMENT_NAME;
  }

  /**
   * Receives the value of the ODFDOM attribute representation TableColumnAttribute ,
   * See {@odf.attribute table:column}
   *
   * 
Attribute is mandatory.
   *
   * @return - the Integer , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Integer getTableColumnAttribute() {
    TableColumnAttribute attr =
        (TableColumnAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "column");
    if (attr != null && !attr.getValue().isEmpty()) {
      return Integer.valueOf(attr.intValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation TableColumnAttribute , See
   * {@odf.attribute table:column}
   *
   * @param tableColumnValue The type is Integer
   */
  public void setTableColumnAttribute(Integer tableColumnValue) {
    TableColumnAttribute attr = new TableColumnAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setIntValue(tableColumnValue.intValue());
  }

  /**
   * Receives the value of the ODFDOM attribute representation TableRowAttribute , See
   * {@odf.attribute table:row}
   *
   * 
Attribute is mandatory.
   *
   * @return - the Integer , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Integer getTableRowAttribute() {
    TableRowAttribute attr = (TableRowAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "row");
    if (attr != null && !attr.getValue().isEmpty()) {
      return Integer.valueOf(attr.intValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation TableRowAttribute , See
   * {@odf.attribute table:row}
   *
   * @param tableRowValue The type is Integer
   */
  public void setTableRowAttribute(Integer tableRowValue) {
    TableRowAttribute attr = new TableRowAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setIntValue(tableRowValue.intValue());
  }

  /**
   * Receives the value of the ODFDOM attribute representation TableTableAttribute ,
   * See {@odf.attribute table:table}
   *
   * Attribute is mandatory.
   *
   * @return - the Integer , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Integer getTableTableAttribute() {
    TableTableAttribute attr =
        (TableTableAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "table");
    if (attr != null && !attr.getValue().isEmpty()) {
      return Integer.valueOf(attr.intValue());
    }
    return null;
  }

  /**
   * Sets the value of ODFDOM attribute representation TableTableAttribute , See
   * {@odf.attribute table:table}
   *
   * @param tableTableValue The type is Integer
   */
  public void setTableTableAttribute(Integer tableTableValue) {
    TableTableAttribute attr = new TableTableAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setIntValue(tableTableValue.intValue());
  }

  /**
   * Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design
   * pattern to get a better understanding.
   *
   * @param visitor an instance of DefaultElementVisitor
   */
  @Override
  public void accept(ElementVisitor visitor) {
    if (visitor instanceof DefaultElementVisitor) {
      DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
      defaultVisitor.visit(this);
    } else {
      visitor.visit(this);
    }
  }
}