Package com.coremedia.blueprint.common.contentbeans

Interface CMHTML

All Superinterfaces:

com.coremedia.objectserver.dataviews.AssumesIdentity, BelowRootNavigation, CMHasContexts, CMLinkable, CMLocalized, CMMedia, CMObject, CMTeasable, com.coremedia.objectserver.beans.ContentBean, HasViewTypeName, Linkable, com.coremedia.blueprint.common.datevalidation.ValidityPeriod

public interface CMHTML
extends CMMedia

CMHTML beans represent static HTML code.

Should be used only if the concrete code snippet is given by an other party, e.g. embedding of external ADs. Your own HTML code should of course be modeled by templates.

Represents the document type CMHTML.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION	Name of the document property 'description'.
static final String	NAME	Name of the ContentType 'CMHTML'.

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.CMMedia

ALT, CAPTION, COPYRIGHT, DATA

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 CMHTML>>	getAspectByName()	Deprecated. since 1907.1; Implement optional features as extensions.
List<? extends com.coremedia.cae.aspect.Aspect<? extends CMHTML>>	getAspects()	Deprecated. since 1907.1; Implement optional features as extensions.
com.coremedia.xml.Markup	getData()	Returns the value of the document property CMMedia.DATA.
String	getDescription()	Returns the value of the document property DESCRIPTION.
Collection<? extends CMHTML>	getLocalizations()	Returns the Locale specific variants of this CMLocalized
CMHTML	getMaster()	Returns the value of the document property CMLocalized.MASTER.
Map<Locale,? extends CMHTML>	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.CMMedia

getAlt, getCaption, getCopyright, getDisableCropping, getTransformedData, getTransformMap

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.navigation.HasViewTypeName

getViewTypeName

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

getLocale, getSegment

Field Details

NAME

static final String NAME

Name of the ContentType 'CMHTML'.

See Also:

• Constant Field Values

DESCRIPTION

static final String DESCRIPTION

Name of the document property 'description'.

See Also:

• Constant Field Values

Method Details

getMaster

CMHTML 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 CMMedia

Specified by:

getMaster in interface CMTeasable

Returns:

a list of CMHTML object

getVariantsByLocale

Map<Locale,? extends CMHTML> 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 CMMedia

Specified by:

getVariantsByLocale in interface CMTeasable

Returns:

the variants of this CMLocalized indexed by their Locale

getLocalizations

Collection<? extends CMHTML> 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 CMMedia

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 CMHTML>> 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 CMMedia

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 CMHTML>> 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 CMMedia

Specified by:

getAspects in interface CMObject

Specified by:

getAspects in interface CMTeasable

Returns:

a list of Aspects

getDescription

String getDescription()

Returns the value of the document property DESCRIPTION.

Returns:

the value of the document property DESCRIPTION

getData

com.coremedia.xml.Markup getData()

Returns the value of the document property CMMedia.DATA.

Specified by:

getData in interface CMMedia

Returns:

the value of the document property CMMedia.DATA