Package com.coremedia.blueprint.common.contentbeans

Interface CMNavigation

All Superinterfaces:

com.coremedia.objectserver.dataviews.AssumesIdentity, BelowRootNavigation, CMHasContexts, CMLinkable, CMLocalized, CMObject, CMTeasable, com.coremedia.objectserver.beans.ContentBean, com.coremedia.blueprint.common.feeds.FeedSource<CMLinkable>, HasViewTypeName, Linkable, Navigation, com.coremedia.blueprint.common.datevalidation.ValidityPeriod

All Known Subinterfaces:

CMChannel, CMContext

public interface CMNavigation
extends Navigation, CMTeasable, com.coremedia.blueprint.common.feeds.FeedSource<CMLinkable>

Base type for navigation items.

Represents the document type CMNavigation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHILDREN	Name of the document property 'children'.
static final String	CSS	Name of the document property 'css'.
static final String	FAVICON	Name of the document property 'favicon'.
static final String	HIDDEN	Name of the document property 'hidden'.
static final String	HIDDEN_IN_SITEMAP	Name of the document property 'hiddenInSitemap'.
static final String	JAVA_SCRIPT	Name of the document property 'javaScript'.
static final String	NAME	Name of the ContentType 'CMNavigation'.
static final String	PLACEMENT	Name of the document property 'placement'.
static final String	THEME	Name of the document property 'theme'.

Fields inherited from interface com.coremedia.blueprint.common.contentbeans.CMHasContexts

CONTEXTS

Fields inherited from interface com.coremedia.blueprint.common.contentbeans.CMLinkable

EXTERNALLY_DISPLAYED_DATE, HTML_DESCRIPTION, HTML_TITLE, KEYWORDS, LINKED_SETTINGS, LOCAL_SETTINGS, LOCATION_TAXONOMY, RESOURCE_BUNDLES2, SEGMENT, SUBJECT_TAXONOMY, TITLE, VALID_FROM, VALID_TO, VIEWTYPE

Fields inherited from interface com.coremedia.blueprint.common.contentbeans.CMLocalized

LOCALE, MASTER, MASTER_VERSION

Fields inherited from interface com.coremedia.blueprint.common.contentbeans.CMTeasable

AUTHORS, DETAIL_TEXT, NOT_SEARCHABLE, PICTURES, RELATED, TEASER_OVERLAY_SETTINGS_STRUCT_NAME, TEASER_OVERLAY_SETTINGS_STYLE_SUB_STRUCT_NAME, TEASER_SETTINGS_STRUCT_NAME, TEASER_TEXT, TEASER_TITLE

Fields inherited from interface com.coremedia.objectserver.beans.ContentBean

METADATA_PROPERTIES_PREFIX

Method Summary

Modifier and Type	Method	Description
Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMNavigation>>	getAspectByName()	Deprecated. since 1907.1; Implement optional features as extensions.
List<? extends com.coremedia.cae.aspect.Aspect<? extends CMNavigation>>	getAspects()	Deprecated. since 1907.1; Implement optional features as extensions.
List<CMCSS>	getCss()	Returns the value of the document property CSS.
com.coremedia.cap.common.Blob	getFavicon()	Returns the value of the document property FAVICON.
List<CMJavaScript>	getJavaScript()	Returns the value of the document property JAVA_SCRIPT.
Collection<? extends CMNavigation>	getLocalizations()	Returns the Locale specific variants of this CMLocalized
CMNavigation	getMaster()	Returns the value of the document property CMLocalized.MASTER.
com.coremedia.cap.struct.Struct	getPlacement()	Returns the value of the document property PLACEMENT.
Map<Locale,? extends CMNavigation>	getVariantsByLocale()	Returns the variants of this CMLocalized indexed by their Locale

Methods inherited from interface com.coremedia.objectserver.dataviews.AssumesIdentity

assumeIdentity

Methods inherited from interface com.coremedia.blueprint.common.contentbeans.BelowRootNavigation

getRootNavigations

Methods inherited from interface com.coremedia.blueprint.common.contentbeans.CMLinkable

getContexts, getExternallyDisplayedDate, getHtmlDescription, getHtmlTitle, getKeywords, getLinkedSettings, getLocalSettings, getLocationTaxonomy, getResourceBundles2, getSubjectTaxonomy, getTitle, getValidFrom, getValidTo, getViewtype, isOpenInNewTab

Methods inherited from interface com.coremedia.blueprint.common.contentbeans.CMLocalized

getCountry, getLang, getLocale, getMasterVersion

Methods inherited from interface com.coremedia.blueprint.common.contentbeans.CMObject

getAspectsProvider, getContentId, getUuid

Methods inherited from interface com.coremedia.blueprint.common.contentbeans.CMTeasable

fetchMediaWithRecursionDetection, getAuthors, getCallToActionSettings, getDetailText, getFirstMedia, getMedia, getPicture, getPictures, getRelated, getRelatedAll, getRelatedAllByType, getRelatedByReferrers, getRelatedBySimilarTaxonomies, getRelatedImplicitly, getRelatedImplicitlyByType, getTarget, getTeaserOverlaySettings, getTeaserOverlayStyle, getTeaserSettings, getTeaserText, getTeaserTitle, getTextAsParagraphs, isNotSearchable

Methods inherited from interface com.coremedia.objectserver.beans.ContentBean

getContent, getContentBeanFactory

Methods inherited from interface com.coremedia.blueprint.common.feeds.FeedSource

getFeedDescription, getFeedFormat, getFeedItems, getFeedTitle, getItemsFlattened, getPublishedDate

Methods inherited from interface com.coremedia.blueprint.common.navigation.HasViewTypeName

getViewTypeName

Methods inherited from interface com.coremedia.blueprint.common.navigation.Linkable

getLocale, getSegment

Methods inherited from interface com.coremedia.blueprint.common.navigation.Navigation

getAspectsProvider, getChildren, getCodeResourcesTreeRelation, getContext, getNavigationPathList, getParentNavigation, getRootNavigation, getSitemapChildren, getTheme, getVisibleChildren, isHidden, isHiddenInSitemap, isRoot

Field Details

NAME

static final String NAME

Name of the ContentType 'CMNavigation'.

See Also:

• Constant Field Values

CHILDREN

static final String CHILDREN

Name of the document property 'children'.

See Also:

• Constant Field Values

HIDDEN

static final String HIDDEN

Name of the document property 'hidden'.

See Also:

• Constant Field Values

HIDDEN_IN_SITEMAP

static final String HIDDEN_IN_SITEMAP

Name of the document property 'hiddenInSitemap'.

See Also:

• Constant Field Values

JAVA_SCRIPT

static final String JAVA_SCRIPT

Name of the document property 'javaScript'.

See Also:

• Constant Field Values

CSS

static final String CSS

Name of the document property 'css'.

See Also:

• Constant Field Values

THEME

static final String THEME

Name of the document property 'theme'.

See Also:

• Constant Field Values

FAVICON

static final String FAVICON

Name of the document property 'favicon'.

See Also:

• Constant Field Values

PLACEMENT

static final String PLACEMENT

Name of the document property 'placement'.

See Also:

• Constant Field Values

Method Details

getMaster

CMNavigation getMaster()

Returns the value of the document property CMLocalized.MASTER.

Specified by:

getMaster in interface CMHasContexts

Specified by:

getMaster in interface CMLinkable

Specified by:

getMaster in interface CMLocalized

Specified by:

getMaster in interface CMTeasable

Returns:

a CMNavigation object

getVariantsByLocale

Map<Locale,? extends CMNavigation> getVariantsByLocale()

Description copied from interface: CMLocalized

Returns the variants of this CMLocalized indexed by their Locale

Specified by:

getVariantsByLocale in interface CMHasContexts

Specified by:

getVariantsByLocale in interface CMLinkable

Specified by:

getVariantsByLocale in interface CMLocalized

Specified by:

getVariantsByLocale in interface CMTeasable

Returns:

the variants of this CMLocalized indexed by their Locale

getLocalizations

Collection<? extends CMNavigation> getLocalizations()

Description copied from interface: CMLocalized

Returns the Locale specific variants of this CMLocalized

Usage:

Add elements for each variant excluding self (self is of type Page in this example).

Freemarker:

 <#if (self.content.localizations)?has_content>
   <#assign localizations=self.content.localizations![] />
   <#list localizations as localization>
     <#if localization.locale != self.content.locale>
       <link rel="alternate" ... />
     </#if>
   </#list>
 </#if>
 

JSP:

 <c:set var="locales" value="${self.content.localizations}"/>
 <c:if test="${not empty locales}">
   <c:forEach var="localization" items="${locales}">
     <c:if test="${localization.locale != self.content.locale}">
       <cm:link var="localitationLink" target="${localization}"/>
       <link rel="alternate" ... />
     </c:if>
   </c:forEach>
 </c:if>
 

Specified by:

getLocalizations in interface CMHasContexts

Specified by:

getLocalizations in interface CMLinkable

Specified by:

getLocalizations in interface CMLocalized

Specified by:

getLocalizations in interface CMTeasable

Returns:

the Locale specific variants of this CMLocalized

getAspectByName

@Deprecated
Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMNavigation>> getAspectByName()

Deprecated.

since 1907.1; Implement optional features as extensions.

Description copied from interface: CMObject

Returns a Map from aspectIDs to Aspects. AspectIDs consists of an aspectname with a prefix which identifies the plugin provider.

Usage:

Access an aspect named osmPlugin.

Freemarker:

 <#assign osmSocialPlugin=self.aspectByName['osmPlugin'] />
 

JSP:

 <c:set var="osmSocialPlugin" value="${self.aspectByName['osmPlugin']}"/>
 

Specified by:

getAspectByName in interface CMHasContexts

Specified by:

getAspectByName in interface CMLinkable

Specified by:

getAspectByName in interface CMLocalized

Specified by:

getAspectByName in interface CMObject

Specified by:

getAspectByName in interface CMTeasable

Returns:

a Map from aspectIDs to Aspects

getAspects

@Deprecated
List<? extends com.coremedia.cae.aspect.Aspect<? extends CMNavigation>> getAspects()

Deprecated.

since 1907.1; Implement optional features as extensions.

Description copied from interface: CMObject

Returns a list of all Aspect from all available PlugIns that are registered to this contentbean.

Usage:

Add all aspects with view asHead.

Freemarker:

 <#list self.aspects as aspect>
   <@cm.include self=aspect view="asHeader"/>
 </#list>
 

JSP:

 <c:forEach items="${self.aspects}" var="aspect">
   <cm:include self="${aspect}" view="asHeader"/>
 </c:forEach>
 

Specified by:

getAspects in interface CMHasContexts

Specified by:

getAspects in interface CMLinkable

Specified by:

getAspects in interface CMLocalized

Specified by:

getAspects in interface CMObject

Specified by:

getAspects in interface CMTeasable

Returns:

a list of Aspects

getJavaScript

List<CMJavaScript> getJavaScript()

Returns the value of the document property JAVA_SCRIPT.

Returns:

a list of CMJavaScript objects

getCss

List<CMCSS> getCss()

Returns the value of the document property CSS.

Returns:

a list of CMCSS objects

getFavicon

com.coremedia.cap.common.Blob getFavicon()

Returns the value of the document property FAVICON.

Returns:

the value of the document property FAVICON

getPlacement

com.coremedia.cap.struct.Struct getPlacement()

Returns the value of the document property PLACEMENT.

Returns:

the value of the document property PLACEMENT