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.QuickAccessTag;
033 import com.liferay.taglib.ui.RatingsTag;
034
035 import javax.portlet.PortletURL;
036 import javax.portlet.WindowState;
037
038 import javax.servlet.ServletContext;
039 import javax.servlet.jsp.PageContext;
040
041
044 public interface VelocityTaglib {
045
046 public String actionURL(long plid, String portletName, String queryString)
047 throws Exception;
048
049 public String actionURL(String portletName, String queryString)
050 throws Exception;
051
052
057 @Deprecated
058 public String actionURL(
059 String windowState, String portletMode, Boolean secure,
060 Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
061 long plid, long refererPlid, String portletName, Boolean anchor,
062 Boolean encrypt, long doAsUserId, Boolean portletConfiguration,
063 String queryString)
064 throws Exception;
065
066 public String actionURL(
067 String windowState, String portletMode, Boolean secure,
068 Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
069 long plid, long refererPlid, String portletName, Boolean anchor,
070 Boolean encrypt, long doAsGroupId, long doAsUserId,
071 Boolean portletConfiguration, String queryString)
072 throws Exception;
073
074 public String actionURL(
075 String windowState, String portletMode, long plid,
076 String portletName, String queryString)
077 throws Exception;
078
079 public String actionURL(
080 String windowState, String portletMode, String portletName,
081 String queryString)
082 throws Exception;
083
084 public void assetCategoriesSummary(
085 String className, long classPK, String message,
086 PortletURL portletURL)
087 throws Exception;
088
089 public void assetLinks(long assetEntryId, String className, long classPK)
090 throws Exception;
091
092 public void assetTagsSummary(
093 String className, long classPK, String message,
094 String assetTagNames, PortletURL portletURL)
095 throws Exception;
096
097 public void breadcrumb() throws Exception;
098
099 public void breadcrumb(
100 String displayStyle, boolean showGuestGroup,
101 boolean showParentGroups, boolean showLayout,
102 boolean showPortletBreadcrumb)
103 throws Exception;
104
105 public void discussion(
106 String className, long classPK, String formAction, String formName,
107 boolean hideControls, boolean ratingsEnabled, String redirect,
108 long userId)
109 throws Exception;
110
111
115 @Deprecated
116 public void discussion(
117 String className, long classPK, String formAction, String formName,
118 boolean hideControls, boolean ratingsEnabled, String redirect,
119 String subject, long userId)
120 throws Exception;
121
122 public void doAsURL(long doAsUserId) throws Exception;
123
124 public void flags(
125 String className, long classPK, String contentTitle, boolean label,
126 String message, long reportedUserId)
127 throws Exception;
128
129 public AssetCategoriesSummaryTag getAssetCategoriesSummaryTag()
130 throws Exception;
131
132 public AssetLinksTag getAssetLinksTag() throws Exception;
133
134 public AssetTagsSummaryTag getAssetTagsSummaryTag() throws Exception;
135
136 public BreadcrumbTag getBreadcrumbTag() throws Exception;
137
138 public ColumnTag getColumnTag() throws Exception;
139
140 public DiscussionTag getDiscussionTag() throws Exception;
141
142 public FlagsTag getFlagsTag() throws Exception;
143
144 public IconTag getIconTag() throws Exception;
145
146 public JournalArticleTag getJournalArticleTag() throws Exception;
147
148 public LayoutTag getLayoutTag() throws Exception;
149
150 public MySitesTag getMySitesTag() throws Exception;
151
152 public PageContext getPageContext();
153
154 public PngImageTag getPngImageTag() throws Exception;
155
156 public QuickAccessTag getQuickAccessTag() throws Exception;
157
158 public RatingsTag getRatingsTag() throws Exception;
159
160 public String getSetting(String name);
161
162 public WindowState getWindowState(String windowState);
163
164 public void icon(String image, boolean label, String message, String url)
165 throws Exception;
166
167
170 @Deprecated
171 public void iconBack() throws Exception;
172
173
176 @Deprecated
177 public void iconClose() throws Exception;
178
179
182 @Deprecated
183 public void iconConfiguration() throws Exception;
184
185
188 @Deprecated
189 public void iconEdit() throws Exception;
190
191
194 @Deprecated
195 public void iconEditDefaults() throws Exception;
196
197
200 @Deprecated
201 public void iconEditGuest() throws Exception;
202
203
206 @Deprecated
207 public void iconHelp() throws Exception;
208
209 public void iconHelp(String message) throws Exception;
210
211
214 @Deprecated
215 public void iconMaximize() throws Exception;
216
217
220 @Deprecated
221 public void iconMinimize() throws Exception;
222
223
226 @Deprecated
227 public void iconOptions() throws Exception;
228
229
232 @Deprecated
233 public void iconPortlet() throws Exception;
234
235
238 @Deprecated
239 public void iconPortlet(Portlet portlet) throws Exception;
240
241
244 @Deprecated
245 public void iconPortletCss() throws Exception;
246
247
250 @Deprecated
251 public void iconPrint() throws Exception;
252
253
256 @Deprecated
257 public void iconRefresh() throws Exception;
258
259 public void include(ServletContext servletContext, String page)
260 throws Exception;
261
262 public void include(String page) throws Exception;
263
264 public void journalArticle(
265 String articleId, long groupId, String ddmTemplateKey)
266 throws Exception;
267
268 public void journalContentSearch() throws Exception;
269
270 public void journalContentSearch(
271 boolean showListed, String targetPortletId, String type)
272 throws Exception;
273
274 public void language() throws Exception;
275
276 public void language(
277 String formName, String formAction, String name,
278 String displayStyle)
279 throws Exception;
280
281 public void language(
282 String formName, String formAction, String name,
283 String[] languageIds, String displayStyle)
284 throws Exception;
285
286 public void layoutIcon(Layout layout) throws Exception;
287
288 public void metaTags() throws Exception;
289
290
293 @Deprecated
294 public void myPlaces() throws Exception;
295
296
299 @Deprecated
300 public void myPlaces(int max) throws Exception;
301
302 public void mySites() throws Exception;
303
304 public void mySites(int max) throws Exception;
305
306 public String permissionsURL(
307 String redirect, String modelResource,
308 String modelResourceDescription, Object resourceGroupId,
309 String resourcePrimKey, String windowState, int[] roleTypes)
310 throws Exception;
311
312
316 @Deprecated
317 public String permissionsURL(
318 String redirect, String modelResource,
319 String modelResourceDescription, String resourcePrimKey,
320 String windowState, int[] roleTypes)
321 throws Exception;
322
323 public void portletIconBack() throws Exception;
324
325 public void portletIconClose() throws Exception;
326
327 public void portletIconConfiguration() throws Exception;
328
329 public void portletIconEdit() throws Exception;
330
331 public void portletIconEditDefaults() throws Exception;
332
333 public void portletIconEditGuest() throws Exception;
334
335 public void portletIconHelp() throws Exception;
336
337 public void portletIconMaximize() throws Exception;
338
339 public void portletIconMinimize() throws Exception;
340
341 public void portletIconOptions() throws Exception;
342
343 public void portletIconPortlet() throws Exception;
344
345 public void portletIconPortlet(Portlet portlet) throws Exception;
346
347 public void portletIconPortletCss() throws Exception;
348
349 public void portletIconPrint() throws Exception;
350
351 public void portletIconRefresh() throws Exception;
352
353 public void quickAccess() throws Exception;
354
355 public void quickAccess(String contentId) throws Exception;
356
357 public void ratings(
358 String className, long classPK, int numberOfStars, String type,
359 String url)
360 throws Exception;
361
362 public String renderURL(long plid, String portletName, String queryString)
363 throws Exception;
364
365 public String renderURL(String portletName, String queryString)
366 throws Exception;
367
368 public String renderURL(
369 String windowState, String portletMode, Boolean secure,
370 Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
371 long refererPlid, String portletName, Boolean anchor,
372 Boolean encrypt, long doAsGroupId, long doAsUserId,
373 Boolean portletConfiguration, String queryString)
374 throws Exception;
375
376
381 @Deprecated
382 public String renderURL(
383 String windowState, String portletMode, Boolean secure,
384 Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
385 String portletName, Boolean anchor, Boolean encrypt,
386 long doAsUserId, Boolean portletConfiguration, String queryString)
387 throws Exception;
388
389 public String renderURL(
390 String windowState, String portletMode, long plid,
391 String portletName, String queryString)
392 throws Exception;
393
394 public String renderURL(
395 String windowState, String portletMode, String portletName,
396 String queryString)
397 throws Exception;
398
399 public void runtime(String portletName) throws Exception;
400
401 public void runtime(String portletName, String queryString)
402 throws Exception;
403
404 public void runtime(
405 String portletName, String queryString, String defaultPreferences)
406 throws Exception;
407
408 public void search() throws Exception;
409
410 public void setTemplate(Template template);
411
412 public void sitesDirectory() throws Exception;
413
414 public void sitesDirectory(String displayStyle, String sites)
415 throws Exception;
416
417 public void socialBookmarks(
418 String displayStyle, String target, String types, String title,
419 String url)
420 throws Exception;
421
422
425 @Deprecated
426 public void staging() throws Exception;
427
428 public void toggle(
429 String id, String showImage, String hideImage, String showMessage,
430 String hideMessage, boolean defaultShowContent)
431 throws Exception;
432
433 public String wrapPortlet(String wrapPage, String portletPage)
434 throws Exception;
435
436 }