Package org.xwiki.image.style.model

Class ImageStyle

  • @Unstable
public class ImageStyle
extends Object
    The image style POJO. Contains the list of all the configurable properties of an image style.
    Since:
    14.3RC1
    Version:
    $Id: 99a58eae61d6eccafbdc85493debfdf4314f21bc $

    • Constructor Detail

      • ImageStyle

        public ImageStyle()

    • Method Detail

      • getIdentifier

        public String getIdentifier()
        Returns:
        the unique identifier of the style (e.g., "thumbnail")

      • setIdentifier

        public ImageStyle setIdentifier​(String identifier)
        Parameters:
        identifier - the unique identifier of the style (e.g., "thumbnail")
        Returns:
        the current object

      • getPrettyName

        public String getPrettyName()
        Returns:
        the pretty name of the style (e.g., "Thumbnail")

      • setPrettyName

        public ImageStyle setPrettyName​(String prettyName)
        Parameters:
        prettyName - the pretty name of the style (e.g., "Thumbnail")
        Returns:
        the current object

      • getType

        public String getType()
        Returns:
        the type of the style (e.g., "thumbnail-style")

      • setType

        public ImageStyle setType​(String type)
        Parameters:
        type - the type of the style (e.g., "thumbnail-style")
        Returns:
        the current object

      • getAdjustableSize

        public Boolean getAdjustableSize()
        Returns:
        true if the style allows user to adjust the size of the image, false otherwise

      • setAdjustableSize

        public ImageStyle setAdjustableSize​(Boolean adjustableSize)
        Parameters:
        adjustableSize - true if the style allows user to adjust the size of the image, false otherwise
        Returns:
        the current object

      • getDefaultWidth

        public Long getDefaultWidth()
        Returns:
        the default image width size in pixels, or null if undefined

      • setDefaultWidth

        public ImageStyle setDefaultWidth​(Long defaultWidth)
        Parameters:
        defaultWidth - the default image width size in pixels, or null if undefined
        Returns:
        the current object

      • getDefaultHeight

        public Long getDefaultHeight()
        Returns:
        the default image height size in pixels, or null if undefined

      • setDefaultHeight

        public ImageStyle setDefaultHeight​(Long defaultHeight)
        Parameters:
        defaultHeight - the default image height size in pixels, or null if undefined
        Returns:
        the current object

      • getAdjustableBorder

        public Boolean getAdjustableBorder()
        Returns:
        true if the style allows user to adjust the border configuration of the image, false otherwise

      • setAdjustableBorder

        public ImageStyle setAdjustableBorder​(Boolean adjustableBorder)
        Parameters:
        adjustableBorder - true if the style allows user to adjust the border configuration of the image, false
        Returns:
        the current object

      • getDefaultBorder

        public Boolean getDefaultBorder()
        Returns:
        true when the image has a border, false otherwise

      • setDefaultBorder

        public ImageStyle setDefaultBorder​(Boolean defaultBorder)
        Parameters:
        defaultBorder - true when the image has a border, false otherwise
        Returns:
        the current object

      • getAdjustableAlignment

        public Boolean getAdjustableAlignment()
        Returns:
        true when the alignment is adjustable, false otherwise

      • setAdjustableAlignment

        public ImageStyle setAdjustableAlignment​(Boolean adjustableAlignment)
        Parameters:
        adjustableAlignment - true when the alignment is adjustable, false otherwise
        Returns:
        the current object

      • getDefaultAlignment

        public String getDefaultAlignment()
        Returns:
        the default alignment of the image, null if undefined

      • setDefaultAlignment

        public ImageStyle setDefaultAlignment​(String defaultAlignment)
        Parameters:
        defaultAlignment - the default alignment of the image, null if undefined
        Returns:
        the current object

      • getAdjustableTextWrap

        public Boolean getAdjustableTextWrap()
        Returns:
        true if the text wrap is adjustable, false otherwise

      • setAdjustableTextWrap

        public ImageStyle setAdjustableTextWrap​(Boolean adjustableTextWrap)
        Parameters:
        adjustableTextWrap - true if the text wrap is adjustable, false otherwise
        Returns:
        the current object

      • getDefaultTextWrap

        public Boolean getDefaultTextWrap()
        Returns:
        the default text wrap configuration, null if undefined

      • setDefaultTextWrap

        public ImageStyle setDefaultTextWrap​(Boolean defaultTextWrap)
        Parameters:
        defaultTextWrap - the default text wrap configuration, null if undefined
        Returns:
        the current object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object