View Javadoc
1   /**
2    * This file Copyright (c) 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.contentapp.column.jcr;
35  
36  import info.magnolia.icons.MagnoliaIcons;
37  import info.magnolia.jcr.util.NodeTypes;
38  import info.magnolia.jcr.util.NodeUtil;
39  import info.magnolia.jcr.util.PropertyUtil;
40  import info.magnolia.ui.contentapp.configuration.column.ColumnType;
41  import info.magnolia.ui.contentapp.configuration.column.icon.IconColumnDefinition;
42  
43  import java.util.HashMap;
44  import java.util.Map;
45  import java.util.Optional;
46  
47  import javax.jcr.Item;
48  import javax.jcr.Node;
49  
50  import com.machinezoo.noexception.Exceptions;
51  import com.vaadin.ui.renderers.HtmlRenderer;
52  
53  import lombok.Getter;
54  import lombok.Setter;
55  
56  /**
57   * Column definition representing JCR node name and icon based on node type.
58   *
59   * Value of property configured as definition name (or jcrName property by default) is returned.
60   */
61  @ColumnType("jcrTitleColumn")
62  public class JcrTitleColumnDefinition extends IconColumnDefinition {
63  
64      private static final String JCR_NAME = "jcrName";
65  
66      @Setter
67      @Getter
68      private Map<String, String> nodeTypeToIcon = new HashMap<>();
69  
70      public JcrTitleColumnDefinition() {
71          setName(JCR_NAME);
72          setRenderer(HtmlRenderer.class);
73          setValueProvider(JcrTitleValueProvider.class);
74      }
75  
76      /**
77       * JCR name property implementation of {@link info.magnolia.ui.contentapp.configuration.column.icon.IconColumnDefinition.IconValueProvider}.
78       */
79      public static class JcrTitleValueProvider extends IconColumnDefinition.IconValueProvider<Item, JcrTitleColumnDefinition> {
80  
81          public JcrTitleValueProvider(JcrTitleColumnDefinition definition) {
82              super(definition);
83          }
84  
85          @Override
86          public String apply(Item item) {
87              return super.apply(item) + Optional.of(item)
88                      .filter(Item::isNode)
89                      .map(Node.class::cast)
90                      .map(Exceptions.wrap().function(node ->
91                              PropertyUtil.getString(node, getDefinition().getName())))
92                      .orElse(Exceptions.wrap().get(item::getName));
93          }
94  
95          @Override
96          protected String getIcon(Item item) {
97              return Optional.of(item)
98                      .filter(Item::isNode)
99                      .map(Node.class::cast)
100                     .map(Exceptions.wrap().function(node ->
101                                     NodeUtil.hasMixin(node, NodeTypes.Deleted.NAME) ?
102                                             MagnoliaIcons.TRASH.getCssClass() :
103                                             getDefinition().getNodeTypeToIcon().get(node.getPrimaryNodeType().getName())))
104                     .orElse(super.getIcon(item));
105         }
106     }
107 }