Interface ImageStyleConfiguration


  • @Role
    @Unstable
    public interface ImageStyleConfiguration
    Give access to the image style configuration.
    Since:
    14.3RC1
    Version:
    $Id: d0b7188473b38b3a33faaec960ec0f5c019b666c $
    • Method Detail

      • getDefaultStyle

        String getDefaultStyle​(String wikiName,
                               String documentReference)
                        throws ImageStyleException
        Resolve the default style for a given wiki and, optionally a given document.
        Parameters:
        wikiName - the name of the wiki (e.g., "xwiki")
        documentReference - the reference of the document for which we want to get the default style, ignored when null
        Returns:
        the identifier of the default image style (the empty string by default, i.e. no default image style)
        Throws:
        ImageStyleException
      • getForceDefaultStyle

        @Unstable
        default boolean getForceDefaultStyle​(String wikiName,
                                             String documentReference)
                                      throws ImageStyleException
        Resolve the force default style for a given wiki and, optionally a given document.
        Parameters:
        wikiName - the name of the wiki (e.g., "xwiki")
        documentReference - the reference of the document for which we want to get the default style, ignored when null
        Returns:
        the value of the force default style configuration option
        Throws:
        ImageStyleException
        Since:
        14.10.16, 15.5.2, 15.8RC1