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.model.Layout;
018    import com.liferay.portal.model.Portlet;
019    import com.liferay.taglib.ui.BreadcrumbTag;
020    import com.liferay.taglib.ui.MySitesTag;
021    import com.liferay.taglib.ui.PngImageTag;
022    
023    import javax.servlet.ServletContext;
024    
025    /**
026     * @author Daniel Reuther
027     */
028    public interface VelocityTaglib {
029    
030            public void actionURL(long plid, String portletName, String queryString)
031                    throws Exception;
032    
033            public void actionURL(String portletName, String queryString)
034                    throws Exception;
035    
036            /**
037             * @deprecated {@link #actionURL(String, String, Boolean, Boolean, Boolean,
038             *             String, long, long, String, Boolean, Boolean, long, long,
039             *             Boolean, String)}
040             */
041            public void actionURL(
042                            String windowState, String portletMode, Boolean secure,
043                            Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
044                            long plid, long refererPlid, String portletName, Boolean anchor,
045                            Boolean encrypt, long doAsUserId, Boolean portletConfiguration,
046                            String queryString)
047                    throws Exception;
048    
049            public void actionURL(
050                            String windowState, String portletMode, Boolean secure,
051                            Boolean copyCurrentRenderParameters, Boolean escapeXml, String name,
052                            long plid, long refererPlid, String portletName, Boolean anchor,
053                            Boolean encrypt, long doAsGroupId, long doAsUserId,
054                            Boolean portletConfiguration, String queryString)
055                    throws Exception;
056    
057            public void actionURL(
058                            String windowState, String portletMode, long plid,
059                            String portletName, String queryString)
060                    throws Exception;
061    
062            public void actionURL(
063                            String windowState, String portletMode, String portletName,
064                            String queryString)
065                    throws Exception;
066    
067            public void breadcrumb() throws Exception;
068    
069            public void breadcrumb(
070                            String displayStyle, boolean showGuestGroup,
071                            boolean showParentGroups, boolean showLayout,
072                            boolean showPortletBreadcrumb)
073                    throws Exception;
074    
075            public void doAsURL(long doAsUserId) throws Exception;
076    
077            public BreadcrumbTag getBreadcrumbTag() throws Exception;
078    
079            public MySitesTag getMySitesTag() throws Exception;
080    
081            public PngImageTag getPngImageTag() throws Exception;
082    
083            public String getSetting(String name);
084    
085            public void iconBack() throws Exception;
086    
087            public void iconClose() throws Exception;
088    
089            public void iconConfiguration() throws Exception;
090    
091            public void iconEdit() throws Exception;
092    
093            public void iconEditDefaults() throws Exception;
094    
095            public void iconEditGuest() throws Exception;
096    
097            public void iconHelp() throws Exception;
098    
099            public void iconMaximize() throws Exception;
100    
101            public void iconMinimize() throws Exception;
102    
103            public void iconOptions() throws Exception;
104    
105            public void iconPortlet() throws Exception;
106    
107            public void iconPortlet(Portlet portlet) throws Exception;
108    
109            public void iconPortletCss() throws Exception;
110    
111            public void iconPrint() throws Exception;
112    
113            public void iconRefresh() throws Exception;
114    
115            public void include(ServletContext servletContext, String page)
116                    throws Exception;
117    
118            public void include(String page) throws Exception;
119    
120            public void journalContentSearch() throws Exception;
121    
122            public void journalContentSearch(
123                            boolean showListed, String targetPortletId, String type)
124                    throws Exception;
125    
126            public void language() throws Exception;
127    
128            public void language(
129                            String formName, String formAction, String name, int displayStyle)
130                    throws Exception;
131    
132            public void language(
133                            String formName, String formAction, String name,
134                            String[] languageIds, int displayStyle)
135                    throws Exception;
136    
137            public void layoutIcon(Layout layout) throws Exception;
138    
139            public void metaTags() throws Exception;
140    
141            /**
142             * @deprecated {@link #mySites}
143             */
144            public void myPlaces() throws Exception;
145    
146            /**
147             * @deprecated {@link #mySites(int)}
148             */
149            public void myPlaces(int max) throws Exception;
150    
151            public void mySites() throws Exception;
152    
153            public void mySites(int max) throws Exception;
154    
155            public void permissionsURL(
156                            String redirect, String modelResource,
157                            String modelResourceDescription, Object resourceGroupId,
158                            String resourcePrimKey, String windowState, int[] roleTypes)
159                    throws Exception;
160    
161            /**
162             * @deprecated {@link #permissionsURL(String, String, String, long, String,
163             *             String, int[])}
164             */
165            public void permissionsURL(
166                            String redirect, String modelResource,
167                            String modelResourceDescription, String resourcePrimKey,
168                            String windowState, int[] roleTypes)
169                    throws Exception;
170    
171            public void renderURL(long plid, String portletName, String queryString)
172                    throws Exception;
173    
174            public void renderURL(String portletName, String queryString)
175                    throws Exception;
176    
177            public void renderURL(
178                            String windowState, String portletMode, Boolean secure,
179                            Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
180                            long refererPlid, String portletName, Boolean anchor,
181                            Boolean encrypt, long doAsGroupId, long doAsUserId,
182                            Boolean portletConfiguration, String queryString)
183                    throws Exception;
184    
185            /**
186             * @deprecated {@link #renderURL(String, String, Boolean, Boolean, Boolean,
187             *             long, long, String, Boolean, Boolean, long, long, Boolean,
188             *             String)}
189             */
190            public void renderURL(
191                            String windowState, String portletMode, Boolean secure,
192                            Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid,
193                            String portletName, Boolean anchor, Boolean encrypt,
194                            long doAsUserId, Boolean portletConfiguration, String queryString)
195                    throws Exception;
196    
197            public void renderURL(
198                            String windowState, String portletMode, long plid,
199                            String portletName, String queryString)
200                    throws Exception;
201    
202            public void renderURL(
203                            String windowState, String portletMode, String portletName,
204                            String queryString)
205                    throws Exception;
206    
207            public void runtime(String portletName) throws Exception;
208    
209            public void runtime(String portletName, String queryString)
210                    throws Exception;
211    
212            public void runtime(
213                            String portletName, String queryString, String defaultPreferences)
214                    throws Exception;
215    
216            public void search() throws Exception;
217    
218            public void staging() throws Exception;
219    
220            public void toggle(
221                            String id, String showImage, String hideImage, String showMessage,
222                            String hideMessage, boolean defaultShowContent)
223                    throws Exception;
224    
225            public String wrapPortlet(String wrapPage, String portletPage)
226                    throws Exception;
227    
228    }