View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.actionbar.definition;
35  
36  import info.magnolia.ui.api.availability.AvailabilityDefinition;
37  import info.magnolia.ui.api.availability.ConfiguredAvailabilityDefinition;
38  
39  /**
40   * This deprecated definition is for backwards compatibility of misconfigured content-apps, since Magnolia 5.3.
41   *
42   * <p>Concretely, the <em>multiple</em> property for section availability is barely ever configured (not even for
43   * sections specifically intended for multi-selection). Therefore, this hack makes sure the actionbar never goes blank
44   * upon multi-selection, while relying of *action-availability* for acting on multi-selection.
45   *
46   * <p>Note that, as of 5.4.3, this definition is (still) the default implementation of
47   * {@link ActionbarSectionDefinition ActionbarSectionDefinition},
48   * until further improvements.
49   *
50   * @deprecated since 5.4.3, you may use (configure) the regular {@link ConfiguredActionbarSectionDefinition},
51   * and set the 'multiple' property to true in config where applicable.
52   */
53  @Deprecated
54  public class DeprecatedActionbarSectionDefinition extends ConfiguredActionbarSectionDefinition {
55  
56      @Override
57      public void setAvailability(AvailabilityDefinition availability) {
58          // FIXME This is plain wrong, availability for multiple selection matches sections for which it is not configured (i.e. set to false)
59          // But we have to keep it for the time being because some content apps rely on this incorrect behavior.
60          ((ConfiguredAvailabilityDefinition) availability).setMultiple(true);
61          super.setAvailability(availability);
62      }
63  }