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.module.blossom.annotation;
35  
36  import java.lang.annotation.ElementType;
37  import java.lang.annotation.Retention;
38  import java.lang.annotation.RetentionPolicy;
39  import java.lang.annotation.Target;
40  
41  /**
42   * Used on methods in classes annotated with {@link Template} or {@link DialogFactory}. The method will be called to
43   * build a tab in the dialog. The tabs label is set in this annotation. Valid arguments for the method is
44   * {@link info.magnolia.module.blossom.dialog.TabBuilder}, {@link info.magnolia.cms.gui.dialog.Dialog} and
45   * {@link info.magnolia.module.blossom.dialog.DialogCreationContext}.
46   * <p/>
47   * This example creates a tab with the label "Content":
48   * <pre>
49   * &#64;TabFactory("Content")
50   * public void contentTab(TabBuilder tab, Dialog dialog) { ... }
51   * </pre>
52   *
53   * @since 0.5
54   */
55  @Retention(RetentionPolicy.RUNTIME)
56  @Target(ElementType.METHOD)
57  public @interface TabFactory {
58  
59      /**
60       * Label of the new tab.
61       */
62      String value();
63  }