View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.contentapp.action;
35  
36  import info.magnolia.ui.api.action.ActionType;
37  import info.magnolia.ui.api.action.ConfiguredActionDefinition;
38  import info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition;
39  import info.magnolia.ui.availability.rule.CanMoveRuleDefinition;
40  import info.magnolia.ui.dialog.layout.DefaultEditorActionLayoutDefinition;
41  import info.magnolia.ui.chooser.definition.SingleItemWorkbenchChooserDefinition;
42  
43  import java.util.Arrays;
44  import java.util.Collections;
45  
46  import com.vaadin.shared.ui.grid.DropLocation;
47  
48  /**
49   * Definition of a {@link info.magnolia.ui.contentapp.action.MoveAction}.
50   */
51  @ActionType("moveAction")
52  public class MoveActionDefinition<T> extends ConfiguredActionDefinition {
53  
54      private MoveWorkbenchDefinition<T> chooser;
55  
56      public MoveActionDefinition() {
57          setImplementationClass(MoveAction.class);
58      }
59  
60      public MoveWorkbenchDefinition<T> getChooser() {
61          return chooser;
62      }
63  
64      public void setChooser(MoveWorkbenchDefinition<T> chooser) {
65          this.chooser = chooser;
66      }
67  
68      /**
69       * {@link info.magnolia.ui.chooser.definition.ChooserDefinition} of a move operation.
70       * @param <T> type of moved items.
71       */
72      public static class MoveWorkbenchDefinition<T> extends SingleItemWorkbenchChooserDefinition<T> {
73  
74          private static final String BEFORE = DropLocation.ABOVE.name().toLowerCase();
75          private static final String AFTER = DropLocation.BELOW.name().toLowerCase();
76  
77          public MoveWorkbenchDefinition() {
78              getActions().put("commit", configureAvailability(new ChooseActionDefinition()));
79              getActions().put(BEFORE, configureAvailability(new ChooseActionDefinition(BEFORE)));
80              getActions().put(AFTER, configureAvailability(new ChooseActionDefinition(AFTER)));
81  
82              final DefaultEditorActionLayoutDefinitionnition.html#DefaultEditorActionLayoutDefinition">DefaultEditorActionLayoutDefinition footerLayout = new DefaultEditorActionLayoutDefinition();
83              footerLayout.setSecondaryActions(Arrays.asList(BEFORE, AFTER));
84              setFooterLayout(footerLayout);
85          }
86  
87          private ConfiguredActionDefinitionapi/action/ConfiguredActionDefinition.html#ConfiguredActionDefinition">ConfiguredActionDefinition configureAvailability(ConfiguredActionDefinition actionDefinition) {
88              final ConfiguredAvailabilityDefinitionefinition.html#ConfiguredAvailabilityDefinition">ConfiguredAvailabilityDefinition availability = new ConfiguredAvailabilityDefinition();
89              availability.setRoot(true);
90              availability.setRules(Collections.singleton(new CanMoveRuleDefinition()));
91              actionDefinition.setAvailability(availability);
92              return actionDefinition;
93          }
94      }
95  
96  }