org.odftoolkit.odfdom.dom.element.table.TableDeletionElement 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.table;

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.element.office.OfficeChangeInfoElement;
import org.odftoolkit.odfdom.dom.attribute.table.TableAcceptanceStateAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableIdAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableMultiDeletionSpannedAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TablePositionAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableRejectingChangeIdAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableTableAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableTypeAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element table:deletion}.
 *
 */
public class TableDeletionElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TABLE, "deletion");

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

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

	/**
	 * Receives the value of the ODFDOM attribute representation TableAcceptanceStateAttribute , See {@odf.attribute table:acceptance-state}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTableAcceptanceStateAttribute() {
		TableAcceptanceStateAttribute attr = (TableAcceptanceStateAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "acceptance-state");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return TableAcceptanceStateAttribute.DEFAULT_VALUE;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TableAcceptanceStateAttribute , See {@odf.attribute table:acceptance-state}
	 *
	 * @param tableAcceptanceStateValue   The type is String
	 */
	public void setTableAcceptanceStateAttribute(String tableAcceptanceStateValue) {
		TableAcceptanceStateAttribute attr = new TableAcceptanceStateAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableAcceptanceStateValue);
	}

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

	/**
	 * Sets the value of ODFDOM attribute representation TableIdAttribute , See {@odf.attribute table:id}
	 *
	 * @param tableIdValue   The type is String
	 */
	public void setTableIdAttribute(String tableIdValue) {
		TableIdAttribute attr = new TableIdAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableIdValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TableMultiDeletionSpannedAttribute , See {@odf.attribute table:multi-deletion-spanned}
	 *
	 * @return - the Integer , the value or null, if the attribute is not set and no default value defined.
	 */
	public Integer getTableMultiDeletionSpannedAttribute() {
		TableMultiDeletionSpannedAttribute attr = (TableMultiDeletionSpannedAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "multi-deletion-spanned");
		if (attr != null) {
			return Integer.valueOf(attr.intValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TableMultiDeletionSpannedAttribute , See {@odf.attribute table:multi-deletion-spanned}
	 *
	 * @param tableMultiDeletionSpannedValue   The type is Integer
	 */
	public void setTableMultiDeletionSpannedAttribute(Integer tableMultiDeletionSpannedValue) {
		TableMultiDeletionSpannedAttribute attr = new TableMultiDeletionSpannedAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setIntValue(tableMultiDeletionSpannedValue.intValue());
	}

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

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

	/**
	 * Receives the value of the ODFDOM attribute representation TableRejectingChangeIdAttribute , See {@odf.attribute table:rejecting-change-id}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTableRejectingChangeIdAttribute() {
		TableRejectingChangeIdAttribute attr = (TableRejectingChangeIdAttribute) getOdfAttribute(OdfDocumentNamespace.TABLE, "rejecting-change-id");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TableRejectingChangeIdAttribute , See {@odf.attribute table:rejecting-change-id}
	 *
	 * @param tableRejectingChangeIdValue   The type is String
	 */
	public void setTableRejectingChangeIdAttribute(String tableRejectingChangeIdValue) {
		TableRejectingChangeIdAttribute attr = new TableRejectingChangeIdAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableRejectingChangeIdValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TableTableAttribute , See {@odf.attribute table:table}
	 *
	 * @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) {
			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());
	}

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

	/**
	 * Sets the value of ODFDOM attribute representation TableTypeAttribute , See {@odf.attribute table:type}
	 *
	 * @param tableTypeValue   The type is String
	 */
	public void setTableTypeAttribute(String tableTypeValue) {
		TableTypeAttribute attr = new TableTypeAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableTypeValue);
	}

	/**
	 * Create child element {@odf.element office:change-info}.
	 *
	 * Child element is mandatory.
	 *
	 * @return the element {@odf.element office:change-info}
	 */
	public OfficeChangeInfoElement newOfficeChangeInfoElement() {
		OfficeChangeInfoElement officeChangeInfo = ((OdfFileDom) this.ownerDocument).newOdfElement(OfficeChangeInfoElement.class);
		this.appendChild(officeChangeInfo);
		return officeChangeInfo;
	}

	/**
	 * Create child element {@odf.element table:cut-offs}.
	 *
	 * @return the element {@odf.element table:cut-offs}
	 */
	public TableCutOffsElement newTableCutOffsElement() {
		TableCutOffsElement tableCutOffs = ((OdfFileDom) this.ownerDocument).newOdfElement(TableCutOffsElement.class);
		this.appendChild(tableCutOffs);
		return tableCutOffs;
	}

	/**
	 * Create child element {@odf.element table:deletions}.
	 *
	 * @return the element {@odf.element table:deletions}
	 */
	public TableDeletionsElement newTableDeletionsElement() {
		TableDeletionsElement tableDeletions = ((OdfFileDom) this.ownerDocument).newOdfElement(TableDeletionsElement.class);
		this.appendChild(tableDeletions);
		return tableDeletions;
	}

	/**
	 * Create child element {@odf.element table:dependencies}.
	 *
	 * @return the element {@odf.element table:dependencies}
	 */
	public TableDependenciesElement newTableDependenciesElement() {
		TableDependenciesElement tableDependencies = ((OdfFileDom) this.ownerDocument).newOdfElement(TableDependenciesElement.class);
		this.appendChild(tableDependencies);
		return tableDependencies;
	}

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