(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.

:: com :: sun :: star :: form :: control ::

unpublished service SubmitButton
Usage Restrictions
not published
Description
specifies a button control which can execute external submissions

The model of the control has to support the ::com::sun::star::form::component::SubmitButton service.

The control is clickable. When clicked (by mouse or keyboard, or programmatically), the following happens:

  1. Any ::com::sun::star::form::submission::XSubmissionVetoListeners registered at the component are given the chance to veto the submission.
  2. The model of the control is examined for an external submission object. That is, ::com::sun::star::form::submission::XSubmissionSupplier::getSubmission is called at the model.
    If there is such a submission object, its ::com::sun::star::form::submission::XSubmission::submit method is invoked.
  3. If there is no external submission, the parent object of the model is examined for the presence of the ::com::sun::star::form::XSubmit interface. If it is present, it's ::com::sun::star::form::XSubmit::submit method is invoked.
    Since the parent object of a submit button can only be a ::com::sun::star::form::component::Form, this means that SubmitButtons are also able to submit ::com::sun::star::form::component::HTMLForms.


Exported Interfaces - Summary
::com::sun::star::form::submission::XSubmission

allows interception (and vetoing) of submissions triggered by the control.

Exported Interfaces - Details
::com::sun::star::form::submission::XSubmission
Description
allows interception (and vetoing) of submissions triggered by the control.

 
Top of Page

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.