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