001
014
015 package com.liferay.taglib.util;
016
017 import com.liferay.portal.kernel.portlet.PortletProvider;
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 import javax.servlet.jsp.PageContext;
039
040
043 public interface VelocityTaglib {
044
045 public String actionURL(long plid, String portletName, String queryString)
046 throws Exception;
047
048 public String actionURL(String portletName, String queryString)
049 throws Exception;
050
051
056 @Deprecated
057 public String actionURL(
058 String windowState, String portletMode, Boolean secure,
059 Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
060 long plid, long refererPlid, String portletName, Boolean anchor,
061 Boolean encrypt, long doAsUserId, Boolean portletConfiguration,
062 String queryString)
063 throws Exception;
064
065 public String actionURL(
066 String windowState, String portletMode, Boolean secure,
067 Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
068 long plid, long refererPlid, String portletName, Boolean anchor,
069 Boolean encrypt, long doAsGroupId, long doAsUserId,
070 Boolean portletConfiguration, String queryString)
071 throws Exception;
072
073 public String actionURL(
074 String windowState, String portletMode, long plid,
075 String portletName, String queryString)
076 throws Exception;
077
078 public String actionURL(
079 String windowState, String portletMode, String portletName,
080 String queryString)
081 throws Exception;
082
083 public void assetCategoriesSummary(
084 String className, long classPK, String message,
085 PortletURL portletURL)
086 throws Exception;
087
088 public void assetLinks(long assetEntryId, String className, long classPK)
089 throws Exception;
090
091 public void assetTagsSummary(
092 String className, long classPK, String message,
093 String assetTagNames, PortletURL portletURL)
094 throws Exception;
095
096 public void breadcrumb() throws Exception;
097
098 public void breadcrumb(
099 long ddmTemplateGroupId, String ddmTemplateKey,
100 boolean showGuestGroup, boolean showParentGroups,
101 boolean showLayout, boolean showPortletBreadcrumb)
102 throws Exception;
103
104 public void discussion(
105 String className, long classPK, String formAction, String formName,
106 boolean hideControls, boolean ratingsEnabled, String redirect,
107 long userId)
108 throws Exception;
109
110
114 @Deprecated
115 public void discussion(
116 String className, long classPK, String formAction, String formName,
117 boolean hideControls, boolean ratingsEnabled, String redirect,
118 String subject, long userId)
119 throws Exception;
120
121 public void doAsURL(long doAsUserId) throws Exception;
122
123 public void flags(
124 String className, long classPK, String contentTitle, boolean label,
125 String message, long reportedUserId)
126 throws Exception;
127
128 public AssetCategoriesSummaryTag<?> getAssetCategoriesSummaryTag()
129 throws Exception;
130
131 public AssetLinksTag getAssetLinksTag() throws Exception;
132
133 public AssetTagsSummaryTag<?> getAssetTagsSummaryTag() throws Exception;
134
135 public BreadcrumbTag getBreadcrumbTag() throws Exception;
136
137 public ColumnTag getColumnTag() throws Exception;
138
139 public DiscussionTag getDiscussionTag() throws Exception;
140
141 public FlagsTag getFlagsTag() throws Exception;
142
143 public IconTag getIconTag() throws Exception;
144
145 public JournalArticleTag getJournalArticleTag() throws Exception;
146
147 public LayoutTag getLayoutTag() throws Exception;
148
149 public MySitesTag getMySitesTag() throws Exception;
150
151 public PageContext getPageContext();
152
153 public PngImageTag getPngImageTag() throws Exception;
154
155 public RatingsTag getRatingsTag() throws Exception;
156
157 public String getSetting(String name);
158
159 public WindowState getWindowState(String windowState);
160
161 public void icon(String image, boolean label, String message, String url)
162 throws Exception;
163
164
167 @Deprecated
168 public void iconBack() throws Exception;
169
170 public void iconHelp(String message) throws Exception;
171
172
175 @Deprecated
176 public void iconOptions() throws Exception;
177
178
181 @Deprecated
182 public void iconPortlet() throws Exception;
183
184
187 @Deprecated
188 public void iconPortlet(Portlet portlet) throws Exception;
189
190 public void include(ServletContext servletContext, String page)
191 throws Exception;
192
193 public void include(String page) throws Exception;
194
195 public void journalArticle(
196 String articleId, long groupId, String ddmTemplateKey)
197 throws Exception;
198
199 public void journalContentSearch() throws Exception;
200
201 public void journalContentSearch(boolean showListed, String targetPortletId)
202 throws Exception;
203
204 public void language() throws Exception;
205
206 public void language(
207 String formName, String formAction, String name,
208 String displayStyle)
209 throws Exception;
210
211 public void language(
212 String formName, String formAction, String name,
213 String[] languageIds, String displayStyle)
214 throws Exception;
215
216 public void layoutIcon(Layout layout) throws Exception;
217
218 public void metaTags() throws Exception;
219
220
223 @Deprecated
224 public void myPlaces() throws Exception;
225
226
229 @Deprecated
230 public void myPlaces(int max) throws Exception;
231
232 public void mySites() throws Exception;
233
234 public void mySites(int max) throws Exception;
235
236 public String permissionsURL(
237 String redirect, String modelResource,
238 String modelResourceDescription, Object resourceGroupId,
239 String resourcePrimKey, String windowState, int[] roleTypes)
240 throws Exception;
241
242
246 @Deprecated
247 public String permissionsURL(
248 String redirect, String modelResource,
249 String modelResourceDescription, String resourcePrimKey,
250 String windowState, int[] roleTypes)
251 throws Exception;
252
253 public void portletIconBack() throws Exception;
254
255 public void portletIconOptions() throws Exception;
256
257 public void portletIconOptions(String direction, String markupView)
258 throws Exception;
259
260 public void portletIconPortlet() throws Exception;
261
262 public void portletIconPortlet(Portlet portlet) throws Exception;
263
264 public void ratings(
265 String className, long classPK, int numberOfStars, String type,
266 String url)
267 throws Exception;
268
269 public String renderURL(long plid, String portletName, String queryString)
270 throws Exception;
271
272 public String renderURL(String portletName, String queryString)
273 throws Exception;
274
275 public String renderURL(
276 String windowState, String portletMode, Boolean secure,
277 Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
278 long refererPlid, String portletName, Boolean anchor,
279 Boolean encrypt, long doAsGroupId, long doAsUserId,
280 Boolean portletConfiguration, String queryString)
281 throws Exception;
282
283
288 @Deprecated
289 public String renderURL(
290 String windowState, String portletMode, Boolean secure,
291 Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
292 String portletName, Boolean anchor, Boolean encrypt,
293 long doAsUserId, Boolean portletConfiguration, String queryString)
294 throws Exception;
295
296 public String renderURL(
297 String windowState, String portletMode, long plid,
298 String portletName, String queryString)
299 throws Exception;
300
301 public String renderURL(
302 String windowState, String portletMode, String portletName,
303 String queryString)
304 throws Exception;
305
306 public void runtime(String portletName) throws Exception;
307
308 public void runtime(
309 String portletProviderClassName,
310 PortletProvider.Action portletProviderAction)
311 throws Exception;
312
313 public void runtime(
314 String portletProviderClassName,
315 PortletProvider.Action portletProviderAction, String instanceId)
316 throws Exception;
317
318 public void runtime(
319 String portletProviderClassName,
320 PortletProvider.Action portletProviderAction, String instanceId,
321 String defaultPreferences)
322 throws Exception;
323
324 public void runtime(String portletName, String queryString)
325 throws Exception;
326
327 public void runtime(
328 String portletName, String queryString, String defaultPreferences)
329 throws Exception;
330
331 public void runtime(
332 String portletName, String instanceId, String queryString,
333 String defaultPreferences)
334 throws Exception;
335
336 public void search() throws Exception;
337
338 public void sitesDirectory() throws Exception;
339
340 public void sitesDirectory(String displayStyle, String sites)
341 throws Exception;
342
343 public void socialBookmarks(
344 String displayStyle, String target, String types, String title,
345 String url)
346 throws Exception;
347
348
351 @Deprecated
352 public void staging() throws Exception;
353
354 public void toggle(
355 String id, String showImage, String hideImage, String showMessage,
356 String hideMessage, boolean defaultShowContent)
357 throws Exception;
358
359 public String wrapPortlet(String wrapPage, String portletPage)
360 throws Exception;
361
362 }