View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.module.admininterface;
35  
36  import info.magnolia.cms.gui.control.Tree;
37  import info.magnolia.cms.i18n.Messages;
38  
39  import javax.servlet.http.HttpServletRequest;
40  
41  
42  /**
43   * Used by the tree handler to configure the tree
44   * @author Philipp Bracher
45   * @version $Revision: 32667 $ ($Author: gjoseph $)
46   */
47  public interface AdminTreeConfiguration {
48  
49      /**
50       * Sets the messages bundle to be used. Must be called by instanciator.
51       */
52      public void setMessages(Messages m);
53  
54      /**
55       * Override this method to configure the tree control (define the columns, ...)
56       * @param tree
57       * @param browseMode true if this tree is shown in simple browse mode
58       */
59      public void prepareTree(Tree tree, boolean browseMode, HttpServletRequest request);
60  
61      /**
62       * Prepare the context menu of the tree. This is called during renderTree
63       * @param tree
64       * @param browseMode true if this tree is shown in simple browse mode
65       */
66      public void prepareContextMenu(Tree tree, boolean browseMode, HttpServletRequest request);
67  
68      /**
69       * Prepare the functionbar (footerbar) of the tree. This is called during renderTree
70       * @param tree
71       * @param browseMode true if this tree is shown in simple browse mode
72       */
73      public void prepareFunctionBar(Tree tree, boolean browseMode, HttpServletRequest request);
74  
75  }