Package com.jalios.jcms
Class TypeTemplateEntry
java.lang.Object
com.jalios.jcms.TypeTemplateEntry
- All Implemented Interfaces:
TypeConstants,Comparable
This class contains info about Type's template.
- Since:
- jcms-6.0.0
- Author:
- Jean-Philippe Encausse
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Stringprotected booleanprotected booleanprotected Stringprotected Stringprotected Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringprotected org.jdom.ElementFields inherited from interface com.jalios.jcms.TypeConstants
CHANGE_LEVEL_CLASS, CHANGE_LEVEL_JSP, CHANGE_LEVEL_NONE, DISPLAY_TPLT_TAG, EXTENSIONS_XML, FIELD_ELT, FIELD_NEW_MARK, FIELD_UPDATED_MARK, FIELDS_ELT, FILE_INDEX_LISTENER, LINK_INDEX_LISTENER, OLD_TYPES_DIR, PACKAGE_NAME, PACKAGE_NAME_SUFFIX, QUERY_TPLT_TAG, TAB_ELT, TABS_ELT, TEMPLATE_TAG, TEMPLATES_SUFFIX, TEMPLATES_TAG, TITLE_ELT, TYPE_ELT, TYPE_FORCE_UPDATE_MARK, TYPE_NEW_MARK, TYPE_UPDATED_MARK, TYPES_DIR, TYPES_XML -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]Check the integrity of the template fieldsintstatic TypeTemplateEntrydecodeTemplate(String className, org.jdom.Element xmlElt, String folderPath) Build a TypeTemplateEntry from the given JDom Elementstatic org.jdom.ElementBuild a JDom Element from the given TypeTemplateEntrybooleangetDescription(String userLang) Returns the description of the template for given user languageReturns the map of descriptions.Returns the full name of the template that will be stored in the store.xml.Returns the label of the template for given user languageReturns the map of labels.getName()Returns the name of the template (== usage + "." + internalName).getPath()Returns the path (e.g.Returns the path to the thumbnail of this template or s.gif if it could not be found.getThumbnailPath(int width, int height, String defaultImagePath) Retrieve the path to the thumbnail of this template in the specified dimension.getUsage()Returns the usage of the template (e.g.booleanReturns true if the template entry has been generated by JCMS without parsing an existing TypeElement.booleanReturns true if the template entry has been added by pluggin mechanism.voidReload all I18N informations for this type template entry.static TypeTemplateEntryresolveDefaultTemplateEntry(Set<TypeTemplateEntry> tmplSet, String defaultUsage, String defaultPath) Returns a default TypeTemplateEntry in the given Set otherwise return a dummy template with the defaultUsage.voidsetDescription(String userLang, String value) Set the description for the given user languagevoidsetDescriptionMap(Map<String, String> descriptionMap) Set the descriptions for the given template.voidsetInternalName(String name) Set the name of the template this name must be unique for the type declaration.voidSet the label for the given user languagevoidsetLabelMap(Map<String, String> labelMap) Set the labels for the given template.voidSet the path of the template.voidsetPlugged(boolean plugged) Returns true if the template entry has been added by pluggin mechanism.voidSet the usage of the template (e.g.toString()
-
Field Details
-
USAGE_DISPLAY_BOX
- See Also:
-
USAGE_DISPLAY_FULL
- See Also:
-
USAGE_DISPLAY_QUERY
- See Also:
-
USAGE_DISPLAY_MODAL
- See Also:
-
USAGE_DISPLAY_FULL_PDA
- See Also:
-
USAGE_DISPLAY_QUERY_PDA
- See Also:
-
USAGE_EDIT
- See Also:
-
USAGE_EDIT_FRONT
- See Also:
-
USAGE_EDIT_MODAL
- See Also:
-
USAGE_EDIT_POPUP
- See Also:
-
USAGE_EDIT_MODAL_FULL
- See Also:
-
className
-
xmlElt
protected org.jdom.Element xmlElt -
name
-
usage
-
path
-
labelMap
-
descriptionMap
-
isInternal
protected boolean isInternal -
isPlugged
protected boolean isPlugged
-
-
Constructor Details
-
TypeTemplateEntry
public TypeTemplateEntry()Default Constructor
-
-
Method Details
-
getName
Returns the name of the template (== usage + "." + internalName).This name must be unique for the type declaration.
- Returns:
- String the name of the template
-
getInternalName
Returns the full name of the template that will be stored in the store.xml.This is the name attribute value of the template's XML.
- Returns:
- String the name of the template
-
setInternalName
Set the name of the template this name must be unique for the type declaration.- Parameters:
name- the name of the template, eg "carousel"
-
getPath
Returns the path (e.g. jsp file) to the template. This path is not overrided by PluginPolicyFilter.- Returns:
- String the path to the template file
-
setPath
Set the path of the template.- Parameters:
path- the path of the JSP used by this template, relative to the webapp root, eg "types/PortletQueryForeach/doPortletQueryForeachCarousel.jsp"
-
getUsage
Returns the usage of the template (e.g. full, query, pda, box, ...).- Returns:
- String the usage of the template
-
setUsage
Set the usage of the template (e.g. full, query, pda, box, ...).- Parameters:
usage- a template usage, e.g. "box"
-
getLabel
Returns the label of the template for given user language- Parameters:
userLang- the user language- Returns:
- String the label
-
setLabel
Set the label for the given user language- Parameters:
userLang- the user languagevalue- the label
-
getLabelMap
Returns the map of labels. Should only be used internally.- Returns:
- Map of labels
-
setLabelMap
Set the labels for the given template. Should only be used internally.- Parameters:
labelMap- the Map of label
-
getDescription
Returns the description of the template for given user language- Parameters:
userLang- the user language- Returns:
- String the map description
-
setDescription
Set the description for the given user language- Parameters:
userLang- the user languagevalue- the description
-
getDescriptionMap
Returns the map of descriptions. Should only be used internally.- Returns:
- descriptions
-
setDescriptionMap
Set the descriptions for the given template. Should only be used internally.- Parameters:
descriptionMap- the map of description
-
isInternal
public boolean isInternal()Returns true if the template entry has been generated by JCMS without parsing an existing TypeElement.- Returns:
- true if it is generated.
-
isPlugged
public boolean isPlugged()Returns true if the template entry has been added by pluggin mechanism.- Returns:
- true if it has been plugged.
-
setPlugged
public void setPlugged(boolean plugged) Returns true if the template entry has been added by pluggin mechanism.- Parameters:
plugged- set true if template was added through plugin, false othewise
-
getThumbnailPath
Returns the path to the thumbnail of this template or s.gif if it could not be found.- Returns:
- String path to thumbnail or "s.gif"
-
getThumbnailPath
Retrieve the path to the thumbnail of this template in the specified dimension.If the thumbnail could not be created (no preview available for this template), the defaultImagePath is returned instead.
Warning : This method create a thumbnail when it does not exists, this process can be a little time consumming, make sure you do not need immediate response time when using it.
- Parameters:
width- the width of the thumbnail to create/reuseheight- the height of the thumbnail to create/reusedefaultImagePath- the default image path used if the thumbnail could not be created- Returns:
- a path relative to the webapp root (e.g. "types/PortletRSS/th-60x45-doPortletRSSFullDisplay.jpg.jpg").
-
getClassName
-
checkIntegrity
Check the integrity of the template fields- Returns:
- String list of errors or ""
-
toString
-
equals
-
compareTo
- Specified by:
compareToin interfaceComparable
-
resolveDefaultTemplateEntry
public static TypeTemplateEntry resolveDefaultTemplateEntry(Set<TypeTemplateEntry> tmplSet, String defaultUsage, String defaultPath) Returns a default TypeTemplateEntry in the given Set otherwise return a dummy template with the defaultUsage. Warning ! do not check the usage of provided TypeTemplateEntry- Parameters:
tmplSet- a Set of TypeTemplateEntry (that may already refined on usage or null)defaultUsage- the template usagedefaultPath- null or override the path of the dummy tte- Returns:
- TypeTemplateEntry
- Since:
- jcms-6.0.1
-
decodeTemplate
public static TypeTemplateEntry decodeTemplate(String className, org.jdom.Element xmlElt, String folderPath) Build a TypeTemplateEntry from the given JDom Element<template usage="PDA" name="lorem" file="doLoremDisplay.jsp"> <label xml:lang="en">Lorem</label> <label xml:lang="fr">Ipsum</label> <description xml:lang="en">Lorem ipsum dolor sit amet</description> <description xml:lang="fr">Lorem ipsum dolor sit amet</description> </template>- Parameters:
className- the short classname of the Type for which this template is decoded (eg Article, TestType, PortletSearch)xmlElt- a JDom ElementfolderPath- path to the template file- Returns:
- a new instance of TypeTemplateEntry, never return null
-
encodeTemplate
Build a JDom Element from the given TypeTemplateEntry<template usage="PDA" name="lorem" file="doLoremDisplay.jsp"> <label xml:lang="en">Lorem</label> <label xml:lang="fr">Ipsum</label> <description xml:lang="en">Lorem ipsum dolor sit amet</description> <description xml:lang="fr">Lorem ipsum dolor sit amet</description> </template>
- Parameters:
tte- TypeTemplateEntry- Returns:
- return a new instance of JDOM "template" XML Element, never return null
-
reloadI18N
public void reloadI18N()Reload all I18N informations for this type template entry. This includes : label and description.- Since:
- jcms-8.0.2
-