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.ConfiguredActionDefinition;
37
38 /**
39 * Configures an action which simply delegates to an {@link info.magnolia.ui.form.EditorCallback EditorCallback},
40 * optionally performing validation beforehand.
41 *
42 * <p>This action is typically configured as a dialog/editor's 'commit' action (instead of a plain save action).
43 * It allows to keep the callback code close to that of the dialog/editor opening action.
44 */
45 public class EditorCallbackActionDefinition extends ConfiguredActionDefinition {
46
47 private boolean callSuccess = true;
48
49 private String successActionName = "success";
50
51 private boolean isValidationEnabled = false;
52
53 public EditorCallbackActionDefinition() {
54 setImplementationClass(EditorCallbackAction.class);
55 }
56
57 /**
58 * Defines whether the action will invoke the success callback when executed (or alternatively the cancel callback).
59 * Default is <code>true</code>, i.e. success.
60 *
61 * @see #getSuccessActionName()
62 * @see info.magnolia.ui.form.EditorCallback#onSuccess(String)
63 */
64 public boolean isCallSuccess() {
65 return this.callSuccess;
66 }
67
68 public void setCallSuccess(boolean callSuccess) {
69 this.callSuccess = callSuccess;
70 }
71
72 /**
73 * Defines the success string to pass to the success callback when executed.
74 * Default is <code>"success"</code>.
75 *
76 * @see #isCallSuccess()
77 * @see info.magnolia.ui.form.EditorCallback#onSuccess(String)
78 */
79 public String getSuccessActionName() {
80 return this.successActionName;
81 }
82
83 public void setSuccessActionName(String successActionName) {
84 this.successActionName = successActionName;
85 }
86
87 /**
88 * Defines whether validation should be performed before invoking the callback.
89 * Default is <code>false</code>, i.e. non-validated.
90 *
91 * @see info.magnolia.ui.form.EditorValidator
92 */
93 public boolean isValidationEnabled() {
94 return isValidationEnabled;
95 }
96
97 public void setValidationEnabled(boolean isValidationEnabled) {
98 this.isValidationEnabled = isValidationEnabled;
99 }
100 }