org.infoglue.cms.controllers.delivery.kernel.impl.simple
Class BasicTemplateController

java.lang.Object
  |
  +--org.infoglue.cms.controllers.delivery.kernel.impl.simple.BasicTemplateController
All Implemented Interfaces:
TemplateController
Direct Known Subclasses:
EditOnSiteBasicTemplateController

public class BasicTemplateController
extends java.lang.Object
implements TemplateController

This is the most basic template controller supplying the templates using it with methods to fetch contents, structure and other suff needed for a site. Mostly this class just acts as a delegator to other more specialized classes.


Field Summary
protected  BrowserBean browserBean
           
protected  ComponentLogic componentLogic
           
protected  ContentDeliveryController contentDeliveryController
           
protected  java.lang.Integer contentId
           
protected static boolean DO_NOT_USE_INHERITANCE
           
protected static boolean DO_NOT_USE_LANGUAGE_FALLBACK
           
protected  IntegrationDeliveryController integrationDeliveryController
           
protected  java.lang.Integer languageId
           
protected static java.lang.String META_INFO_BINDING_NAME
           
protected static java.lang.String NAV_TITLE_ATTRIBUTE_NAME
           
protected  NodeDeliveryController nodeDeliveryController
           
protected  javax.servlet.http.HttpServletRequest request
           
protected  java.lang.Integer siteNodeId
           
protected static java.lang.String TEMPLATE_ATTRIBUTE_NAME
           
protected  java.util.Map templateLogicContext
           
protected static java.lang.String TITLE_ATTRIBUTE_NAME
           
protected static boolean USE_INHERITANCE
           
protected static boolean USE_LANGUAGE_FALLBACK
           
 
Constructor Summary
BasicTemplateController()
          The constructor for the templateController.
 
Method Summary
 void addToContext(java.lang.String name, java.lang.Object object)
          Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc
 java.lang.String decoratePage(java.lang.String page)
          This method adds the neccessairy html to a template to make it right-clickable.
 java.lang.String getArchiveBaseUrl(java.lang.Integer contentId, java.lang.String assetKey)
          This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
 java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName, int index, java.lang.String assetKey)
          This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
 java.lang.String getArchiveBaseUrl(java.lang.String contentBindningName, java.lang.String assetKey)
          This method deliveres a String with the URL to the base path of the directory resulting from an unpacking of a uploaded zip-digitalAsset.
 java.util.Vector getArchiveEntries(java.lang.Integer contentId, java.lang.String assetKey)
           
 java.lang.Integer getAssetFileSize(java.lang.Integer contentId)
          Provide the same interface for getting asset filesize as for getting url.
 java.lang.Integer getAssetFileSize(java.lang.Integer contentId, java.lang.String assetKey)
           
 java.lang.Integer getAssetFileSize(java.lang.String contentBindningName, int index)
           
 java.lang.Integer getAssetFileSize(java.lang.String contentBindningName, java.lang.String assetKey)
           
 java.util.Collection getAssetKeys(java.lang.String contentBindningName)
          This method deliveres a list of strings which represents all assetKeys for a content.
 java.lang.String getAssetThumbnailUrl(java.lang.Integer contentId, int width, int height)
          This method deliveres a String with the URL to the thumbnail for the digital asset asked for.
 java.lang.String getAssetThumbnailUrl(java.lang.Integer contentId, java.lang.String assetKey, int width, int height)
          This method deliveres a String with the URL to the thumbnail for the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.Integer contentId)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.Integer contentId, java.lang.String assetKey)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.String contentBindningName)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.String contentBindningName, int index)
          This method deliveres a String with the URL to the digital asset asked for.
 java.lang.String getAssetUrl(java.lang.String contentBindningName, java.lang.String assetKey)
          This method deliveres a String with the URL to the digital asset asked for.
 java.util.List getAvailableLanguages()
          This method returns a list of all languages available on the current site/repository.
 org.infoglue.cms.entities.content.ContentVO getBoundContent(java.lang.String structureBindningName)
          The method returns a single ContentVO-objects that is the bound content of named binding.
 java.util.List getBoundContents(java.lang.String structureBindningName)
          The method returns a list of ContentVO-objects that is the bound content of named binding.
 java.util.List getBoundFolderContents(java.lang.Integer siteNodeId, java.lang.String structureBindningName, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder)
          The method returns a list of ContentVO-objects that is children to the bound content of named binding on the siteNode sent in.
 java.util.List getBoundFolderContents(java.lang.String structureBindningName, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder)
          The method returns a list of ContentVO-objects that is children to the bound content of named binding.
 WebPage getBoundPage(java.lang.String structureBindningName, int position)
          The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
 java.util.List getBoundPages(java.lang.Integer siteNodeId, java.lang.String structureBindningName)
          This methods get a list of bound pages with the structureBindningName sent in which resides on the siteNodeId sent in.
 java.util.List getBoundPages(java.lang.String structureBindningName)
           
 BrowserBean getBrowserBean()
          Getter for the browserBean which supplies information about the users browser, OS and other stuff.
 ChartHelper getChartHelper()
          This method gets the math utility.
 java.util.Collection getChildContents(java.lang.Integer contentId, boolean includeFolders)
          This method gets the children of a content.
 java.util.List getChildContents(java.lang.Integer contentId, boolean searchRecursive, java.lang.String sortAttribute, java.lang.String sortOrder)
          The method returns a list of ContentVO-objects that is children to the bound content sent in.
 java.util.List getChildPages()
          The method returns a list of WebPage-objects that is the children of the current siteNode.
 java.util.List getChildPages(java.lang.Integer siteNodeId)
          The method returns a list of WebPage-objects that is the children of the given siteNode.
 java.util.List getChildPages(java.lang.String structureBindingName)
          The method returns a list of WebPage-objects that is the children of the given siteNode.
 ColorHelper getColorHelper()
          This method gets the color utility.
 ComponentLogic getComponentLogic()
          This method gets a component logic helper object.
 org.infoglue.cms.entities.content.ContentVO getContent()
          Getter for the current content
 org.infoglue.cms.entities.content.ContentVO getContent(java.lang.Integer contentId)
          Getter for the current content
 java.lang.String getContentAttribute(java.lang.Integer contentId, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for.
 java.lang.String getContentAttribute(java.lang.Integer contentId, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttribute(java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for if it exists in the content defined in the url-parameter contentId.
 java.lang.String getContentAttribute(java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for.
 java.lang.String getContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.lang.String backgroundImageUrl)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.Integer contentId, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight)
          This method deliveres a String with the content-attribute asked for generated as a gif-file.
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor, java.lang.String backgroundImageUrl)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
           
 java.lang.String getContentAttributeAsImageUrl(java.lang.String contentBindningName, java.lang.String attributeName, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor, java.lang.String backgroundImageUrl)
           
 java.lang.String getContentAttributeAsPDFUrl(java.lang.String contentBindningName, java.lang.String attributeName)
          This method uses the content-attribute to generate a pdf-file.
 java.lang.Integer getContentId()
          Getter for the contentId
 java.lang.Integer getContentId(java.lang.Integer siteNodeId, java.lang.String contentBindningName)
          Getter for bound contentId for a binding on a special siteNode
 java.lang.Integer getContentId(java.lang.String contentBindningName)
          Getter for bound contentId for a binding
 org.infoglue.cms.entities.management.ContentTypeDefinitionVO getContentTypeDefinitionVO(java.lang.Integer contentId)
          The method returns the ContentTypeVO-objects of the given contentId.
 java.lang.String getCurrentPagePath()
          This method constructs a string representing the path to the page with respect to where in the structure the page is.
 java.lang.String getCurrentPageUrl()
          This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.
 java.lang.String getDigitalAssetBaseUrl()
          This method returns the base url for the digital assets.
 java.lang.String getEncodedUrl(java.lang.String s, java.lang.String enc)
           
 FontHelper getFontHelper()
          This method gets the color utility.
 java.util.List getFormAttributes(java.lang.String contentBindningName, java.lang.String attributeName)
          This method returns a list of form elements/attributes based on the schema sent in.
 boolean getHasLocalizedVersion(java.lang.Integer contentId)
          This method return true if a localized version with the current language exist
 boolean getHasUserPageAccess(java.lang.Integer siteNodeId)
          This method return true if the user logged in has access to the siteNode sent in.
 boolean getHasUserPageWriteAccess(java.lang.Integer siteNodeId)
          This method return true if the user logged in has access to the siteNode sent in.
 javax.servlet.http.HttpServletRequest getHttpServletRequest()
          Getter for request-object
 java.lang.String getInlineAssetUrl(java.lang.String assetKey)
          This method deliveres a String with the URL to the digital asset asked for.
 boolean getIsEditOnSightDisabled()
          This method returns true if the page in question (ie sitenode) has page-caching disabled.
 boolean getIsPageCacheDisabled()
          This method returns true if the if the page in question (ie sitenode) has page-caching disabled.
 boolean getIsPageProtected()
          This method returns true if the page in question (ie sitenode) has it's protected property enabled.
 boolean getIsParentToCurrent(java.lang.Integer siteNodeId)
          This method helps us find out if the current site node is the same or a child to the sent in one.
 java.util.Locale getLanguageCode(java.lang.Integer languageId)
          This method supplies a method to get the locale of the language sent in.
 java.lang.Integer getLanguageId()
          Getter for the languageId
 java.util.Locale getLocale()
          This method supplies a method to get the locale of the language currently in use.
 java.util.List getLocalizedBoundPages(java.lang.String structureBindningName)
          The method returns a list of WebPage-objects that is the bound sitenodes of named binding.
 MathHelper getMathHelper()
          This method gets the math utility.
 java.util.List getNodeAvailableLanguages()
          This method returns a list of all languages available on the current sitenode.
 java.util.List getNodeAvailableLanguages(java.lang.Integer siteNodeId)
           
 java.text.NumberFormat getNumberFormatHelper()
          This method gets the NumberFormat instance with the proper locale.
 ObjectConverter getObjectConverter()
          This method gets the object converter utility.
 java.lang.Object getObjectWithName(java.lang.String classname)
           
 java.lang.String getPageBaseUrl(java.lang.String structureBindningName)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageContentType()
          This method returns the contenttype this page should return.
 java.lang.String getPageNavTitle(java.lang.Integer siteNodeId)
          This method deliveres a String with the Navigation title the page asked for has.
 java.lang.String getPageNavTitle(java.lang.String structureBindningName)
          This method deliveres a String with the Navigation title the page asked for has.
 java.lang.String getPageNavTitle(java.lang.String structureBindningName, int index)
          This method deliveres a String with the Navigation title the page asked for has.
 java.lang.String getPageTitle()
          This method deliveres a String with the Navigation title the page the user are on has.
 java.lang.String getPageUrl(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId)
          This method deliveres a new url pointing to the same address as now but with new parameters.
 java.lang.String getPageUrl(java.lang.String structureBindningName)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageUrl(java.lang.String structureBindningName, java.lang.Integer contentId)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageUrl(java.lang.String structureBindningName, int position, java.lang.Integer contentId)
          This method deliveres a String with the URL to the page asked for.
 java.lang.String getPageUrl(WebPage webpage, java.lang.Integer contentId)
          This method just gets a new URL but with the given contentId in it.
 java.lang.String getPageUrlAfterLanguageChange(java.lang.String languageCode)
          This method deliveres a new url pointing to the same address as now but in the language corresponding to the code sent in.
 java.lang.String getPageUrlOnPosition(java.lang.String structureBindningName, int position)
          This method deliveres a String with the URL to the page asked for.
 org.infoglue.cms.entities.structure.SiteNodeVO getParentSiteNode(java.lang.Integer siteNodeId)
          This method returns the parent siteNode to the given siteNode.
 java.lang.String getParsedContentAttribute(java.lang.Integer contentId, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
 java.lang.String getParsedContentAttribute(java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
 java.lang.String getParsedContentAttribute(java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 java.lang.String getParsedContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName)
          This method deliveres a String with the content-attribute asked for after it has been parsed and all special tags have been converted.
 java.lang.String getParsedContentAttribute(java.lang.String contentBindningName, java.lang.String attributeName, boolean clean)
          This method is just a dummy method used to ensure that we can ensure to not get a decorated attribute value if OnSiteEdit is on.
 ExtranetPrincipal getPrincipal()
           
 java.util.Map getPrincipalPropertyHashValues(ExtranetPrincipal extranetPrincipal, java.lang.String propertyName)
          Getting a property for a Principal - used for personalisation.
 java.util.Map getPrincipalPropertyHashValues(ExtranetPrincipal extranetPrincipal, java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for a Principal - used for personalisation.
 java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName)
          Getting a property for the current Principal - used for personalisation.
 java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for the current Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(ExtranetPrincipal extranetPrincipal, java.lang.String propertyName)
          Getting a property for the current Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(ExtranetPrincipal extranetPrincipal, java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for a Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(java.lang.String propertyName)
          Getting a property for the current Principal - used for personalisation.
 java.lang.String getPrincipalPropertyValue(java.lang.String propertyName, boolean escapeSpecialCharacters)
          Getting a property for the current Principal - used for personalisation.
 java.util.List getRelatedContents(java.lang.Integer contentId, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedContents(java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedContents(java.lang.String bindingName, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedContentsByQualifyer(java.lang.String qualifyerXML)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedPages(java.lang.Integer contentId, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.util.List getRelatedPages(java.lang.String attributeName)
          This method gets a List of related siteNodes defined in an attribute as an xml-definition.
 java.util.List getRelatedPages(java.lang.String bindingName, java.lang.String attributeName)
          This method gets a List of related contents defined in an attribute as an xml-definition.
 java.lang.String getRepositoryBaseUrl()
          This method returns the base url for the digital assets.
 java.util.Enumeration getRequestParamenterNames()
          Getter for request-parameters
 java.lang.String getRequestParameter(java.lang.String parameterName)
          Getter for request-parameter
 java.lang.String[] getRequestParameterValues(java.lang.String parameterName)
          Getter for request-parameters
 java.lang.Integer getSiteNodeId()
          Getter for the siteNodeId
 java.lang.Integer getSiteNodeId(java.lang.String structureBindningName)
          Getter for the siteNodeId on a specific bound page
 java.lang.String getStringAsImageUrl(java.lang.String text, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.awt.Color foregroundColor, java.awt.Color backgroundColor)
          This method deliveres a String with the content-attribute asked for generated as a png-file.
 java.lang.String getStringAsImageUrl(java.lang.String text, int canvasWidth, int canvasHeight, int textStartPosX, int textStartPosY, int textWidth, int textHeight, java.lang.String fontName, int fontStyle, int fontSize, java.lang.String foregroundColor, java.lang.String backgroundColor)
          This method deliveres a String with the content-attribute asked for generated as a png-file.
 java.lang.String getTemplateAttributeName()
          Getter for the template attribute name.
 TemplateController getTemplateController(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId)
          This method should be much more sophisticated later and include a check to see if there is a digital asset uploaded which is more specialized and can be used to act as serverside logic to the template.
 TemplateController getTemplateController(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId, javax.servlet.http.HttpServletRequest request)
           
 java.lang.String getUrlContent(java.lang.String url)
          This method fetches a given URL contents.
 java.lang.String getUrlContent(java.lang.String url, boolean includeRequest)
          This method fetches a given URL contents.
 java.lang.String getUrlContent(java.lang.String url, boolean includeRequest, java.lang.String encoding)
          This method fetches a given URL contents.
 java.lang.String getUrlContent(java.lang.String url, java.lang.String encoding)
          This method fetches a given URL contents.
 WebServiceHelper getWebServiceHelper()
          This method gets the webservice utility.
 org.infoglue.cms.applications.common.VisualFormatter getVisualFormatter()
          This method gets the formatter object that helps with formatting of data.
 java.lang.String include(java.lang.String contentBindningName, java.lang.String attributeName)
          This method allows the current template to include another template which is also rendered in the current context as if it were a part.
 java.lang.String include(java.lang.String contentBindningName, java.lang.String attributeName, boolean cacheInclude)
           
 java.lang.String include(java.lang.String contentBindningName, java.lang.String attributeName, boolean cacheInclude, java.lang.String cName, java.lang.Object cObject)
          This method allows the current template to include another template which is also rendered in the current context as if it were a part.
 java.lang.String renderString(java.lang.String template)
          This method allows a user to get any string rendered as a template.
 java.lang.String replace(java.lang.String originalString, java.lang.String expressionToReplace, java.lang.String newString)
          This method lets a user substitute a string located in the page by a regular expression with another string.
 java.lang.String replace(java.lang.String originalString, java.lang.String substring, java.lang.String stringToReplace, java.lang.String newString)
          This method lets a user substitute a string located in the page by a regular expression with another string.
 void setBrowserBean(BrowserBean browserBean)
          Setter for the bean which contains information about the users browser.
 void setComponentLogic(ComponentLogic componentLogic)
          This method gets a component logic helper object.
 void setDeliveryControllers(NodeDeliveryController nodeDeliveryController, ContentDeliveryController contentDeliveryController, IntegrationDeliveryController integrationDeliveryController)
          Setting to enable us to set initialized versions of the Node and Content delivery Controllers.
 void setHttpRequest(javax.servlet.http.HttpServletRequest request)
          Setter for the template to get all the parameters from the user.
 void setStandardRequestParameters(java.lang.Integer siteNodeId, java.lang.Integer languageId, java.lang.Integer contentId)
          Setter for the template to get all the parameters from the user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

META_INFO_BINDING_NAME

protected static final java.lang.String META_INFO_BINDING_NAME
See Also:
Constant Field Values

TEMPLATE_ATTRIBUTE_NAME

protected static final java.lang.String TEMPLATE_ATTRIBUTE_NAME
See Also:
Constant Field Values

TITLE_ATTRIBUTE_NAME

protected static final java.lang.String TITLE_ATTRIBUTE_NAME
See Also:
Constant Field Values

NAV_TITLE_ATTRIBUTE_NAME

protected static final java.lang.String NAV_TITLE_ATTRIBUTE_NAME
See Also:
Constant Field Values

USE_LANGUAGE_FALLBACK

protected static final boolean USE_LANGUAGE_FALLBACK
See Also:
Constant Field Values

DO_NOT_USE_LANGUAGE_FALLBACK

protected static final boolean DO_NOT_USE_LANGUAGE_FALLBACK
See Also:
Constant Field Values

USE_INHERITANCE

protected static final boolean USE_INHERITANCE
See Also:
Constant Field Values

DO_NOT_USE_INHERITANCE

protected static final boolean DO_NOT_USE_INHERITANCE
See Also:
Constant Field Values

siteNodeId

protected java.lang.Integer siteNodeId

languageId

protected java.lang.Integer languageId

contentId

protected java.lang.Integer contentId

request

protected javax.servlet.http.HttpServletRequest request

browserBean

protected BrowserBean browserBean

nodeDeliveryController

protected NodeDeliveryController nodeDeliveryController

contentDeliveryController

protected ContentDeliveryController contentDeliveryController

integrationDeliveryController

protected IntegrationDeliveryController integrationDeliveryController

componentLogic

protected ComponentLogic componentLogic

templateLogicContext

protected java.util.Map templateLogicContext
Constructor Detail

BasicTemplateController

public BasicTemplateController()
The constructor for the templateController. It should be used to initialize the templateController for efficient use.

Method Detail

addToContext

public void addToContext(java.lang.String name,
                         java.lang.Object object)
Add objects to be used in subsequent parsing like getParsedContentAttribute, include, etc


setStandardRequestParameters

public void setStandardRequestParameters(java.lang.Integer siteNodeId,
                                         java.lang.Integer languageId,
                                         java.lang.Integer contentId)
Setter for the template to get all the parameters from the user.

Specified by:
setStandardRequestParameters in interface TemplateController

setHttpRequest

public void setHttpRequest(javax.servlet.http.HttpServletRequest request)
Setter for the template to get all the parameters from the user.

Specified by:
setHttpRequest in interface TemplateController

setBrowserBean

public void setBrowserBean(BrowserBean browserBean)
Setter for the bean which contains information about the users browser.

Specified by:
setBrowserBean in interface TemplateController

getTemplateAttributeName

public java.lang.String getTemplateAttributeName()
Getter for the template attribute name.

Specified by:
getTemplateAttributeName in interface TemplateController

getSiteNodeId

public java.lang.Integer getSiteNodeId()
Getter for the siteNodeId

Specified by:
getSiteNodeId in interface TemplateController

getLanguageId

public java.lang.Integer getLanguageId()
Getter for the languageId

Specified by:
getLanguageId in interface TemplateController

getContentId

public java.lang.Integer getContentId()
Getter for the contentId

Specified by:
getContentId in interface TemplateController

getComponentLogic

public ComponentLogic getComponentLogic()
This method gets a component logic helper object.

Specified by:
getComponentLogic in interface TemplateController

setComponentLogic

public void setComponentLogic(ComponentLogic componentLogic)
This method gets a component logic helper object.

Specified by:
setComponentLogic in interface TemplateController

getVisualFormatter

public org.infoglue.cms.applications.common.VisualFormatter getVisualFormatter()
This method gets the formatter object that helps with formatting of data.

Specified by:
getVisualFormatter in interface TemplateController

getColorHelper

public ColorHelper getColorHelper()
This method gets the color utility.

Specified by:
getColorHelper in interface TemplateController

getFontHelper

public FontHelper getFontHelper()
This method gets the color utility.

Specified by:
getFontHelper in interface TemplateController

getMathHelper

public MathHelper getMathHelper()
This method gets the math utility.

Specified by:
getMathHelper in interface TemplateController

getChartHelper

public ChartHelper getChartHelper()
This method gets the math utility.


getWebServiceHelper

public WebServiceHelper getWebServiceHelper()
This method gets the webservice utility.


getNumberFormatHelper

public java.text.NumberFormat getNumberFormatHelper()
This method gets the NumberFormat instance with the proper locale.

Specified by:
getNumberFormatHelper in interface TemplateController

getObjectConverter

public ObjectConverter getObjectConverter()
This method gets the object converter utility.


getContent

public org.infoglue.cms.entities.content.ContentVO getContent()
Getter for the current content

Specified by:
getContent in interface TemplateController

getContent

public org.infoglue.cms.entities.content.ContentVO getContent(java.lang.Integer contentId)
Getter for the current content

Specified by:
getContent in interface TemplateController

getPrincipal

public ExtranetPrincipal getPrincipal()

getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(java.lang.String propertyName)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.


getPrincipalPropertyHashValues

public java.util.Map getPrincipalPropertyHashValues(java.lang.String propertyName)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.


getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(ExtranetPrincipal extranetPrincipal,
                                                  java.lang.String propertyName)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.


getPrincipalPropertyHashValues

public java.util.Map getPrincipalPropertyHashValues(ExtranetPrincipal extranetPrincipal,
                                                    java.lang.String propertyName)
Getting a property for a Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.


getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(ExtranetPrincipal extranetPrincipal,
                                                  java.lang.String propertyName,
                                                  boolean escapeSpecialCharacters)
Getting a property for a Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.


getPrincipalPropertyValue

public java.lang.String getPrincipalPropertyValue(java.lang.String propertyName,
                                                  boolean escapeSpecialCharacters)
Getting a property for the current Principal - used for personalisation. This method starts with getting the property on the user and if it does not exist we check out the group-properties as well.


getPrincipalPropertyHashValues

public java.util.Map getPrincipalPropertyHashValues(ExtranetPrincipal extranetPrincipal,
                                                    java.lang.String propertyName,
                                                    boolean escapeSpecialCharacters)</