org.odftoolkit.odfdom.dom.element.form.FormGridElement 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.form;
import org.odftoolkit.odfdom.dom.DefaultElementVisitor;
import org.odftoolkit.odfdom.dom.OdfDocumentNamespace;
import org.odftoolkit.odfdom.dom.attribute.form.FormControlImplementationAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormDisabledAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormIdAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormNameAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormPrintableAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormTabIndexAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormTabStopAttribute;
import org.odftoolkit.odfdom.dom.attribute.form.FormTitleAttribute;
import org.odftoolkit.odfdom.dom.attribute.xforms.XformsBindAttribute;
import org.odftoolkit.odfdom.dom.attribute.xml.XmlIdAttribute;
import org.odftoolkit.odfdom.dom.element.office.OfficeEventListenersElement;
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 form:grid}. */
public class FormGridElement extends OdfElement {
public static final OdfName ELEMENT_NAME = OdfName.newName(OdfDocumentNamespace.FORM, "grid");
/**
* Create the instance of FormGridElement
*
* @param ownerDoc The type is OdfFileDom
*/
public FormGridElement(OdfFileDom ownerDoc) {
super(ownerDoc, ELEMENT_NAME);
}
/**
* Get the element name
*
* @return return OdfName the name of element {@odf.element form:grid}.
*/
public OdfName getOdfName() {
return ELEMENT_NAME;
}
/**
* Receives the value of the ODFDOM attribute representation
* FormControlImplementationAttribute , See {@odf.attribute form:control-implementation}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getFormControlImplementationAttribute() {
FormControlImplementationAttribute attr =
(FormControlImplementationAttribute)
getOdfAttribute(OdfDocumentNamespace.FORM, "control-implementation");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation FormControlImplementationAttribute
* , See {@odf.attribute form:control-implementation}
*
* @param formControlImplementationValue The type is String
*/
public void setFormControlImplementationAttribute(String formControlImplementationValue) {
FormControlImplementationAttribute attr =
new FormControlImplementationAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(formControlImplementationValue);
}
/**
* Receives the value of the ODFDOM attribute representation FormDisabledAttribute ,
* See {@odf.attribute form:disabled}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getFormDisabledAttribute() {
FormDisabledAttribute attr =
(FormDisabledAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "disabled");
if (attr != null) {
return Boolean.valueOf(attr.booleanValue());
}
return Boolean.valueOf(FormDisabledAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation FormDisabledAttribute , See
* {@odf.attribute form:disabled}
*
* @param formDisabledValue The type is Boolean
*/
public void setFormDisabledAttribute(Boolean formDisabledValue) {
FormDisabledAttribute attr = new FormDisabledAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(formDisabledValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation FormIdAttribute , See
* {@odf.attribute form:id}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getFormIdAttribute() {
FormIdAttribute attr = (FormIdAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "id");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation FormIdAttribute , See
* {@odf.attribute form:id}
*
* @param formIdValue The type is String
*/
public void setFormIdAttribute(String formIdValue) {
FormIdAttribute attr = new FormIdAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(formIdValue);
}
/**
* Receives the value of the ODFDOM attribute representation FormNameAttribute , See
* {@odf.attribute form:name}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getFormNameAttribute() {
FormNameAttribute attr = (FormNameAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "name");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation FormNameAttribute , See
* {@odf.attribute form:name}
*
* @param formNameValue The type is String
*/
public void setFormNameAttribute(String formNameValue) {
FormNameAttribute attr = new FormNameAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(formNameValue);
}
/**
* Receives the value of the ODFDOM attribute representation FormPrintableAttribute ,
* See {@odf.attribute form:printable}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getFormPrintableAttribute() {
FormPrintableAttribute attr =
(FormPrintableAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "printable");
if (attr != null) {
return Boolean.valueOf(attr.booleanValue());
}
return Boolean.valueOf(FormPrintableAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation FormPrintableAttribute , See
* {@odf.attribute form:printable}
*
* @param formPrintableValue The type is Boolean
*/
public void setFormPrintableAttribute(Boolean formPrintableValue) {
FormPrintableAttribute attr = new FormPrintableAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(formPrintableValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation FormTabIndexAttribute ,
* See {@odf.attribute form:tab-index}
*
* @return - the Integer , the value or null, if the attribute is not
* set and no default value defined.
*/
public Integer getFormTabIndexAttribute() {
FormTabIndexAttribute attr =
(FormTabIndexAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "tab-index");
if (attr != null) {
return Integer.valueOf(attr.intValue());
}
return Integer.valueOf(FormTabIndexAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation FormTabIndexAttribute , See
* {@odf.attribute form:tab-index}
*
* @param formTabIndexValue The type is Integer
*/
public void setFormTabIndexAttribute(Integer formTabIndexValue) {
FormTabIndexAttribute attr = new FormTabIndexAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setIntValue(formTabIndexValue.intValue());
}
/**
* Receives the value of the ODFDOM attribute representation FormTabStopAttribute ,
* See {@odf.attribute form:tab-stop}
*
* @return - the Boolean , the value or null, if the attribute is not
* set and no default value defined.
*/
public Boolean getFormTabStopAttribute() {
FormTabStopAttribute attr =
(FormTabStopAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "tab-stop");
if (attr != null) {
return Boolean.valueOf(attr.booleanValue());
}
return Boolean.valueOf(FormTabStopAttribute.DEFAULT_VALUE);
}
/**
* Sets the value of ODFDOM attribute representation FormTabStopAttribute , See
* {@odf.attribute form:tab-stop}
*
* @param formTabStopValue The type is Boolean
*/
public void setFormTabStopAttribute(Boolean formTabStopValue) {
FormTabStopAttribute attr = new FormTabStopAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setBooleanValue(formTabStopValue.booleanValue());
}
/**
* Receives the value of the ODFDOM attribute representation FormTitleAttribute , See
* {@odf.attribute form:title}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getFormTitleAttribute() {
FormTitleAttribute attr =
(FormTitleAttribute) getOdfAttribute(OdfDocumentNamespace.FORM, "title");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation FormTitleAttribute , See
* {@odf.attribute form:title}
*
* @param formTitleValue The type is String
*/
public void setFormTitleAttribute(String formTitleValue) {
FormTitleAttribute attr = new FormTitleAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(formTitleValue);
}
/**
* Receives the value of the ODFDOM attribute representation XformsBindAttribute ,
* See {@odf.attribute xforms:bind}
*
* @return - the String , the value or null, if the attribute is not set
* and no default value defined.
*/
public String getXformsBindAttribute() {
XformsBindAttribute attr =
(XformsBindAttribute) getOdfAttribute(OdfDocumentNamespace.XFORMS, "bind");
if (attr != null) {
return String.valueOf(attr.getValue());
}
return null;
}
/**
* Sets the value of ODFDOM attribute representation XformsBindAttribute , See
* {@odf.attribute xforms:bind}
*
* @param xformsBindValue The type is String
*/
public void setXformsBindAttribute(String xformsBindValue) {
XformsBindAttribute attr = new XformsBindAttribute((OdfFileDom) this.ownerDocument);
setOdfAttribute(attr);
attr.setValue(xformsBindValue);
}
/**
* Receives the value of the ODFDOM attribute representation XmlIdAttribute , See
* {@odf.attribute xml:id}
*
*
Attribute is mandatory.
*
* @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 form:column}.
*
* @return the element {@odf.element form:column}
*/
public FormColumnElement newFormColumnElement() {
FormColumnElement formColumn =
((OdfFileDom) this.ownerDocument).newOdfElement(FormColumnElement.class);
this.appendChild(formColumn);
return formColumn;
}
/**
* Create child element {@odf.element form:properties}.
*
* @return the element {@odf.element form:properties}
*/
public FormPropertiesElement newFormPropertiesElement() {
FormPropertiesElement formProperties =
((OdfFileDom) this.ownerDocument).newOdfElement(FormPropertiesElement.class);
this.appendChild(formProperties);
return formProperties;
}
/**
* Create child element {@odf.element office:event-listeners}.
*
* @return the element {@odf.element office:event-listeners}
*/
public OfficeEventListenersElement newOfficeEventListenersElement() {
OfficeEventListenersElement officeEventListeners =
((OdfFileDom) this.ownerDocument).newOdfElement(OfficeEventListenersElement.class);
this.appendChild(officeEventListeners);
return officeEventListeners;
}
@Override
public void accept(ElementVisitor visitor) {
if (visitor instanceof DefaultElementVisitor) {
DefaultElementVisitor defaultVisitor = (DefaultElementVisitor) visitor;
defaultVisitor.visit(this);
} else {
visitor.visit(this);
}
}
}