org.odftoolkit.odfdom.dom.element.table.TableDataPilotDisplayInfoElement 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.attribute.table.TableDataFieldAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableDisplayMemberModeAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableEnabledAttribute;
import org.odftoolkit.odfdom.dom.attribute.table.TableMemberCountAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element table:data-pilot-display-info}.
 *
 */
public class TableDataPilotDisplayInfoElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TABLE, "data-pilot-display-info");

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

	/**
	 * Get the element name
	 *
	 * @return  return   OdfName the name of element {@odf.element table:data-pilot-display-info}.
	 */
	public OdfName getOdfName() {
		return ELEMENT_NAME;
	}

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

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

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

	/**
	 * Sets the value of ODFDOM attribute representation TableDisplayMemberModeAttribute , See {@odf.attribute table:display-member-mode}
	 *
	 * @param tableDisplayMemberModeValue   The type is String
	 */
	public void setTableDisplayMemberModeAttribute(String tableDisplayMemberModeValue) {
		TableDisplayMemberModeAttribute attr = new TableDisplayMemberModeAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(tableDisplayMemberModeValue);
	}

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

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

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

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

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