Package com.coremedia.blueprint.common.contentbeans

Interface CMImage

All Superinterfaces:
com.coremedia.objectserver.dataviews.AssumesIdentity, CMLocalized, CMObject, com.coremedia.objectserver.beans.ContentBean
public interface CMImage extends CMLocalized

A technical image, e.g. for usage in stylesheets.

Not for editorial usage. Use CMPicture instead. In order to avoid confusion, you should withdraw all rights on doctype CMImage from ordinary editors.

Represents the document type CMImage.

  • Field Details

  • Method Details

    • getMaster

      CMImage getMaster()
      Returns the value of the document property CMLocalized.MASTER.
      Specified by:
      getMaster in interface CMLocalized
      Returns:
      a list of CMImage object

    • getVariantsByLocale

      Map<Locale,? extends CMImage> getVariantsByLocale()
      Description copied from interface: CMLocalized
      Returns the variants of this CMLocalized indexed by their Locale
      Specified by:
      getVariantsByLocale in interface CMLocalized
      Returns:
      the variants of this CMLocalized indexed by their Locale

    • getLocalizations

      Collection<? extends CMImage> 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 CMLocalized
      Returns:
      the Locale specific variants of this CMLocalized

    • getAspectByName

      @Deprecated Map<String,? extends com.coremedia.cae.aspect.Aspect<? extends CMImage>> 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 CMLocalized
      Specified by:
      getAspectByName in interface CMObject
      Returns:
      a Map from aspectIDs to Aspects

    • getAspects

      @Deprecated List<? extends com.coremedia.cae.aspect.Aspect<? extends CMImage>> 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 CMLocalized
      Specified by:
      getAspects in interface CMObject
      Returns:
      a list of Aspects

    • getData

      com.coremedia.cap.common.Blob getData()
      Returns the value of the document property DATA.
      Returns:
      the value of the document property DATA

    • getDescription

      String getDescription()
      Returns the value of the document property DESCRIPTION.
      Returns:
      the value of the document property DESCRIPTION