Package org.silverpeas.components.gallery.constant

Enum Class MediaResolution

java.lang.Object
java.lang.Enum<MediaResolution>
org.silverpeas.components.gallery.constant.MediaResolution
All Implemented Interfaces:
Serializable, Comparable<MediaResolution>, Constable
public enum MediaResolution extends Enum<MediaResolution>
Author:
Yohann Chastagnier

  • Enum Constant Details

  • Field Details

  • Method Details

    • values

      public static MediaResolution[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MediaResolution valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromNameOrLabel

      public static MediaResolution fromNameOrLabel(String nameOrLabel)

    • getName

      public String getName()

    • isDisplayed

      public boolean isDisplayed()
      Indicates if the definition can be displayed to the user.
      Returns:
      true if the definition can be displayed, false otherwise.

    • getLabel

      public String getLabel()

    • getWidth

      public Integer getWidth()

    • getHeight

      public Integer getHeight()

    • getThumbnailSuffix

      public String getThumbnailSuffix()

    • isWatermarkApplicable

      public boolean isWatermarkApplicable()

    • getWatermarkSize

      public Integer getWatermarkSize()
      Gets the size of the watermark to apply to a media of this resolution. The settings are read on demand and not once for all at the initialization of this enumeration: the resources of Silverpeas aren't necessarily available when the class is loaded (this is the case for example when the class is loaded by a documentation or a code analysis tool).
      Returns:
      the size of the watermark or null if no watermark is applicable.

    • isTiny

      public boolean isTiny()

    • isSmall

      public boolean isSmall()

    • isMedium

      public boolean isMedium()

    • isLarge

      public boolean isLarge()

    • isPreview

      public boolean isPreview()

    • isWatermark

      public boolean isWatermark()