1 /**
2 * This file Copyright (c) 2015-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.framework.action;
35
36 import info.magnolia.ui.api.action.AbstractAction;
37 import info.magnolia.ui.api.action.ActionExecutionException;
38 import info.magnolia.ui.form.EditorCallback;
39 import info.magnolia.ui.form.EditorValidator;
40
41 import javax.inject.Inject;
42
43 /**
44 * Invokes either {@link EditorCallback#onSuccess(String)} or {@link EditorCallback#onCancel()} depending
45 * on the definition. Optionally performs the validation via {@link EditorValidator} beforehand.
46 *
47 * @param <D> the definition type
48 *
49 * @see EditorCallbackActionDefinition#isCallSuccess()
50 * @see EditorCallbackActionDefinition#isValidationEnabled()
51 */
52 public class EditorCallbackAction<D extends EditorCallbackActionDefinition> extends AbstractAction<D> {
53
54 private final EditorCallback callback;
55 private final EditorValidator validator;
56
57 @Inject
58 public EditorCallbackAction(D definition, EditorCallback callback, EditorValidator validator) {
59 super(definition);
60 this.callback = callback;
61 this.validator = validator;
62 }
63
64 @Override
65 public void execute() throws ActionExecutionException {
66 // validate
67 if (getDefinition().isValidationEnabled() && !validateForm()) {
68 return;
69 }
70
71 // invoke appropriate callback
72 if (getDefinition().isCallSuccess()) {
73 callback.onSuccess(getDefinition().getSuccessActionName());
74 } else {
75 callback.onCancel();
76 }
77 }
78
79 protected boolean validateForm() {
80 boolean isValid = validator.isValid();
81 validator.showValidation(!isValid);
82 return isValid;
83 }
84 }