Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
DialogFactory	97	0	-	0	0	-1.0 -	Show methods

Class DialogFactory

Class DialogFactory	Line # 97	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/**
2		* This file Copyright (c) 2010-2016 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		* Declares a class or a method to be used for creating a dialog. The unique id of the dialog is specified in the
43		* annotation.
44		* <p/>
45		* When used on a class it is used in combination with {@link info.magnolia.module.blossom.annotation.TabFactory} on its
46		* methods. All methods annotated with {@link TabFactory} will be detected and called to contribute tabs to the dialog.
47		* The ordering of tabs inside the dialog can be set using the {@link info.magnolia.module.blossom.annotation.TabOrder}
48		* annotation.
49		* <p/>
50		* For example:
51		* <pre>
52		* &#64;DialogFactory("page-properties")
53		* &#64;TabOrder("Content", "Meta")
54		* public class PagePropertiesDialog {
55		*
56		* &#64;TabFactory("Content")
57		* public void contentTab(TabBuilder tab) {...}
58		*
59		* &#64;TabFactory("Meta")
60		* public void metaTab(TabBuilder tab) {...}
61		* }
62		* </pre>
63		* <p/>
64		* It can also be used on a method in a template. The method will be called to take care of the full dialog creation.
65		* Valid arguments for such a method are:
66		* <ul>
67		* <li>{@link info.magnolia.ui.dialog.config.DialogBuilder}
68		* <li>{@link info.magnolia.ui.dialog.definition.ConfiguredDialogDefinition}
69		* <li>{@link info.magnolia.ui.dialog.definition.ConfiguredFormDialogDefinition}
70		* <li>{@link info.magnolia.module.blossom.dialog.DialogCreationContext}
71		* <li>{@link javax.jcr.Node}
72		* <li>{@link com.vaadin.data.Item}
73		* <li>{@link info.magnolia.ui.framework.config.UiConfig}
74		* <li>info.magnolia.dam.app.ui.config.DamConfig or info.magnolia.dam.asset.config.DamConfig
75		* <li>{@link info.magnolia.context.WebContext}
76		* <li>{@link info.magnolia.context.Context}
77		* <li>{@link info.magnolia.cms.security.User}
78		* <li>{@link info.magnolia.cms.security.MgnlUser}
79		* </ul>
80		* <p/>
81		* For example:
82		* <pre>
83		* &#64;DialogFactory("page-properties")
84		* public void pageProperties(DialogBuilder dialog) {...}
85		* </pre>
86		* You can use {@link info.magnolia.module.blossom.annotation.I18nBasename} to specify which resource bundle should be
87		* used for localization of the dialogs label and its fields.
88		*
89		* @see info.magnolia.module.blossom.annotation.TabFactory
90		* @see info.magnolia.module.blossom.annotation.TabOrder
91		* @see info.magnolia.module.blossom.annotation.Template
92		* @see info.magnolia.module.blossom.dialog.DialogCreationContext
93		* @since 1.0
94		*/
95		@Retention(RetentionPolicy.RUNTIME)
96		@Target({ElementType.TYPE, ElementType.METHOD})
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
97		public @interface DialogFactory {
98
99		/**
100		* Id of the dialog.
101		*/
102		String value();
103
104		/**
105		* Label of the dialog.
106		*/
107		String label() default "";
108		}