Package io.wcm.handler.media

Class MediaNameConstants

  • @ProviderType
public final class MediaNameConstants
extends java.lang.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

      • NT_MEDIAFORMAT

        public static final java.lang.String NT_MEDIAFORMAT
        Media format node type
        See Also:
        Constant Field Values

      • PN_MEDIA_SOURCE

        public static final java.lang.String PN_MEDIA_SOURCE
        Media source
        See Also:
        Constant Field Values

      • PN_MEDIA_REF

        public static final java.lang.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

        public static final java.lang.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

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

      • PN_MEDIA_CROP_STANDARD

        public static final java.lang.String PN_MEDIA_CROP_STANDARD
        Default property name for cropping parameters (Adobe/Core Component standard)
        See Also:
        Constant Field Values

      • PN_MEDIA_ROTATION

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

      • PN_MEDIA_ROTATION_STANDARD

        public static final java.lang.String PN_MEDIA_ROTATION_STANDARD
        Default property name for rotate parameter (Adobe/Core Component standard)
        See Also:
        Constant Field Values

      • PN_MEDIA_MAP

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

      • PN_MEDIA_MAP_STANDARD

        public static final java.lang.String PN_MEDIA_MAP_STANDARD
        Default property name for map parameter (Adobe/Core Component standard)
        See Also:
        Constant Field Values

      • PN_MEDIA_ALTTEXT

        public static final java.lang.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

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

      • PN_MEDIA_FORCE_ALTTEXT_FROM_ASSET

        public static final java.lang.String PN_MEDIA_FORCE_ALTTEXT_FROM_ASSET
        Default property name for forcing reading alt. text from DAM asset description (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values

      • PN_MEDIA_FORCE_ALTTEXT_FROM_ASSET_STANDARD

        public static final java.lang.String PN_MEDIA_FORCE_ALTTEXT_FROM_ASSET_STANDARD
        Default property name for forcing reading alt. text from DAM asset description (Adobe/Core Component standard)
        See Also:
        Constant Field Values

      • PN_MEDIA_IS_DECORATIVE

        public static final java.lang.String PN_MEDIA_IS_DECORATIVE
        Default property name for marking image as "decorative" - requiring no alt. text (Legacy wcm.io Handler Standard)
        See Also:
        Constant Field Values

      • PN_MEDIA_IS_DECORATIVE_STANDARD

        public static final java.lang.String PN_MEDIA_IS_DECORATIVE_STANDARD
        Default property name for marking image as "decorative" - requiring no alt. text (Adobe/Core Component standard)
        See Also:
        Constant Field Values

      • NN_MEDIA_INLINE

        public static final java.lang.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

        public static final java.lang.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

      • CSS_DUMMYIMAGE

        public static final java.lang.String CSS_DUMMYIMAGE
        CSS class for dummy image
        See Also:
        Constant Field Values

      • CSS_DIFF_ADDED

        public static final java.lang.String CSS_DIFF_ADDED
        CSS class for "Added in Diff Mode"
        See Also:
        Constant Field Values

      • CSS_DIFF_UPDATED

        public static final java.lang.String CSS_DIFF_UPDATED
        CSS class for "Updated in Diff Mode"
        See Also:
        Constant Field Values

      • CSS_DIFF_REMOVED

        public static final java.lang.String CSS_DIFF_REMOVED
        CSS class for "Removed in Diff Mode"
        See Also:
        Constant Field Values

      • PROP_CSS_CLASS

        public static final java.lang.String PROP_CSS_CLASS
        Property name for setting additional CSS classes
        See Also:
        Constant Field Values

      • PN_COMPONENT_MEDIA_AUTOCROP

        public static final java.lang.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

        public static final java.lang.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

        public static final java.lang.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

        public static final java.lang.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

        public static final java.lang.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

        public static final java.lang.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

        public static final java.lang.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

      • MEDIAFORMAT_PROP_PARENT_MEDIA_FORMAT

        public static final java.lang.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

      • URI_TEMPLATE_PLACEHOLDER_WIDTH

        public static final java.lang.String URI_TEMPLATE_PLACEHOLDER_WIDTH
        URI template placeholder for width.
        See Also:
        Constant Field Values

      • URI_TEMPLATE_PLACEHOLDER_HEIGHT

        public static final java.lang.String URI_TEMPLATE_PLACEHOLDER_HEIGHT
        URI template placeholder for height.
        See Also:
        Constant Field Values