info.magnolia.module.templatingkit.templates
Class STKTemplateModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

java.lang.Object
  info.magnolia.rendering.model.RenderingModelImpl<RD>
      info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel<RD>
          info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD>
              info.magnolia.module.templatingkit.templates.STKTemplateModel<RD>

Type Parameters:

RD - - an instance of STKPage

All Implemented Interfaces:

info.magnolia.module.templatingkit.templates.STKRenderingModel<RD>, info.magnolia.rendering.model.RenderingModel<RD>

Direct Known Subclasses:

SingletonParagraphTemplateModel

Deprecated. since STK 2.0: use class STKPageModel instead.

public class STKTemplateModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>
extends info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD>

Base Model Implementation for STK.

Version:

$Id$

Author:

pbracher

Field Summary

Fields inherited from class info.magnolia.module.templatingkit.templates.pages.STKPageModel

LINK_PROP_NAME, LINK_TITLE_PROP_NAME

Fields inherited from class info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel

DEFAULT_SITEROOT_TEMPLATE_CATEGORY, stkFunctions, templatingFunctions

Fields inherited from class info.magnolia.rendering.model.RenderingModelImpl

content, contentMap, definition, parentModel

Fields inherited from interface info.magnolia.rendering.model.RenderingModel

SKIP_RENDERING

Constructor Summary

STKTemplateModel(javax.jcr.Node content, RD definition, info.magnolia.rendering.model.RenderingModel<?> parent, info.magnolia.module.templatingkit.functions.STKTemplatingFunctions stkFunctions, info.magnolia.templating.functions.TemplatingFunctions templatingFunctions)
Deprecated.

Method Summary

String	execute() Deprecated.
String	getBadge() Deprecated. since 2.0: badge logic is provided by the footer area and not anymore by the page itself, see info.magnolia.module.templatingkit.templates.areas.FooterAreaModel.
String	getBodyClass() Deprecated. since 2.0: use STKPageModel instead.
Collection<info.magnolia.module.templatingkit.navigation.Link>	getBreadcrumb() Deprecated. since 2.0: breadcrumb logic is provided by the breadcrumb area and not anymore by the page itself, see info.magnolia.module.templatingkit.templates.areas.BreadcrumbAreaModel.
List<?>	getCategories() Deprecated. since 2.0: use STKPageModel instead.
String	getCategoryLink(String categoryName) Deprecated. since 2.0: use STKPageModel instead.
Collection<info.magnolia.module.templatingkit.navigation.Link>	getContentNavigation() Deprecated. since 2.0: contentNavigation is now an Area within the 'main area. There for the logic is provided by the contentNavigation area's model info.magnolia.module.templatingkit.templates.areas.ContentNavigationAreaModel.
RD	getDefinition() Deprecated. Overriding this method is apparently necessary to keep the return type in sync with the old statically defined return type.
String	getExternalLink() Deprecated. since 2.0: use TemplatingFunctions instead.
String	getExternalLinkTitle() Deprecated. since 2.0: use info.magnolia.templating.functions.TemplatingFunctionss instead.
ExtrasAreaModel	getExtras() Deprecated. since 2.0: Providing and managing the inherited extras content should be managed by the ExtrasArea.
info.magnolia.module.templatingkit.templates.InheritedContentModel	getFooter() Deprecated. since 2.0: the footer is now an Area element. Providing the footer elements by inheritance is now a base functionality of the info.magnolia.templating.elements.AreaElement.
String	getHomeLink() Deprecated. since 2.0: code moved to STKTemplatingFunctions
String	getHomeName() Deprecated. since 2.0: code moved to STKTemplatingFunctions
String	getHomeTitle() Deprecated. since 2.0: code moved to STKTemplatingFunctions
info.magnolia.module.templatingkit.templates.components.ImageModel	getImageModel() Deprecated. since 2.0: use STKPageModel instead.
String	getLanguage() Deprecated. since 2.0: code moved to TemplatingFunctions
String	getLogoImageLink() Deprecated. since 2.0: use STKPageModel instead
info.magnolia.module.templatingkit.templates.InheritedContentModel	getMetaNavigation() Deprecated. since 2.0: the metaNavigation is now an Area element. Providing the metaNavigation elements by inheritance is now a base functionality of the info.magnolia.templating.elements.AreaElement.
info.magnolia.module.templatingkit.navigation.SiteNavigationModel	getNavigation() Deprecated. since 2.0: use STKPageModel instead.
javax.jcr.Node	getNode() Deprecated.
info.magnolia.rendering.model.RenderingModel<?>	getParent() Deprecated.
String	getPrintLogoImageLink() Deprecated. since 2.0: use STKPageModel instead
Collection<javax.jcr.Node>	getPromos() Deprecated. since 2.0: the promos is now an Area element. Providing the promos elements by inheritance is now a base functionality of the info.magnolia.templating.elements.AreaElement.
String	getSearchPageLink() Deprecated. since 2.0: code moved to SearchResultModel.
String	getSectionAbstract() Deprecated. since 1.2 Use getSectionText() instead
String	getSectionText() Deprecated. since 2.0: sectionHeader logic is provided by the sectionHeader area and not anymore by the page itself, see SectionHeaderAreaModel.
String	getSectionTitle() Deprecated. since 2.0: sectionHeader logic is provided by the sectionHeader area and not anymore by the page itself, see info.magnolia.module.templatingkit.templates.areas.SectionHeaderAreaModel.
info.magnolia.module.templatingkit.sites.Site	getSite() Deprecated. since 2.0: use STKPageModel instead.
javax.jcr.Node	getSiteRoot() Deprecated. since 2.0: use STKPageModel instead.
String	getSiteTitle() Deprecated. since 2.0: code moved to STKTemplatingFunctions
protected javax.jcr.Node	resolveSectionPage() Deprecated. since 2.0: use STKPageModel instead
void	setSite(info.magnolia.module.templatingkit.sites.Site site) Deprecated. since 2.0

Methods inherited from class info.magnolia.rendering.model.RenderingModelImpl

getContent, getDef, getRoot

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface info.magnolia.rendering.model.RenderingModel

getContent, getRoot

Constructor Detail

STKTemplateModel

@Inject
public STKTemplateModel(javax.jcr.Node content,
                               RD definition,
                               info.magnolia.rendering.model.RenderingModel<?> parent,
                               info.magnolia.module.templatingkit.functions.STKTemplatingFunctions stkFunctions,
                               info.magnolia.templating.functions.TemplatingFunctions templatingFunctions)

Deprecated.

Method Detail

getBodyClass

public String getBodyClass()

Deprecated. since 2.0: use STKPageModel instead.

Overrides:

getBodyClass in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getLanguage

public String getLanguage()

Deprecated. since 2.0: code moved to TemplatingFunctions

getNavigation

public info.magnolia.module.templatingkit.navigation.SiteNavigationModel getNavigation()

Deprecated. since 2.0: use STKPageModel instead.

Overrides:

getNavigation in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getBreadcrumb

public Collection<info.magnolia.module.templatingkit.navigation.Link> getBreadcrumb()
                                                                             throws javax.jcr.RepositoryException

Deprecated. since 2.0: breadcrumb logic is provided by the breadcrumb area and not anymore by the page itself, see info.magnolia.module.templatingkit.templates.areas.BreadcrumbAreaModel.

Throws:

javax.jcr.RepositoryException

getSiteRoot

public javax.jcr.Node getSiteRoot()

Deprecated. since 2.0: use STKPageModel instead.

Specified by:

getSiteRoot in interface info.magnolia.module.templatingkit.templates.STKRenderingModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Overrides:

getSiteRoot in class info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getFooter

public info.magnolia.module.templatingkit.templates.InheritedContentModel getFooter()
                                                                             throws javax.jcr.RepositoryException

Deprecated. since 2.0: the footer is now an Area element. Providing the footer elements by inheritance is now a base functionality of the info.magnolia.templating.elements.AreaElement.

Throws:

javax.jcr.RepositoryException

getMetaNavigation

public info.magnolia.module.templatingkit.templates.InheritedContentModel getMetaNavigation()
                                                                                     throws javax.jcr.RepositoryException

Deprecated. since 2.0: the metaNavigation is now an Area element. Providing the metaNavigation elements by inheritance is now a base functionality of the info.magnolia.templating.elements.AreaElement.

Throws:

javax.jcr.RepositoryException

getExtras

public ExtrasAreaModel getExtras()
                          throws javax.jcr.RepositoryException

Deprecated. since 2.0: Providing and managing the inherited extras content should be managed by the ExtrasArea.

Throws:

javax.jcr.RepositoryException

getPromos

public Collection<javax.jcr.Node> getPromos()
                                     throws javax.jcr.RepositoryException

Deprecated. since 2.0: the promos is now an Area element. Providing the promos elements by inheritance is now a base functionality of the info.magnolia.templating.elements.AreaElement.

Throws:

javax.jcr.RepositoryException

getLogoImageLink

public String getLogoImageLink()

Deprecated. since 2.0: use STKPageModel instead

Overrides:

getLogoImageLink in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getPrintLogoImageLink

public String getPrintLogoImageLink()

Deprecated. since 2.0: use STKPageModel instead

Overrides:

getPrintLogoImageLink in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getSectionTitle

public String getSectionTitle()
                       throws javax.jcr.RepositoryException

Deprecated. since 2.0: sectionHeader logic is provided by the sectionHeader area and not anymore by the page itself, see info.magnolia.module.templatingkit.templates.areas.SectionHeaderAreaModel.

Throws:

javax.jcr.RepositoryException

getSectionAbstract

public String getSectionAbstract()
                          throws javax.jcr.RepositoryException

Deprecated. since 1.2 Use getSectionText() instead

Throws:

javax.jcr.RepositoryException

getSectionText

public String getSectionText()
                      throws javax.jcr.RepositoryException

Deprecated. since 2.0: sectionHeader logic is provided by the sectionHeader area and not anymore by the page itself, see SectionHeaderAreaModel.

Throws:

javax.jcr.RepositoryException

resolveSectionPage

protected javax.jcr.Node resolveSectionPage()
                                     throws javax.jcr.RepositoryException

Deprecated. since 2.0: use STKPageModel instead

Overrides:

resolveSectionPage in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Throws:

javax.jcr.RepositoryException

getHomeName

public String getHomeName()

Deprecated. since 2.0: code moved to STKTemplatingFunctions

getHomeTitle

public String getHomeTitle()

Deprecated. since 2.0: code moved to STKTemplatingFunctions

getSiteTitle

public String getSiteTitle()

Deprecated. since 2.0: code moved to STKTemplatingFunctions

getHomeLink

public String getHomeLink()

Deprecated. since 2.0: code moved to STKTemplatingFunctions

getContentNavigation

public Collection<info.magnolia.module.templatingkit.navigation.Link> getContentNavigation()
                                                                                    throws javax.jcr.RepositoryException

Deprecated. since 2.0: contentNavigation is now an Area within the 'main area. There for the logic is provided by the contentNavigation area's model info.magnolia.module.templatingkit.templates.areas.ContentNavigationAreaModel.

Overrides:

getContentNavigation in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Throws:

javax.jcr.RepositoryException

getSearchPageLink

public String getSearchPageLink()

Deprecated. since 2.0: code moved to SearchResultModel.

getExternalLink

public String getExternalLink()

Deprecated. since 2.0: use TemplatingFunctions instead.

getExternalLinkTitle

public String getExternalLinkTitle()

Deprecated. since 2.0: use info.magnolia.templating.functions.TemplatingFunctionss instead.

getBadge

public final String getBadge()

Deprecated. since 2.0: badge logic is provided by the footer area and not anymore by the page itself, see info.magnolia.module.templatingkit.templates.areas.FooterAreaModel.

getSite

public info.magnolia.module.templatingkit.sites.Site getSite()

Deprecated. since 2.0: use STKPageModel instead.

Specified by:

getSite in interface info.magnolia.module.templatingkit.templates.STKRenderingModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Overrides:

getSite in class info.magnolia.module.templatingkit.templates.AbstractSTKTemplateModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

setSite

public void setSite(info.magnolia.module.templatingkit.sites.Site site)

Deprecated. since 2.0

getCategories

public List<?> getCategories()

Deprecated. since 2.0: use STKPageModel instead.

Overrides:

getCategories in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getCategoryLink

public String getCategoryLink(String categoryName)

Deprecated. since 2.0: use STKPageModel instead.

Overrides:

getCategoryLink in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getImageModel

public info.magnolia.module.templatingkit.templates.components.ImageModel getImageModel()

Deprecated. since 2.0: use STKPageModel instead.

Overrides:

getImageModel in class info.magnolia.module.templatingkit.templates.pages.STKPageModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getDefinition

public RD getDefinition()

Deprecated.

Overriding this method is apparently necessary to keep the return type in sync with the old statically defined return type. This will make for backward compatibility when compiling legacy code against newer versions of this class.

Specified by:

getDefinition in interface info.magnolia.rendering.model.RenderingModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Overrides:

getDefinition in class info.magnolia.rendering.model.RenderingModelImpl<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Since:

1.4.2 FIXME: Should these overwrites really stay in the class? Class extends now the RenderingModelImpl and uses Node and not Content anymore.

getParent

public info.magnolia.rendering.model.RenderingModel<?> getParent()

Deprecated.

Specified by:

getParent in interface info.magnolia.rendering.model.RenderingModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Overrides:

getParent in class info.magnolia.rendering.model.RenderingModelImpl<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

getNode

public javax.jcr.Node getNode()

Deprecated.

Specified by:

getNode in interface info.magnolia.rendering.model.RenderingModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Overrides:

getNode in class info.magnolia.rendering.model.RenderingModelImpl<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

execute

public String execute()

Deprecated.

Specified by:

execute in interface info.magnolia.rendering.model.RenderingModel<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>

Overrides:

execute in class info.magnolia.rendering.model.RenderingModelImpl<RD extends info.magnolia.module.templatingkit.templates.pages.STKPage>