org.odftoolkit.odfdom.dom.element.text.TextHiddenTextElement 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.TextConditionAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextIsHiddenAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStringValueAttribute;

/**
 * DOM implementation of OpenDocument element  {@odf.element text:hidden-text}.
 *
 */
public class TextHiddenTextElement extends OdfElement {

	public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TEXT, "hidden-text");

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

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

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

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

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

	/**
	 * Sets the value of ODFDOM attribute representation TextIsHiddenAttribute , See {@odf.attribute text:is-hidden}
	 *
	 * @param textIsHiddenValue   The type is Boolean
	 */
	public void setTextIsHiddenAttribute(Boolean textIsHiddenValue) {
		TextIsHiddenAttribute attr = new TextIsHiddenAttribute((OdfFileDom) this.ownerDocument);
		setOdfAttribute(attr);
		attr.setBooleanValue(textIsHiddenValue.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);
	}

	@Override
	public void accept(ElementVisitor visitor) {
		if (visitor instanceof DefaultElementVisitor) {
			DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
			defaultVisitor.visit(this);
		} else {
			visitor.visit(this);
		}
	}
	/**
	 * Add text content. Only elements which are allowed to have text content offer this method.
	 */
	public void newTextNode(String content) {
		if (content != null && !content.equals("")) {
			this.appendChild(this.getOwnerDocument().createTextNode(content));
		}
	}
}