Class MediaNameConstants


  • @ProviderType
    public final class MediaNameConstants
    extends Object
    Names used for media handling.

    Conventions:

    • NT_ prefix stands for "node type"
    • NN_ prefix stands for "node name"
    • PN_ prefix stands for "property name"
    • RP_ prefix stands for "request property"
    • RA_ prefix stands for "request attribute"
    • CSS_ prefix stands for "CSS class"
    • Field Detail

      • PN_MEDIA_REF

        @NotNull
        public static final @NotNull String PN_MEDIA_REF
        Default property name for reference to media library item (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_REF_STANDARD

        @NotNull
        public static final @NotNull String PN_MEDIA_REF_STANDARD
        Default property name for reference to media library item (Adobe/Core Component standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_CROP

        @NotNull
        public static final @NotNull String PN_MEDIA_CROP
        Default property name for cropping parameters (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_CROP_STANDARD

        @NotNull
        public static final @NotNull String PN_MEDIA_CROP_STANDARD
        Default property name for cropping parameters (Adobe/Core Component standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_ROTATION

        @NotNull
        public static final @NotNull String PN_MEDIA_ROTATION
        Default property name for rotate parameter (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_ROTATION_STANDARD

        @NotNull
        public static final @NotNull String PN_MEDIA_ROTATION_STANDARD
        Default property name for rotate parameter (Adobe/Core Component standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_MAP

        @NotNull
        public static final @NotNull String PN_MEDIA_MAP
        Default property name for map parameter (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_MAP_STANDARD

        @NotNull
        public static final @NotNull String PN_MEDIA_MAP_STANDARD
        Default property name for map parameter (Adobe/Core Component standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_ALTTEXT

        @NotNull
        public static final @NotNull String PN_MEDIA_ALTTEXT
        Default property name for media alt. text (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values
      • PN_MEDIA_ALTTEXT_STANDARD

        @NotNull
        public static final @NotNull String PN_MEDIA_ALTTEXT_STANDARD
        Default property name for media alt. text (Adobe/Core Component standard)
        See Also:
        Constant Field Values
      • NN_MEDIA_INLINE

        @NotNull
        public static final @NotNull String NN_MEDIA_INLINE
        Default node name for inline media item stored in node within the content page (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values
      • NN_MEDIA_INLINE_STANDARD

        @NotNull
        public static final @NotNull String NN_MEDIA_INLINE_STANDARD
        Default node name for inline media item stored in node within the content page (Adobe/Core Component standard)
        See Also:
        Constant Field Values
      • PN_FLASH_VARS

        @Deprecated
        @NotNull
        public static final @NotNull String PN_FLASH_VARS
        Deprecated.
        Flash support is deprecated
        Default property name for flash variables
        See Also:
        Constant Field Values
      • CSS_DUMMYIMAGE

        @NotNull
        public static final @NotNull String CSS_DUMMYIMAGE
        CSS class for dummy image
        See Also:
        Constant Field Values
      • CSS_DIFF_ADDED

        @NotNull
        public static final @NotNull String CSS_DIFF_ADDED
        CSS class for "Added in Diff Mode"
        See Also:
        Constant Field Values
      • CSS_DIFF_UPDATED

        @NotNull
        public static final @NotNull String CSS_DIFF_UPDATED
        CSS class for "Updated in Diff Mode"
        See Also:
        Constant Field Values
      • CSS_DIFF_REMOVED

        @NotNull
        public static final @NotNull String CSS_DIFF_REMOVED
        CSS class for "Removed in Diff Mode"
        See Also:
        Constant Field Values
      • PROP_BREAKPOINT

        @Deprecated
        @NotNull
        public static final @NotNull String PROP_BREAKPOINT
        Deprecated.
        This is used only for the "legacy mode" of responsive image handling.
        Property name for responsive breakpoint (mq)
        See Also:
        Constant Field Values
      • PROP_CSS_CLASS

        @NotNull
        public static final @NotNull String PROP_CSS_CLASS
        Property name for setting additional CSS classes
        See Also:
        Constant Field Values
      • PN_COMPONENT_MEDIA_AUTOCROP

        @NotNull
        public static final @NotNull String PN_COMPONENT_MEDIA_AUTOCROP
        Enable "auto-cropping" mode for this component by setting to true.

        Property is to be set on component or in policy.

        See Also:
        Constant Field Values
      • PN_COMPONENT_MEDIA_FORMATS

        @NotNull
        public static final @NotNull String PN_COMPONENT_MEDIA_FORMATS
        List of media format names accepted by this component.

        Property is to be set on component or in policy.

        See Also:
        Constant Field Values
      • PN_COMPONENT_MEDIA_FORMATS_MANDATORY

        @NotNull
        public static final @NotNull String PN_COMPONENT_MEDIA_FORMATS_MANDATORY
        Resolving of all media formats is mandatory. This can be a single boolean, or a boolean array where each entry matches with the media format name defined in PN_COMPONENT_MEDIA_FORMATS.

        Property is to be set on component or in policy.

        See Also:
        Constant Field Values
      • PN_COMPONENT_MEDIA_FORMATS_MANDATORY_NAMES

        @NotNull
        public static final @NotNull String PN_COMPONENT_MEDIA_FORMATS_MANDATORY_NAMES
        List of media format names that are mandatory. The list of names is merged with the list of names defined in PN_COMPONENT_MEDIA_FORMATS, but all formats defined in this property ad defined as mandatory.

        Property is to be set on component or in policy.

        See Also:
        Constant Field Values
      • PN_COMPONENT_MEDIA_RESPONSIVE_TYPE

        @NotNull
        public static final @NotNull String PN_COMPONENT_MEDIA_RESPONSIVE_TYPE
        If multiple responsive image settings are defined, this property defines which gets active. Possible values: none, imageSizes, pictureSources

        Property is to be set on component or in policy.

        See Also:
        Constant Field Values
      • NN_COMPONENT_MEDIA_RESPONSIVEIMAGE_SIZES

        @NotNull
        public static final @NotNull String NN_COMPONENT_MEDIA_RESPONSIVEIMAGE_SIZES
        Defines "image sizes" responsive image setting. Contains properties sizes, widths.

        Child node is to be defined on component or in policy.

        See Also:
        Constant Field Values
      • NN_COMPONENT_MEDIA_RESPONSIVEPICTURE_SOURCES

        @NotNull
        public static final @NotNull String NN_COMPONENT_MEDIA_RESPONSIVEPICTURE_SOURCES
        Defines "picture sources" responsive image setting. Contains child nodes for each source definition with properties mediaFormat, media, widths.

        Child node is to be defined on component or in policy.

        See Also:
        Constant Field Values
      • NN_COMPONENT_MEDIA_RESPONSIVE_PICTURE_SOURCES

        @Deprecated
        @NotNull
        public static final @NotNull String NN_COMPONENT_MEDIA_RESPONSIVE_PICTURE_SOURCES
        Defines "picture sources" responsive image setting. Contains child nodes for each source definition with properties mediaFormat, media, widths.

        Child node is to be defined on component or in policy.

        See Also:
        Constant Field Values
      • MEDIAFORMAT_PROP_PARENT_MEDIA_FORMAT

        public static final String MEDIAFORMAT_PROP_PARENT_MEDIA_FORMAT
        Media format property name for the parent media format. Parent media format is the original media format that is used to generate a width-based sub-media-format for responsive images.
        See Also:
        Constant Field Values