001
014
015 package com.liferay.taglib.util;
016
017 import com.liferay.portal.kernel.template.Template;
018 import com.liferay.portal.model.Layout;
019 import com.liferay.portal.model.Portlet;
020 import com.liferay.taglib.aui.ColumnTag;
021 import com.liferay.taglib.aui.LayoutTag;
022 import com.liferay.taglib.ui.AssetCategoriesSummaryTag;
023 import com.liferay.taglib.ui.AssetLinksTag;
024 import com.liferay.taglib.ui.AssetTagsSummaryTag;
025 import com.liferay.taglib.ui.BreadcrumbTag;
026 import com.liferay.taglib.ui.DiscussionTag;
027 import com.liferay.taglib.ui.FlagsTag;
028 import com.liferay.taglib.ui.IconTag;
029 import com.liferay.taglib.ui.JournalArticleTag;
030 import com.liferay.taglib.ui.MySitesTag;
031 import com.liferay.taglib.ui.PngImageTag;
032 import com.liferay.taglib.ui.RatingsTag;
033
034 import javax.portlet.PortletURL;
035 import javax.portlet.WindowState;
036
037 import javax.servlet.ServletContext;
038
039
042 public interface VelocityTaglib {
043
044 public void actionURL(long plid, String portletName, String queryString)
045 throws Exception;
046
047 public void actionURL(String portletName, String queryString)
048 throws Exception;
049
050
055 public void actionURL(
056 String windowState, String portletMode, Boolean secure,
057 Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
058 long plid, long refererPlid, String portletName, Boolean anchor,
059 Boolean encrypt, long doAsUserId, Boolean portletConfiguration,
060 String queryString)
061 throws Exception;
062
063 public void actionURL(
064 String windowState, String portletMode, Boolean secure,
065 Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
066 long plid, long refererPlid, String portletName, Boolean anchor,
067 Boolean encrypt, long doAsGroupId, long doAsUserId,
068 Boolean portletConfiguration, String queryString)
069 throws Exception;
070
071 public void actionURL(
072 String windowState, String portletMode, long plid,
073 String portletName, String queryString)
074 throws Exception;
075
076 public void actionURL(
077 String windowState, String portletMode, String portletName,
078 String queryString)
079 throws Exception;
080
081 public void assetCategoriesSummary(
082 String className, long classPK, String message,
083 PortletURL portletURL)
084 throws Exception;
085
086 public void assetLinks(long assetEntryId, String className, long classPK)
087 throws Exception;
088
089 public void assetTagsSummary(
090 String className, long classPK, String message,
091 String assetTagNames, PortletURL portletURL)
092 throws Exception;
093
094 public void breadcrumb() throws Exception;
095
096 public void breadcrumb(
097 String displayStyle, boolean showGuestGroup,
098 boolean showParentGroups, boolean showLayout,
099 boolean showPortletBreadcrumb)
100 throws Exception;
101
102 public void discussion(
103 String className, long classPK, String formAction, String formName,
104 boolean hideControls, boolean ratingsEnabled, String redirect,
105 long userId)
106 throws Exception;
107
108
112 public void discussion(
113 String className, long classPK, String formAction, String formName,
114 boolean hideControls, boolean ratingsEnabled, String redirect,
115 String subject, long userId)
116 throws Exception;
117
118 public void doAsURL(long doAsUserId) throws Exception;
119
120 public void flags(
121 String className, long classPK, String contentTitle, boolean label,
122 String message, long reportedUserId)
123 throws Exception;
124
125 public AssetCategoriesSummaryTag getAssetCategoriesSummaryTag()
126 throws Exception;
127
128 public AssetLinksTag getAssetLinksTag() throws Exception;
129
130 public AssetTagsSummaryTag getAssetTagsSummaryTag() throws Exception;
131
132 public BreadcrumbTag getBreadcrumbTag() throws Exception;
133
134 public ColumnTag getColumnTag() throws Exception;
135
136 public DiscussionTag getDiscussionTag() throws Exception;
137
138 public FlagsTag getFlagsTag() throws Exception;
139
140 public IconTag getIconTag() throws Exception;
141
142 public JournalArticleTag getJournalArticleTag() throws Exception;
143
144 public LayoutTag getLayoutTag() throws Exception;
145
146 public MySitesTag getMySitesTag() throws Exception;
147
148 public PngImageTag getPngImageTag() throws Exception;
149
150 public RatingsTag getRatingsTag() throws Exception;
151
152 public String getSetting(String name);
153
154 public WindowState getWindowState(String windowState);
155
156 public void icon(String image, boolean label, String message, String url)
157 throws Exception;
158
159
162 public void iconBack() throws Exception;
163
164
167 public void iconClose() throws Exception;
168
169
172 public void iconConfiguration() throws Exception;
173
174
177 public void iconEdit() throws Exception;
178
179
182 public void iconEditDefaults() throws Exception;
183
184
187 public void iconEditGuest() throws Exception;
188
189
192 public void iconHelp() throws Exception;
193
194 public void iconHelp(String message) throws Exception;
195
196
199 public void iconMaximize() throws Exception;
200
201
204 public void iconMinimize() throws Exception;
205
206
209 public void iconOptions() throws Exception;
210
211
214 public void iconPortlet() throws Exception;
215
216
219 public void iconPortlet(Portlet portlet) throws Exception;
220
221
224 public void iconPortletCss() throws Exception;
225
226
229 public void iconPrint() throws Exception;
230
231
234 public void iconRefresh() throws Exception;
235
236 public void include(ServletContext servletContext, String page)
237 throws Exception;
238
239 public void include(String page) throws Exception;
240
241 public void journalArticle(
242 String articleId, long groupId, String templateId)
243 throws Exception;
244
245 public void journalContentSearch() throws Exception;
246
247 public void journalContentSearch(
248 boolean showListed, String targetPortletId, String type)
249 throws Exception;
250
251 public void language() throws Exception;
252
253 public void language(
254 String formName, String formAction, String name, int displayStyle)
255 throws Exception;
256
257 public void language(
258 String formName, String formAction, String name,
259 String[] languageIds, int displayStyle)
260 throws Exception;
261
262 public void layoutIcon(Layout layout) throws Exception;
263
264 public void metaTags() throws Exception;
265
266
269 public void myPlaces() throws Exception;
270
271
274 public void myPlaces(int max) throws Exception;
275
276 public void mySites() throws Exception;
277
278 public void mySites(int max) throws Exception;
279
280 public void permissionsURL(
281 String redirect, String modelResource,
282 String modelResourceDescription, Object resourceGroupId,
283 String resourcePrimKey, String windowState, int[] roleTypes)
284 throws Exception;
285
286
290 public void permissionsURL(
291 String redirect, String modelResource,
292 String modelResourceDescription, String resourcePrimKey,
293 String windowState, int[] roleTypes)
294 throws Exception;
295
296 public void portletIconBack() throws Exception;
297
298 public void portletIconClose() throws Exception;
299
300 public void portletIconConfiguration() throws Exception;
301
302 public void portletIconEdit() throws Exception;
303
304 public void portletIconEditDefaults() throws Exception;
305
306 public void portletIconEditGuest() throws Exception;
307
308 public void portletIconHelp() throws Exception;
309
310 public void portletIconMaximize() throws Exception;
311
312 public void portletIconMinimize() throws Exception;
313
314 public void portletIconOptions() throws Exception;
315
316 public void portletIconPortlet() throws Exception;
317
318 public void portletIconPortlet(Portlet portlet) throws Exception;
319
320 public void portletIconPortletCss() throws Exception;
321
322 public void portletIconPrint() throws Exception;
323
324 public void portletIconRefresh() throws Exception;
325
326 public void ratings(
327 String className, long classPK, int numberOfStars, String type,
328 String url)
329 throws Exception;
330
331 public void renderURL(long plid, String portletName, String queryString)
332 throws Exception;
333
334 public void renderURL(String portletName, String queryString)
335 throws Exception;
336
337 public void renderURL(
338 String windowState, String portletMode, Boolean secure,
339 Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
340 long refererPlid, String portletName, Boolean anchor,
341 Boolean encrypt, long doAsGroupId, long doAsUserId,
342 Boolean portletConfiguration, String queryString)
343 throws Exception;
344
345
350 public void renderURL(
351 String windowState, String portletMode, Boolean secure,
352 Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
353 String portletName, Boolean anchor, Boolean encrypt,
354 long doAsUserId, Boolean portletConfiguration, String queryString)
355 throws Exception;
356
357 public void renderURL(
358 String windowState, String portletMode, long plid,
359 String portletName, String queryString)
360 throws Exception;
361
362 public void renderURL(
363 String windowState, String portletMode, String portletName,
364 String queryString)
365 throws Exception;
366
367 public void runtime(String portletName) throws Exception;
368
369 public void runtime(String portletName, String queryString)
370 throws Exception;
371
372 public void runtime(
373 String portletName, String queryString, String defaultPreferences)
374 throws Exception;
375
376 public void search() throws Exception;
377
378 public void setTemplate(Template template);
379
380 public void sitesDirectory() throws Exception;
381
382 public void sitesDirectory(String displayStyle, String sites)
383 throws Exception;
384
385 public void socialBookmarks(
386 String displayStyle, String target, String types, String title,
387 String url)
388 throws Exception;
389
390 public void staging() throws Exception;
391
392 public void toggle(
393 String id, String showImage, String hideImage, String showMessage,
394 String hideMessage, boolean defaultShowContent)
395 throws Exception;
396
397 public String wrapPortlet(String wrapPage, String portletPage)
398 throws Exception;
399
400 }