org.odftoolkit.odfdom.dom.element.text.TextSequenceElement Maven / Gradle / Ivy
Show all versions of odfdom-java Show documentation
/**
* **********************************************************************
*
* 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.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.style.StyleNumFormatAttribute;
import org.odftoolkit.odfdom.dom.attribute.style.StyleNumLetterSyncAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextFormulaAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextRefNameAttribute;
import org.odftoolkit.odfdom.pkg.ElementVisitor;
import org.odftoolkit.odfdom.pkg.OdfElement;
import org.odftoolkit.odfdom.pkg.OdfFileDom;
import org.odftoolkit.odfdom.pkg.OdfName;
/** DOM implementation of OpenDocument element {@odf.element text:sequence}. */
public class TextSequenceElement extends OdfElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TEXT, "sequence");
/**
* Create the instance of TextSequenceElement
*
* @param ownerDoc The type is OdfFileDom
*/
public TextSequenceElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element text:sequence}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation StyleNumFormatAttribute
* , See {@odf.attribute style:num-format}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getStyleNumFormatAttribute() {
StyleNumFormatAttribute attr =
(StyleNumFormatAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "num-format");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation StyleNumFormatAttribute , See
* {@odf.attribute style:num-format}
*
* @param styleNumFormatValue The type is String
*/
public void setStyleNumFormatAttribute(String styleNumFormatValue) {
StyleNumFormatAttribute attr = new StyleNumFormatAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(styleNumFormatValue);
}
/**
* Receives the value of the ODFDOM attribute representation StyleNumLetterSyncAttribute
* , See {@odf.attribute style:num-letter-sync}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getStyleNumLetterSyncAttribute() {
StyleNumLetterSyncAttribute attr =
(StyleNumLetterSyncAttribute)
getOdfAttribute(OdfDocumentNamespace.STYLE, "num-letter-sync");
if (attr != null && !attr.getValue().isEmpty()) {
return Boolean.valueOf(attr.booleanValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation StyleNumLetterSyncAttribute ,
* See {@odf.attribute style:num-letter-sync}
*
* @param styleNumLetterSyncValue The type is Boolean
*/
public void setStyleNumLetterSyncAttribute(Boolean styleNumLetterSyncValue) {
StyleNumLetterSyncAttribute attr =
new StyleNumLetterSyncAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(styleNumLetterSyncValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation TextFormulaAttribute ,
* See {@odf.attribute text:formula}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getTextFormulaAttribute() {
TextFormulaAttribute attr =
(TextFormulaAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "formula");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextFormulaAttribute , See
* {@odf.attribute text:formula}
*
* @param textFormulaValue The type is String
*/
public void setTextFormulaAttribute(String textFormulaValue) {
TextFormulaAttribute attr = new TextFormulaAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textFormulaValue);
}
/**
* 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 TextRefNameAttribute ,
* See {@odf.attribute text:ref-name}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getTextRefNameAttribute() {
TextRefNameAttribute attr =
(TextRefNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "ref-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextRefNameAttribute , See
* {@odf.attribute text:ref-name}
*
* @param textRefNameValue The type is String
*/
public void setTextRefNameAttribute(String textRefNameValue) {
TextRefNameAttribute attr = new TextRefNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textRefNameValue);
}
/**
* Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design
* pattern to get a better understanding.
*
* @param visitor an instance of DefaultElementVisitor
*/
@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));
}
}
}