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

Class FormButtonElement

    • Field Detail

      • ELEMENT_NAME

        public static final OdfName ELEMENT_NAME

    • Constructor Detail

      • FormButtonElement

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

    • Method Detail

      • getFormButtonTypeAttribute

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

      • setFormButtonTypeAttribute

        public void setFormButtonTypeAttribute​(String formButtonTypeValue)
        Sets the value of ODFDOM attribute representation FormButtonTypeAttribute , See @form:button-type
        Parameters:
        formButtonTypeValue - 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

      • getFormDefaultButtonAttribute

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

      • setFormDefaultButtonAttribute

        public void setFormDefaultButtonAttribute​(Boolean formDefaultButtonValue)
        Sets the value of ODFDOM attribute representation FormDefaultButtonAttribute , See @form:default-button
        Parameters:
        formDefaultButtonValue - The type is Boolean

      • getFormDelayForRepeatAttribute

        public String getFormDelayForRepeatAttribute()
        Receives the value of the ODFDOM attribute representation FormDelayForRepeatAttribute , See @form:delay-for-repeat
        Returns:
        - the String , the value or null, if the attribute is not set and no default value defined.

      • setFormDelayForRepeatAttribute

        public void setFormDelayForRepeatAttribute​(String formDelayForRepeatValue)
        Sets the value of ODFDOM attribute representation FormDelayForRepeatAttribute , See @form:delay-for-repeat
        Parameters:
        formDelayForRepeatValue - The type is String

      • getFormDisabledAttribute

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

      • setFormDisabledAttribute

        public void setFormDisabledAttribute​(Boolean formDisabledValue)
        Sets the value of ODFDOM attribute representation FormDisabledAttribute , See @form:disabled
        Parameters:
        formDisabledValue - The type is Boolean

      • getFormFocusOnClickAttribute

        public Boolean getFormFocusOnClickAttribute()
        Receives the value of the ODFDOM attribute representation FormFocusOnClickAttribute , See @form:focus-on-click
        Returns:
        - the Boolean , the value or null, if the attribute is not set and no default value defined.

      • setFormFocusOnClickAttribute

        public void setFormFocusOnClickAttribute​(Boolean formFocusOnClickValue)
        Sets the value of ODFDOM attribute representation FormFocusOnClickAttribute , See @form:focus-on-click
        Parameters:
        formFocusOnClickValue - The type is Boolean

      • getFormIdAttribute

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

      • setFormIdAttribute

        public void setFormIdAttribute​(String formIdValue)
        Sets the value of ODFDOM attribute representation FormIdAttribute , See @form:id
        Parameters:
        formIdValue - The type is String

      • getFormImageAlignAttribute

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

      • setFormImageAlignAttribute

        public void setFormImageAlignAttribute​(String formImageAlignValue)
        Sets the value of ODFDOM attribute representation FormImageAlignAttribute , See @form:image-align
        Parameters:
        formImageAlignValue - The type is String

      • getFormImageDataAttribute

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

      • setFormImageDataAttribute

        public void setFormImageDataAttribute​(String formImageDataValue)
        Sets the value of ODFDOM attribute representation FormImageDataAttribute , See @form:image-data
        Parameters:
        formImageDataValue - The type is String

      • getFormImagePositionAttribute

        public String getFormImagePositionAttribute()
        Receives the value of the ODFDOM attribute representation FormImagePositionAttribute , See @form:image-position

        Attribute is mandatory.

        Returns:
        - the String , the value or null, if the attribute is not set and no default value defined.

      • setFormImagePositionAttribute

        public void setFormImagePositionAttribute​(String formImagePositionValue)
        Sets the value of ODFDOM attribute representation FormImagePositionAttribute , See @form:image-position
        Parameters:
        formImagePositionValue - The type is String

      • getFormLabelAttribute

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

      • setFormLabelAttribute

        public void setFormLabelAttribute​(String formLabelValue)
        Sets the value of ODFDOM attribute representation FormLabelAttribute , See @form:label
        Parameters:
        formLabelValue - 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

      • getFormPrintableAttribute

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

      • setFormPrintableAttribute

        public void setFormPrintableAttribute​(Boolean formPrintableValue)
        Sets the value of ODFDOM attribute representation FormPrintableAttribute , See @form:printable
        Parameters:
        formPrintableValue - The type is Boolean

      • getFormRepeatAttribute

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

      • setFormRepeatAttribute

        public void setFormRepeatAttribute​(Boolean formRepeatValue)
        Sets the value of ODFDOM attribute representation FormRepeatAttribute , See @form:repeat
        Parameters:
        formRepeatValue - The type is Boolean

      • getFormTabIndexAttribute

        public Integer getFormTabIndexAttribute()
        Receives the value of the ODFDOM attribute representation FormTabIndexAttribute , See @form:tab-index
        Returns:
        - the Integer , the value or null, if the attribute is not set and no default value defined.

      • setFormTabIndexAttribute

        public void setFormTabIndexAttribute​(Integer formTabIndexValue)
        Sets the value of ODFDOM attribute representation FormTabIndexAttribute , See @form:tab-index
        Parameters:
        formTabIndexValue - The type is Integer

      • getFormTabStopAttribute

        public Boolean getFormTabStopAttribute()
        Receives the value of the ODFDOM attribute representation FormTabStopAttribute , See @form:tab-stop
        Returns:
        - the Boolean , the value or null, if the attribute is not set and no default value defined.

      • setFormTabStopAttribute

        public void setFormTabStopAttribute​(Boolean formTabStopValue)
        Sets the value of ODFDOM attribute representation FormTabStopAttribute , See @form:tab-stop
        Parameters:
        formTabStopValue - The type is Boolean

      • getFormTitleAttribute

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

      • setFormTitleAttribute

        public void setFormTitleAttribute​(String formTitleValue)
        Sets the value of ODFDOM attribute representation FormTitleAttribute , See @form:title
        Parameters:
        formTitleValue - The type is String

      • getFormToggleAttribute

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

      • setFormToggleAttribute

        public void setFormToggleAttribute​(Boolean formToggleValue)
        Sets the value of ODFDOM attribute representation FormToggleAttribute , See @form:toggle
        Parameters:
        formToggleValue - The type is Boolean

      • getFormValueAttribute

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

      • setFormValueAttribute

        public void setFormValueAttribute​(String formValueValue)
        Sets the value of ODFDOM attribute representation FormValueAttribute , See @form:value
        Parameters:
        formValueValue - The type is String

      • getFormXformsSubmissionAttribute

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

      • setFormXformsSubmissionAttribute

        public void setFormXformsSubmissionAttribute​(String formXformsSubmissionValue)
        Sets the value of ODFDOM attribute representation FormXformsSubmissionAttribute , See @form:xforms-submission
        Parameters:
        formXformsSubmissionValue - 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

      • getXformsBindAttribute

        public String getXformsBindAttribute()
        Receives the value of the ODFDOM attribute representation XformsBindAttribute , See @xforms:bind
        Returns:
        - the String , the value or null, if the attribute is not set and no default value defined.

      • setXformsBindAttribute

        public void setXformsBindAttribute​(String xformsBindValue)
        Sets the value of ODFDOM attribute representation XformsBindAttribute , See @xforms:bind
        Parameters:
        xformsBindValue - 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

      • getXmlIdAttribute

        public String getXmlIdAttribute()
        Receives the value of the ODFDOM attribute representation XmlIdAttribute , See @xml:id

        Attribute is mandatory.

        Returns:
        - the String , the value or null, if the attribute is not set and no default value defined.

      • setXmlIdAttribute

        public void setXmlIdAttribute​(String xmlIdValue)
        Sets the value of ODFDOM attribute representation XmlIdAttribute , See @xml:id
        Parameters:
        xmlIdValue - The type is String

      • 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