Package org.odftoolkit.odfdom.dom.element.form

Class FormFormElement

java.lang.Object
org.apache.xerces.dom.NodeImpl
org.apache.xerces.dom.ChildNode
org.apache.xerces.dom.ParentNode
org.apache.xerces.dom.ElementImpl
org.apache.xerces.dom.ElementNSImpl
org.odftoolkit.odfdom.pkg.OdfElement
org.odftoolkit.odfdom.dom.element.form.FormFormElement
All Implemented Interfaces:
Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo
public class FormFormElement extends OdfElement
DOM implementation of OpenDocument element <form:form>.
See Also:

  • Field Details

    • ELEMENT_NAME

      public static final OdfName ELEMENT_NAME

  • Constructor Details

    • FormFormElement

      public FormFormElement(OdfFileDom ownerDoc)
      Create the instance of FormFormElement
      Parameters:
      ownerDoc - The type is OdfFileDom

  • Method Details

    • getOdfName

      public OdfName getOdfName()
      Get the element name
      Specified by:
      getOdfName in class OdfElement
      Returns:
      return OdfName the name of element <form:form>.

    • getFormAllowDeletesAttribute

      public Boolean getFormAllowDeletesAttribute()
      Receives the value of the ODFDOM attribute representation FormAllowDeletesAttribute , See @form:allow-deletes
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setFormAllowDeletesAttribute

      public void setFormAllowDeletesAttribute(Boolean formAllowDeletesValue)
      Sets the value of ODFDOM attribute representation FormAllowDeletesAttribute , See @form:allow-deletes
      Parameters:
      formAllowDeletesValue - The type is Boolean

    • getFormAllowInsertsAttribute

      public Boolean getFormAllowInsertsAttribute()
      Receives the value of the ODFDOM attribute representation FormAllowInsertsAttribute , See @form:allow-inserts
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setFormAllowInsertsAttribute

      public void setFormAllowInsertsAttribute(Boolean formAllowInsertsValue)
      Sets the value of ODFDOM attribute representation FormAllowInsertsAttribute , See @form:allow-inserts
      Parameters:
      formAllowInsertsValue - The type is Boolean

    • getFormAllowUpdatesAttribute

      public Boolean getFormAllowUpdatesAttribute()
      Receives the value of the ODFDOM attribute representation FormAllowUpdatesAttribute , See @form:allow-updates
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setFormAllowUpdatesAttribute

      public void setFormAllowUpdatesAttribute(Boolean formAllowUpdatesValue)
      Sets the value of ODFDOM attribute representation FormAllowUpdatesAttribute , See @form:allow-updates
      Parameters:
      formAllowUpdatesValue - The type is Boolean

    • getFormApplyFilterAttribute

      public Boolean getFormApplyFilterAttribute()
      Receives the value of the ODFDOM attribute representation FormApplyFilterAttribute , See @form:apply-filter
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setFormApplyFilterAttribute

      public void setFormApplyFilterAttribute(Boolean formApplyFilterValue)
      Sets the value of ODFDOM attribute representation FormApplyFilterAttribute , See @form:apply-filter
      Parameters:
      formApplyFilterValue - The type is Boolean

    • getFormCommandAttribute

      public String getFormCommandAttribute()
      Receives the value of the ODFDOM attribute representation FormCommandAttribute , See @form:command
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormCommandAttribute

      public void setFormCommandAttribute(String formCommandValue)
      Sets the value of ODFDOM attribute representation FormCommandAttribute , See @form:command
      Parameters:
      formCommandValue - The type is String

    • getFormCommandTypeAttribute

      public String getFormCommandTypeAttribute()
      Receives the value of the ODFDOM attribute representation FormCommandTypeAttribute , See @form:command-type
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormCommandTypeAttribute

      public void setFormCommandTypeAttribute(String formCommandTypeValue)
      Sets the value of ODFDOM attribute representation FormCommandTypeAttribute , See @form:command-type
      Parameters:
      formCommandTypeValue - The type is String

    • getFormControlImplementationAttribute

      public String getFormControlImplementationAttribute()
      Receives the value of the ODFDOM attribute representation FormControlImplementationAttribute , See @form:control-implementation
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormControlImplementationAttribute

      public void setFormControlImplementationAttribute(String formControlImplementationValue)
      Sets the value of ODFDOM attribute representation FormControlImplementationAttribute , See @form:control-implementation
      Parameters:
      formControlImplementationValue - The type is String

    • getFormDatasourceAttribute

      public String getFormDatasourceAttribute()
      Receives the value of the ODFDOM attribute representation FormDatasourceAttribute , See @form:datasource
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormDatasourceAttribute

      public void setFormDatasourceAttribute(String formDatasourceValue)
      Sets the value of ODFDOM attribute representation FormDatasourceAttribute , See @form:datasource
      Parameters:
      formDatasourceValue - The type is String

    • getFormDetailFieldsAttribute

      public String getFormDetailFieldsAttribute()
      Receives the value of the ODFDOM attribute representation FormDetailFieldsAttribute , See @form:detail-fields
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormDetailFieldsAttribute

      public void setFormDetailFieldsAttribute(String formDetailFieldsValue)
      Sets the value of ODFDOM attribute representation FormDetailFieldsAttribute , See @form:detail-fields
      Parameters:
      formDetailFieldsValue - The type is String

    • getFormEnctypeAttribute

      public String getFormEnctypeAttribute()
      Receives the value of the ODFDOM attribute representation FormEnctypeAttribute , See @form:enctype
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormEnctypeAttribute

      public void setFormEnctypeAttribute(String formEnctypeValue)
      Sets the value of ODFDOM attribute representation FormEnctypeAttribute , See @form:enctype
      Parameters:
      formEnctypeValue - The type is String

    • getFormEscapeProcessingAttribute

      public Boolean getFormEscapeProcessingAttribute()
      Receives the value of the ODFDOM attribute representation FormEscapeProcessingAttribute , See @form:escape-processing
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setFormEscapeProcessingAttribute

      public void setFormEscapeProcessingAttribute(Boolean formEscapeProcessingValue)
      Sets the value of ODFDOM attribute representation FormEscapeProcessingAttribute , See @form:escape-processing
      Parameters:
      formEscapeProcessingValue - The type is Boolean

    • getFormFilterAttribute

      public String getFormFilterAttribute()
      Receives the value of the ODFDOM attribute representation FormFilterAttribute , See @form:filter
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormFilterAttribute

      public void setFormFilterAttribute(String formFilterValue)
      Sets the value of ODFDOM attribute representation FormFilterAttribute , See @form:filter
      Parameters:
      formFilterValue - The type is String

    • getFormIgnoreResultAttribute

      public Boolean getFormIgnoreResultAttribute()
      Receives the value of the ODFDOM attribute representation FormIgnoreResultAttribute , See @form:ignore-result
      Returns:
      - the Boolean , the value or null, if the attribute is not set and no default value defined.

    • setFormIgnoreResultAttribute

      public void setFormIgnoreResultAttribute(Boolean formIgnoreResultValue)
      Sets the value of ODFDOM attribute representation FormIgnoreResultAttribute , See @form:ignore-result
      Parameters:
      formIgnoreResultValue - The type is Boolean

    • getFormMasterFieldsAttribute

      public String getFormMasterFieldsAttribute()
      Receives the value of the ODFDOM attribute representation FormMasterFieldsAttribute , See @form:master-fields
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormMasterFieldsAttribute

      public void setFormMasterFieldsAttribute(String formMasterFieldsValue)
      Sets the value of ODFDOM attribute representation FormMasterFieldsAttribute , See @form:master-fields
      Parameters:
      formMasterFieldsValue - The type is String

    • getFormMethodAttribute

      public String getFormMethodAttribute()
      Receives the value of the ODFDOM attribute representation FormMethodAttribute , See @form:method
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormMethodAttribute

      public void setFormMethodAttribute(String formMethodValue)
      Sets the value of ODFDOM attribute representation FormMethodAttribute , See @form:method
      Parameters:
      formMethodValue - The type is String

    • getFormNameAttribute

      public String getFormNameAttribute()
      Receives the value of the ODFDOM attribute representation FormNameAttribute , See @form:name
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormNameAttribute

      public void setFormNameAttribute(String formNameValue)
      Sets the value of ODFDOM attribute representation FormNameAttribute , See @form:name
      Parameters:
      formNameValue - The type is String

    • getFormNavigationModeAttribute

      public String getFormNavigationModeAttribute()
      Receives the value of the ODFDOM attribute representation FormNavigationModeAttribute , See @form:navigation-mode
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormNavigationModeAttribute

      public void setFormNavigationModeAttribute(String formNavigationModeValue)
      Sets the value of ODFDOM attribute representation FormNavigationModeAttribute , See @form:navigation-mode
      Parameters:
      formNavigationModeValue - The type is String

    • getFormOrderAttribute

      public String getFormOrderAttribute()
      Receives the value of the ODFDOM attribute representation FormOrderAttribute , See @form:order
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormOrderAttribute

      public void setFormOrderAttribute(String formOrderValue)
      Sets the value of ODFDOM attribute representation FormOrderAttribute , See @form:order
      Parameters:
      formOrderValue - The type is String

    • getFormTabCycleAttribute

      public String getFormTabCycleAttribute()
      Receives the value of the ODFDOM attribute representation FormTabCycleAttribute , See @form:tab-cycle
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setFormTabCycleAttribute

      public void setFormTabCycleAttribute(String formTabCycleValue)
      Sets the value of ODFDOM attribute representation FormTabCycleAttribute , See @form:tab-cycle
      Parameters:
      formTabCycleValue - The type is String

    • getOfficeTargetFrameAttribute

      public String getOfficeTargetFrameAttribute()
      Receives the value of the ODFDOM attribute representation OfficeTargetFrameAttribute , See @office:target-frame
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setOfficeTargetFrameAttribute

      public void setOfficeTargetFrameAttribute(String officeTargetFrameValue)
      Sets the value of ODFDOM attribute representation OfficeTargetFrameAttribute , See @office:target-frame
      Parameters:
      officeTargetFrameValue - The type is String

    • getXlinkActuateAttribute

      public String getXlinkActuateAttribute()
      Receives the value of the ODFDOM attribute representation XlinkActuateAttribute , See @xlink:actuate
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setXlinkActuateAttribute

      public void setXlinkActuateAttribute(String xlinkActuateValue)
      Sets the value of ODFDOM attribute representation XlinkActuateAttribute , See @xlink:actuate
      Parameters:
      xlinkActuateValue - The type is String

    • getXlinkHrefAttribute

      public String getXlinkHrefAttribute()
      Receives the value of the ODFDOM attribute representation XlinkHrefAttribute , See @xlink:href
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setXlinkHrefAttribute

      public void setXlinkHrefAttribute(String xlinkHrefValue)
      Sets the value of ODFDOM attribute representation XlinkHrefAttribute , See @xlink:href
      Parameters:
      xlinkHrefValue - The type is String

    • getXlinkTypeAttribute

      public String getXlinkTypeAttribute()
      Receives the value of the ODFDOM attribute representation XlinkTypeAttribute , See @xlink:type
      Returns:
      - the String , the value or null, if the attribute is not set and no default value defined.

    • setXlinkTypeAttribute

      public void setXlinkTypeAttribute(String xlinkTypeValue)
      Sets the value of ODFDOM attribute representation XlinkTypeAttribute , See @xlink:type
      Parameters:
      xlinkTypeValue - The type is String

    • newFormButtonElement

      public FormButtonElement newFormButtonElement(String formImagePositionValue, String xmlIdValue)
      Create child element <form:button>.
      Parameters:
      formImagePositionValue - the String value of FormImagePositionAttribute , see @form:image-position at specification
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:button>

    • newFormCheckboxElement

      public FormCheckboxElement newFormCheckboxElement(String formImagePositionValue, String xmlIdValue)
      Create child element <form:checkbox>.
      Parameters:
      formImagePositionValue - the String value of FormImagePositionAttribute , see @form:image-position at specification
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:checkbox>

    • newFormComboboxElement

      public FormComboboxElement newFormComboboxElement(String xmlIdValue)
      Create child element <form:combobox>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:combobox>

    • newFormConnectionResourceElement

      public FormConnectionResourceElement newFormConnectionResourceElement(String xlinkHrefValue)
      Create child element <form:connection-resource>.
      Parameters:
      xlinkHrefValue - the String value of XlinkHrefAttribute, see @xlink:href at specification
      Returns:
      the element <form:connection-resource>

    • newFormDateElement

      public FormDateElement newFormDateElement(String xmlIdValue)
      Create child element <form:date>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:date>

    • newFormFileElement

      public FormFileElement newFormFileElement(String xmlIdValue)
      Create child element <form:file>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:file>

    • newFormFixedTextElement

      public FormFixedTextElement newFormFixedTextElement(String xmlIdValue)
      Create child element <form:fixed-text>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:fixed-text>

    • newFormFormElement

      public FormFormElement newFormFormElement()
      Create child element <form:form>.
      Returns:
      the element <form:form>

    • newFormFormattedTextElement

      public FormFormattedTextElement newFormFormattedTextElement(String xmlIdValue)
      Create child element <form:formatted-text>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:formatted-text>

    • newFormFrameElement

      public FormFrameElement newFormFrameElement(String xmlIdValue)
      Create child element <form:frame>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:frame>

    • newFormGenericControlElement

      public FormGenericControlElement newFormGenericControlElement(String xmlIdValue)
      Create child element <form:generic-control>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:generic-control>

    • newFormGridElement

      public FormGridElement newFormGridElement(String xmlIdValue)
      Create child element <form:grid>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:grid>

    • newFormHiddenElement

      public FormHiddenElement newFormHiddenElement(String xmlIdValue)
      Create child element <form:hidden>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:hidden>

    • newFormImageElement

      public FormImageElement newFormImageElement(String xmlIdValue)
      Create child element <form:image>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:image>

    • newFormImageFrameElement

      public FormImageFrameElement newFormImageFrameElement(String xmlIdValue)
      Create child element <form:image-frame>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:image-frame>

    • newFormListboxElement

      public FormListboxElement newFormListboxElement(String xmlIdValue)
      Create child element <form:listbox>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:listbox>

    • newFormNumberElement

      public FormNumberElement newFormNumberElement(String xmlIdValue)
      Create child element <form:number>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:number>

    • newFormPasswordElement

      public FormPasswordElement newFormPasswordElement(String xmlIdValue)
      Create child element <form:password>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:password>

    • newFormPropertiesElement

      public FormPropertiesElement newFormPropertiesElement()
      Create child element <form:properties>.
      Returns:
      the element <form:properties>

    • newFormRadioElement

      public FormRadioElement newFormRadioElement(String formImagePositionValue, String xmlIdValue)
      Create child element <form:radio>.
      Parameters:
      formImagePositionValue - the String value of FormImagePositionAttribute , see @form:image-position at specification
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:radio>

    • newFormTextElement

      public FormTextElement newFormTextElement(String xmlIdValue)
      Create child element <form:text>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:text>

    • newFormTextareaElement

      public FormTextareaElement newFormTextareaElement(String xmlIdValue)
      Create child element <form:textarea>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:textarea>

    • newFormTimeElement

      public FormTimeElement newFormTimeElement(String xmlIdValue)
      Create child element <form:time>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:time>

    • newFormValueRangeElement

      public FormValueRangeElement newFormValueRangeElement(String xmlIdValue)
      Create child element <form:value-range>.
      Parameters:
      xmlIdValue - the String value of XmlIdAttribute, see @xml:id at specification
      Returns:
      the element <form:value-range>

    • newOfficeEventListenersElement

      public OfficeEventListenersElement newOfficeEventListenersElement()
      Create child element <office:event-listeners>.
      Returns:
      the element <office:event-listeners>

    • accept

      public void accept(ElementVisitor visitor)
      Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design pattern to get a better understanding.
      Overrides:
      accept in class OdfElement
      Parameters:
      visitor - an instance of DefaultElementVisitor