org.odftoolkit.odfdom.dom.element.text.TextUserIndexElement Maven / Gradle / Ivy
The 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.text;
import org.odftoolkit.odfdom.dom.element.OdfStylableElement;
import org.odftoolkit.odfdom.dom.element.OdfStyleableShapeElement;
import org.odftoolkit.odfdom.dom.style.OdfStyleFamily;
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.TextNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextProtectedAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextProtectionKeyAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextProtectionKeyDigestAlgorithmAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.xml.XmlIdAttribute;
/**
* DOM implementation of OpenDocument element {@odf.element text:user-index}.
*
*/
public class TextUserIndexElement extends OdfStylableElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TEXT, "user-index");
/**
* Create the instance of TextUserIndexElement
*
* @param ownerDoc The type is OdfFileDom
*/
public TextUserIndexElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME, OdfStyleFamily.Section, OdfName.newName(OdfDocumentNamespace.TEXT, "style-name"));
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element text:user-index}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation TextNameAttribute , See {@odf.attribute text:name}
*
* Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextNameAttribute() {
TextNameAttribute attr = (TextNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextNameAttribute , See {@odf.attribute text:name}
*
* @param textNameValue The type is String
*/
public void setTextNameAttribute(String textNameValue) {
TextNameAttribute attr = new TextNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextProtectedAttribute , See {@odf.attribute text:protected}
*
* @return - the Boolean , the value or null, if the attribute is not set and no default value defined.
*/
public Boolean getTextProtectedAttribute() {
TextProtectedAttribute attr = (TextProtectedAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "protected");
if (attr != null) {
return Boolean.valueOf(attr.booleanValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextProtectedAttribute , See {@odf.attribute text:protected}
*
* @param textProtectedValue The type is Boolean
*/
public void setTextProtectedAttribute(Boolean textProtectedValue) {
TextProtectedAttribute attr = new TextProtectedAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(textProtectedValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation TextProtectionKeyAttribute , See {@odf.attribute text:protection-key}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextProtectionKeyAttribute() {
TextProtectionKeyAttribute attr = (TextProtectionKeyAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "protection-key");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextProtectionKeyAttribute , See {@odf.attribute text:protection-key}
*
* @param textProtectionKeyValue The type is String
*/
public void setTextProtectionKeyAttribute(String textProtectionKeyValue) {
TextProtectionKeyAttribute attr = new TextProtectionKeyAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textProtectionKeyValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextProtectionKeyDigestAlgorithmAttribute , See {@odf.attribute text:protection-key-digest-algorithm}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextProtectionKeyDigestAlgorithmAttribute() {
TextProtectionKeyDigestAlgorithmAttribute attr = (TextProtectionKeyDigestAlgorithmAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "protection-key-digest-algorithm");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return TextProtectionKeyDigestAlgorithmAttribute.DEFAULT_VALUE;
}
/**
* Sets the value of ODFDOM attribute representation TextProtectionKeyDigestAlgorithmAttribute , See {@odf.attribute text:protection-key-digest-algorithm}
*
* @param textProtectionKeyDigestAlgorithmValue The type is String
*/
public void setTextProtectionKeyDigestAlgorithmAttribute(String textProtectionKeyDigestAlgorithmValue) {
TextProtectionKeyDigestAlgorithmAttribute attr = new TextProtectionKeyDigestAlgorithmAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textProtectionKeyDigestAlgorithmValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextStyleNameAttribute , See {@odf.attribute text:style-name}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextStyleNameAttribute() {
TextStyleNameAttribute attr = (TextStyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextStyleNameAttribute , See {@odf.attribute text:style-name}
*
* @param textStyleNameValue The type is String
*/
public void setTextStyleNameAttribute(String textStyleNameValue) {
TextStyleNameAttribute attr = new TextStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation XmlIdAttribute , See {@odf.attribute xml:id}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getXmlIdAttribute() {
XmlIdAttribute attr = (XmlIdAttribute) getOdfAttribute(OdfDocumentNamespace.XML, "id");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XmlIdAttribute , See {@odf.attribute xml:id}
*
* @param xmlIdValue The type is String
*/
public void setXmlIdAttribute(String xmlIdValue) {
XmlIdAttribute attr = new XmlIdAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xmlIdValue);
}
/**
* Create child element {@odf.element text:index-body}.
*
* Child element is mandatory.
*
* @return the element {@odf.element text:index-body}
*/
public TextIndexBodyElement newTextIndexBodyElement() {
TextIndexBodyElement textIndexBody = ((OdfFileDom) this.ownerDocument).newOdfElement(TextIndexBodyElement.class);
this.appendChild(textIndexBody);
return textIndexBody;
}
/**
* Create child element {@odf.element text:user-index-source}.
*
* @param textIndexNameValue the String value of TextIndexNameAttribute, see {@odf.attribute text:index-name} at specification
* Child element is mandatory.
*
* @return the element {@odf.element text:user-index-source}
*/
public TextUserIndexSourceElement newTextUserIndexSourceElement(String textIndexNameValue) {
TextUserIndexSourceElement textUserIndexSource = ((OdfFileDom) this.ownerDocument).newOdfElement(TextUserIndexSourceElement.class);
textUserIndexSource.setTextIndexNameAttribute(textIndexNameValue);
this.appendChild(textUserIndexSource);
return textUserIndexSource;
}
@Override
public void accept(ElementVisitor visitor) {
if (visitor instanceof DefaultElementVisitor) {
DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
defaultVisitor.visit(this);
} else {
visitor.visit(this);
}
}
}