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.jcr.util.PropertyUtil;
37  import info.magnolia.ui.contentapp.configuration.column.ColumnType;
38  import info.magnolia.ui.contentapp.configuration.column.icon.IconColumnDefinition;
39  
40  import java.util.HashMap;
41  import java.util.Map;
42  
43  import javax.jcr.Item;
44  import javax.jcr.Node;
45  import javax.jcr.RepositoryException;
46  
47  import org.slf4j.Logger;
48  import org.slf4j.LoggerFactory;
49  
50  import com.vaadin.ui.renderers.HtmlRenderer;
51  
52  import lombok.Getter;
53  import lombok.Setter;
54  
55  /**
56   * Column definition representing JCR node name and icon based on node type.
57   */
58  @ColumnType("jcrNameColumn")
59  public class JcrNameColumnDefinition extends IconColumnDefinition {
60  
61      private static final Logger log = LoggerFactory.getLogger(JcrNameColumnDefinition.class);
62  
63      @Setter
64      @Getter
65      private Map<String, String> nodeTypeToIcon = new HashMap<>();
66  
67      public JcrNameColumnDefinition() {
68          setRenderer(HtmlRenderer.class);
69          setValueProvider(JcrNameValueProvider.class);
70      }
71  
72      /**
73       * JCR name property implementation of {@link info.magnolia.ui.contentapp.configuration.column.icon.IconColumnDefinition.IconValueProvider}.
74       */
75      public static class JcrNameValueProvider extends IconColumnDefinition.IconValueProvider<Item, JcrNameColumnDefinition> {
76  
77          public JcrNameValueProvider(JcrNameColumnDefinition definition) {
78              super(definition);
79          }
80  
81          @Override
82          public String apply(Item node) {
83              try {
84                  return super.apply(node) + (node.isNode() ? PropertyUtil.getString((Node) node, "jcrName", node.getName()) : node.getName());
85              } catch (RepositoryException e) {
86                  log.debug("Failed to render JCR item name in a Grid column", e);
87                  return "";
88              }
89          }
90  
91          @Override
92          protected String getIcon(Item node) {
93              try {
94                  return node.isNode() ? getDefinition().getNodeTypeToIcon().get(((Node)node).getPrimaryNodeType().getName()) : super.getIcon(node);
95              } catch (RepositoryException e) {
96                  log.debug("Failed to render JCR item icon in a Grid column", e);
97                  return "";
98              }
99          }
100     }
101 }