org.odftoolkit.odfdom.dom.element.table.TableTableColumnGroupElement 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.TableDisplayAttribute;
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:table-column-group}. */
public class TableTableColumnGroupElement extends OdfElement {

  public static final OdfName ELEMENT_NAME =
      OdfName.newName(OdfDocumentNamespace.TABLE, "table-column-group");

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

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

  /**
   * Receives the value of the ODFDOM attribute representation TableDisplayAttribute ,
   * See {@odf.attribute table:display}
   *
   * @return - the Boolean , the value or null, if the attribute is not
   *     set and no default value defined.
   */
  public Boolean getTableDisplayAttribute() {
    TableDisplayAttribute attr =
        (TableDisplayAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "display");
    if (attr != null && !attr.getValue().isEmpty()) {
      return Boolean.valueOf(attr.booleanValue());
    }
    return Boolean.valueOf(TableDisplayAttribute.DEFAULT_VALUE_TRUE);
  }

  /**
   * Sets the value of ODFDOM attribute representation TableDisplayAttribute , See
   * {@odf.attribute table:display}
   *
   * @param tableDisplayValue The type is Boolean
   */
  public void setTableDisplayAttribute(Boolean tableDisplayValue) {
    TableDisplayAttribute attr = new TableDisplayAttribute((OdfFileDom) this.ownerDocument);
    setOdfAttribute(attr);
    attr.setBooleanValue(tableDisplayValue.booleanValue());
  }

  /**
   * Create child element {@odf.element table:table-column}.
   *
   * @return the element {@odf.element table:table-column}
   */
  public TableTableColumnElement newTableTableColumnElement() {
    TableTableColumnElement tableTableColumn =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableTableColumnElement.class);
    this.appendChild(tableTableColumn);
    return tableTableColumn;
  }

  /**
   * Create child element {@odf.element table:table-column-group}.
   *
   * @return the element {@odf.element table:table-column-group}
   */
  public TableTableColumnGroupElement newTableTableColumnGroupElement() {
    TableTableColumnGroupElement tableTableColumnGroup =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableTableColumnGroupElement.class);
    this.appendChild(tableTableColumnGroup);
    return tableTableColumnGroup;
  }

  /**
   * Create child element {@odf.element table:table-columns}.
   *
   * @return the element {@odf.element table:table-columns}
   */
  public TableTableColumnsElement newTableTableColumnsElement() {
    TableTableColumnsElement tableTableColumns =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableTableColumnsElement.class);
    this.appendChild(tableTableColumns);
    return tableTableColumns;
  }

  /**
   * Create child element {@odf.element table:table-header-columns}.
   *
   * @return the element {@odf.element table:table-header-columns}
   */
  public TableTableHeaderColumnsElement newTableTableHeaderColumnsElement() {
    TableTableHeaderColumnsElement tableTableHeaderColumns =
        ((OdfFileDom) this.ownerDocument).newOdfElement(TableTableHeaderColumnsElement.class);
    this.appendChild(tableTableHeaderColumns);
    return tableTableHeaderColumns;
  }

  /**
   * 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);
    }
  }
}