Interface ThumbnailConfig

  • All Known Implementing Classes:
    ThumbnailConfigImpl

    public interface ThumbnailConfig
    This interface specifies the accessors for a thumbnail configuration.
    Since:
    CQ 5.4.0
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String PN_DOCENTER
      Name of the configuration property for whether the thumbnail shall be rendered centered or not.
      static java.lang.String PN_HEIGHT
      Name of the configuration property for the thumbnail's height.
      static java.lang.String PN_WIDTH
      Name of the configuration property for the thumbnail's width.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean doCenter()
      Returns whether this thumbnail is rendered centered.
      int getHeight()
      Retrieves the height in pixels for a thumbnail.
      int getWidth()
      Retrieves the width in pixels for a thumbnail.
    • Field Detail

      • PN_WIDTH

        static final java.lang.String PN_WIDTH
        Name of the configuration property for the thumbnail's width.
        See Also:
        Constant Field Values
      • PN_HEIGHT

        static final java.lang.String PN_HEIGHT
        Name of the configuration property for the thumbnail's height.
        See Also:
        Constant Field Values
      • PN_DOCENTER

        static final java.lang.String PN_DOCENTER
        Name of the configuration property for whether the thumbnail shall be rendered centered or not.
        See Also:
        Constant Field Values
    • Method Detail

      • getWidth

        int getWidth()
        Retrieves the width in pixels for a thumbnail.
        Returns:
        The width of the thumbnail.
      • getHeight

        int getHeight()
        Retrieves the height in pixels for a thumbnail.
        Returns:
        The height of the thumbnail.
      • doCenter

        boolean doCenter()
        Returns whether this thumbnail is rendered centered.
        Returns:
        true if the thumbnail is rendered centered.