org.odftoolkit.odfdom.dom.element.number.NumberNumberElement 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.number;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.number.NumberDecimalPlacesAttribute;
import org.odftoolkit.odfdom.dom.attribute.number.NumberDecimalReplacementAttribute;
import org.odftoolkit.odfdom.dom.attribute.number.NumberDisplayFactorAttribute;
import org.odftoolkit.odfdom.dom.attribute.number.NumberGroupingAttribute;
import org.odftoolkit.odfdom.dom.attribute.number.NumberMinIntegerDigitsAttribute;
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 number:number}. */
public class NumberNumberElement extends OdfElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.NUMBER, "number");
/**
* Create the instance of NumberNumberElement
*
* @param ownerDoc The type is OdfFileDom
*/
public NumberNumberElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element number:number}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation NumberDecimalPlacesAttribute
* , See {@odf.attribute number:decimal-places}
*
* @return - the Integer , the value or null, if the attribute is not
* set and no default value defined.
*/
public Integer getNumberDecimalPlacesAttribute() {
NumberDecimalPlacesAttribute attr =
(NumberDecimalPlacesAttribute)
getOdfAttribute(OdfDocumentNamespace.NUMBER, "decimal-places");
if (attr != null && !attr.getValue().isEmpty()) {
return Integer.valueOf(attr.intValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation NumberDecimalPlacesAttribute ,
* See {@odf.attribute number:decimal-places}
*
* @param numberDecimalPlacesValue The type is Integer
*/
public void setNumberDecimalPlacesAttribute(Integer numberDecimalPlacesValue) {
NumberDecimalPlacesAttribute attr =
new NumberDecimalPlacesAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(numberDecimalPlacesValue.intValue());
}
/**
* Receives the value of the ODFDOM attribute representation
* NumberDecimalReplacementAttribute , See {@odf.attribute number:decimal-replacement}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getNumberDecimalReplacementAttribute() {
NumberDecimalReplacementAttribute attr =
(NumberDecimalReplacementAttribute)
getOdfAttribute(OdfDocumentNamespace.NUMBER, "decimal-replacement");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation NumberDecimalReplacementAttribute
* , See {@odf.attribute number:decimal-replacement}
*
* @param numberDecimalReplacementValue The type is String
*/
public void setNumberDecimalReplacementAttribute(String numberDecimalReplacementValue) {
NumberDecimalReplacementAttribute attr =
new NumberDecimalReplacementAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(numberDecimalReplacementValue);
}
/**
* Receives the value of the ODFDOM attribute representation NumberDisplayFactorAttribute
* , See {@odf.attribute number:display-factor}
*
* @return - the Double , the value or null, if the attribute is not set
* and no default value defined.
*/
public Double getNumberDisplayFactorAttribute() {
NumberDisplayFactorAttribute attr =
(NumberDisplayFactorAttribute)
getOdfAttribute(OdfDocumentNamespace.NUMBER, "display-factor");
if (attr != null && !attr.getValue().isEmpty()) {
return Double.valueOf(attr.doubleValue());
}
return Double.valueOf(NumberDisplayFactorAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation NumberDisplayFactorAttribute ,
* See {@odf.attribute number:display-factor}
*
* @param numberDisplayFactorValue The type is Double
*/
public void setNumberDisplayFactorAttribute(Double numberDisplayFactorValue) {
NumberDisplayFactorAttribute attr =
new NumberDisplayFactorAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setDoubleValue(numberDisplayFactorValue.doubleValue());
}
/**
* Receives the value of the ODFDOM attribute representation NumberGroupingAttribute
* , See {@odf.attribute number:grouping}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getNumberGroupingAttribute() {
NumberGroupingAttribute attr =
(NumberGroupingAttribute) getOdfAttribute(OdfDocumentNamespace.NUMBER, "grouping");
if (attr != null && !attr.getValue().isEmpty()) {
return Boolean.valueOf(attr.booleanValue());
}
return Boolean.valueOf(NumberGroupingAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation NumberGroupingAttribute , See
* {@odf.attribute number:grouping}
*
* @param numberGroupingValue The type is Boolean
*/
public void setNumberGroupingAttribute(Boolean numberGroupingValue) {
NumberGroupingAttribute attr = new NumberGroupingAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(numberGroupingValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation NumberMinIntegerDigitsAttribute
* , See {@odf.attribute number:min-integer-digits}
*
* @return - the Integer , the value or null, if the attribute is not
* set and no default value defined.
*/
public Integer getNumberMinIntegerDigitsAttribute() {
NumberMinIntegerDigitsAttribute attr =
(NumberMinIntegerDigitsAttribute)
getOdfAttribute(OdfDocumentNamespace.NUMBER, "min-integer-digits");
if (attr != null && !attr.getValue().isEmpty()) {
return Integer.valueOf(attr.intValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation NumberMinIntegerDigitsAttribute
* , See {@odf.attribute number:min-integer-digits}
*
* @param numberMinIntegerDigitsValue The type is Integer
*/
public void setNumberMinIntegerDigitsAttribute(Integer numberMinIntegerDigitsValue) {
NumberMinIntegerDigitsAttribute attr =
new NumberMinIntegerDigitsAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(numberMinIntegerDigitsValue.intValue());
}
/**
* Create child element {@odf.element number:embedded-text}.
*
* @param numberPositionValue the Integer value of NumberPositionAttribute
* , see {@odf.attribute number:position} at specification
* @return the element {@odf.element number:embedded-text}
*/
public NumberEmbeddedTextElement newNumberEmbeddedTextElement(int numberPositionValue) {
NumberEmbeddedTextElement numberEmbeddedText =
((OdfFileDom) this.ownerDocument).newOdfElement(NumberEmbeddedTextElement.class);
numberEmbeddedText.setNumberPositionAttribute(numberPositionValue);
this.appendChild(numberEmbeddedText);
return numberEmbeddedText;
}
/**
* 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);
}
}
}