org.odftoolkit.odfdom.dom.element.text.TextOutlineLevelStyleElement 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.style.StyleNumPrefixAttribute;
import org.odftoolkit.odfdom.dom.attribute.style.StyleNumSuffixAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextDisplayLevelsAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextLevelAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStartValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStyleNameAttribute;
import org.odftoolkit.odfdom.dom.element.OdfStyleBase;
import org.odftoolkit.odfdom.dom.element.style.StyleListLevelPropertiesElement;
import org.odftoolkit.odfdom.dom.element.style.StyleTextPropertiesElement;
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:outline-level-style}. */
public class TextOutlineLevelStyleElement extends OdfStyleBase {
public static final OdfName ELEMENT_NAME =
OdfName.newName(OdfDocumentNamespace.TEXT, "outline-level-style");
/**
* Create the instance of TextOutlineLevelStyleElement
*
* @param ownerDoc The type is OdfFileDom
*/
public TextOutlineLevelStyleElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element
* text:outline-level-style}.
*/
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 StyleNumPrefixAttribute
* , See {@odf.attribute style:num-prefix}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getStyleNumPrefixAttribute() {
StyleNumPrefixAttribute attr =
(StyleNumPrefixAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "num-prefix");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation StyleNumPrefixAttribute , See
* {@odf.attribute style:num-prefix}
*
* @param styleNumPrefixValue The type is String
*/
public void setStyleNumPrefixAttribute(String styleNumPrefixValue) {
StyleNumPrefixAttribute attr = new StyleNumPrefixAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(styleNumPrefixValue);
}
/**
* Receives the value of the ODFDOM attribute representation StyleNumSuffixAttribute
* , See {@odf.attribute style:num-suffix}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getStyleNumSuffixAttribute() {
StyleNumSuffixAttribute attr =
(StyleNumSuffixAttribute) getOdfAttribute(OdfDocumentNamespace.STYLE, "num-suffix");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation StyleNumSuffixAttribute , See
* {@odf.attribute style:num-suffix}
*
* @param styleNumSuffixValue The type is String
*/
public void setStyleNumSuffixAttribute(String styleNumSuffixValue) {
StyleNumSuffixAttribute attr = new StyleNumSuffixAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(styleNumSuffixValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextDisplayLevelsAttribute
* , See {@odf.attribute text:display-levels}
*
* @return - the Integer , the value or null, if the attribute is not
* set and no default value defined.
*/
public Integer getTextDisplayLevelsAttribute() {
TextDisplayLevelsAttribute attr =
(TextDisplayLevelsAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "display-levels");
if (attr != null && !attr.getValue().isEmpty()) {
return Integer.valueOf(attr.intValue());
}
return Integer.valueOf(TextDisplayLevelsAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation TextDisplayLevelsAttribute , See
* {@odf.attribute text:display-levels}
*
* @param textDisplayLevelsValue The type is Integer
*/
public void setTextDisplayLevelsAttribute(Integer textDisplayLevelsValue) {
TextDisplayLevelsAttribute attr =
new TextDisplayLevelsAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(textDisplayLevelsValue.intValue());
}
/**
* Receives the value of the ODFDOM attribute representation TextLevelAttribute , See
* {@odf.attribute text:level}
*
*
Attribute is mandatory.
*
* @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 null;
}
/**
* 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 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 Integer.valueOf(TextStartValueAttribute.DEFAULT_VALUE);
}
/**
* 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);
}
/**
* Create child element {@odf.element style:list-level-properties}.
*
* @return the element {@odf.element style:list-level-properties}
*/
public StyleListLevelPropertiesElement newStyleListLevelPropertiesElement() {
StyleListLevelPropertiesElement styleListLevelProperties =
((OdfFileDom) this.ownerDocument).newOdfElement(StyleListLevelPropertiesElement.class);
this.appendChild(styleListLevelProperties);
return styleListLevelProperties;
}
/**
* Create child element {@odf.element style:text-properties}.
*
* @param textDisplayValue the String value of TextDisplayAttribute, see
* {@odf.attribute text:display} at specification
* @return the element {@odf.element style:text-properties}
*/
public StyleTextPropertiesElement newStyleTextPropertiesElement(String textDisplayValue) {
StyleTextPropertiesElement styleTextProperties =
((OdfFileDom) this.ownerDocument).newOdfElement(StyleTextPropertiesElement.class);
styleTextProperties.setTextDisplayAttribute(textDisplayValue);
this.appendChild(styleTextProperties);
return styleTextProperties;
}
/**
* 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);
}
}
}