Liferay 6.2.0-ce-m3

com.liferay.taglib.util
Class VelocityTaglib

java.lang.Object
  extended by com.liferay.taglib.util.VelocityTaglib

public class VelocityTaglib
extends Object


Constructor Summary
VelocityTaglib()
           
VelocityTaglib(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.jsp.PageContext pageContext, TemplateContext templateContext)
           
 
Method Summary
 void actionURL(long plid, String portletName, String queryString)
           
 void actionURL(String portletName, String queryString)
           
 void 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. actionURL(String, String, Boolean, Boolean, Boolean, String, long, long, String, Boolean, Boolean, long, long, Boolean, String)
 void 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)
           
 void actionURL(String windowState, String portletMode, long plid, String portletName, String queryString)
           
 void 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(String displayStyle, boolean showGuestGroup, boolean showParentGroups, boolean showLayout, boolean showPortletBreadcrumb)
           
 void discussion(String className, long classPK, String formAction, String formName, boolean hideControls, boolean ratingsEnabled, String redirect, String subject, long userId)
           
 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()
           
 PngImageTag getPngImageTag()
           
 RatingsTag getRatingsTag()
           
 String getSetting(String name)
           
 WindowState getWindowState(String windowState)
           
 void icon(String image, boolean label, String message, String url)
           
 void iconBack()
           
 void iconClose()
           
 void iconConfiguration()
           
 void iconEdit()
           
 void iconEditDefaults()
           
 void iconEditGuest()
           
 void iconHelp()
           
 void iconMaximize()
           
 void iconMinimize()
           
 void iconOptions()
           
 void iconPortlet()
           
 void iconPortlet(Portlet portlet)
           
 void iconPortletCss()
           
 void iconPrint()
           
 void iconRefresh()
           
 void include(javax.servlet.ServletContext servletContext, String page)
           
 void include(String page)
           
 VelocityTaglib init(javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.jsp.PageContext pageContext, TemplateContext templateContext)
           
 void journalArticle(String articleId, long groupId, String templateId)
           
 void journalContentSearch()
           
 void journalContentSearch(boolean showListed, String targetPortletId, String type)
           
 void language()
           
 void language(String formName, String formAction, String name, int displayStyle)
           
 void language(String formName, String formAction, String name, String[] languageIds, int displayStyle)
           
 void layoutIcon(Layout layout)
           
 void metaTags()
           
 void myPlaces()
          Deprecated. mySites()
 void myPlaces(int max)
          Deprecated. mySites(int)
 void mySites()
           
 void mySites(int max)
           
 void permissionsURL(String redirect, String modelResource, String modelResourceDescription, Object resourceGroupId, String resourcePrimKey, String windowState, int[] roleTypes)
           
 void permissionsURL(String redirect, String modelResource, String modelResourceDescription, String resourcePrimKey, String windowState, int[] roleTypes)
          Deprecated. #permissionsURL(String, String, String, long, String, String, int[])
 void ratings(String className, long classPK, int numberOfStars, String type, String url)
           
 void renderURL(long plid, String portletName, String queryString)
           
 void renderURL(String portletName, String queryString)
           
 void 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)
           
 void 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. renderURL(String, String, Boolean, Boolean, Boolean, long, long, String, Boolean, Boolean, long, long, Boolean, String)
 void renderURL(String windowState, String portletMode, long plid, String portletName, String queryString)
           
 void renderURL(String windowState, String portletMode, String portletName, String queryString)
           
 void runtime(String portletName)
           
 void runtime(String portletName, String queryString)
           
 void runtime(String portletName, String queryString, String defaultPreferences)
           
 void search()
           
 void setTemplateContext(TemplateContext templateContext)
           
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()
           
 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

VelocityTaglib

public VelocityTaglib()

VelocityTaglib

public VelocityTaglib(javax.servlet.ServletContext servletContext,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      javax.servlet.jsp.PageContext pageContext,
                      TemplateContext templateContext)
Method Detail

actionURL

public void actionURL(long plid,
                      String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

actionURL

public void actionURL(String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

actionURL

public void 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. actionURL(String, String, Boolean, Boolean, Boolean, String, long, long, String, Boolean, Boolean, long, long, Boolean, String)

Throws:
Exception

actionURL

public void 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
Throws:
Exception

actionURL

public void actionURL(String windowState,
                      String portletMode,
                      long plid,
                      String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

actionURL

public void actionURL(String windowState,
                      String portletMode,
                      String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

assetCategoriesSummary

public void assetCategoriesSummary(String className,
                                   long classPK,
                                   String message,
                                   PortletURL portletURL)
                            throws Exception
Throws:
Exception

assetLinks

public void assetLinks(long assetEntryId,
                       String className,
                       long classPK)
                throws Exception
Throws:
Exception

assetTagsSummary

public void assetTagsSummary(String className,
                             long classPK,
                             String message,
                             String assetTagNames,
                             PortletURL portletURL)
                      throws Exception
Throws:
Exception

breadcrumb

public void breadcrumb()
                throws Exception
Throws:
Exception

breadcrumb

public void breadcrumb(String displayStyle,
                       boolean showGuestGroup,
                       boolean showParentGroups,
                       boolean showLayout,
                       boolean showPortletBreadcrumb)
                throws Exception
Throws:
Exception

discussion

public void discussion(String className,
                       long classPK,
                       String formAction,
                       String formName,
                       boolean hideControls,
                       boolean ratingsEnabled,
                       String redirect,
                       String subject,
                       long userId)
                throws Exception
Throws:
Exception

doAsURL

public void doAsURL(long doAsUserId)
             throws Exception
Throws:
Exception

flags

public void flags(String className,
                  long classPK,
                  String contentTitle,
                  boolean label,
                  String message,
                  long reportedUserId)
           throws Exception
Throws:
Exception

getAssetCategoriesSummaryTag

public AssetCategoriesSummaryTag getAssetCategoriesSummaryTag()
                                                       throws Exception
Throws:
Exception

getAssetLinksTag

public AssetLinksTag getAssetLinksTag()
                               throws Exception
Throws:
Exception

getAssetTagsSummaryTag

public AssetTagsSummaryTag getAssetTagsSummaryTag()
                                           throws Exception
Throws:
Exception

getBreadcrumbTag

public BreadcrumbTag getBreadcrumbTag()
                               throws Exception
Throws:
Exception

getColumnTag

public ColumnTag getColumnTag()
                       throws Exception
Throws:
Exception

getDiscussionTag

public DiscussionTag getDiscussionTag()
                               throws Exception
Throws:
Exception

getFlagsTag

public FlagsTag getFlagsTag()
                     throws Exception
Throws:
Exception

getIconTag

public IconTag getIconTag()
                   throws Exception
Throws:
Exception

getJournalArticleTag

public JournalArticleTag getJournalArticleTag()
                                       throws Exception
Throws:
Exception

getLayoutTag

public LayoutTag getLayoutTag()
                       throws Exception
Throws:
Exception

getMySitesTag

public MySitesTag getMySitesTag()
                         throws Exception
Throws:
Exception

getPngImageTag

public PngImageTag getPngImageTag()
                           throws Exception
Throws:
Exception

getRatingsTag

public RatingsTag getRatingsTag()
                         throws Exception
Throws:
Exception

getSetting

public String getSetting(String name)

getWindowState

public WindowState getWindowState(String windowState)

icon

public void icon(String image,
                 boolean label,
                 String message,
                 String url)
          throws Exception
Throws:
Exception

iconBack

public void iconBack()
              throws Exception
Throws:
Exception

iconClose

public void iconClose()
               throws Exception
Throws:
Exception

iconConfiguration

public void iconConfiguration()
                       throws Exception
Throws:
Exception

iconEdit

public void iconEdit()
              throws Exception
Throws:
Exception

iconEditDefaults

public void iconEditDefaults()
                      throws Exception
Throws:
Exception

iconEditGuest

public void iconEditGuest()
                   throws Exception
Throws:
Exception

iconHelp

public void iconHelp()
              throws Exception
Throws:
Exception

iconMaximize

public void iconMaximize()
                  throws Exception
Throws:
Exception

iconMinimize

public void iconMinimize()
                  throws Exception
Throws:
Exception

iconOptions

public void iconOptions()
                 throws Exception
Throws:
Exception

iconPortlet

public void iconPortlet()
                 throws Exception
Throws:
Exception

iconPortlet

public void iconPortlet(Portlet portlet)
                 throws Exception
Throws:
Exception

iconPortletCss

public void iconPortletCss()
                    throws Exception
Throws:
Exception

iconPrint

public void iconPrint()
               throws Exception
Throws:
Exception

iconRefresh

public void iconRefresh()
                 throws Exception
Throws:
Exception

include

public void include(javax.servlet.ServletContext servletContext,
                    String page)
             throws Exception
Throws:
Exception

include

public void include(String page)
             throws Exception
Throws:
Exception

init

public VelocityTaglib init(javax.servlet.ServletContext servletContext,
                           javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response,
                           javax.servlet.jsp.PageContext pageContext,
                           TemplateContext templateContext)

journalArticle

public void journalArticle(String articleId,
                           long groupId,
                           String templateId)
                    throws Exception
Throws:
Exception

journalContentSearch

public void journalContentSearch()
                          throws Exception
Throws:
Exception

journalContentSearch

public void journalContentSearch(boolean showListed,
                                 String targetPortletId,
                                 String type)
                          throws Exception
Throws:
Exception

language

public void language()
              throws Exception
Throws:
Exception

language

public void language(String formName,
                     String formAction,
                     String name,
                     int displayStyle)
              throws Exception
Throws:
Exception

language

public void language(String formName,
                     String formAction,
                     String name,
                     String[] languageIds,
                     int displayStyle)
              throws Exception
Throws:
Exception

layoutIcon

public void layoutIcon(Layout layout)
                throws Exception
Throws:
Exception

metaTags

public void metaTags()
              throws Exception
Throws:
Exception

myPlaces

public void myPlaces()
              throws Exception
Deprecated. mySites()

Throws:
Exception

myPlaces

public void myPlaces(int max)
              throws Exception
Deprecated. mySites(int)

Throws:
Exception

mySites

public void mySites()
             throws Exception
Throws:
Exception

mySites

public void mySites(int max)
             throws Exception
Throws:
Exception

permissionsURL

public void permissionsURL(String redirect,
                           String modelResource,
                           String modelResourceDescription,
                           Object resourceGroupId,
                           String resourcePrimKey,
                           String windowState,
                           int[] roleTypes)
                    throws Exception
Throws:
Exception

permissionsURL

public void permissionsURL(String redirect,
                           String modelResource,
                           String modelResourceDescription,
                           String resourcePrimKey,
                           String windowState,
                           int[] roleTypes)
                    throws Exception
Deprecated. #permissionsURL(String, String, String, long, String, String, int[])

Throws:
Exception

ratings

public void ratings(String className,
                    long classPK,
                    int numberOfStars,
                    String type,
                    String url)
             throws Exception
Throws:
Exception

renderURL

public void renderURL(long plid,
                      String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

renderURL

public void renderURL(String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

renderURL

public void 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
Throws:
Exception

renderURL

public void 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. renderURL(String, String, Boolean, Boolean, Boolean, long, long, String, Boolean, Boolean, long, long, Boolean, String)

Throws:
Exception

renderURL

public void renderURL(String windowState,
                      String portletMode,
                      long plid,
                      String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

renderURL

public void renderURL(String windowState,
                      String portletMode,
                      String portletName,
                      String queryString)
               throws Exception
Throws:
Exception

runtime

public void runtime(String portletName)
             throws Exception
Throws:
Exception

runtime

public void runtime(String portletName,
                    String queryString)
             throws Exception
Throws:
Exception

runtime

public void runtime(String portletName,
                    String queryString,
                    String defaultPreferences)
             throws Exception
Throws:
Exception

search

public void search()
            throws Exception
Throws:
Exception

setTemplateContext

public void setTemplateContext(TemplateContext templateContext)

sitesDirectory

public void sitesDirectory()
                    throws Exception
Throws:
Exception

sitesDirectory

public void sitesDirectory(String displayStyle,
                           String sites)
                    throws Exception
Throws:
Exception

socialBookmarks

public void socialBookmarks(String displayStyle,
                            String target,
                            String types,
                            String title,
                            String url)
                     throws Exception
Throws:
Exception

staging

public void staging()
             throws Exception
Throws:
Exception

toggle

public void toggle(String id,
                   String showImage,
                   String hideImage,
                   String showMessage,
                   String hideMessage,
                   boolean defaultShowContent)
            throws Exception
Throws:
Exception

wrapPortlet

public String wrapPortlet(String wrapPage,
                          String portletPage)
                   throws Exception
Throws:
Exception

setUp

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

Liferay 6.2.0-ce-m3