Package org.xwiki.rendering.macro.descriptor

Interface ParameterDescriptor

  • All Known Implementing Classes:
    DefaultParameterDescriptor
    public interface ParameterDescriptor
    Define a macro parameter.
    Since:
    1.7M2
    Version:
    $Id: f1420bad4ad90aabf18ff0908dc4138e3885c62b $

    • Method Detail

      • getId

        String getId()
        Returns:
        the identifier of the parameter.
        Since:
        2.1M1

      • getName

        String getName()
        Returns:
        the display name of the parameter.
        Since:
        2.1M1

      • getDescription

        String getDescription()
        Returns:
        the description of the parameter.

      • getParameterType

        Type getParameterType()
        Returns:
        the type of the property.
        Since:
        3.0M1

      • getDefaultValue

        Object getDefaultValue()
        Returns:
        the default value of the parameter.

      • isMandatory

        boolean isMandatory()
        Returns:
        indicate if the parameter is mandatory.
        Since:
        1.7

      • isDeprecated

        default boolean isDeprecated()
        Returns:
        indicate if the parameter is deprecated.
        Since:
        10.10RC1

      • isAdvanced

        default boolean isAdvanced()
        Returns:
        indicate if the parameter is advanced.
        Since:
        10.10RC1

      • getGroupDescriptor

        default org.xwiki.properties.PropertyGroupDescriptor getGroupDescriptor()
        Returns:
        a hierarchy of groups and its associated feature.
        Since:
        10.11RC1

      • getDisplayType

        default Type getDisplayType()
        Returns:
        the type used to display the property.
        Since:
        11.0

      • isDisplayHidden

        default boolean isDisplayHidden()
        Returns:
        whether the parameter should be displayed in UIs or not. For example the WYSIWYG editor uses it to decide whether to display it or not in the Macro editor UI.
        Since:
        12.4RC1