Skip to content

WICKET-7141 Add hook method afterUpdateFormComponentModels() in Form process #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

WICKET-7141 Add hook method afterUpdateFormComponentModels() in Form process #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions wicket-core-tests/src/test/java/org/apache/wicket/markup/html/form/FormVisitTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,17 @@ public void processForms()
assertTrue(page.outerForm.onValidateCalled);
assertTrue(page.outerForm.onSubmitCalled);
assertTrue(page.outerForm.isSubmittedFlagged);
assertTrue(page.outerForm.onBeforeUpdateFormComponentModelsCalled);
assertTrue(page.outerForm.onAfterUpdateFormComponentModelsCalled);
assertTrue(page.outerForm.onValidateModelObjectsCalled);
assertTrue(page.outerField.onValidCalled);
assertTrue(page.outerField.updateModelCalled);
assertTrue(formValidator.validatedCalled);
assertTrue(page.innerForm.onValidateCalled);
assertTrue(page.innerForm.onSubmitCalled);
assertTrue(page.innerForm.isSubmittedFlagged);
assertTrue(page.innerForm.onBeforeUpdateFormComponentModelsCalled);
assertTrue(page.innerForm.onAfterUpdateFormComponentModelsCalled);
assertTrue(page.innerForm.onValidateModelObjectsCalled);
assertTrue(page.innerField.onValidCalled);
assertTrue(page.innerField.updateModelCalled);
Expand All @@ -84,13 +88,17 @@ public void processOuterFormOnly()
assertTrue(page.outerForm.onValidateCalled);
assertTrue(page.outerForm.onSubmitCalled);
assertTrue(page.outerForm.isSubmittedFlagged);
assertTrue(page.outerForm.onBeforeUpdateFormComponentModelsCalled);
assertTrue(page.outerForm.onAfterUpdateFormComponentModelsCalled);
assertTrue(page.outerForm.onValidateModelObjectsCalled);
assertTrue(page.outerField.onValidCalled);
assertTrue(page.outerField.updateModelCalled);
assertTrue(formValidator.validatedCalled);
assertFalse(page.innerForm.onValidateCalled);
assertFalse(page.innerForm.onSubmitCalled);
assertFalse(page.innerForm.isSubmittedFlagged);
assertFalse(page.innerForm.onBeforeUpdateFormComponentModelsCalled);
assertFalse(page.innerForm.onAfterUpdateFormComponentModelsCalled);
assertFalse(page.innerForm.onValidateModelObjectsCalled);
assertFalse(page.innerField.onValidCalled);
assertFalse(page.innerField.updateModelCalled);
Expand All @@ -105,13 +113,17 @@ public void processInnerFormOnly()
assertFalse(page.outerForm.onValidateCalled);
assertFalse(page.outerForm.onSubmitCalled);
assertFalse(page.outerForm.isSubmittedFlagged);
assertFalse(page.outerForm.onBeforeUpdateFormComponentModelsCalled);
assertFalse(page.outerForm.onAfterUpdateFormComponentModelsCalled);
assertFalse(page.outerForm.onValidateModelObjectsCalled);
assertFalse(page.outerField.onValidCalled);
assertFalse(page.outerField.updateModelCalled);
assertFalse(formValidator.validatedCalled);
assertTrue(page.innerForm.onValidateCalled);
assertTrue(page.innerForm.onSubmitCalled);
assertTrue(page.innerForm.isSubmittedFlagged);
assertTrue(page.innerForm.onBeforeUpdateFormComponentModelsCalled);
assertTrue(page.innerForm.onAfterUpdateFormComponentModelsCalled);
assertTrue(page.innerForm.onValidateModelObjectsCalled);
assertTrue(page.innerField.onValidCalled);
assertTrue(page.innerField.updateModelCalled);
Expand Down Expand Up @@ -329,6 +341,32 @@ public void validateFormComponentsInPostorder()

assertTrue(page.innerField.onValidCallOrder < page.outerField.onValidCallOrder);
}

@Test
public void callInnerFormOnBeforeUpdateFormComponentModels()
{
tester.newFormTester("outerForm").submit();

assertTrue(page.innerForm.onBeforeUpdateFormComponentModelsCalled);
}

@Test
public void dontCallInnerFormOnBeforeUpdateFormComponentModels()
{
page.innerForm.wantSubmitOnParentFormSubmit = false;
tester.newFormTester("outerForm").submit();

assertFalse(page.innerForm.onBeforeUpdateFormComponentModelsCalled);
}

@Test
public void callFormOnBeforeUpdateFormComponentModelsInPostorder()
{
tester.newFormTester("outerForm").submit();

assertTrue(
page.innerForm.onBeforeUpdateFormComponentModelsCallOrder < page.outerForm.onBeforeUpdateFormComponentModelsCallOrder);
}

@Test
public void updateInnerFormComponentModel()
Expand All @@ -355,6 +393,32 @@ public void updateFormComponentModelsInPostorder()
assertTrue(page.innerField.updateModelOrder < page.outerField.updateModelOrder);
}

@Test
public void callInnerFormOnAfterUpdateFormComponentModels()
{
tester.newFormTester("outerForm").submit();

assertTrue(page.innerForm.onAfterUpdateFormComponentModelsCalled);
}

@Test
public void dontCallInnerFormOnAfterUpdateFormComponentModels()
{
page.innerForm.wantSubmitOnParentFormSubmit = false;
tester.newFormTester("outerForm").submit();

assertFalse(page.innerForm.onAfterUpdateFormComponentModelsCalled);
}

@Test
public void callFormOnAfterUpdateFormComponentModelsInPostorder()
{
tester.newFormTester("outerForm").submit();

assertTrue(
page.innerForm.onAfterUpdateFormComponentModelsCallOrder < page.outerForm.onAfterUpdateFormComponentModelsCallOrder);
}

@Test
public void callInnerFormOnValidateModelObjects()
{
Expand Down Expand Up @@ -426,6 +490,10 @@ static class TestForm extends Form<Void>
boolean onErrorCalled;
boolean onSubmitCalled;
boolean isSubmittedFlagged;
boolean onBeforeUpdateFormComponentModelsCalled;
int onBeforeUpdateFormComponentModelsCallOrder;
boolean onAfterUpdateFormComponentModelsCalled;
int onAfterUpdateFormComponentModelsCallOrder;
boolean onValidateModelObjectsCalled;
int onValidateModelObjectsCallOrder;
int numberOfOnErrorCalls;
Expand Down Expand Up @@ -460,6 +528,18 @@ protected void onValidate()
onValidateCalled = true;
}

@Override
protected void onBeforeUpdateFormComponentModels() {
onBeforeUpdateFormComponentModelsCalled = true;
onBeforeUpdateFormComponentModelsCallOrder = sequence++;
}

@Override
protected void onAfterUpdateFormComponentModels() {
onAfterUpdateFormComponentModelsCalled = true;
onAfterUpdateFormComponentModelsCallOrder = sequence++;
}

@Override
protected void onValidateModelObjects()
{
Expand Down
57 changes: 56 additions & 1 deletion wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1002,10 +1002,14 @@ public void process(IFormSubmitter submittingComponent)

// before updating, call the interception method for clients
beforeUpdateFormComponentModels();
internalOnBeforeUpdateFormComponentModels();

// Update model using form data
updateFormComponentModels();

// after updating, call the interception method for clients
internalOnAfterUpdateFormComponentModels();

// validate model objects after input values have been bound
internalOnValidateModelObjects();
if (hasError())
Expand Down Expand Up @@ -1288,15 +1292,66 @@ protected void addDefaultSubmitButtonHandler(IHeaderResponse headerResponse)
headerResponse.render(OnEventHeaderItem.forMarkupId(getMarkupId(), "keypress", script.toString()));
}


/**
* Template method to allow clients to do any processing (like recording the current model so
* that, in case onSubmit does further validation, the model can be rolled back) before the
* actual updating of form component models is done.
*/
*
* @deprecated Use {@linkplain #onBeforeUpdateFormComponentModels} instead.
*/
@Deprecated(since = "10.5.0", forRemoval = true)
protected void beforeUpdateFormComponentModels()
{
}


/**
* Calls {@linkplain #onBeforeUpdateFormComponentModels()} on this form and all nested forms that are
* visible and enabled.
*/
private void internalOnBeforeUpdateFormComponentModels()
{
visitFormsPostOrder(this, (form, visit) -> {
if (form.isVisibleInHierarchy() && form.isEnabledInHierarchy())
{
form.onBeforeUpdateFormComponentModels();
}
});
}

/**
* Hook method to allow clients to do any processing (like recording the current model so
* that, in case onSubmit does further validation, the model can be rolled back) before the
* actual updating of form component models is done.
*/
protected void onBeforeUpdateFormComponentModels()
{
}

/**
* Calls {@linkplain #onAfterUpdateFormComponentModels()} on this form and all nested forms that are
* visible and enabled.
*/
private void internalOnAfterUpdateFormComponentModels()
{
visitFormsPostOrder(this, (form, visit) -> {
if (form.isVisibleInHierarchy() && form.isEnabledInHierarchy())
{
form.onAfterUpdateFormComponentModels();
}
});
}

/**
* Hook method to allow clients to do any processing (like updating entities or DTO from the models
* to be used later on the next late-stage validation) after the actual updating of form component
* models is done.
*/
protected void onAfterUpdateFormComponentModels()
{
}

/**
* Called (by the default implementation of 'process') when all fields validated, the form was
* updated and it's data was allowed to be persisted. It is meant for delegating further
Expand Down