Interface AnnotationConfiguration


  • @Role
    public interface AnnotationConfiguration
    The configuration of the Annotations Application for the current wiki.
    Since:
    4.0M2
    Version:
    $Id: 15e1330d6654d9d2b91dfca45c4d86538e9fe102 $
    • Field Detail

      • CONFIGURATION_PAGE_SPACE_NAME

        static final String CONFIGURATION_PAGE_SPACE_NAME
        The configuration page's space name.
        See Also:
        Constant Field Values
    • Method Detail

      • isInstalled

        boolean isInstalled()
        Returns:
        true if the annotations application is installed.
      • isActivated

        boolean isActivated()
        Returns:
        true if the annotations UI is activated, false otherwise.
      • getExceptionSpaces

        List<SpaceReference> getExceptionSpaces()
        Returns:
        the list of spaces where the annotations UI should not be displayed.
      • isDisplayedByDefault

        boolean isDisplayedByDefault()
        Returns:
        true if annotations are displayed by default in the UI.
      • isDisplayedHighlightedByDefault

        boolean isDisplayedHighlightedByDefault()
        Returns:
        true if the annotations should be highlighted by default in the UI.
      • getAnnotationClassReference

        DocumentReference getAnnotationClassReference()
        Returns:
        the reference of the XWiki class defining an annotation's structure.