org.odftoolkit.odfdom.dom.element.text.TextAlphabeticalIndexMarkElement Maven / Gradle / Ivy

/************************************************************************
 *
 * 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.text;

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.text.TextKey1Attribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextKey1PhoneticAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextKey2Attribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextKey2PhoneticAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextMainEntryAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStringValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStringValuePhoneticAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element text:alphabetical-index-mark}.
 *
 */
public class TextAlphabeticalIndexMarkElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TEXT, "alphabetical-index-mark");

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

	/**
	 * Get the element name
	 *
	 * @return  return   OdfName the name of element {@odf.element text:alphabetical-index-mark}.
	 */
	public OdfName getOdfName() {
		return ELEMENT_NAME;
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TextKey1Attribute , See {@odf.attribute text:key1}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTextKey1Attribute() {
		TextKey1Attribute attr = (TextKey1Attribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "key1");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TextKey1Attribute , See {@odf.attribute text:key1}
	 *
	 * @param textKey1Value   The type is String
	 */
	public void setTextKey1Attribute(String textKey1Value) {
		TextKey1Attribute attr = new TextKey1Attribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(textKey1Value);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TextKey1PhoneticAttribute , See {@odf.attribute text:key1-phonetic}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTextKey1PhoneticAttribute() {
		TextKey1PhoneticAttribute attr = (TextKey1PhoneticAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "key1-phonetic");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TextKey1PhoneticAttribute , See {@odf.attribute text:key1-phonetic}
	 *
	 * @param textKey1PhoneticValue   The type is String
	 */
	public void setTextKey1PhoneticAttribute(String textKey1PhoneticValue) {
		TextKey1PhoneticAttribute attr = new TextKey1PhoneticAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(textKey1PhoneticValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TextKey2Attribute , See {@odf.attribute text:key2}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTextKey2Attribute() {
		TextKey2Attribute attr = (TextKey2Attribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "key2");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TextKey2Attribute , See {@odf.attribute text:key2}
	 *
	 * @param textKey2Value   The type is String
	 */
	public void setTextKey2Attribute(String textKey2Value) {
		TextKey2Attribute attr = new TextKey2Attribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(textKey2Value);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TextKey2PhoneticAttribute , See {@odf.attribute text:key2-phonetic}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTextKey2PhoneticAttribute() {
		TextKey2PhoneticAttribute attr = (TextKey2PhoneticAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "key2-phonetic");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TextKey2PhoneticAttribute , See {@odf.attribute text:key2-phonetic}
	 *
	 * @param textKey2PhoneticValue   The type is String
	 */
	public void setTextKey2PhoneticAttribute(String textKey2PhoneticValue) {
		TextKey2PhoneticAttribute attr = new TextKey2PhoneticAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(textKey2PhoneticValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TextMainEntryAttribute , See {@odf.attribute text:main-entry}
	 *
	 * @return - the Boolean , the value or null, if the attribute is not set and no default value defined.
	 */
	public Boolean getTextMainEntryAttribute() {
		TextMainEntryAttribute attr = (TextMainEntryAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "main-entry");
		if (attr != null) {
			return Boolean.valueOf(attr.booleanValue());
		}
		return Boolean.valueOf(TextMainEntryAttribute.DEFAULT_VALUE);
	}

	/**
	 * Sets the value of ODFDOM attribute representation TextMainEntryAttribute , See {@odf.attribute text:main-entry}
	 *
	 * @param textMainEntryValue   The type is Boolean
	 */
	public void setTextMainEntryAttribute(Boolean textMainEntryValue) {
		TextMainEntryAttribute attr = new TextMainEntryAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setBooleanValue(textMainEntryValue.booleanValue());
	}

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

	/**
	 * Sets the value of ODFDOM attribute representation TextStringValueAttribute , See {@odf.attribute text:string-value}
	 *
	 * @param textStringValueValue   The type is String
	 */
	public void setTextStringValueAttribute(String textStringValueValue) {
		TextStringValueAttribute attr = new TextStringValueAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(textStringValueValue);
	}

	/**
	 * Receives the value of the ODFDOM attribute representation TextStringValuePhoneticAttribute , See {@odf.attribute text:string-value-phonetic}
	 *
	 * @return - the String , the value or null, if the attribute is not set and no default value defined.
	 */
	public String getTextStringValuePhoneticAttribute() {
		TextStringValuePhoneticAttribute attr = (TextStringValuePhoneticAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "string-value-phonetic");
		if (attr != null) {
			return String.valueOf(attr.getValue());
		}
		return null;
	}

	/**
	 * Sets the value of ODFDOM attribute representation TextStringValuePhoneticAttribute , See {@odf.attribute text:string-value-phonetic}
	 *
	 * @param textStringValuePhoneticValue   The type is String
	 */
	public void setTextStringValuePhoneticAttribute(String textStringValuePhoneticValue) {
		TextStringValuePhoneticAttribute attr = new TextStringValuePhoneticAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setValue(textStringValuePhoneticValue);
	}

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