Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiMacroConstants | 28 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.rendering.wikimacro.internal; | |
21 | ||
22 | /** | |
23 | * Constants identifying various properties used for defining wiki macros. | |
24 | * | |
25 | * @version $Id: 130c14b78b1ea96a41411632c942ed8ec3e2724d $ | |
26 | * @since 2.0M4 | |
27 | */ | |
28 | public interface WikiMacroConstants | |
29 | { | |
30 | /** | |
31 | * Constant for representing XWiki.WikiMacroClass xwiki class space name. | |
32 | */ | |
33 | String WIKI_MACRO_CLASS_SPACE = "XWiki"; | |
34 | ||
35 | /** | |
36 | * Constant for representing XWiki.WikiMacroClass xwiki class page name. | |
37 | */ | |
38 | String WIKI_MACRO_CLASS_PAGE = "WikiMacroClass"; | |
39 | ||
40 | /** | |
41 | * Constant for representing XWiki.WikiMacroClass xwiki class. | |
42 | */ | |
43 | String WIKI_MACRO_CLASS = WIKI_MACRO_CLASS_SPACE + '.' + WIKI_MACRO_CLASS_PAGE; | |
44 | ||
45 | /** | |
46 | * Constant for representing macro id property. | |
47 | */ | |
48 | String MACRO_ID_PROPERTY = "id"; | |
49 | ||
50 | /** | |
51 | * Constant for representing macro name property. | |
52 | */ | |
53 | String MACRO_NAME_PROPERTY = "name"; | |
54 | ||
55 | /** | |
56 | * Constant for representing macro description property. | |
57 | */ | |
58 | String MACRO_DESCRIPTION_PROPERTY = "description"; | |
59 | ||
60 | /** | |
61 | * Constant for representing default macro category property. | |
62 | */ | |
63 | String MACRO_DEFAULT_CATEGORY_PROPERTY = "defaultCategory"; | |
64 | ||
65 | /** | |
66 | * Name of the macro visibility property in the Wiki Macro Class. | |
67 | */ | |
68 | String MACRO_VISIBILITY_PROPERTY = "visibility"; | |
69 | ||
70 | /** | |
71 | * Constant for representing macro inline support property. | |
72 | */ | |
73 | String MACRO_INLINE_PROPERTY = "supportsInlineMode"; | |
74 | ||
75 | /** | |
76 | * Constant for representing macro content type property. | |
77 | */ | |
78 | String MACRO_CONTENT_TYPE_PROPERTY = "contentType"; | |
79 | ||
80 | /** | |
81 | * Constant for representing macro content mandatory status. | |
82 | */ | |
83 | String MACRO_CONTENT_MANDATORY = "Mandatory"; | |
84 | ||
85 | /** | |
86 | * Constant for representing macro content optional status. | |
87 | */ | |
88 | String MACRO_CONTENT_OPTIONAL = "Optional"; | |
89 | ||
90 | /** | |
91 | * Constant for representing macro content empty status. | |
92 | */ | |
93 | String MACRO_CONTENT_EMPTY = "No content"; | |
94 | ||
95 | /** | |
96 | * Constant for representing macro content description property. | |
97 | */ | |
98 | String MACRO_CONTENT_DESCRIPTION_PROPERTY = "contentDescription"; | |
99 | ||
100 | /** | |
101 | * Constant for representing macro code property. | |
102 | */ | |
103 | String MACRO_CODE_PROPERTY = "code"; | |
104 | ||
105 | /** | |
106 | * Constant for representing XWiki.WikiMacroParameterClass xwiki class space name. | |
107 | */ | |
108 | String WIKI_MACRO_PARAMETER_CLASS_SPACE = "XWiki"; | |
109 | ||
110 | /** | |
111 | * Constant for representing XWiki.WikiMacroParameterClass xwiki class page name. | |
112 | */ | |
113 | String WIKI_MACRO_PARAMETER_CLASS_PAGE = "WikiMacroParameterClass"; | |
114 | ||
115 | /** | |
116 | * Constant for representing XWiki.WikiMacroParameterClass xwiki class. | |
117 | */ | |
118 | String WIKI_MACRO_PARAMETER_CLASS = WIKI_MACRO_PARAMETER_CLASS_SPACE + '.' + WIKI_MACRO_PARAMETER_CLASS_PAGE; | |
119 | ||
120 | /** | |
121 | * Constant for representing parameter name property. Same as MACRO_NAME_PROPERTY (Check style Fix) | |
122 | */ | |
123 | String PARAMETER_NAME_PROPERTY = "name"; | |
124 | ||
125 | /** | |
126 | * Constant for representing parameter description property. Same as MACRO_DESCRIPTION_PROPERTY (Check style Fix) | |
127 | */ | |
128 | String PARAMETER_DESCRIPTION_PROPERTY = "description"; | |
129 | ||
130 | /** | |
131 | * Constant for representing parameter mandatory property. | |
132 | */ | |
133 | String PARAMETER_MANDATORY_PROPERTY = "mandatory"; | |
134 | ||
135 | /** | |
136 | * Constant for representing parameter defaultValue property. | |
137 | * | |
138 | * @since 2.3M1 | |
139 | */ | |
140 | String PARAMETER_DEFAULT_VALUE_PROPERTY = "defaultValue"; | |
141 | } |