|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.portletdisplaytemplate.util.PortletDisplayTemplateUtil
public class PortletDisplayTemplateUtil
| Constructor Summary | |
|---|---|
PortletDisplayTemplateUtil()
|
|
| Method Summary | |
|---|---|
static DDMTemplate |
fetchDDMTemplate(long groupId,
String displayStyle)
Deprecated. As of 7.0.0, replaced by getPortletDisplayTemplateDDMTemplate(long, long, String) |
static long |
getDDMTemplateGroupId(long groupId)
Returns the group ID of the portlet display template's DDM template. |
static String |
getDDMTemplateKey(String displayStyle)
Returns the template key of the portlet display template's DDM template from the display style stored in the portlet configuration. |
static String |
getDDMTemplateUuid(String displayStyle)
Deprecated. As of 7.0.0, replaced by getDDMTemplateKey(String) |
static DDMTemplate |
getDefaultPortletDisplayTemplateDDMTemplate(long groupId,
long classNameId)
Returns the default portlet display template's DDM template that's associated with the class name ID. |
static String |
getDisplayStyle(String ddmTemplateKey)
Returns the display style that's associated with the template key of the portlet display template's DDM template. |
static PortletDisplayTemplate |
getPortletDisplayTemplate()
|
static DDMTemplate |
getPortletDisplayTemplateDDMTemplate(long groupId,
long classNameId,
String displayStyle)
Returns the portlet display template's DDM template that's associated with the class name ID and that matches the group and display style stored in the portlet configuration. |
static DDMTemplate |
getPortletDisplayTemplateDDMTemplate(long groupId,
long classNameId,
String displayStyle,
boolean useDefault)
Returns the portlet display template's DDM template that's associated with the class name ID and that matches the group and display style stored in the portlet configuration. |
static long |
getPortletDisplayTemplateDDMTemplateId(long groupId,
String displayStyle)
Deprecated. As of 7.0.0, replaced by getPortletDisplayTemplateDDMTemplate(long, long, String) |
static List<TemplateHandler> |
getPortletDisplayTemplateHandlers()
Returns the portlet display template handlers. |
static Map<String,TemplateVariableGroup> |
getTemplateVariableGroups(String language)
Returns the portlet display template's map of script variable groups for which hints are displayed in the template editor palette. |
static String |
renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
DDMTemplate ddmTemplate,
List<?> entries)
Returns the result of rendering the DDM template with the entries in the page context. |
static String |
renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
DDMTemplate ddmTemplate,
List<?> entries,
Map<String,Object> contextObjects)
Returns the result of rendering the DDM template with the entries in the page context and template context. |
static String |
renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
long ddmTemplateId,
List<?> entries)
Returns the result of rendering the DDM template with the entries in the page context. |
static String |
renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
long ddmTemplateId,
List<?> entries,
Map<String,Object> contextObjects)
Returns the result of rendering the DDM template with the entries in the page context and template context. |
void |
setPortletDisplayTemplate(PortletDisplayTemplate portletDisplayTemplate)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public PortletDisplayTemplateUtil()
| Method Detail |
|---|
@Deprecated
public static DDMTemplate fetchDDMTemplate(long groupId,
String displayStyle)
getPortletDisplayTemplateDDMTemplate(long, long, String)
groupId - the primary key of the groupdisplayStyle - the display style stored in the portlet
configuration
public static long getDDMTemplateGroupId(long groupId)
groupId - the primary key of the group
public static String getDDMTemplateKey(String displayStyle)
displayStyle - the display style stored in the portlet
configuration
@Deprecated public static String getDDMTemplateUuid(String displayStyle)
getDDMTemplateKey(String)
displayStyle - the display style stored in the portlet
configuration
public static DDMTemplate getDefaultPortletDisplayTemplateDDMTemplate(long groupId,
long classNameId)
groupId - the primary key of the groupclassNameId - the primary key of the class name of the model the
display style is related to
public static String getDisplayStyle(String ddmTemplateKey)
ddmTemplateKey - the template key of the portlet display template's
DDM template
public static PortletDisplayTemplate getPortletDisplayTemplate()
public static DDMTemplate getPortletDisplayTemplateDDMTemplate(long groupId,
long classNameId,
String displayStyle)
groupId - the primary key of the groupclassNameId - the primary key of the class name of the model the
display style is related todisplayStyle - the display style stored in the portlet
configuration
public static DDMTemplate getPortletDisplayTemplateDDMTemplate(long groupId,
long classNameId,
String displayStyle,
boolean useDefault)
groupId - the primary key of the groupclassNameId - the primary key of the class name of the model the
display style is related todisplayStyle - the display style stored in the portlet
configurationuseDefault - whether to return the default portlet display
template's DDM template that's associated with the class name ID
if none are found for the given parameters.
@Deprecated
public static long getPortletDisplayTemplateDDMTemplateId(long groupId,
String displayStyle)
getPortletDisplayTemplateDDMTemplate(long, long, String)
groupId - the primary key of the groupdisplayStyle - the display style stored in the portlet
configuration
public static List<TemplateHandler> getPortletDisplayTemplateHandlers()
public static Map<String,TemplateVariableGroup> getTemplateVariableGroups(String language)
language - the portlet display template's scripting language.
Acceptable values for the FreeMarker, Velocity, or XSL languages
are TemplateConstants.LANG_TYPE_FTL,
TemplateConstants.LANG_TYPE_VM,
or TemplateConstants.LANG_TYPE_XSL,
respectively.
TemplateHandler.getTemplateVariableGroups(long, String,
java.util.Locale)
public static String renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
DDMTemplate ddmTemplate,
List<?> entries)
throws Exception
request - the request with which the template is renderedresponse - the response with which the template is renderedddmTemplate - the DDM templateentries - the entries that are rendered in the template
Exception - if the DDM template could not be rendered
public static String renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
DDMTemplate ddmTemplate,
List<?> entries,
Map<String,Object> contextObjects)
throws Exception
request - the request with which the template is renderedresponse - the response with which the template is renderedddmTemplate - the DDM templateentries - the entries that are rendered in the templatecontextObjects - the map of objects defining the context in which
the template is rendered
Exception - if the DDM template could not be rendered
public static String renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
long ddmTemplateId,
List<?> entries)
throws Exception
request - the request with which the template is rendered.response - the response with which the template is rendered.ddmTemplateId - the primary key of the DDM templateentries - the entries that are rendered in the template
Exception - if the DDM template could not be rendered
public static String renderDDMTemplate(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
long ddmTemplateId,
List<?> entries,
Map<String,Object> contextObjects)
throws Exception
request - the request with which the template is rendered.response - the response with which the template is rendered.ddmTemplateId - the primary key of the DDM templateentries - the entries that are rendered in the templatecontextObjects - the map of objects defining the context in which
the template is rendered
Exception - if the DDM template could not be renderedpublic void setPortletDisplayTemplate(PortletDisplayTemplate portletDisplayTemplate)
|
Liferay 7.0-ce-m6 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||