Liferay 7.0-ce-b4

com.liferay.taglib.util
Interface VelocityTaglib

All Known Implementing Classes:
DummyVelocityTaglib, VelocityTaglibImpl

public interface VelocityTaglib


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.1.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 displayStyle)
           
 void language(String formName, String formAction, String name, String[] languageIds, String displayStyle)
           
 void layoutIcon(Layout layout)
           
 void metaTags()
           
 void myPlaces()
          Deprecated. As of 6.1.0, replaced by mySites()
 void myPlaces(int max)
          Deprecated. As of 6.1.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.1.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()
           
 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)
           
 

Method Detail

actionURL

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

actionURL

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

actionURL

@Deprecated
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.1.0, replaced by actionURL(String, String, Boolean, Boolean, Boolean, String, long, long, String, Boolean, Boolean, long, long, Boolean, String)

Throws:
Exception

actionURL

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

actionURL

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

actionURL

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

assetCategoriesSummary

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

assetLinks

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

assetTagsSummary

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

breadcrumb

void breadcrumb()
                throws Exception
Throws:
Exception

breadcrumb

void breadcrumb(long ddmTemplateGroupId,
                String ddmTemplateKey,
                boolean showGuestGroup,
                boolean showParentGroups,
                boolean showLayout,
                boolean showPortletBreadcrumb)
                throws Exception
Throws:
Exception

discussion

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

discussion

@Deprecated
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))}

Throws:
Exception

doAsURL

void doAsURL(long doAsUserId)
             throws Exception
Throws:
Exception

flags

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

getAssetCategoriesSummaryTag

AssetCategoriesSummaryTag<?> getAssetCategoriesSummaryTag()
                                                          throws Exception
Throws:
Exception

getAssetLinksTag

AssetLinksTag getAssetLinksTag()
                               throws Exception
Throws:
Exception

getAssetTagsSummaryTag

AssetTagsSummaryTag<?> getAssetTagsSummaryTag()
                                              throws Exception
Throws:
Exception

getBreadcrumbTag

BreadcrumbTag getBreadcrumbTag()
                               throws Exception
Throws:
Exception

getColumnTag

ColumnTag getColumnTag()
                       throws Exception
Throws:
Exception

getDiscussionTag

DiscussionTag getDiscussionTag()
                               throws Exception
Throws:
Exception

getFlagsTag

FlagsTag getFlagsTag()
                     throws Exception
Throws:
Exception

getIconTag

IconTag getIconTag()
                   throws Exception
Throws:
Exception

getJournalArticleTag

JournalArticleTag getJournalArticleTag()
                                       throws Exception
Throws:
Exception

getLayoutTag

LayoutTag getLayoutTag()
                       throws Exception
Throws:
Exception

getMySitesTag

MySitesTag getMySitesTag()
                         throws Exception
Throws:
Exception

getPageContext

javax.servlet.jsp.PageContext getPageContext()

getPngImageTag

PngImageTag getPngImageTag()
                           throws Exception
Throws:
Exception

getRatingsTag

RatingsTag getRatingsTag()
                         throws Exception
Throws:
Exception

getSetting

String getSetting(String name)

getWindowState

WindowState getWindowState(String windowState)

icon

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

iconBack

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

Throws:
Exception

iconHelp

void iconHelp(String message)
              throws Exception
Throws:
Exception

iconOptions

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

Throws:
Exception

iconPortlet

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

Throws:
Exception

iconPortlet

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

Throws:
Exception

include

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

include

void include(String page)
             throws Exception
Throws:
Exception

journalArticle

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

journalContentSearch

void journalContentSearch()
                          throws Exception
Throws:
Exception

journalContentSearch

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

language

void language()
              throws Exception
Throws:
Exception

language

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

language

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

layoutIcon

void layoutIcon(Layout layout)
                throws Exception
Throws:
Exception

metaTags

void metaTags()
              throws Exception
Throws:
Exception

myPlaces

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

Throws:
Exception

myPlaces

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

Throws:
Exception

mySites

void mySites()
             throws Exception
Throws:
Exception

mySites

void mySites(int max)
             throws Exception
Throws:
Exception

permissionsURL

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

permissionsURL

@Deprecated
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[])

Throws:
Exception

portletIconBack

void portletIconBack()
                     throws Exception
Throws:
Exception

portletIconOptions

void portletIconOptions()
                        throws Exception
Throws:
Exception

portletIconOptions

void portletIconOptions(String direction,
                        String markupView)
                        throws Exception
Throws:
Exception

portletIconPortlet

void portletIconPortlet()
                        throws Exception
Throws:
Exception

portletIconPortlet

void portletIconPortlet(Portlet portlet)
                        throws Exception
Throws:
Exception

ratings

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

renderURL

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

renderURL

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

renderURL

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

renderURL

@Deprecated
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.1.0, replaced by renderURL(String, String, Boolean, Boolean, Boolean, long, long, String, Boolean, Boolean, long, long, Boolean, String)

Throws:
Exception

renderURL

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

renderURL

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

runtime

void runtime(String portletName)
             throws Exception
Throws:
Exception

runtime

void runtime(String portletProviderClassName,
             PortletProvider.Action portletProviderAction)
             throws Exception
Throws:
Exception

runtime

void runtime(String portletProviderClassName,
             PortletProvider.Action portletProviderAction,
             String instanceId)
             throws Exception
Throws:
Exception

runtime

void runtime(String portletProviderClassName,
             PortletProvider.Action portletProviderAction,
             String instanceId,
             String defaultPreferences)
             throws Exception
Throws:
Exception

runtime

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

runtime

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

runtime

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

search

void search()
            throws Exception
Throws:
Exception

sitesDirectory

void sitesDirectory()
                    throws Exception
Throws:
Exception

sitesDirectory

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

socialBookmarks

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

staging

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

Throws:
Exception

toggle

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

wrapPortlet

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

Liferay 7.0-ce-b4