View Javadoc

1   /**
2    * This file Copyright (c) 2010-2012 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.admincentral.dialog.action;
35  
36  import info.magnolia.ui.model.action.ActionDefinition;
37  
38  /**
39   * Defines a dialog action configuration for simple call back actions.
40   */
41  public class CallbackDialogActionDefinition implements ActionDefinition {
42  
43      private String name;
44      private String label;
45      private boolean callSuccess = true;
46      private String successActionName = "success";
47  
48      public String getName() {
49          return name;
50      }
51  
52      public void setName(String name) {
53          this.name = name;
54      }
55  
56      public String getLabel() {
57          return label;
58      }
59  
60      public void setLabel(String label) {
61          this.label = label;
62      }
63  
64  
65      public boolean isCallSuccess() {
66          return this.callSuccess;
67      }
68  
69      /**
70       * @param callSuccess  true (default) call Callback.onSuccess(String action).
71       *          false call Callback.onCancel()
72       */
73      public void setCallSuccess(boolean callSuccess) {
74          this.callSuccess = callSuccess;
75      }
76  
77  
78      public String getSuccessActionName() {
79          return this.successActionName;
80      }
81  
82      /**
83       * @param successActionName will be passed as parameter to Callback.onSuccess(String successActionName)
84       * in case of callSuccess = true.
85       */
86      public void setSuccessActionName(String successActionName) {
87          this.successActionName = successActionName;
88      }
89  
90  
91  }