1 /**
2 * This file Copyright (c) 2020 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.editor;
35
36 import info.magnolia.jcr.util.NodeNameHelper;
37 import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
38
39 import java.util.Locale;
40
41 import javax.inject.Inject;
42 import javax.jcr.Item;
43 import javax.jcr.Node;
44
45
46 /**
47 * Arranges provided JCR nodes according to their order, renames them in correct way
48 * so that the node names reflect the indices correctly.
49 *
50 * @deprecated since 6.2.1, use {@link info.magnolia.ui.editor.JcrChildNodeProvider}. This class is for compatibility
51 * use only to compensate compatibility UI {@link MultiValueSubChildrenNodePropertiesTransformer} behaviour.
52 */
53 @Deprecated
54 public class LexicographicallyIndexedJcrNodeOrderHandler extends DefaultJcrNodeOrderHandler {
55
56 @Inject
57 public LexicographicallyIndexedJcrNodeOrderHandler(I18NAuthoringSupport<Item> i18NAuthoringSupport,
58 Locale locale,
59 NodeNameHelper nodeNameHelper) {
60 super(i18NAuthoringSupport, locale, nodeNameHelper);
61 }
62
63 @Override
64 protected String createIndexedName(String name, int idx) {
65 return String.format("%s%02d", name, idx);
66 }
67
68 /**
69 * Definition of {@link LexicographicallyIndexedJcrNodeOrderHandler}.
70 */
71 public static class Definition extends MultiFormDefinition.OrderHandlerDefinition<Node> {
72
73 public Definition() {
74 setImplementationClass(LexicographicallyIndexedJcrNodeOrderHandler.class);
75 }
76 }
77 }