Package org.xwiki.rendering.macro.display

Class DisplayMacroParameters

  • public class DisplayMacroParameters
extends Object
    Parameters for the DisplayMacro Macro.
    Since:
    3.4M1
    Version:
    $Id: 60379451aab8c92d2b76da7cd9951e9726c66702 $

    • Constructor Detail

      • DisplayMacroParameters

        public DisplayMacroParameters()

    • Method Detail

      • setReference

        public void setReference​(String reference)
        Parameters:
        reference - the reference to display
        Since:
        3.4M1

      • getReference

        public String getReference()
        Returns:
        the reference of the resource to display
        Since:
        3.4M1

      • getType

        public EntityType getType()
        Returns:
        the type of the reference
        Since:
        3.4M1

      • setType

        public void setType​(EntityType type)
        Parameters:
        type - the type of the reference
        Since:
        3.4M1

      • setSection

        public void setSection​(String sectionId)
        Parameters:
        sectionId - see getSection()

      • getSection

        public String getSection()
        Returns:
        the optional id of a section to include in the referenced document. If not specified the whole document is included.

      • setExcludeFirstHeading

        public void setExcludeFirstHeading​(boolean excludeFirstHeading)
        Parameters:
        excludeFirstHeading - true to remove the first heading found inside the document or the section, false to keep it
        Since:
        12.4RC1

      • isExcludeFirstHeading

        public boolean isExcludeFirstHeading()
        Returns:
        whether to exclude the first heading from the displayed document or section, or not.
        Since:
        12.4RC1

      • setPage

        public void setPage​(String page)
        Parameters:
        page - the reference of the page to display
        Since:
        10.6RC1