org.odftoolkit.odfdom.dom.element.text.TextNumberedParagraphElement 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.text.TextContinueNumberingAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextLevelAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextListIdAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStartValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.xml.XmlIdAttribute;
import org.odftoolkit.odfdom.dom.element.OdfStylableElement;
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;
/** DOM implementation of OpenDocument element {@odf.element text:numbered-paragraph}. */
public class TextNumberedParagraphElement extends OdfStylableElement {
public static final OdfName ELEMENT_NAME =
OdfName.newName(OdfDocumentNamespace.TEXT, "numbered-paragraph");
/**
* Create the instance of TextNumberedParagraphElement
*
* @param ownerDoc The type is OdfFileDom
*/
public TextNumberedParagraphElement(OdfFileDom ownerDoc) {
super(
ownerDoc,
ELEMENT_NAME,
OdfStyleFamily.List,
OdfName.newName(OdfDocumentNamespace.TEXT, "style-name"));
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element text:numbered-paragraph}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation TextContinueNumberingAttribute
* , See {@odf.attribute text:continue-numbering}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getTextContinueNumberingAttribute() {
TextContinueNumberingAttribute attr =
(TextContinueNumberingAttribute)
getOdfAttribute(OdfDocumentNamespace.TEXT, "continue-numbering");
if (attr != null && !attr.getValue().isEmpty()) {
return Boolean.valueOf(attr.booleanValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextContinueNumberingAttribute ,
* See {@odf.attribute text:continue-numbering}
*
* @param textContinueNumberingValue The type is Boolean
*/
public void setTextContinueNumberingAttribute(Boolean textContinueNumberingValue) {
TextContinueNumberingAttribute attr =
new TextContinueNumberingAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(textContinueNumberingValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation TextLevelAttribute , See
* {@odf.attribute text:level}
*
* @return - the Integer , the value or null, if the attribute is not
* set and no default value defined.
*/
public Integer getTextLevelAttribute() {
TextLevelAttribute attr =
(TextLevelAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "level");
if (attr != null && !attr.getValue().isEmpty()) {
return Integer.valueOf(attr.intValue());
}
return Integer.valueOf(TextLevelAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation TextLevelAttribute , See
* {@odf.attribute text:level}
*
* @param textLevelValue The type is Integer
*/
public void setTextLevelAttribute(Integer textLevelValue) {
TextLevelAttribute attr = new TextLevelAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(textLevelValue.intValue());
}
/**
* Receives the value of the ODFDOM attribute representation TextListIdAttribute ,
* See {@odf.attribute text:list-id}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getTextListIdAttribute() {
TextListIdAttribute attr =
(TextListIdAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "list-id");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextListIdAttribute , See
* {@odf.attribute text:list-id}
*
* @param textListIdValue The type is String
*/
public void setTextListIdAttribute(String textListIdValue) {
TextListIdAttribute attr = new TextListIdAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textListIdValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextStartValueAttribute
* , See {@odf.attribute text:start-value}
*
* @return - the Integer , the value or null, if the attribute is not
* set and no default value defined.
*/
public Integer getTextStartValueAttribute() {
TextStartValueAttribute attr =
(TextStartValueAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "start-value");
if (attr != null && !attr.getValue().isEmpty()) {
return Integer.valueOf(attr.intValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextStartValueAttribute , See
* {@odf.attribute text:start-value}
*
* @param textStartValueValue The type is Integer
*/
public void setTextStartValueAttribute(Integer textStartValueValue) {
TextStartValueAttribute attr = new TextStartValueAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(textStartValueValue.intValue());
}
/**
* 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:h}.
*
* @param textOutlineLevelValue the Integer value of TextOutlineLevelAttribute
* , see {@odf.attribute text:outline-level} at specification
* @return the element {@odf.element text:h}
*/
public TextHElement newTextHElement(int textOutlineLevelValue) {
TextHElement textH = ((OdfFileDom) this.ownerDocument).newOdfElement(TextHElement.class);
textH.setTextOutlineLevelAttribute(textOutlineLevelValue);
this.appendChild(textH);
return textH;
}
/**
* Create child element {@odf.element text:number}.
*
* @return the element {@odf.element text:number}
*/
public TextNumberElement newTextNumberElement() {
TextNumberElement textNumber =
((OdfFileDom) this.ownerDocument).newOdfElement(TextNumberElement.class);
this.appendChild(textNumber);
return textNumber;
}
/**
* Create child element {@odf.element text:p}.
*
* @return the element {@odf.element text:p}
*/
public TextPElement newTextPElement() {
TextPElement textP = ((OdfFileDom) this.ownerDocument).newOdfElement(TextPElement.class);
this.appendChild(textP);
return textP;
}
/**
* 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);
}
}
}