Uses of Interface
org.craftercms.engine.model.SiteItem

Packages that use SiteItem

Package	Description
org.craftercms.engine.freemarker
org.craftercms.engine.model
org.craftercms.engine.model.sorting
org.craftercms.engine.navigation
org.craftercms.engine.navigation.impl
org.craftercms.engine.scripting
org.craftercms.engine.scripting.impl
org.craftercms.engine.security
org.craftercms.engine.service
org.craftercms.engine.service.impl
org.craftercms.engine.util
org.craftercms.engine.view

Uses of SiteItem in org.craftercms.engine.freemarker

Methods in org.craftercms.engine.freemarker that return SiteItem

Modifier and Type	Method	Description
protected SiteItem	RenderComponentDirective.getComponent(String componentPath, freemarker.core.Environment env)
protected SiteItem	RenderComponentDirective.getComponentFromNode(freemarker.template.TemplateModel parentParam, freemarker.template.TemplateModel componentParam, freemarker.core.Environment env)
protected SiteItem	RenderComponentDirective.getComponentFromPath(freemarker.template.TemplateModel componentPathParam, freemarker.core.Environment env)
protected SiteItem	ExecuteControllerDirective.getContentModel(freemarker.core.Environment env)

Methods in org.craftercms.engine.freemarker with parameters of type SiteItem

Modifier and Type	Method	Description
protected Map<String,Object>	RenderComponentDirective.createScriptVariables(SiteItem component, Map<String,Object> templateModel, Map<String,Object> additionalModel)
protected Map<String,Object>	RenderComponentDirective.executeScripts(SiteItem component, Map<String,Object> additionalModel, freemarker.core.Environment env)
protected String	RenderComponentDirective.getComponentTemplateName(SiteItem component, freemarker.core.Environment env)
protected freemarker.template.SimpleHash	RenderComponentDirective.getFullModel(SiteItem component, Map<String,Object> templateModel, Map<String,Object> additionalModel)
protected freemarker.template.Template	RenderComponentDirective.getTemplate(SiteItem component, freemarker.core.Environment env)

Uses of SiteItem in org.craftercms.engine.model

Classes in org.craftercms.engine.model that implement SiteItem

Modifier and Type	Class	Description
class	AbstractXmlSiteItem	Base implementation of SiteItem that handles all XML related operations
class	DefaultSiteItem	Basic adapter to a Item, enhanced with methods that can be easily invoked in template engines like Freemarker.
class	EmbeddedSiteItem	Implementation of SiteItem for embedded site items

Fields in org.craftercms.engine.model declared as SiteItem

Modifier and Type	Field	Description
protected SiteItem	EmbeddedSiteItem.parentItem	The parent of the embedded component

Fields in org.craftercms.engine.model with type parameters of type SiteItem

Modifier and Type	Field	Description
protected List<SiteItem>	DefaultSiteItem.childItems
protected Comparator<SiteItem>	DefaultSiteItem.sortComparator

Methods in org.craftercms.engine.model that return SiteItem

Modifier and Type	Method	Description
SiteItem	DefaultSiteItem.createItemWrapper(org.craftercms.core.service.Item item)
SiteItem	EmbeddedSiteItem.createItemWrapper(org.craftercms.core.service.Item item)
SiteItem	SiteItem.createItemWrapper(org.craftercms.core.service.Item item)
SiteItem	DefaultSiteItem.getChildItem(String storeName)
SiteItem	EmbeddedSiteItem.getChildItem(String storeName)
SiteItem	SiteItem.getChildItem(String storeName)

Methods in org.craftercms.engine.model that return types with arguments of type SiteItem

Modifier and Type	Method	Description
List<SiteItem>	DefaultSiteItem.getChildItems()
List<SiteItem>	EmbeddedSiteItem.getChildItems()
List<SiteItem>	SiteItem.getChildItems()
List<SiteItem>	DefaultSiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	EmbeddedSiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	SiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)

Method parameters in org.craftercms.engine.model with type arguments of type SiteItem

Modifier and Type	Method	Description
List<SiteItem>	DefaultSiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	DefaultSiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	EmbeddedSiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	EmbeddedSiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	SiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)
List<SiteItem>	SiteItem.sortItems(List<SiteItem> items, Comparator<SiteItem> comparator)

Constructors in org.craftercms.engine.model with parameters of type SiteItem

Modifier	Constructor	Description
	EmbeddedSiteItem(SiteItem parentItem, org.dom4j.Element rootElement, org.craftercms.commons.converters.Converter<org.dom4j.Element,Object> modelFieldConverter)

Constructor parameters in org.craftercms.engine.model with type arguments of type SiteItem

Modifier	Constructor	Description
	DefaultSiteItem(org.craftercms.core.service.Item item, org.craftercms.commons.converters.Converter<org.dom4j.Element,Object> modelFieldConverter, Comparator<SiteItem> sortComparator)

Uses of SiteItem in org.craftercms.engine.model.sorting

Methods in org.craftercms.engine.model.sorting with parameters of type SiteItem

Modifier and Type	Method	Description
int	OrderDefaultComparator.compare(SiteItem siteItem1, SiteItem siteItem2)
protected Float	OrderDefaultComparator.getOrderDefault(SiteItem siteItem)

Uses of SiteItem in org.craftercms.engine.navigation

Method parameters in org.craftercms.engine.navigation with type arguments of type SiteItem

Modifier and Type	Method	Description
List<NavItem>	NavBreadcrumbBuilder.getBreadcrumb(String url, String root, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)	Returns the navigation items that form the breadcrumb for the specified store URL.
NavItem	NavTreeBuilder.getNavTree(String url, int depth, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)	Returns the navigation tree with the specified depth for the specified store URL.

Uses of SiteItem in org.craftercms.engine.navigation.impl

Fields in org.craftercms.engine.navigation.impl with type parameters of type SiteItem

Modifier and Type	Field	Description
protected org.craftercms.commons.converters.Converter<SiteItem,NavItem>	NavBreadcrumbBuilderImpl.defaultItemConverter
protected org.craftercms.commons.converters.Converter<SiteItem,NavItem>	NavTreeBuilderImpl.defaultItemConverter

Methods in org.craftercms.engine.navigation.impl with parameters of type SiteItem

Modifier and Type	Method	Description
NavItem	DefaultItemConverter.convert(SiteItem siteItem)
protected Map<String,String>	DefaultItemConverter.getAdditionalAttributes(SiteItem siteItem)
protected String	DefaultItemConverter.getNavigationLabel(SiteItem siteItem)
protected String	DefaultItemConverter.getNavigationUrl(SiteItem siteItem)
protected NavItem	NavTreeBuilderImpl.getNavItem(SiteItem siteItem, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
protected List<NavItem>	NavTreeBuilderImpl.getNavSubItems(SiteItem siteItem, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)

Method parameters in org.craftercms.engine.navigation.impl with type arguments of type SiteItem

Modifier and Type	Method	Description
List<NavItem>	NavBreadcrumbBuilderImpl.getBreadcrumb(String url, String root, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
protected NavItem	NavTreeBuilderImpl.getNavItem(SiteItem siteItem, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
protected List<NavItem>	NavTreeBuilderImpl.getNavSubItems(SiteItem siteItem, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
NavItem	NavTreeBuilderImpl.getNavTree(String url, int depth, String currentPageUrl, org.craftercms.commons.converters.Converter<SiteItem,NavItem> itemConverter)
void	NavBreadcrumbBuilderImpl.setDefaultItemConverter(org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter)

Constructor parameters in org.craftercms.engine.navigation.impl with type arguments of type SiteItem

Modifier	Constructor	Description
	NavTreeBuilderImpl(SiteItemService siteItemService, org.craftercms.commons.converters.Converter<SiteItem,NavItem> defaultItemConverter)

Uses of SiteItem in org.craftercms.engine.scripting

Methods in org.craftercms.engine.scripting with parameters of type SiteItem

Modifier and Type	Method	Description
List<String>	SiteItemScriptResolver.getScriptUrls(SiteItem item)

Uses of SiteItem in org.craftercms.engine.scripting.impl

Methods in org.craftercms.engine.scripting.impl with parameters of type SiteItem

Modifier and Type	Method	Description
List<String>	SiteItemScriptResolverImpl.getScriptUrls(SiteItem item)

Uses of SiteItem in org.craftercms.engine.security

Methods in org.craftercms.engine.security with parameters of type SiteItem

Modifier and Type	Method	Description
void	CrafterPageAccessManager.checkAccess(SiteItem page)	Checks if the user has sufficient rights to access the specified page: If the page doesn't contain any required role, no authentication is needed. If the page has the role "Anonymous", no authentication is needed. If the page has the role "Authenticated", just authentication is needed. If the page has any other the roles, the user needs to have any of those roles.
protected List<String>	CrafterPageAccessManager.getAuthorizedRolesForPage(SiteItem page)

Uses of SiteItem in org.craftercms.engine.service

Methods in org.craftercms.engine.service that return SiteItem

Modifier and Type	Method	Description
SiteItem	SiteItemService.getSiteItem(String url)	Returns the site item for the given URL
SiteItem	SiteItemService.getSiteItem(String url, org.craftercms.core.processors.ItemProcessor processor)	Returns the site item for the given URL
SiteItem	SiteItemService.getSiteItem(String url, org.craftercms.core.processors.ItemProcessor processor, org.apache.commons.collections4.Predicate<org.craftercms.core.service.Item> predicate)	Returns the site item for the given URL
SiteItem	SiteItemService.getSiteItem(SiteItem parent, org.dom4j.Element element)	Returns the site item for the given XML element
SiteItem	SiteItemService.getSiteTree(String url, int depth)	Returns the site tree for the given URL.
SiteItem	SiteItemService.getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex)	Deprecated.
SiteItem	SiteItemService.getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex, String[]... nodeXPathAndExpectedValuePairs)	Deprecated.
SiteItem	SiteItemService.getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex, Map<String,String> nodeXPathAndExpectedValuePairs)	Deprecated.
SiteItem	SiteItemService.getSiteTree(String url, int depth, org.craftercms.core.service.ItemFilter filter, org.craftercms.core.processors.ItemProcessor processor)	Returns the site tree for the given URL.

Methods in org.craftercms.engine.service with parameters of type SiteItem

Modifier and Type	Method	Description
SiteItem	SiteItemService.getSiteItem(SiteItem parent, org.dom4j.Element element)	Returns the site item for the given XML element

Uses of SiteItem in org.craftercms.engine.service.impl

Fields in org.craftercms.engine.service.impl with type parameters of type SiteItem

Modifier and Type	Field	Description
protected Comparator<SiteItem>	SiteItemServiceImpl.sortComparator

Methods in org.craftercms.engine.service.impl that return SiteItem

Modifier and Type	Method	Description
protected SiteItem	SiteItemServiceImpl.createItemWrapper(org.craftercms.core.service.Item item)
SiteItem	SiteItemServiceImpl.getSiteItem(String url)
SiteItem	SiteItemServiceImpl.getSiteItem(String url, org.craftercms.core.processors.ItemProcessor processor)
SiteItem	SiteItemServiceImpl.getSiteItem(String url, org.craftercms.core.processors.ItemProcessor processor, org.apache.commons.collections4.Predicate<org.craftercms.core.service.Item> predicate)
SiteItem	SiteItemServiceImpl.getSiteItem(SiteItem parent, org.dom4j.Element element)
SiteItem	SiteItemServiceImpl.getSiteTree(String url, int depth)
SiteItem	SiteItemServiceImpl.getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex)	Deprecated.
SiteItem	SiteItemServiceImpl.getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex, String[]... nodeXPathAndExpectedValuePairs)	Deprecated.
SiteItem	SiteItemServiceImpl.getSiteTree(String url, int depth, String includeByNameRegex, String excludeByNameRegex, Map<String,String> nodeXPathAndExpectedValuePairs)	Deprecated.
SiteItem	SiteItemServiceImpl.getSiteTree(String url, int depth, org.craftercms.core.service.ItemFilter filter, org.craftercms.core.processors.ItemProcessor processor)

Methods in org.craftercms.engine.service.impl with parameters of type SiteItem

Modifier and Type	Method	Description
SiteItem	SiteItemServiceImpl.getSiteItem(SiteItem parent, org.dom4j.Element element)

Method parameters in org.craftercms.engine.service.impl with type arguments of type SiteItem

Modifier and Type	Method	Description
void	SiteItemServiceImpl.setSortComparator(Comparator<SiteItem> sortComparator)

Uses of SiteItem in org.craftercms.engine.util

Methods in org.craftercms.engine.util with parameters of type SiteItem

Modifier and Type	Method	Description
static void	GroovyScriptUtils.addSiteItemScriptVariables(Map<String,Object> variables, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.ServletContext servletContext, SiteItem item, Object templateModel)

Uses of SiteItem in org.craftercms.engine.view

Fields in org.craftercms.engine.view declared as SiteItem

Modifier and Type	Field	Description
protected SiteItem	CrafterPageView.page

Methods in org.craftercms.engine.view that return SiteItem

Modifier and Type	Method	Description
SiteItem	CrafterPageView.getPage()
protected SiteItem	CrafterPageViewResolver.getPage(String url)

Methods in org.craftercms.engine.view with parameters of type SiteItem

Modifier and Type	Method	Description
protected List<Script>	CrafterPageViewResolver.loadScripts(ScriptFactory scriptFactory, SiteItem page)

Constructors in org.craftercms.engine.view with parameters of type SiteItem

Modifier	Constructor	Description
	CrafterPageView(SiteItem page, Locale locale, String pageViewNameXPathQuery, String mimeTypeXPathQuery, List<Script> scripts, org.springframework.web.servlet.ViewResolver delegatedViewResolver)
	UserAgentAwareCrafterPageView(SiteItem page, Locale locale, String pageViewNameXPathQuery, String mimeTypeXPathQuery, List<Script> scripts, org.springframework.web.servlet.ViewResolver delegatedViewResolver, UserAgentTemplateDetector userAgentTemplateDetector)