| Package | Description |
|---|---|
| com.adobe.acs.commons.forms.components |
Forms System - Components.
|
| com.adobe.acs.commons.forms.helpers |
Forms System - Helpers.
|
| Modifier and Type | Method and Description |
|---|---|
Form |
FormComponent.getForm(org.apache.sling.api.SlingHttpServletRequest request)
Get the data from the HTTP Request and move into the Map-based Form abstraction
|
Form |
MultiStepFormComponent.getForm(org.apache.sling.api.SlingHttpServletRequest request,
String step)
Get the data from the HTTP Request and move into the Map-based Form
abstraction
|
Form |
FormComponent.validate(Form form)
Validate the provided form data.
|
Form |
MultiStepFormComponent.validate(Form form,
String step)
Validate the provided form data.
|
| Modifier and Type | Method and Description |
|---|---|
void |
FormComponent.onFailure(Form form,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Handle unsuccessful form submission.
|
void |
MultiStepFormComponent.onFailure(Form form,
String step,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Handle unsuccessful form submission.
|
void |
FormComponent.onSuccess(Form form,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Handle successful form submission.
|
void |
MultiStepFormComponent.onSuccess(Form form,
String step,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Handle successful form submission.
|
boolean |
FormComponent.save(Form form)
Save the data to the underlying data store; implementation specific.
|
boolean |
MultiStepFormComponent.save(Form form,
String step)
Save the data to the underlying data store; implementation specific.
|
Form |
FormComponent.validate(Form form)
Validate the provided form data.
|
Form |
MultiStepFormComponent.validate(Form form,
String step)
Validate the provided form data.
|
| Modifier and Type | Method and Description |
|---|---|
Form |
FormHelper.getForm(String formName,
org.apache.sling.api.SlingHttpServletRequest request)
Gets the From from either the POST Requests parameters or the GET
request's (synthetic) attributes.
|
Form |
FormHelper.getForm(String formName,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Gets the From from either the POST Requests parameters or the GET
request's (synthetic) attributes.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ForwardAsGetFormHelper.forwardAsGet(Form form,
com.day.cq.wcm.api.Page page,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Creates a synthetic GET request that can be used in the context of a real
POST request to retrieve GET renditions of resources.
|
void |
ForwardAsGetFormHelper.forwardAsGet(Form form,
com.day.cq.wcm.api.Page page,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response,
org.apache.sling.api.request.RequestDispatcherOptions options)
Same as forwardAsGet(Form form, Page pae, SlingHttpServletRequest request, SlingHttpServletResponse) except allows
RequestDispatcherOptions to be passed in.
|
void |
ForwardAsGetFormHelper.forwardAsGet(Form form,
org.apache.sling.api.resource.Resource resource,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Creates a synthetic GET request that can be used in the context of a real
POST request to retrieve GET renditions of resources.
|
void |
ForwardAsGetFormHelper.forwardAsGet(Form form,
org.apache.sling.api.resource.Resource resource,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response,
org.apache.sling.api.request.RequestDispatcherOptions options)
Creates a synthetic GET request that can be used in the context of a real
POST request to retrieve GET renditions of resources.
|
void |
ForwardAsGetFormHelper.forwardAsGet(Form form,
String path,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response,
org.apache.sling.api.request.RequestDispatcherOptions options)
/**
Creates a synthetic GET request that can be used in the context of a real
POST request to retrieve GET renditions of resources.
|
String |
FormHelper.getFormInputsHTML(Form form,
String... keys)
Returns a series of hidden fields used to persist multi-page form data
between forms.
|
void |
FormHelper.renderForm(Form form,
com.day.cq.wcm.api.Page page,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Wrapped method to create a interface from FormHelper to normalize APIs that are commonly used.
|
void |
FormHelper.renderForm(Form form,
org.apache.sling.api.resource.Resource resource,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Wrapped method to create a interface from FormHelper to normalize APIs that are commonly used.
|
void |
FormHelper.renderForm(Form form,
String path,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Wrapped method to create a interface from FormHelper to normalize APIs that are commonly used.
|
void |
FormHelper.renderOtherForm(Form form,
com.day.cq.wcm.api.Page page,
String selectors,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Wrapped method to create a interface from FormHelper to normalize APIs that are commonly used.
|
void |
FormHelper.renderOtherForm(Form form,
org.apache.sling.api.resource.Resource resource,
String selectors,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Wrapped method to create a interface from FormHelper to normalize APIs that are commonly used.
|
void |
FormHelper.renderOtherForm(Form form,
String path,
String selectors,
org.apache.sling.api.SlingHttpServletRequest request,
org.apache.sling.api.SlingHttpServletResponse response)
Wrapped method to create a interface from FormHelper to normalize APIs that are commonly used.
|
void |
PostRedirectGetFormHelper.sendRedirect(Form form,
com.day.cq.wcm.api.Page page,
org.apache.sling.api.SlingHttpServletResponse response)
Issues a 302 redirect with the form serialized into a JSON object that can be
read out by the PostRedirectGetFormHelper on the "other side".
|
void |
PostRedirectGetFormHelper.sendRedirect(Form form,
com.day.cq.wcm.api.Page page,
String formSelector,
org.apache.sling.api.SlingHttpServletResponse response)
Same as:
sendRedirect(Form form, Page page, SlingHttpServletResponse response)
but adds the Form selector query parameter to redirect request.
|
void |
PostRedirectGetFormHelper.sendRedirect(Form form,
org.apache.sling.api.resource.Resource resource,
org.apache.sling.api.SlingHttpServletResponse response)
/**
Issues a 302 redirect with the form serialized into a JSON object that can be
read out by the PostRedirectGetFormHelper on the "other side".
|
void |
PostRedirectGetFormHelper.sendRedirect(Form form,
org.apache.sling.api.resource.Resource resource,
String formSelector,
org.apache.sling.api.SlingHttpServletResponse response)
Same as:
sendRedirect(Form form, Resource resource, SlingHttpServletResponse response)
but adds the Form selector query parameter to redirect request.
|
void |
PostRedirectGetFormHelper.sendRedirect(Form form,
String path,
org.apache.sling.api.SlingHttpServletResponse response)
Issues a 302 redirect with the form serialized into a JSON object that can be
read out by the PostRedirectGetFormHelper on the "other side".
|
void |
PostRedirectGetFormHelper.sendRedirect(Form form,
String path,
String formSelector,
org.apache.sling.api.SlingHttpServletResponse response)
Same as:
sendRedirect(Form form, String path, SlingHttpServletResponse response)
but adds the Form selector query parameter to redirect request.
|
Copyright © 2013–2020 Adobe. All rights reserved.