Liferay 7.0-ce-b4

com.liferay.taglib.util
Class VelocityTaglibImpl

java.lang.Object
  extended by com.liferay.taglib.util.VelocityTaglibImpl
All Implemented Interfaces:
VelocityTaglib

public class VelocityTaglibImpl
extends Object
implements VelocityTaglib


Constructor Summary
VelocityTaglibImpl(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Map<String,Object> contextObjects)
           
 
Method Summary
 String actionURL(long plid, String portletName, String queryString)
           
 String actionURL(String portletName, String queryString)
           
 String actionURL(String windowState, String portletMode, Boolean secure, Boolean copyCurrentRenderParameters, Boolean escapeXml, String name, long plid, long refererPlid, String portletName, Boolean anchor, Boolean encrypt, long doAsUserId, Boolean portletConfiguration, String queryString)
          Deprecated. As of 6.2.0, replaced by actionURL(String, String, Boolean, Boolean, Boolean, String, long, long, String, Boolean, Boolean, long, long, Boolean, String)
 String actionURL(String windowState, String portletMode, Boolean secure, Boolean copyCurrentRenderParameters, Boolean escapeXml, String name, long plid, long refererPlid, String portletName, Boolean anchor, Boolean encrypt, long doAsGroupId, long doAsUserId, Boolean portletConfiguration, String queryString)
           
 String actionURL(String windowState, String portletMode, long plid, String portletName, String queryString)
           
 String actionURL(String windowState, String portletMode, String portletName, String queryString)
           
 void assetCategoriesSummary(String className, long classPK, String message, PortletURL portletURL)
           
 void assetLinks(long assetEntryId, String className, long classPK)
           
 void assetTagsSummary(String className, long classPK, String message, String assetTagNames, PortletURL portletURL)
           
 void breadcrumb()
           
 void breadcrumb(long ddmTemplateGroupId, String ddmTemplateKey, boolean showGuestGroup, boolean showParentGroups, boolean showLayout, boolean showPortletBreadcrumb)
           
 void discussion(String className, long classPK, String formAction, String formName, boolean hideControls, boolean ratingsEnabled, String redirect, long userId)
           
 void discussion(String className, long classPK, String formAction, String formName, boolean hideControls, boolean ratingsEnabled, String redirect, String subject, long userId)
          Deprecated. As of 6.2.0, replaced by discussion(String, long, String, String, boolean, boolean, String, long))}
 void doAsURL(long doAsUserId)
           
 void flags(String className, long classPK, String contentTitle, boolean label, String message, long reportedUserId)
           
 AssetCategoriesSummaryTag<?> getAssetCategoriesSummaryTag()
           
 AssetLinksTag getAssetLinksTag()
           
 AssetTagsSummaryTag<?> getAssetTagsSummaryTag()
           
 BreadcrumbTag getBreadcrumbTag()
           
 ColumnTag getColumnTag()
           
 DiscussionTag getDiscussionTag()
           
 FlagsTag getFlagsTag()
           
 IconTag getIconTag()
           
 JournalArticleTag getJournalArticleTag()
           
 LayoutTag getLayoutTag()
           
 MySitesTag getMySitesTag()
           
 javax.servlet.jsp.PageContext getPageContext()
           
 PngImageTag getPngImageTag()
           
 RatingsTag getRatingsTag()
           
 String getSetting(String name)
           
 WindowState getWindowState(String windowState)
           
 void icon(String image, boolean label, String message, String url)
           
 void iconBack()
          Deprecated. As of 6.2.0, replaced by iconBack()
 void iconHelp(String message)
           
 void iconOptions()
          Deprecated. As of 6.2.0, replaced by portletIconOptions()
 void iconPortlet()
          Deprecated. As of 6.2.0, replaced by portletIconPortlet()
 void iconPortlet(Portlet portlet)
          Deprecated. As of 6.2.0, replaced by portletIconPortlet(Portlet)
 void include(javax.servlet.ServletContext servletContext, String page)
           
 void include(String page)
           
 void journalArticle(String articleId, long groupId, String ddmTemplateKey)
           
 void journalContentSearch()
           
 void journalContentSearch(boolean showListed, String targetPortletId)
           
 void language()
           
 void language(String formName, String formAction, String name, String ddmTemplateKey)
           
 void language(String formName, String formAction, String name, String[] languageIds, String ddmTemplateKey)
           
 void layoutIcon(Layout layout)
           
 void metaTags()
           
 void myPlaces()
          Deprecated. As of 6.2.0, replaced by mySites()
 void myPlaces(int max)
          Deprecated. As of 6.2.0, replaced by mySites(int)
 void mySites()
           
 void mySites(int max)
           
 String permissionsURL(String redirect, String modelResource, String modelResourceDescription, Object resourceGroupId, String resourcePrimKey, String windowState, int[] roleTypes)
           
 String permissionsURL(String redirect, String modelResource, String modelResourceDescription, String resourcePrimKey, String windowState, int[] roleTypes)
          Deprecated. As of 6.2.0, replaced by permissionsURL(String, String, String, Object, String, String, int[])
 void portletIconBack()
           
 void portletIconOptions()
           
 void portletIconOptions(String direction, String markupView)
           
 void portletIconPortlet()
           
 void portletIconPortlet(Portlet portlet)
           
 void ratings(String className, long classPK, int numberOfStars, String type, String url)
           
 String renderURL(long plid, String portletName, String queryString)
           
 String renderURL(String portletName, String queryString)
           
 String renderURL(String windowState, String portletMode, Boolean secure, Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid, long refererPlid, String portletName, Boolean anchor, Boolean encrypt, long doAsGroupId, long doAsUserId, Boolean portletConfiguration, String queryString)
           
 String renderURL(String windowState, String portletMode, Boolean secure, Boolean copyCurrentRenderParameters, Boolean escapeXml, long plid, String portletName, Boolean anchor, Boolean encrypt, long doAsUserId, Boolean portletConfiguration, String queryString)
          Deprecated. As of 6.2.0, replaced by renderURL(String, String, Boolean, Boolean, Boolean, long, long, String, Boolean, Boolean, long, long, Boolean, String)
 String renderURL(String windowState, String portletMode, long plid, String portletName, String queryString)
           
 String renderURL(String windowState, String portletMode, String portletName, String queryString)
           
 void runtime(String portletName)
           
 void runtime(String portletProviderClassName, PortletProvider.Action portletProviderAction)
           
 void runtime(String portletProviderClassName, PortletProvider.Action portletProviderAction, String instanceId)
           
 void runtime(String portletProviderClassName, PortletProvider.Action portletProviderAction, String instanceId, String defaultPreferences)
           
 void runtime(String portletName, String queryString)
           
 void runtime(String portletName, String queryString, String defaultPreferences)
           
 void runtime(String portletName, String instanceId, String queryString, String defaultPreferences)
           
 void search()
           
protected  void setUp(TagSupport tagSupport)
           
 void sitesDirectory()
           
 void sitesDirectory(String displayStyle, String sites)
           
 void socialBookmarks(String displayStyle, String target, String types, String title, String url)
           
 void staging()
          Deprecated. As of 7.0.0, with no direct replacement
 void toggle(String id, String showImage, String hideImage, String showMessage, String hideMessage, boolean defaultShowContent)
           
 String wrapPortlet(String wrapPage, String portletPage)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VelocityTaglibImpl

public VelocityTaglibImpl(javax.servlet.ServletContext servletContext,
                          javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          Map<String,Object> contextObjects)
Method Detail

actionURL

public String actionURL(long plid,
                        String portletName,
                        String queryString)
                 throws Exception
Specified by:
actionURL in interface VelocityTaglib
Throws:
Exception

actionURL

public String actionURL(String portletName,
                        String queryString)
                 throws Exception
Specified by:
actionURL in interface VelocityTaglib
Throws:
Exception

actionURL

@Deprecated
public String actionURL(String windowState,
                                   String portletMode,
                                   Boolean secure,
                                   Boolean copyCurrentRenderParameters,
                                   Boolean escapeXml,
                                   String name,
                                   long plid,
                                   long refererPlid,
                                   String portletName,
                                   Boolean anchor,
                                   Boolean encrypt,
                                   long doAsUserId,
                                   Boolean portletConfiguration,
                                   String queryString)
                 throws Exception
Deprecated. As of 6.2.0, replaced by actionURL(String, String, Boolean, Boolean, Boolean, String, long, long, String, Boolean, Boolean, long, long, Boolean, String)

Specified by:
actionURL in interface VelocityTaglib
Throws:
Exception

actionURL

public String actionURL(String windowState,
                        String portletMode,
                        Boolean secure,
                        Boolean copyCurrentRenderParameters,
                        Boolean escapeXml,
                        String name,
                        long plid,
                        long refererPlid,
                        String portletName,
                        Boolean anchor,
                        Boolean encrypt,
                        long doAsGroupId,
                        long doAsUserId,
                        Boolean portletConfiguration,
                        String queryString)
                 throws Exception
Specified by:
actionURL in interface VelocityTaglib
Throws:
Exception

actionURL

public String actionURL(String windowState,
                        String portletMode,
                        long plid,
                        String portletName,
                        String queryString)
                 throws Exception
Specified by:
actionURL in interface VelocityTaglib
Throws:
Exception

actionURL

public String actionURL(String windowState,
                        String portletMode,
                        String portletName,
                        String queryString)
                 throws Exception
Specified by:
actionURL in interface VelocityTaglib
Throws:
Exception

assetCategoriesSummary

public void assetCategoriesSummary(String className,
                                   long classPK,
                                   String message,
                                   PortletURL portletURL)
                            throws Exception
Specified by:
assetCategoriesSummary in interface VelocityTaglib
Throws:
Exception

assetLinks

public void assetLinks(long assetEntryId,
                       String className,
                       long classPK)
                throws Exception
Specified by:
assetLinks in interface VelocityTaglib
Throws:
Exception

assetTagsSummary

public void assetTagsSummary(String className,
                             long classPK,
                             String message,
                             String assetTagNames,
                             PortletURL portletURL)
                      throws Exception
Specified by:
assetTagsSummary in interface VelocityTaglib
Throws:
Exception

breadcrumb

public void breadcrumb()
                throws Exception
Specified by:
breadcrumb in interface VelocityTaglib
Throws:
Exception

breadcrumb

public void breadcrumb(long ddmTemplateGroupId,
                       String ddmTemplateKey,
                       boolean showGuestGroup,
                       boolean showParentGroups,
                       boolean showLayout,
                       boolean showPortletBreadcrumb)
                throws Exception
Specified by:
breadcrumb in interface VelocityTaglib
Throws:
Exception

discussion

public void discussion(String className,
                       long classPK,
                       String formAction,
                       String formName,
                       boolean hideControls,
                       boolean ratingsEnabled,
                       String redirect,
                       long userId)
                throws Exception
Specified by:
discussion in interface VelocityTaglib
Throws:
Exception

discussion

@Deprecated
public void discussion(String className,
                                  long classPK,
                                  String formAction,
                                  String formName,
                                  boolean hideControls,
                                  boolean ratingsEnabled,
                                  String redirect,
                                  String subject,
                                  long userId)
                throws Exception
Deprecated. As of 6.2.0, replaced by discussion(String, long, String, String, boolean, boolean, String, long))}

Specified by:
discussion in interface VelocityTaglib
Throws:
Exception

doAsURL

public void doAsURL(long doAsUserId)
             throws Exception
Specified by:
doAsURL in interface VelocityTaglib
Throws:
Exception

flags

public void flags(String className,
                  long classPK,
                  String contentTitle,
                  boolean label,
                  String message,
                  long reportedUserId)
           throws Exception
Specified by:
flags in interface VelocityTaglib
Throws:
Exception

getAssetCategoriesSummaryTag

public AssetCategoriesSummaryTag<?> getAssetCategoriesSummaryTag()
                                                          throws Exception
Specified by:
getAssetCategoriesSummaryTag in interface VelocityTaglib
Throws:
Exception

getAssetLinksTag

public AssetLinksTag getAssetLinksTag()
                               throws Exception
Specified by:
getAssetLinksTag in interface VelocityTaglib
Throws:
Exception

getAssetTagsSummaryTag

public AssetTagsSummaryTag<?> getAssetTagsSummaryTag()
                                              throws Exception
Specified by:
getAssetTagsSummaryTag in interface VelocityTaglib
Throws:
Exception

getBreadcrumbTag

public BreadcrumbTag getBreadcrumbTag()
                               throws Exception
Specified by:
getBreadcrumbTag in interface VelocityTaglib
Throws:
Exception

getColumnTag

public ColumnTag getColumnTag()
                       throws Exception
Specified by:
getColumnTag in interface VelocityTaglib
Throws:
Exception

getDiscussionTag

public DiscussionTag getDiscussionTag()
                               throws Exception
Specified by:
getDiscussionTag in interface VelocityTaglib
Throws:
Exception

getFlagsTag

public FlagsTag getFlagsTag()
                     throws Exception
Specified by:
getFlagsTag in interface VelocityTaglib
Throws:
Exception

getIconTag

public IconTag getIconTag()
                   throws Exception
Specified by:
getIconTag in interface VelocityTaglib
Throws:
Exception

getJournalArticleTag

public JournalArticleTag getJournalArticleTag()
                                       throws Exception
Specified by:
getJournalArticleTag in interface VelocityTaglib
Throws:
Exception

getLayoutTag

public LayoutTag getLayoutTag()
                       throws Exception
Specified by:
getLayoutTag in interface VelocityTaglib
Throws:
Exception

getMySitesTag

public MySitesTag getMySitesTag()
                         throws Exception
Specified by:
getMySitesTag in interface VelocityTaglib
Throws:
Exception

getPageContext

public javax.servlet.jsp.PageContext getPageContext()
Specified by:
getPageContext in interface VelocityTaglib

getPngImageTag

public PngImageTag getPngImageTag()
                           throws Exception
Specified by:
getPngImageTag in interface VelocityTaglib
Throws:
Exception

getRatingsTag

public RatingsTag getRatingsTag()
                         throws Exception
Specified by:
getRatingsTag in interface VelocityTaglib
Throws:
Exception

getSetting

public String getSetting(String name)
Specified by:
getSetting in interface VelocityTaglib

getWindowState

public WindowState getWindowState(String windowState)
Specified by:
getWindowState in interface VelocityTaglib

icon

public void icon(String image,
                 boolean label,
                 String message,
                 String url)
          throws Exception
Specified by:
icon in interface VelocityTaglib
Throws:
Exception

iconBack

@Deprecated
public void iconBack()
              throws Exception
Deprecated. As of 6.2.0, replaced by iconBack()

Specified by:
iconBack in interface VelocityTaglib
Throws:
Exception

iconHelp

public void iconHelp(String message)
              throws Exception
Specified by:
iconHelp in interface VelocityTaglib
Throws:
Exception

iconOptions

@Deprecated
public void iconOptions()
                 throws Exception
Deprecated. As of 6.2.0, replaced by portletIconOptions()

Specified by:
iconOptions in interface VelocityTaglib
Throws:
Exception

iconPortlet

@Deprecated
public void iconPortlet()
                 throws Exception
Deprecated. As of 6.2.0, replaced by portletIconPortlet()

Specified by:
iconPortlet in interface VelocityTaglib
Throws:
Exception

iconPortlet

@Deprecated
public void iconPortlet(Portlet portlet)
                 throws Exception
Deprecated. As of 6.2.0, replaced by portletIconPortlet(Portlet)

Specified by:
iconPortlet in interface VelocityTaglib
Throws:
Exception

include

public void include(javax.servlet.ServletContext servletContext,
                    String page)
             throws Exception
Specified by:
include in interface VelocityTaglib
Throws:
Exception

include

public void include(String page)
             throws Exception
Specified by:
include in interface VelocityTaglib
Throws:
Exception

journalArticle

public void journalArticle(String articleId,
                           long groupId,
                           String ddmTemplateKey)
                    throws Exception
Specified by:
journalArticle in interface VelocityTaglib
Throws:
Exception

journalContentSearch

public void journalContentSearch()
                          throws Exception
Specified by:
journalContentSearch in interface VelocityTaglib
Throws:
Exception

journalContentSearch

public void journalContentSearch(boolean showListed,
                                 String targetPortletId)
                          throws Exception
Specified by:
journalContentSearch in interface VelocityTaglib
Throws:
Exception

language

public void language()
              throws Exception
Specified by:
language in interface VelocityTaglib
Throws:
Exception

language

public void language(String formName,
                     String formAction,
                     String name,
                     String ddmTemplateKey)
              throws Exception
Specified by:
language in interface VelocityTaglib
Throws:
Exception

language

public void language(String formName,
                     String formAction,
                     String name,
                     String[] languageIds,
                     String ddmTemplateKey)
              throws Exception
Specified by:
language in interface VelocityTaglib
Throws:
Exception

layoutIcon

public void layoutIcon(Layout layout)
                throws Exception
Specified by:
layoutIcon in interface VelocityTaglib
Throws:
Exception

metaTags

public void metaTags()
              throws Exception
Specified by:
metaTags in interface VelocityTaglib
Throws:
Exception

myPlaces

@Deprecated
public void myPlaces()
              throws Exception
Deprecated. As of 6.2.0, replaced by mySites()

Specified by:
myPlaces in interface VelocityTaglib
Throws:
Exception

myPlaces

@Deprecated
public void myPlaces(int max)
              throws Exception
Deprecated. As of 6.2.0, replaced by mySites(int)

Specified by:
myPlaces in interface VelocityTaglib
Throws:
Exception

mySites

public void mySites()
             throws Exception
Specified by:
mySites in interface VelocityTaglib
Throws:
Exception

mySites

public void mySites(int max)
             throws Exception
Specified by:
mySites in interface VelocityTaglib
Throws:
Exception

permissionsURL

public String permissionsURL(String redirect,
                             String modelResource,
                             String modelResourceDescription,
                             Object resourceGroupId,
                             String resourcePrimKey,
                             String windowState,
                             int[] roleTypes)
                      throws Exception
Specified by:
permissionsURL in interface VelocityTaglib
Throws:
Exception

permissionsURL

@Deprecated
public String permissionsURL(String redirect,
                                        String modelResource,
                                        String modelResourceDescription,
                                        String resourcePrimKey,
                                        String windowState,
                                        int[] roleTypes)
                      throws Exception
Deprecated. As of 6.2.0, replaced by permissionsURL(String, String, String, Object, String, String, int[])

Specified by:
permissionsURL in interface VelocityTaglib
Throws:
Exception

portletIconBack

public void portletIconBack()
                     throws Exception
Specified by:
portletIconBack in interface VelocityTaglib
Throws:
Exception

portletIconOptions

public void portletIconOptions()
                        throws Exception
Specified by:
portletIconOptions in interface VelocityTaglib
Throws:
Exception

portletIconOptions

public void portletIconOptions(String direction,
                               String markupView)
                        throws Exception
Specified by:
portletIconOptions in interface VelocityTaglib
Throws:
Exception

portletIconPortlet

public void portletIconPortlet()
                        throws Exception
Specified by:
portletIconPortlet in interface VelocityTaglib
Throws:
Exception

portletIconPortlet

public void portletIconPortlet(Portlet portlet)
                        throws Exception
Specified by:
portletIconPortlet in interface VelocityTaglib
Throws:
Exception

ratings

public void ratings(String className,
                    long classPK,
                    int numberOfStars,
                    String type,
                    String url)
             throws Exception
Specified by:
ratings in interface VelocityTaglib
Throws:
Exception

renderURL

public String renderURL(long plid,
                        String portletName,
                        String queryString)
                 throws Exception
Specified by:
renderURL in interface VelocityTaglib
Throws:
Exception

renderURL

public String renderURL(String portletName,
                        String queryString)
                 throws Exception
Specified by:
renderURL in interface VelocityTaglib
Throws:
Exception

renderURL

public String renderURL(String windowState,
                        String portletMode,
                        Boolean secure,
                        Boolean copyCurrentRenderParameters,
                        Boolean escapeXml,
                        long plid,
                        long refererPlid,
                        String portletName,
                        Boolean anchor,
                        Boolean encrypt,
                        long doAsGroupId,
                        long doAsUserId,
                        Boolean portletConfiguration,
                        String queryString)
                 throws Exception
Specified by:
renderURL in interface VelocityTaglib
Throws:
Exception

renderURL

@Deprecated
public String renderURL(String windowState,
                                   String portletMode,
                                   Boolean secure,
                                   Boolean copyCurrentRenderParameters,
                                   Boolean escapeXml,
                                   long plid,
                                   String portletName,
                                   Boolean anchor,
                                   Boolean encrypt,
                                   long doAsUserId,
                                   Boolean portletConfiguration,
                                   String queryString)
                 throws Exception
Deprecated. As of 6.2.0, replaced by renderURL(String, String, Boolean, Boolean, Boolean, long, long, String, Boolean, Boolean, long, long, Boolean, String)

Specified by:
renderURL in interface VelocityTaglib
Throws:
Exception

renderURL

public String renderURL(String windowState,
                        String portletMode,
                        long plid,
                        String portletName,
                        String queryString)
                 throws Exception
Specified by:
renderURL in interface VelocityTaglib
Throws:
Exception

renderURL

public String renderURL(String windowState,
                        String portletMode,
                        String portletName,
                        String queryString)
                 throws Exception
Specified by:
renderURL in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletName)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletProviderClassName,
                    PortletProvider.Action portletProviderAction)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletProviderClassName,
                    PortletProvider.Action portletProviderAction,
                    String instanceId)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletProviderClassName,
                    PortletProvider.Action portletProviderAction,
                    String instanceId,
                    String defaultPreferences)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletName,
                    String queryString)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletName,
                    String queryString,
                    String defaultPreferences)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

runtime

public void runtime(String portletName,
                    String instanceId,
                    String queryString,
                    String defaultPreferences)
             throws Exception
Specified by:
runtime in interface VelocityTaglib
Throws:
Exception

search

public void search()
            throws Exception
Specified by:
search in interface VelocityTaglib
Throws:
Exception

sitesDirectory

public void sitesDirectory()
                    throws Exception
Specified by:
sitesDirectory in interface VelocityTaglib
Throws:
Exception

sitesDirectory

public void sitesDirectory(String displayStyle,
                           String sites)
                    throws Exception
Specified by:
sitesDirectory in interface VelocityTaglib
Throws:
Exception

socialBookmarks

public void socialBookmarks(String displayStyle,
                            String target,
                            String types,
                            String title,
                            String url)
                     throws Exception
Specified by:
socialBookmarks in interface VelocityTaglib
Throws:
Exception

staging

@Deprecated
public void staging()
             throws Exception
Deprecated. As of 7.0.0, with no direct replacement

Specified by:
staging in interface VelocityTaglib
Throws:
Exception

toggle

public void toggle(String id,
                   String showImage,
                   String hideImage,
                   String showMessage,
                   String hideMessage,
                   boolean defaultShowContent)
            throws Exception
Specified by:
toggle in interface VelocityTaglib
Throws:
Exception

wrapPortlet

public String wrapPortlet(String wrapPage,
                          String portletPage)
                   throws Exception
Specified by:
wrapPortlet in interface VelocityTaglib
Throws:
Exception

setUp

protected void setUp(TagSupport tagSupport)
              throws Exception
Throws:
Exception

Liferay 7.0-ce-b4