org.odftoolkit.odfdom.dom.element.text.TextUserFieldDeclElement 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.office.OfficeBooleanValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeCurrencyAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeDateValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeStringValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeTimeValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeValueAttribute;
import org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextFormulaAttribute;
import org.odftoolkit.odfdom.dom.attribute.text.TextNameAttribute;
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:user-field-decl}. */
public class TextUserFieldDeclElement extends OdfElement {
public static final OdfName ELEMENT_NAME =
OdfName.newName(OdfDocumentNamespace.TEXT, "user-field-decl");
/**
* Create the instance of TextUserFieldDeclElement
*
* @param ownerDoc The type is OdfFileDom
*/
public TextUserFieldDeclElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element text:user-field-decl}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation OfficeBooleanValueAttribute
* , See {@odf.attribute office:boolean-value}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getOfficeBooleanValueAttribute() {
OfficeBooleanValueAttribute attr =
(OfficeBooleanValueAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "boolean-value");
if (attr != null && !attr.getValue().isEmpty()) {
return Boolean.valueOf(attr.booleanValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeBooleanValueAttribute ,
* See {@odf.attribute office:boolean-value}
*
* @param officeBooleanValueValue The type is Boolean
*/
public void setOfficeBooleanValueAttribute(Boolean officeBooleanValueValue) {
OfficeBooleanValueAttribute attr =
new OfficeBooleanValueAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(officeBooleanValueValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation OfficeCurrencyAttribute
* , See {@odf.attribute office:currency}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getOfficeCurrencyAttribute() {
OfficeCurrencyAttribute attr =
(OfficeCurrencyAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "currency");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeCurrencyAttribute , See
* {@odf.attribute office:currency}
*
* @param officeCurrencyValue The type is String
*/
public void setOfficeCurrencyAttribute(String officeCurrencyValue) {
OfficeCurrencyAttribute attr = new OfficeCurrencyAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(officeCurrencyValue);
}
/**
* Receives the value of the ODFDOM attribute representation OfficeDateValueAttribute
* , See {@odf.attribute office:date-value}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getOfficeDateValueAttribute() {
OfficeDateValueAttribute attr =
(OfficeDateValueAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "date-value");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeDateValueAttribute , See
* {@odf.attribute office:date-value}
*
* @param officeDateValueValue The type is String
*/
public void setOfficeDateValueAttribute(String officeDateValueValue) {
OfficeDateValueAttribute attr = new OfficeDateValueAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(officeDateValueValue);
}
/**
* Receives the value of the ODFDOM attribute representation OfficeStringValueAttribute
* , See {@odf.attribute office:string-value}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getOfficeStringValueAttribute() {
OfficeStringValueAttribute attr =
(OfficeStringValueAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "string-value");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeStringValueAttribute , See
* {@odf.attribute office:string-value}
*
* @param officeStringValueValue The type is String
*/
public void setOfficeStringValueAttribute(String officeStringValueValue) {
OfficeStringValueAttribute attr =
new OfficeStringValueAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(officeStringValueValue);
}
/**
* Receives the value of the ODFDOM attribute representation OfficeTimeValueAttribute
* , See {@odf.attribute office:time-value}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getOfficeTimeValueAttribute() {
OfficeTimeValueAttribute attr =
(OfficeTimeValueAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "time-value");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeTimeValueAttribute , See
* {@odf.attribute office:time-value}
*
* @param officeTimeValueValue The type is String
*/
public void setOfficeTimeValueAttribute(String officeTimeValueValue) {
OfficeTimeValueAttribute attr = new OfficeTimeValueAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(officeTimeValueValue);
}
/**
* Receives the value of the ODFDOM attribute representation OfficeValueAttribute ,
* See {@odf.attribute office:value}
*
*
Attribute is mandatory.
*
* @return - the Double , the value or null, if the attribute is not set
* and no default value defined.
*/
public Double getOfficeValueAttribute() {
OfficeValueAttribute attr =
(OfficeValueAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "value");
if (attr != null && !attr.getValue().isEmpty()) {
return Double.valueOf(attr.doubleValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeValueAttribute , See
* {@odf.attribute office:value}
*
* @param officeValueValue The type is Double
*/
public void setOfficeValueAttribute(Double officeValueValue) {
OfficeValueAttribute attr = new OfficeValueAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setDoubleValue(officeValueValue.doubleValue());
}
/**
* Receives the value of the ODFDOM attribute representation OfficeValueTypeAttribute
* , See {@odf.attribute office:value-type}
*
*
Attribute is mandatory.
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getOfficeValueTypeAttribute() {
OfficeValueTypeAttribute attr =
(OfficeValueTypeAttribute) getOdfAttribute(OdfDocumentNamespace.OFFICE, "value-type");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation OfficeValueTypeAttribute , See
* {@odf.attribute office:value-type}
*
* @param officeValueTypeValue The type is String
*/
public void setOfficeValueTypeAttribute(String officeValueTypeValue) {
OfficeValueTypeAttribute attr = new OfficeValueTypeAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(officeValueTypeValue);
}
/**
* 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);
}
/**
* 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);
}
}
/** Removes all the content from the element */
@Override
public void removeContent() {
super.removeContent();
this.removeAttributeNS(OdfDocumentNamespace.OFFICE.getUri(), "value");
this.removeAttributeNS(OdfDocumentNamespace.OFFICE.getUri(), "value-type");
this.removeAttributeNS(OdfDocumentNamespace.OFFICE.getUri(), "time-value");
this.removeAttributeNS(OdfDocumentNamespace.OFFICE.getUri(), "date-value");
this.removeAttributeNS(OdfDocumentNamespace.OFFICE.getUri(), "boolean-value");
this.removeAttributeNS(
"urn:org:documentfoundation:names:experimental:calc:xmlns:calcext:1.0", "value-type");
this.removeAttributeNS(OdfDocumentNamespace.TABLE.getUri(), "formula");
}
}