io.wcm.handler.media.MediaNameConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.wcm.handler.media Show documentation
Media resolving, processing and markup generation.
There is a newer version: 2.3.0
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package io.wcm.handler.media;

import org.osgi.annotation.versioning.ProviderType;

/**
 * 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"
 * 
 */
@ProviderType
public final class MediaNameConstants {

  private MediaNameConstants() {
    // holds constants only
  }

  /**
   * Media format node type
   */
  public static final String NT_MEDIAFORMAT = "wcmio:MediaFormat";

  /**
   * Media source
   */
  public static final String PN_MEDIA_SOURCE = "mediaSource";

  /**
   * Default property name for reference to media library item
   */
  public static final String PN_MEDIA_REF = "mediaRef";

  /**
   * Default property name for cropping paraemters
   */
  public static final String PN_MEDIA_CROP = "mediaCrop";

  /**
   * Default node name for inline media item stored in node within the content page
   */
  public static final String NN_MEDIA_INLINE = "mediaInline";

  /**
   * Default property name for media alt. text
   */
  public static final String PN_MEDIA_ALTTEXT = "mediaAltText";

  /**
   * Default property name for flash variables
   */
  public static final String PN_FLASH_VARS = "flashVars";

  /**
   * CSS class for dummy image
   */
  public static final String CSS_DUMMYIMAGE = "wcmio_mediahandler_wcm_dummy";

  /**
   * CSS class for "Added in Diff Mode"
   */
  public static final String CSS_DIFF_ADDED = "wcmio_mediahandler_wcm_diff_added";

  /**
   * CSS class for "Updated in Diff Mode"
   */
  public static final String CSS_DIFF_UPDATED = "wcmio_mediahandler_wcm_diff_updated";

  /**
   * CSS class for "Removed in Diff Mode"
   */
  public static final String CSS_DIFF_REMOVED = "wcmio_mediahandler_wcm_diff_removed";

  /**
   * Property name for responsive breakpoint (mq)
   */
  public static final String PROP_BREAKPOINT = "mq";

  /**
   * Property name for setting additional CSS classes
   */
  public static final String PROP_CSS_CLASS = "cssClass";

}