View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 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.cms.gui.dialog;
35  
36  import info.magnolia.cms.beans.config.ObservedManager;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.core.ItemType;
39  import info.magnolia.objectfactory.Classes;
40  import info.magnolia.objectfactory.Components;
41  
42  import java.util.Iterator;
43  
44  import org.apache.commons.lang.StringUtils;
45  
46  
47  /**
48   * @author Fabrizio Giustina
49   * @version $Revision: 41137 $ ($Author: gjoseph $)
50   */
51  public final class ControlsManager extends ObservedManager {
52  
53      /**
54       * Node data name for control class.
55       */
56      private static final String DATA_CONTROL_CLASS = "class"; //$NON-NLS-1$
57  
58      /**
59       * Node data name for control name.
60       */
61      private static final String DATA_CONTROL_NAME = "name"; //$NON-NLS-1$
62  
63      /**
64       * Registers dialog controls.
65       */
66      protected void onRegister(Content configNode) {
67          log.info("Loading dialog controls configuration from {}", configNode.getHandle()); //$NON-NLS-1$
68  
69          Iterator iterator = configNode.getChildren(ItemType.CONTENTNODE).iterator();
70  
71          while (iterator.hasNext()) {
72              Content controlNode = (Content) iterator.next();
73  
74              log.debug("Initializing control [{}]", controlNode); //$NON-NLS-1$
75  
76              String classNodeData = controlNode.getNodeData(DATA_CONTROL_CLASS).getString();
77              String nameNodeData = controlNode.getNodeData(DATA_CONTROL_NAME).getString();
78  
79              if (StringUtils.isEmpty(nameNodeData)) {
80                  nameNodeData = controlNode.getName();
81              }
82  
83              if (StringUtils.isEmpty(classNodeData) || StringUtils.isEmpty(nameNodeData)) {
84                  log.warn("Can't add custom control with name [{}] and class [{}] specified in node [{}]", new Object[]{nameNodeData, classNodeData, controlNode.getName()});
85                  continue;
86              }
87              Class controlClass = null;
88  
89              try {
90                  controlClass = Classes.getClassFactory().forName(classNodeData);
91              }
92              catch (ClassNotFoundException e) {
93                  log.error("Failed to load dialog control with class [" + classNodeData + "]", e); //$NON-NLS-1$
94                  continue;
95              }
96  
97              if (!DialogControl.class.isAssignableFrom(controlClass)) {
98                  log.error("Invalid class specified for control [{}]: does not implement DialogControl", nameNodeData);
99                  continue;
100             }
101 
102             DialogFactory.registerDialog(nameNodeData, controlClass);
103 
104         }
105     }
106 
107     /**
108      * @return Returns the instance.
109      */
110     public static ControlsManager getInstance() {
111         return Components.getSingleton(ControlsManager.class);
112     }
113 
114     protected void onClear() {
115     }
116 
117 }