Atlassian Stash SPI
| com.atlassian.stash.ui.FormFragment |
This interface is deprecated.
use ContextualFormFragment
Allows the injection of fields into existing forms provided by the host application.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Render your fields after a validation error has occurred.
| |||||||||||
Store the fields supplied by this form and perform any other actions.
| |||||||||||
Validate the fields supplied by this form fragment.
| |||||||||||
Render your fields after a validation error has occurred. Note that the validation error may have occurred on a
field not supplied by this FormFragment.
| appendable | the Appendable to append field HTML that will be injected into the form, with any relevant errors supplied by the fieldErrors map rendered inline. The fields and error messaging should match the style of the pre-existing fields in the form. |
|---|---|
| requestParams | the map of parameters from the request. This will contain any input supplied by the user in
the fields rendered by doView(Appendable), alongside any other fields in the form rendered by
the system or other FormFragments. |
| fieldErrors | a Map of String field names to sets of String error messages. If the field name
matches one of the fields supplied by your doView(Appendable) implementation, you should render
the error messages alongside your field. |
| IOException | if there was a problem writing to the supplied appendable. |
|---|
| appendable | the Appendable to append field HTML that will be injected into the form. The fields should match the style of the pre-existing fields in the form. |
|---|
| IOException | if there was a problem writing to the supplied appendable. |
|---|
Store the fields supplied by this form and perform any other actions. Any failures at this point are considered
unrecoverable and should throw an unchecked exception to halt the request (which will redirect the user to a 500
page). Any recoverable errors should be handled above in the validate(Map method.
This method is invoked only if the validate(Map method on all registered FormFragments and the
form's own field validation has completed without any validation errors.
| requestParams | the map of parameters from the request. This will contain any input supplied by the user in
the fields rendered by doView(Appendable), alongside any other fields in the form rendered by
the system or other FormFragments.
|
|---|
Validate the fields supplied by this form fragment. This method should not persist any field values, as
validation may fail on another field not specified by this FormFragment. See execute(Map, which is
invoked after validate(Map if all fragments have successfully validated. This method should make all
reasonable attempts to ensure that the subsequent invocation of execute(Map will not fail.
| requestParams | the map of parameters from the request. This will contain any input supplied by the user in
the fields rendered by doView(Appendable), alongside any other fields in the form rendered by
the system or other FormFragments. |
|---|---|
| errors | use this to report any validation errors on the input supplied from your fields. See
ValidationErrors for more details.
|