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.cms.taglibs;
35  
36  import info.magnolia.cms.beans.config.ServerConfiguration;
37  import info.magnolia.context.MgnlContext;
38  
39  import javax.servlet.jsp.jstl.core.ConditionalTagSupport;
40  
41  
42  /**
43   * Everything between adminOnly tags will only be shown on an authoring instance, not on a public instance. This
44   * allows you to provide functionality that is only available to page authors but not to the general public.
45   * @jsp.tag name="adminOnly" body-content="JSP"
46   * @jsp.tag-example
47   * <cms:adminOnly>
48   *    <cms:editBar/>
49   * </cms:adminOnly>
50   *
51   * @author Sameer Charles
52   * @author Fabrizio Giustina
53   * @version $Revision $ ($Author $)
54   */
55  public class AdminOnly extends ConditionalTagSupport {
56      /**
57       * Determines if the content should be displayed in preview mode.
58       */
59      private boolean showInPreview;
60  
61      /**
62       * Also show content in preview mode. Default is false.
63       * @jsp.attribute required="false" rtexprvalue="true" type="boolean"
64       */
65      public void setShowInPreview(boolean showInPreview) {
66          this.showInPreview = showInPreview;
67      }
68  
69      protected boolean condition() {
70          if (ServerConfiguration.getInstance().isAdmin() && (!MgnlContext.getAggregationState().isPreviewMode() || showInPreview)) {
71              return true;
72          }
73          return false;
74      }
75  
76      public void release() {
77          this.showInPreview = false;
78          super.release();
79      }
80  }