001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
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    /**
040     * @author Daniel Reuther
041     */
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            /**
051             * @deprecated As of 6.1.0, replaced by {@link #actionURL(String, String,
052             *             Boolean, Boolean, Boolean, String, long, long, String,
053             *             Boolean, Boolean, long, long, Boolean, String)}
054             */
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                            String subject, long userId)
106                    throws Exception;
107    
108            public void doAsURL(long doAsUserId) throws Exception;
109    
110            public void flags(
111                            String className, long classPK, String contentTitle, boolean label,
112                            String message, long reportedUserId)
113                    throws Exception;
114    
115            public AssetCategoriesSummaryTag getAssetCategoriesSummaryTag()
116                    throws Exception;
117    
118            public AssetLinksTag getAssetLinksTag() throws Exception;
119    
120            public AssetTagsSummaryTag getAssetTagsSummaryTag() throws Exception;
121    
122            public BreadcrumbTag getBreadcrumbTag() throws Exception;
123    
124            public ColumnTag getColumnTag() throws Exception;
125    
126            public DiscussionTag getDiscussionTag() throws Exception;
127    
128            public FlagsTag getFlagsTag() throws Exception;
129    
130            public IconTag getIconTag() throws Exception;
131    
132            public JournalArticleTag getJournalArticleTag() throws Exception;
133    
134            public LayoutTag getLayoutTag() throws Exception;
135    
136            public MySitesTag getMySitesTag() throws Exception;
137    
138            public PngImageTag getPngImageTag() throws Exception;
139    
140            public RatingsTag getRatingsTag() throws Exception;
141    
142            public String getSetting(String name);
143    
144            public WindowState getWindowState(String windowState);
145    
146            public void icon(String image, boolean label, String message, String url)
147                    throws Exception;
148    
149            public void iconBack() throws Exception;
150    
151            public void iconClose() throws Exception;
152    
153            public void iconConfiguration() throws Exception;
154    
155            public void iconEdit() throws Exception;
156    
157            public void iconEditDefaults() throws Exception;
158    
159            public void iconEditGuest() throws Exception;
160    
161            public void iconHelp() throws Exception;
162    
163            public void iconMaximize() throws Exception;
164    
165            public void iconMinimize() throws Exception;
166    
167            public void iconOptions() throws Exception;
168    
169            public void iconPortlet() throws Exception;
170    
171            public void iconPortlet(Portlet portlet) throws Exception;
172    
173            public void iconPortletCss() throws Exception;
174    
175            public void iconPrint() throws Exception;
176    
177            public void iconRefresh() throws Exception;
178    
179            public void include(ServletContext servletContext, String page)
180                    throws Exception;
181    
182            public void include(String page) throws Exception;
183    
184            public void journalArticle(
185                            String articleId, long groupId, String templateId)
186                    throws Exception;
187    
188            public void journalContentSearch() throws Exception;
189    
190            public void journalContentSearch(
191                            boolean showListed, String targetPortletId, String type)
192                    throws Exception;
193    
194            public void language() throws Exception;
195    
196            public void language(
197                            String formName, String formAction, String name, int displayStyle)
198                    throws Exception;
199    
200            public void language(
201                            String formName, String formAction, String name,
202                            String[] languageIds, int displayStyle)
203                    throws Exception;
204    
205            public void layoutIcon(Layout layout) throws Exception;
206    
207            public void metaTags() throws Exception;
208    
209            /**
210             * @deprecated As of 6.1.0, replaced by {@link #mySites}
211             */
212            public void myPlaces() throws Exception;
213    
214            /**
215             * @deprecated As of 6.1.0, replaced by {@link #mySites(int)}
216             */
217            public void myPlaces(int max) throws Exception;
218    
219            public void mySites() throws Exception;
220    
221            public void mySites(int max) throws Exception;
222    
223            public void permissionsURL(
224                            String redirect, String modelResource,
225                            String modelResourceDescription, Object resourceGroupId,
226                            String resourcePrimKey, String windowState, int[] roleTypes)
227                    throws Exception;
228    
229            /**
230             * @deprecated As of 6.2.0, replaced by {@link #permissionsURL(String,
231             *             String, String, long, String, String, int[])}
232             */
233            public void permissionsURL(
234                            String redirect, String modelResource,
235                            String modelResourceDescription, String resourcePrimKey,
236                            String windowState, int[] roleTypes)
237                    throws Exception;
238    
239            public void ratings(
240                            String className, long classPK, int numberOfStars, String type,
241                            String url)
242                    throws Exception;
243    
244            public void renderURL(long plid, String portletName, String queryString)
245                    throws Exception;
246    
247            public void renderURL(String portletName, String queryString)
248                    throws Exception;
249    
250            public void renderURL(
251                            String windowState, String portletMode, Boolean secure,
252                            Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
253                            long refererPlid, String portletName, Boolean anchor,
254                            Boolean encrypt, long doAsGroupId, long doAsUserId,
255                            Boolean portletConfiguration, String queryString)
256                    throws Exception;
257    
258            /**
259             * @deprecated As of 6.1.0, replaced by {@link #renderURL(String, String,
260             *             Boolean, Boolean, Boolean, long, long, String, Boolean,
261             *             Boolean, long, long, Boolean, String)}
262             */
263            public void renderURL(
264                            String windowState, String portletMode, Boolean secure,
265                            Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
266                            String portletName, Boolean anchor, Boolean encrypt,
267                            long doAsUserId, Boolean portletConfiguration, String queryString)
268                    throws Exception;
269    
270            public void renderURL(
271                            String windowState, String portletMode, long plid,
272                            String portletName, String queryString)
273                    throws Exception;
274    
275            public void renderURL(
276                            String windowState, String portletMode, String portletName,
277                            String queryString)
278                    throws Exception;
279    
280            public void runtime(String portletName) throws Exception;
281    
282            public void runtime(String portletName, String queryString)
283                    throws Exception;
284    
285            public void runtime(
286                            String portletName, String queryString, String defaultPreferences)
287                    throws Exception;
288    
289            public void search() throws Exception;
290    
291            public void setTemplate(Template template);
292    
293            public void sitesDirectory() throws Exception;
294    
295            public void sitesDirectory(String displayStyle, String sites)
296                    throws Exception;
297    
298            public void socialBookmarks(
299                            String displayStyle, String target, String types, String title,
300                            String url)
301                    throws Exception;
302    
303            public void staging() throws Exception;
304    
305            public void toggle(
306                            String id, String showImage, String hideImage, String showMessage,
307                            String hideMessage, boolean defaultShowContent)
308                    throws Exception;
309    
310            public String wrapPortlet(String wrapPage, String portletPage)
311                    throws Exception;
312    
313    }