org.odftoolkit.odfdom.dom.element.text.TextNotesConfigurationElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of odfdom-java Show documentation
Show all versions of odfdom-java Show documentation
ODFDOM is an OpenDocument Format (ODF) framework. Its purpose
is to provide an easy common way to create, access and
manipulate ODF files, without requiring detailed knowledge of
the ODF specification. It is designed to provide the ODF
developer community with an easy lightwork programming API
portable to any object-oriented language.
The current reference implementation is written in Java.
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.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.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.TextCitationBodyStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextCitationStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextDefaultStyleNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextFootnotesPositionAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextMasterPageNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextNoteClassAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStartNumberingAtAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextStartValueAttribute;
/**
* DOM implementation of OpenDocument element {@odf.element text:notes-configuration}.
*
*/
public class TextNotesConfigurationElement extends OdfElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.TEXT, "notes-configuration");
/**
* Create the instance of TextNotesConfigurationElement
*
* @param ownerDoc The type is OdfFileDom
*/
public TextNotesConfigurationElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element text:notes-configuration}.
*/
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) {
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 TextCitationBodyStyleNameAttribute , See {@odf.attribute text:citation-body-style-name}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextCitationBodyStyleNameAttribute() {
TextCitationBodyStyleNameAttribute attr = (TextCitationBodyStyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "citation-body-style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextCitationBodyStyleNameAttribute , See {@odf.attribute text:citation-body-style-name}
*
* @param textCitationBodyStyleNameValue The type is String
*/
public void setTextCitationBodyStyleNameAttribute(String textCitationBodyStyleNameValue) {
TextCitationBodyStyleNameAttribute attr = new TextCitationBodyStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textCitationBodyStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextCitationStyleNameAttribute , See {@odf.attribute text:citation-style-name}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextCitationStyleNameAttribute() {
TextCitationStyleNameAttribute attr = (TextCitationStyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "citation-style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextCitationStyleNameAttribute , See {@odf.attribute text:citation-style-name}
*
* @param textCitationStyleNameValue The type is String
*/
public void setTextCitationStyleNameAttribute(String textCitationStyleNameValue) {
TextCitationStyleNameAttribute attr = new TextCitationStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textCitationStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextDefaultStyleNameAttribute , See {@odf.attribute text:default-style-name}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextDefaultStyleNameAttribute() {
TextDefaultStyleNameAttribute attr = (TextDefaultStyleNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "default-style-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextDefaultStyleNameAttribute , See {@odf.attribute text:default-style-name}
*
* @param textDefaultStyleNameValue The type is String
*/
public void setTextDefaultStyleNameAttribute(String textDefaultStyleNameValue) {
TextDefaultStyleNameAttribute attr = new TextDefaultStyleNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textDefaultStyleNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextFootnotesPositionAttribute , See {@odf.attribute text:footnotes-position}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextFootnotesPositionAttribute() {
TextFootnotesPositionAttribute attr = (TextFootnotesPositionAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "footnotes-position");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextFootnotesPositionAttribute , See {@odf.attribute text:footnotes-position}
*
* @param textFootnotesPositionValue The type is String
*/
public void setTextFootnotesPositionAttribute(String textFootnotesPositionValue) {
TextFootnotesPositionAttribute attr = new TextFootnotesPositionAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textFootnotesPositionValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextMasterPageNameAttribute , See {@odf.attribute text:master-page-name}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextMasterPageNameAttribute() {
TextMasterPageNameAttribute attr = (TextMasterPageNameAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "master-page-name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextMasterPageNameAttribute , See {@odf.attribute text:master-page-name}
*
* @param textMasterPageNameValue The type is String
*/
public void setTextMasterPageNameAttribute(String textMasterPageNameValue) {
TextMasterPageNameAttribute attr = new TextMasterPageNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textMasterPageNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextNoteClassAttribute , See {@odf.attribute text:note-class}
*
* Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextNoteClassAttribute() {
TextNoteClassAttribute attr = (TextNoteClassAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "note-class");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextNoteClassAttribute , See {@odf.attribute text:note-class}
*
* @param textNoteClassValue The type is String
*/
public void setTextNoteClassAttribute(String textNoteClassValue) {
TextNoteClassAttribute attr = new TextNoteClassAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textNoteClassValue);
}
/**
* Receives the value of the ODFDOM attribute representation TextStartNumberingAtAttribute , See {@odf.attribute text:start-numbering-at}
*
* @return - the String , the value or null, if the attribute is not set and no default value defined.
*/
public String getTextStartNumberingAtAttribute() {
TextStartNumberingAtAttribute attr = (TextStartNumberingAtAttribute) getOdfAttribute(OdfDocumentNamespace.TEXT, "start-numbering-at");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation TextStartNumberingAtAttribute , See {@odf.attribute text:start-numbering-at}
*
* @param textStartNumberingAtValue The type is String
*/
public void setTextStartNumberingAtAttribute(String textStartNumberingAtValue) {
TextStartNumberingAtAttribute attr = new TextStartNumberingAtAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(textStartNumberingAtValue);
}
/**
* 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) {
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());
}
/**
* Create child element {@odf.element text:note-continuation-notice-backward}.
*
* @return the element {@odf.element text:note-continuation-notice-backward}
*/
public TextNoteContinuationNoticeBackwardElement newTextNoteContinuationNoticeBackwardElement() {
TextNoteContinuationNoticeBackwardElement textNoteContinuationNoticeBackward = ((OdfFileDom) this.ownerDocument).newOdfElement(TextNoteContinuationNoticeBackwardElement.class);
this.appendChild(textNoteContinuationNoticeBackward);
return textNoteContinuationNoticeBackward;
}
/**
* Create child element {@odf.element text:note-continuation-notice-forward}.
*
* @return the element {@odf.element text:note-continuation-notice-forward}
*/
public TextNoteContinuationNoticeForwardElement newTextNoteContinuationNoticeForwardElement() {
TextNoteContinuationNoticeForwardElement textNoteContinuationNoticeForward = ((OdfFileDom) this.ownerDocument).newOdfElement(TextNoteContinuationNoticeForwardElement.class);
this.appendChild(textNoteContinuationNoticeForward);
return textNoteContinuationNoticeForward;
}
@Override
public void accept(ElementVisitor visitor) {
if (visitor instanceof DefaultElementVisitor) {
DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
defaultVisitor.visit(this);
} else {
visitor.visit(this);
}
}
}