Reset/Cancel a Form

Sometimes we need to cancel a form or reset all the editable form fields. The following post provides few methods for doing so.

1. Rollback - the traditional way. It rollbacks to the previous state for the changes that are not committed yet.
        It closes all open Row Iterators and executes the View Object.
        Either use it on a  buttons Action Listener or directly drag the Rollback operation from the Data Control.
        Only problem is it rollbacks all the uncommitted transactions instead of only resetting the form field.
        It invokes ROLLBACK from database and executes View Object to return latest data from DB for all  rows.
        This works well when we want to undo multiple changes at once.

2.  <af:resetButton> - Resets the content of a form for all editable components, updating all editable components with the current values of the model on the server.

1. <af:resetButton text="resetButton" id="rb1"/>

 
3. Using ResetUtils  - It resets all editable value holders present inside UIComponent 'myForm' .The UIComponent is searched for within the component tree and the first one encountered is reset back to the original value.

1. public void resetActionListener(ActionEvent actionEvent){
3. UIComponent myForm = actionEvent.getComponent();
4. oracle.adf.view.rich.util.ResetUtils.reset(myForm);
5. }

4. Using af:resetActionListener.  Drag the af:resetActionListener component onto the cancel button and set immediate=true on the cancel button so client validation is bypassed .

1. <af:commandButton text="Cancel" id="cb1" action="#{bindings.Rollback.execute}" inlineStyle="font-weight:bolder;" immediate="true" >
2. <af:resetActionListener/>
3. </af:commandButton>

5. Queue an action on an existing button containing  af:resetActionListener attached to it on the page.The button's binding is present in the bean.

1. public void resetActionUsingQueueListener(ActionEvent aEvent){
2. //Queue the binded button's action to this button's action event.
3. ActionEvent actionEvent = new ActionEvent(this.getResetButton());
4. actionEvent.queue();
5. }

6. Create instance of resetActionListener in bean and call processAction ()

1. public void resetAct(ActionEvent actionEvent) {
2. ResetActionListener ral = new ResetActionListener();
3. ral.processAction(actionEvent);
4. }

7.Another way is Cancel by undoing changes - set "immediate=true" on the cancel button.
Open the ViewImpl class and add the following code which first determine whether or not the row is new or an existing row and accordingly either removes/refresh it.

1. public String getRowStatus(Row row){
2. DepartmentsViewRowImpl rwImpl = (DepartmentsViewRowImpl)row;
3. String rwStatus = translateStatusToString(rwImpl.getEntity(0).getEntityState());
4. return rwStatus;
5. }
7. private String translateStatusToString(byte b) {
8. String ret = null; switch (b) {
9. case Entity.STATUS_INITIALIZED: {
10. ret = "Initialized"; break;
11. }
12. case Entity.STATUS_MODIFIED: {
13. ret = "Modified"; break;
14. }
15. case Entity.STATUS_UNMODIFIED: {
16. ret = "Unmodified"; break;
17. }
18. case Entity.STATUS_NEW: {
19. ret = "New"; break;
20. } }
21. return ret;
22. }

Provide the ActionListener ('onCancel') for Cancel Button on the page  -

1. public void onCancel(ActionEvent actionEvent) {
2. FacesContext fctx = FacesContext.getCurrentInstance();
3. DCBindingContainer bindings = (DCBindingContainer) BindingContext.getCurrent().getCurrentBindingsEntry();
4. DCIteratorBinding iter = bindings.findIteratorBinding("DepartmentsView1Iterator");
5. Row rw = iter.getCurrentRow();
6. OperationBinding getRowStatusBinding = bindings.getOperationBinding("getRowStatus");
7. String rwStatus = (String)getRowStatusBinding.execute();
8. if ("NEW".equalsIgnoreCase(rwStatus)){
9. iter.removeCurrentRow();
10. iter.refreshIfNeeded();
11. } else{
12. rw.refresh(Row.REFRESH_UNDO_CHANGES);
13. }
14. fctx.renderResponse();
15. }

8. Custom bean method to reset the UIcomponent (form) :

1. public void resetAction(ActionEvent aE) {
2. AdfFacesContext adfFacesContext = AdfFacesContext.getCurrentInstance();
3. resetValueInputItems(adfFacesContext,searchForm);
4. }
6. private void resetValueInputItems(AdfFacesContext adfFacesContext, UIComponent component){
7. List<UIComponent> items = component.getChildren();
8. for ( UIComponent item : items ) {
10. //resetValueInputItems(adfFacesContext,item); //uncomment in case of nested UIComponents
12. if ( item instanceof RichInputText ) {
13. RichInputText input = (RichInputText)item;
14. if ( !input.isDisabled() ) {
15. input.resetValue() ;
16. adfFacesContext.addPartialTarget(input);
17. }
18. } else if ( item instanceof RichInputDate ) {
19. RichInputDate input = (RichInputDate)item;
20. if ( !input.isDisabled() ) {
21. input.resetValue() ;
22. input.setValue("");
23. adfFacesContext.addPartialTarget(input);
24. }
25. } else if (item instanceof RichSelectOneChoice){
26. RichSelectOneChoice input = (RichSelectOneChoice)item;
27. if ( !input.isDisabled() ) {
28. input.resetValue() ;
29. input.setValue("");
30. adfFacesContext.addPartialTarget(input);
31. }
32. }
33. } //end -for each loop
34. }