java.lang.Object
- org.javlo.template.Template

All Implemented Interfaces:

Comparable<Template>

Direct Known Subclasses:

DefaultTemplate
```
public class Template
extends Object
implements Comparable<Template>
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Template.TemplateBean

static class Template.TemplateDateComparator

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`__NO_CONTEXT`
`protected StaticConfig`	`config`
`static String`	`CONFIG_FILE`
`static String`	`DEFAULT_TEMPLATE_NAME`
`static String`	`EDIT_TEMPLATE_CODE`
`static String`	`FORCE_TEMPLATE_PARAM_NAME`
`static String`	`GZ_FILE_EXT`
`protected static Logger`	`logger`	create a static logger.
`static String`	`PLUGIN_FOLDER`
`static String`	`PREVIEW_EDIT_CODE`
`static org.javlo.template.Template.TemplateComparator`	`TEMPLATE_COMPARATOR`

Constructor Summary

Constructors
Constructor Description

Template()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addArea(String rowName)`
`void`	`addRow()`
`List<GenericMessage>`	`checkRenderer(GlobalContext globalContext, I18nAccess i18nAccess)`	check the structure of the template.
`void`	`clearRenderer(ContentContext ctx)`
`int`	`compareTo(Template template)`
`protected void`	`createMainComponentSass(GlobalContext globalContext)`
`void`	`delete()`
`void`	`deleteArea(String area)`
`void`	`deleteRow(String name)`
`void`	`disabledAlternativeTemplate(ContentContext ctx)`
`void`	`enabledAlternativeTemplate(ContentContext ctx)`
`boolean`	`equals(Object obj)`
`boolean`	`exist()`
`static Map<String,String>`	`extractPropertiesFromHtml(String html)`
`String`	`get404File()`
`String`	`getAdminMailHtml(GlobalContext globalContext)`
`String`	`getAjaxAreas()`
`Map<String,List<IListItem>>`	`getAllList(GlobalContext globalContext, Locale locale)`
`static Template`	`getApplicationInstance(javax.servlet.ServletContext application, ContentContext ctx, String templateDir)`
`static Area`	`getArea(Collection<Row> rows, String name)`
`Map<String,String>`	`getAreaExcludeProperties()`
`List<String>`	`getAreas()`
`List<String>`	`getAreas(boolean admin)`
`List<String>`	`getAreasForceDisplay()`	this area is display if specialrendere is defined
`Map<String,String>`	`getAreasMap()`
`String`	`getAuthors()`
`Integer`	`getBootstrapVersion()`
`String`	`getBuildId()`	return a code of build.
`List<ExtendedColor>`	`getColorList()`
`Map<Integer,ExtendedColor>`	`getColorsMap()`
`String`	`getColumnableClassTagIn()`
`String`	`getColumnableColClass(int size, int totalSize, int leftSize, String inStyle)`
`String`	`getColumnableColClassDefault()`
`String`	`getColumnableColStyle(int size)`
`String`	`getColumnableColStyleDefault()`
`String`	`getColumnableColTag()`
`String`	`getColumnableColTagIn()`
`String`	`getColumnableRowClass()`
`String`	`getColumnableRowStyle()`
`String`	`getColumnableRowTag()`
`String`	`getColumnableRowTagIn()`
`List<Integer>`	`getColumnableSizes()`
`String`	`getColumnableStyleTagIn()`
`protected List<File>`	`getComponentFile(GlobalContext globalContext)`
`Set<String>`	`getComponentsExclude()`
`Set<String>`	`getComponentsExcludeForArea(String area)`
`Set<String>`	`getComponentsIncludeForArea(String area)`
`Map<String,String>`	`getConfig()`
`Properties`	`getConfigComponentFile(GlobalContext globalContext, String type)`
`String`	`getConfigItem(String key, String defaultValue)`
`String`	`getCookiesMessageName()`
`String`	`getCookiesMessagePath()`
`String`	`getCookiesTypeName()`
`Date`	`getCreationDate()`
`protected List<String>`	`getCSS()`
`protected Map<String,List<String>>`	`getCSSByFolder()`
`Map<String,List<String>>`	`getCSSByFolder(String filter)`
`String`	`getDefaultArea()`
`String`	`getDefaultImageFilter()`
`String`	`getDeployId()`
`int`	`getDepth()`
`String`	`getDescription(String lang)`
`String`	`getDominantColor()`
`List<String>`	`getDynamicComponentList()`
`List<Properties>`	`getDynamicComponentsProperties(GlobalContext globalContext)`
`String`	`getEditTemplateMode()`	mode of the edit template, can be used in template renderer for include special css or js. preview css is : edit_preview_[mode].css
`List<String>`	`getEmailLinkFileList()`
`String`	`getEscapeMenuId()`
`protected String`	`getExcludeProperties(String zone)`
`static Template`	`getFakeTemplate(String name)`
`Template`	`getFinalTemplate(ContentContext ctx)`	template can be change in some context, call this method for obtain the final Template to be use for rendering.
`File`	`getFolder()`
`String`	`getFolder(String siteKey)`
`String`	`getFolder(GlobalContext globalContext)`
`Properties`	`getFontReference(GlobalContext globalContext)`
`List<String>`	`getFonts()`
`Map<String,String>`	`getFreeData()`
`String`	`getHomeRenderer(GlobalContext globalContext)`
`String`	`getHomeRendererFullName(GlobalContext globalContext)`
`List<String>`	`getHostDetected(ContentContext ctx)`	detect host used in links (index.html)
`Map<String,List<String>>`	`getHtmlByFolder(String filter)`
`protected String`	`getHTMLFile(Device device)`
`String`	`getHTMLFileParams(Device device)`
`String`	`getHTMLHomeFile()`
`List<String>`	`getHTMLIDS()`
`Map`	`getI18nProperties(GlobalContext globalContext, Locale locale, int mode)`
`String`	`getId()`
`ConfigurationProperties`	`getImageConfig()`
`File`	`getImageConfigFile()`
`String`	`getImageConfigFileName()`
`List<String>`	`getImageFilters()`
`String`	`getImageFiltersRAW()`
`static Template`	`getInstance(StaticConfig config, ContentContext ctx, String templateDir)`
`String`	`getLastSelectedClass()`
`List<String>`	`getLayouts()`	return all renderer defined in the template.
`String`	`getLicenceFile()`
`File`	`getLinkEmail(String lg)`
`String`	`getLinkEmailFileName(String lg)`
`String`	`getLocalWorkMailingTemplateFolder()`
`String`	`getLocalWorkTemplateFolder()`
`String`	`getLoginFile(ContentContext ctx)`
`File`	`getMacroFile(GlobalContext globalContext, String fileName)`
`Properties`	`getMacroProperties(GlobalContext globalContext, String macroKey)`
`Mail`	`getMail(ContentContext ctx, String mailName, String lg)`
`static Template`	`getMailingInstance(StaticConfig config, ContentContext ctx, String templateDir)`
`String`	`getMailingTemplate()`
`File`	`getMailJsp(ContentContext ctx, String mailName)`
`String`	`getMailSubject(String lg)`
`String`	`getMenuRenderer(Device device)`
`String`	`getMessageContainerId()`
`String`	`getMessageTemplate(ContentContext ctx)`
`String`	`getMimeTypeImage(GlobalContext globalContext, String fileExtension)`
`String`	`getName()`
`protected String`	`getNewAreaName()`
`String`	`getNoImage()`
`String`	`getNoImageUrl(ContentContext ctx, String filter)`
`String`	`getOwner()`
`List<String>`	`getPageTypes()`
`String`	`getPageTypesRAW()`
`Template`	`getParent()`
`String`	`getParentName()`
`int`	`getPDFHeigth()`
`List<String>`	`getPlugins()`
`int`	`getQRCodeSize()`
`Map<String,String>`	`getQuietableAreaMap()`
`protected String`	`getRAWPlugins()`
`protected String`	`getRelativeLoginFile(ContentContext ctx)`
`String`	`getRenderer(ContentContext ctx)`
`String`	`getRenderer(ContentContext ctx, String file)`
`protected String`	`getRendererFile(Device device)`
`String`	`getRendererFullName(ContentContext ctx)`
`List<String>`	`getRenderers()`	return all renderer defined in the template.
`List<String>`	`getResources()`
`Collection<File>`	`getResources(ContentContext ctx)`	get resources define in the template.
`Row`	`getRow(String name)`
`Map<String,String>`	`getRowExcludeProperties()`
`List<Row>`	`getRows()`
`String`	`getRssCSS()`
`String`	`getRSSImageURL()`
`protected String`	`getRSSRendererFile()`
`String`	`getRSSRendererFullName(ContentContext ctx)`
`String`	`getSearchFormID()`
`String`	`getSearchRenderer(ContentContext ctx)`
`String`	`getSelectedClass()`
`List<javax.mail.internet.InternetAddress>`	`getSenders()`
`String`	`getSource()`
`File`	`getSourceFolder()`
`String`	`getSourceFolderName()`
`String`	`getSpecialAreaRenderer()`
`String`	`getSpecialRendererTemplate()`
`List<String>`	`getStructures()`	return all renderer defined in the template.
`TemplateStyle`	`getStyle()`
`TemplateData`	`getTemplateData()`
`Map<String,String>`	`getTemplateExcludeProperties()`
`String`	`getTemplateRealPath()`
`String`	`getUnSelectedClass()`
`String`	`getUserMailHtml(GlobalContext globalContext)`	mail for send to user with : ${logo} : url to logo ${site} : global site title ${title} : title of the email ${text} : main text of the email ${action.link} : action button url ${action.text} : action button text ${email} : contact email ${root} : root url #cccccc : special color #555555 : title color #333333 : text color
`String`	`getVersion()`
`File`	`getVisualAbsoluteFile()`
`String`	`getVisualFile()`
`String`	`getVisualPDFile()`
`List<String>`	`getWebFonts(GlobalContext globalContext)`
`String`	`getWorkMailingTemplateFolder()`
`String`	`getWorkTemplateFolder()`
`String`	`getWorkTemplateRealPath(GlobalContext globalContext)`
`String`	`getWysiwygCss()`	return the css for wysiwyg layout
`int`	`hashCode()`
`void`	`importTemplateInWebapp(StaticConfig config, ContentContext ctx)`
`void`	`importTemplateInWebapp(StaticConfig config, ContentContext ctx, boolean clear)`
`protected void`	`importTemplateInWebapp(StaticConfig config, ContentContext ctx, GlobalContext globalContext, File templateTarget, Map<String,String> childrenData, boolean compressResource, boolean parent, Boolean importComponents, boolean clear)`
`boolean`	`isAdminArea(String area)`
`boolean`	`isAlternativeTemplate(ContentContext ctx)`
`boolean`	`isBootstrap()`
`boolean`	`isChildOf(String templateId)`
`boolean`	`isColorPalette()`
`boolean`	`isColumnable()`
`boolean`	`isCompressResources()`	return true if resources can be compressed by CMS (css, js).
`protected boolean`	`isDefaultRenderer()`
`boolean`	`isDeleted()`
`boolean`	`isEditable()`
`boolean`	`isEndAreaTag()`
`boolean`	`isFake()`
`boolean`	`isForStatic()`
`boolean`	`isHTML()`
`boolean`	`isImportParentComponents()`
`boolean`	`isLanguageLinkKeepGetParams()`
`boolean`	`isLinkEmail(String lg)`
`boolean`	`isMailing()`
`boolean`	`isNavigationArea(String area)`
`boolean`	`isNosecureArea(String area)`
`boolean`	`isOnePage()`
`protected boolean`	`isParent()`
`boolean`	`isPDFFile()`
`boolean`	`isPDFRenderer()`	return true if this template contains a renderer for PDF.
`boolean`	`isReady()`
`boolean`	`isRealContentFromAnyArea()`	true if all area can be signifiant for read content, false if only main area is signifiant.
`boolean`	`isRemoveEmptyArea()`	if area empty remove from html (default true)
`boolean`	`isRenderer(GlobalContext globalContext)`
`boolean`	`isShortkeyToEdit()`
`boolean`	`isSubjectLocked()`
`boolean`	`isTemplateInWebapp(ContentContext ctx)`
`boolean`	`isValid()`
`protected void`	`loadTemplatePart(TemplatePart part, String prefix)`
`static void`	`main(String[] args)`
`int`	`rebuildTemplate(ContentContext ctx, boolean css)`
`protected int`	`rebuildTemplateCss(ContentContext ctx, File folder)`
`void`	`reload()`
`void`	`reloadConfig(ContentContext ctx)`
`void`	`resetRows()`
`protected void`	`saveTemplatePart(TemplatePart part, String prefix)`
`void`	`setArea(String area, String id)`
`void`	`setAuthors(String name)`
`void`	`setCreationDate(Date date)`
`void`	`setDepth(int depth)`
`void`	`setDominantColor(String color)`
`void`	`setHTMLIDS(Collection<String> ids)`
`void`	`setImageFiltersRAW(String imageFilterRAW)`
`void`	`setOwner(String owner)`
`void`	`setParentName(String parent)`
`void`	`setProperty(String name, String value)`
`void`	`setReady(boolean ready)`
`void`	`setSource(String name)`
`void`	`setValid(boolean inValid)`
`void`	`storeRows(Collection<Row> rows)`
`void`	`storeStyle(TemplateStyle style)`
`String`	`toString()`
`boolean`	`visibleForRoles(Collection<String> inRoles)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PREVIEW_EDIT_CODE

public static final String PREVIEW_EDIT_CODE

See Also:: Constant Field Values

FORCE_TEMPLATE_PARAM_NAME

public static final String FORCE_TEMPLATE_PARAM_NAME

See Also:: Constant Field Values

__NO_CONTEXT

public static final String __NO_CONTEXT

See Also:: Constant Field Values

TEMPLATE_COMPARATOR

public static final org.javlo.template.Template.TemplateComparator TEMPLATE_COMPARATOR

logger
```
protected static Logger logger
```
create a static logger.

CONFIG_FILE
```
public static final String CONFIG_FILE
```
See Also:

Constant Field Values

EDIT_TEMPLATE_CODE

public static final String EDIT_TEMPLATE_CODE

See Also:: Constant Field Values

PLUGIN_FOLDER

public static final String PLUGIN_FOLDER

See Also:: Constant Field Values

GZ_FILE_EXT
```
public static final String GZ_FILE_EXT
```
See Also:

Constant Field Values

DEFAULT_TEMPLATE_NAME

public static final String DEFAULT_TEMPLATE_NAME

See Also:: Constant Field Values

config
```
protected StaticConfig config
```

Constructor Detail
- Template
```
public Template()
```

Method Detail

getApplicationInstance

public static Template getApplicationInstance(javax.servlet.ServletContext application,
                                              ContentContext ctx,
                                              String templateDir)
                                       throws Exception

Throws:: Exception

getFakeTemplate

public static Template getFakeTemplate(String name)

getInstance

public static Template getInstance(StaticConfig config,
                                   ContentContext ctx,
                                   String templateDir)
                            throws Exception

Throws:: Exception

getMailingInstance

public static Template getMailingInstance(StaticConfig config,
                                          ContentContext ctx,
                                          String templateDir)
                                   throws Exception

Throws:: Exception

checkRenderer

public List<GenericMessage> checkRenderer(GlobalContext globalContext,
                                          I18nAccess i18nAccess)
                                   throws IOException,
                                          XMLManipulationHelper.BadXMLException

check the structure of the template.

Returns:: the error message, null if no error.
Throws:: IOException; XMLManipulationHelper.BadXMLException

clearRenderer

public void clearRenderer(ContentContext ctx)

reloadConfig

public void reloadConfig(ContentContext ctx)

delete
```
public void delete()
```

disabledAlternativeTemplate

public void disabledAlternativeTemplate(ContentContext ctx)

enabledAlternativeTemplate

public void enabledAlternativeTemplate(ContentContext ctx)

exist
```
public boolean exist()
```

getAjaxAreas
```
public String getAjaxAreas()
```

getAreas
```
public List<String> getAreas()
```

getAreas

public List<String> getAreas(boolean admin)

isAdminArea

public boolean isAdminArea(String area)

getComponentsExclude

public Set<String> getComponentsExclude()

getComponentsIncludeForArea

public Set<String> getComponentsIncludeForArea(String area)

getComponentsExcludeForArea

public Set<String> getComponentsExcludeForArea(String area)

getAreasMap

public Map<String,String> getAreasMap()

getQuietableAreaMap

public Map<String,String> getQuietableAreaMap()

setArea

public void setArea(String area,
                    String id)

deleteArea

public void deleteArea(String area)

getNewAreaName
```
protected String getNewAreaName()
```

addArea

public void addArea(String rowName)

getRow
```
public Row getRow(String name)
```

addRow
```
public void addRow()
```

getAreasForceDisplay
```
public List<String> getAreasForceDisplay()
```
this area is display if specialrendere is defined

Returns:

getAuthors
```
public String getAuthors()
```

getComponentFile

protected List<File> getComponentFile(GlobalContext globalContext)
                               throws IOException

Throws:: IOException

createMainComponentSass

protected void createMainComponentSass(GlobalContext globalContext)
                                throws IOException

Throws:: IOException

getCSSByFolder

public Map<String,List<String>> getCSSByFolder(String filter)
                                              throws IOException

Throws:: IOException

getHtmlByFolder

public Map<String,List<String>> getHtmlByFolder(String filter)
                                               throws IOException

Throws:: IOException

getCSSByFolder

protected Map<String,List<String>> getCSSByFolder()
                                                 throws IOException

Throws:: IOException

getCSS

protected List<String> getCSS()
                       throws IOException

Throws:: IOException

getWysiwygCss
```
public String getWysiwygCss()
```
return the css for wysiwyg layout

getConfigComponentFile

public Properties getConfigComponentFile(GlobalContext globalContext,
                                         String type)
                                  throws IOException

Throws:: IOException

getCreationDate
```
public Date getCreationDate()
```

getDepth
```
public int getDepth()
```

getDescription

public String getDescription(String lang)

getDominantColor
```
public String getDominantColor()
```

getEscapeMenuId
```
public String getEscapeMenuId()
```

extractPropertiesFromHtml

public static Map<String,String> extractPropertiesFromHtml(String html)

getDynamicComponentsProperties

public final List<Properties> getDynamicComponentsProperties(GlobalContext globalContext)
                                                      throws IOException

Throws:: IOException

getEmailLinkFileList

public List<String> getEmailLinkFileList()

getFinalTemplate
```
public Template getFinalTemplate(ContentContext ctx)
                          throws Exception
```
template can be change in some context, call this method for obtain the final Template to be use for rendering.

Parameters:

ctx -

Returns:

final template for rendering.

Throws:

ConfigurationException

IOException

Exception

getFolder

public String getFolder(GlobalContext globalContext)

getFolder

public String getFolder(String siteKey)

getFontReference

public Properties getFontReference(GlobalContext globalContext)
                            throws IOException

Throws:: IOException

getHomeRenderer

public String getHomeRenderer(GlobalContext globalContext)

getVersion
```
public String getVersion()
```

getBootstrapVersion
```
public Integer getBootstrapVersion()
```

isColumnable
```
public boolean isColumnable()
```

getColumnableSizes

public List<Integer> getColumnableSizes()

getColumnableRowTag
```
public String getColumnableRowTag()
```

getColumnableRowTagIn
```
public String getColumnableRowTagIn()
```

getColumnableColTagIn
```
public String getColumnableColTagIn()
```

getColumnableStyleTagIn

public String getColumnableStyleTagIn()

getColumnableClassTagIn

public String getColumnableClassTagIn()

getColumnableColTag
```
public String getColumnableColTag()
```

getColumnableRowStyle
```
public String getColumnableRowStyle()
```

getColumnableRowClass
```
public String getColumnableRowClass()
```

getColumnableColStyleDefault

public String getColumnableColStyleDefault()

getColumnableColStyle

public String getColumnableColStyle(int size)

getColumnableColClass

public String getColumnableColClass(int size,
                                    int totalSize,
                                    int leftSize,
                                    String inStyle)

getColumnableColClassDefault

public String getColumnableColClassDefault()

getHomeRendererFullName

public String getHomeRendererFullName(GlobalContext globalContext)

getHostDetected

public List<String> getHostDetected(ContentContext ctx)
                             throws FileNotFoundException,
                                    IOException

detect host used in links (index.html)

Returns:: a list of host
Throws:: IOException; FileNotFoundException

getHTMLFile

protected String getHTMLFile(Device device)

getRelativeLoginFile

protected String getRelativeLoginFile(ContentContext ctx)

getLoginFile

public String getLoginFile(ContentContext ctx)

getHTMLFileParams

public String getHTMLFileParams(Device device)

getMenuRenderer

public String getMenuRenderer(Device device)

getUserMailHtml
```
public String getUserMailHtml(GlobalContext globalContext)
                       throws IOException
```
mail for send to user with : ${logo} : url to logo ${site} : global site title ${title} : title of the email ${text} : main text of the email ${action.link} : action button url ${action.text} : action button text ${email} : contact email ${root} : root url #cccccc : special color #555555 : title color #333333 : text color

Parameters:

globalContext -

Returns:

Throws:

IOException

getAdminMailHtml

public String getAdminMailHtml(GlobalContext globalContext)
                        throws IOException

Throws:: IOException

getHTMLHomeFile
```
public String getHTMLHomeFile()
```

get404File
```
public String get404File()
```

getI18nProperties

public Map getI18nProperties(GlobalContext globalContext,
                             Locale locale,
                             int mode)
                      throws IOException

Throws:: IOException

getAllList

public Map<String,List<IListItem>> getAllList(GlobalContext globalContext,
                                                    Locale locale)
                                             throws IOException

Throws:: IOException

getId
```
public String getId()
```

getImageConfigFile
```
public File getImageConfigFile()
```

getImageConfig

public ConfigurationProperties getImageConfig()

getImageConfigFileName

public String getImageConfigFileName()

getImageFilters
```
public List<String> getImageFilters()
```

getImageFiltersRAW
```
public String getImageFiltersRAW()
```

getNoImage
```
public String getNoImage()
```

getNoImageUrl

public String getNoImageUrl(ContentContext ctx,
                            String filter)
                     throws Exception

Throws:: Exception

getDefaultImageFilter
```
public String getDefaultImageFilter()
```

getPageTypes
```
public List<String> getPageTypes()
```

getPageTypesRAW
```
public String getPageTypesRAW()
```

getSpecialAreaRenderer

public String getSpecialAreaRenderer()

setImageFiltersRAW

public void setImageFiltersRAW(String imageFilterRAW)

getLastSelectedClass
```
public String getLastSelectedClass()
```

getLicenceFile
```
public String getLicenceFile()
```

getLinkEmail

public File getLinkEmail(String lg)

getLinkEmailFileName

public String getLinkEmailFileName(String lg)

getLocalWorkMailingTemplateFolder

public String getLocalWorkMailingTemplateFolder()

getLocalWorkTemplateFolder

public String getLocalWorkTemplateFolder()

getMacroFile

public final File getMacroFile(GlobalContext globalContext,
                               String fileName)
                        throws IOException

Throws:: IOException

getMacroProperties

public Properties getMacroProperties(GlobalContext globalContext,
                                     String macroKey)
                              throws IOException

Throws:: IOException

getMail

public Mail getMail(ContentContext ctx,
                    String mailName,
                    String lg)
             throws IOException

Throws:: IOException

getMailJsp

public File getMailJsp(ContentContext ctx,
                       String mailName)
                throws Exception

Throws:: Exception

getMailSubject

public String getMailSubject(String lg)

getName
```
public String getName()
```

getOwner
```
public String getOwner()
```

getParent
```
public Template getParent()
```

getParentName
```
public String getParentName()
```

setParentName

public void setParentName(String parent)

getMessageContainerId
```
public String getMessageContainerId()
```

getMessageTemplate

public String getMessageTemplate(ContentContext ctx)

getRenderer

public String getRenderer(ContentContext ctx)
                   throws Exception

Throws:: Exception

getRenderer

public String getRenderer(ContentContext ctx,
                          String file)
                   throws Exception

Throws:: Exception

getRSSRendererFile
```
protected String getRSSRendererFile()
```

getRSSRendererFullName

public String getRSSRendererFullName(ContentContext ctx)
                              throws ServiceException

Throws:: ServiceException

getRendererFile

protected String getRendererFile(Device device)

isDefaultRenderer
```
protected boolean isDefaultRenderer()
```

getRenderers
```
public List<String> getRenderers()
```
return all renderer defined in the template.

Returns:

getLayouts
```
public List<String> getLayouts()
```
return all renderer defined in the template.

Returns:

getStructures
```
public List<String> getStructures()
```
return all renderer defined in the template.

Returns:

getRendererFullName

public String getRendererFullName(ContentContext ctx)
                           throws ServiceException

Throws:: ServiceException

getResources
```
public List<String> getResources()
```

getResources

public Collection<File> getResources(ContentContext ctx)

get resources define in the template.

Returns:

getRssCSS
```
public String getRssCSS()
```

getSearchFormID
```
public String getSearchFormID()
```

getSearchRenderer

public String getSearchRenderer(ContentContext ctx)
                         throws Exception

Throws:: Exception

getSelectedClass
```
public String getSelectedClass()
```

getSource
```
public String getSource()
```

getEditTemplateMode
```
public String getEditTemplateMode()
```
mode of the edit template, can be used in template renderer for include special css or js. preview css is : edit_preview_[mode].css

Returns:

getSourceFolder
```
public File getSourceFolder()
```

getSourceFolderName
```
public String getSourceFolderName()
```

getFolder
```
public File getFolder()
```

getSpecialRendererTemplate

public String getSpecialRendererTemplate()

getTemplateData
```
public TemplateData getTemplateData()
```

getTemplateRealPath
```
public String getTemplateRealPath()
```

getWorkTemplateRealPath

public String getWorkTemplateRealPath(GlobalContext globalContext)

isDeleted
```
public boolean isDeleted()
```

getUnSelectedClass
```
public String getUnSelectedClass()
```

getVisualFile
```
public String getVisualFile()
```

getVisualAbsoluteFile
```
public File getVisualAbsoluteFile()
```

getVisualPDFile
```
public String getVisualPDFile()
```

getWorkMailingTemplateFolder

public String getWorkMailingTemplateFolder()

getWorkTemplateFolder
```
public String getWorkTemplateFolder()
```

rebuildTemplate

public int rebuildTemplate(ContentContext ctx,
                           boolean css)

rebuildTemplateCss

protected int rebuildTemplateCss(ContentContext ctx,
                                 File folder)

importTemplateInWebapp

public void importTemplateInWebapp(StaticConfig config,
                                   ContentContext ctx)
                            throws IOException

Throws:: IOException

importTemplateInWebapp

public void importTemplateInWebapp(StaticConfig config,
                                   ContentContext ctx,
                                   boolean clear)
                            throws IOException

Throws:: IOException

importTemplateInWebapp

protected void importTemplateInWebapp(StaticConfig config,
                                      ContentContext ctx,
                                      GlobalContext globalContext,
                                      File templateTarget,
                                      Map<String,String> childrenData,
                                      boolean compressResource,
                                      boolean parent,
                                      Boolean importComponents,
                                      boolean clear)
                               throws IOException

Throws:: IOException

isAlternativeTemplate

public boolean isAlternativeTemplate(ContentContext ctx)

isHTML
```
public boolean isHTML()
```

isLinkEmail

public boolean isLinkEmail(String lg)

isMailing
```
public boolean isMailing()
```

isShortkeyToEdit
```
public boolean isShortkeyToEdit()
```

isOnePage
```
public boolean isOnePage()
```

isForStatic
```
public boolean isForStatic()
```

isNavigationArea

public boolean isNavigationArea(String area)

isNosecureArea

public boolean isNosecureArea(String area)

isParent
```
protected boolean isParent()
```

isChildOf

public boolean isChildOf(String templateId)

isPDFFile
```
public boolean isPDFFile()
```

isReady
```
public boolean isReady()
```

isRenderer

public boolean isRenderer(GlobalContext globalContext)

isSubjectLocked
```
public boolean isSubjectLocked()
```

getSenders

public List<javax.mail.internet.InternetAddress> getSenders()

isTemplateInWebapp

public boolean isTemplateInWebapp(ContentContext ctx)
                           throws IOException

Throws:: IOException

isValid
```
public boolean isValid()
```

reload
```
public void reload()
```

setAuthors

public void setAuthors(String name)

setProperty

public void setProperty(String name,
                        String value)

setCreationDate

public void setCreationDate(Date date)

setDepth
```
public void setDepth(int depth)
```

setDominantColor

public void setDominantColor(String color)

setOwner

public void setOwner(String owner)

setReady

public void setReady(boolean ready)

setSource

public void setSource(String name)

setValid

public void setValid(boolean inValid)

toString
```
public String toString()
```
Overrides:

toString in class Object

visibleForRoles

public boolean visibleForRoles(Collection<String> inRoles)

getBuildId
```
public String getBuildId()
```
return a code of build. This code change if some element will modifified.

Returns:

compareTo
```
public int compareTo(Template template)
```
Specified by:

compareTo in interface Comparable<Template>

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

setHTMLIDS

public void setHTMLIDS(Collection<String> ids)

getHTMLIDS
```
public List<String> getHTMLIDS()
```

getRAWPlugins
```
protected String getRAWPlugins()
```

getPlugins
```
public List<String> getPlugins()
```

getDeployId
```
public String getDeployId()
```

isPDFRenderer
```
public boolean isPDFRenderer()
```
return true if this template contains a renderer for PDF.

Returns:

true if PDF renderer defined.

isCompressResources
```
public boolean isCompressResources()
```
return true if resources can be compressed by CMS (css, js).

Returns:

true by default or the value of "resources.compress" property.

getRSSImageURL
```
public String getRSSImageURL()
```

getConfigItem

public String getConfigItem(String key,
                            String defaultValue)

isRealContentFromAnyArea
```
public boolean isRealContentFromAnyArea()
```
true if all area can be signifiant for read content, false if only main area is signifiant.

Returns:

getPDFHeigth
```
public int getPDFHeigth()
```

getQRCodeSize
```
public int getQRCodeSize()
```

getFreeData

public Map<String,String> getFreeData()

loadTemplatePart

protected void loadTemplatePart(TemplatePart part,
                                String prefix)

saveTemplatePart

protected void saveTemplatePart(TemplatePart part,
                                String prefix)

getStyle
```
public TemplateStyle getStyle()
```

storeStyle

public void storeStyle(TemplateStyle style)

getRows
```
public List<Row> getRows()
```

resetRows
```
public void resetRows()
```

getArea

public static Area getArea(Collection<Row> rows,
                           String name)

deleteRow

public void deleteRow(String name)

storeRows

public void storeRows(Collection<Row> rows)

isEditable
```
public boolean isEditable()
```

isImportParentComponents

public boolean isImportParentComponents()

getMailingTemplate
```
public String getMailingTemplate()
```

isBootstrap
```
public boolean isBootstrap()
```

isRemoveEmptyArea
```
public boolean isRemoveEmptyArea()
```
if area empty remove from html (default true)

Returns:

getTemplateExcludeProperties

public Map<String,String> getTemplateExcludeProperties()

getAreaExcludeProperties

public Map<String,String> getAreaExcludeProperties()

getExcludeProperties

protected String getExcludeProperties(String zone)

getRowExcludeProperties

public Map<String,String> getRowExcludeProperties()

getCookiesMessageName
```
public String getCookiesMessageName()
```

getCookiesTypeName
```
public String getCookiesTypeName()
```

getCookiesMessagePath
```
public String getCookiesMessagePath()
```

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

getMimeTypeImage

public String getMimeTypeImage(GlobalContext globalContext,
                               String fileExtension)

isLanguageLinkKeepGetParams

public boolean isLanguageLinkKeepGetParams()

isEndAreaTag
```
public boolean isEndAreaTag()
```

getConfig

public Map<String,String> getConfig()

isColorPalette
```
public boolean isColorPalette()
```

getColorList

public List<ExtendedColor> getColorList()

getColorsMap

public Map<Integer,ExtendedColor> getColorsMap()

getFonts
```
public List<String> getFonts()
```

getWebFonts

public List<String> getWebFonts(GlobalContext globalContext)

getDefaultArea
```
public String getDefaultArea()
```

isFake
```
public boolean isFake()
```

getDynamicComponentList

public List<String> getDynamicComponentList()

main

public static void main(String[] args)
                 throws IOException

Throws:: IOException

Modifier and Type	Class	Description
`static class`	`Template.TemplateBean`
`static class`	`Template.TemplateDateComparator`

Class Template

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREVIEW_EDIT_CODE

FORCE_TEMPLATE_PARAM_NAME

__NO_CONTEXT

TEMPLATE_COMPARATOR

logger

CONFIG_FILE

EDIT_TEMPLATE_CODE

PLUGIN_FOLDER

GZ_FILE_EXT

DEFAULT_TEMPLATE_NAME

config

Constructor Detail

Template

Method Detail

getApplicationInstance

getFakeTemplate

getInstance

getMailingInstance

checkRenderer

clearRenderer

reloadConfig

delete

disabledAlternativeTemplate

enabledAlternativeTemplate

exist

getAjaxAreas

getAreas

getAreas

isAdminArea

getComponentsExclude

getComponentsIncludeForArea

getComponentsExcludeForArea

getAreasMap

getQuietableAreaMap

setArea

deleteArea

getNewAreaName

addArea

getRow

addRow

getAreasForceDisplay

getAuthors

getComponentFile

createMainComponentSass

getCSSByFolder

getHtmlByFolder

getCSSByFolder

getCSS

getWysiwygCss

getConfigComponentFile

getCreationDate

getDepth

getDescription

getDominantColor

getEscapeMenuId

extractPropertiesFromHtml

getDynamicComponentsProperties

getEmailLinkFileList

getFinalTemplate

getFolder

getFolder

getFontReference

getHomeRenderer

getVersion

getBootstrapVersion

isColumnable

getColumnableSizes

getColumnableRowTag

getColumnableRowTagIn

getColumnableColTagIn

getColumnableStyleTagIn

getColumnableClassTagIn

getColumnableColTag