Interface TemplateCustomization

    • Method Detail

      • getTocTitle

        String getTocTitle()
        Returns the 'Table of Contents' section title.
        Since:
        0.4.0
      • isIncludeUnknownGroup

        boolean isIncludeUnknownGroup()
        If the unknown group should be included or not in the final rendered document or not.
        Since:
        0.3.0
      • getUnknownGroupLocalization

        String getUnknownGroupLocalization()
        Returns the title for the unknown group.
        Since:
        0.4.0
      • isIncludeEnvFormat

        boolean isIncludeEnvFormat()
        If the properties should be converted to their environment variable representation to have a quicker way to copy and paste them.
        Since:
        0.4.0
      • isIncludeGenerationDate

        boolean isIncludeGenerationDate()
        If the generation date should be rendered into the document or not.
        Since:
        0.4.0
      • isRemoveEmptyGroups

        boolean isRemoveEmptyGroups()
        If empty groups must be removed from the final document or not.
        Since:
        0.4.0
      • getLocale

        String getLocale()
        Returns the set locale.
        Since:
        0.4.0
      • getContentCustomization

        @NonNull
        ContentCustomization getContentCustomization()
        Returns the template content customization.
        Since:
        0.6.0
      • setContentCustomization

        void setContentCustomization​(@NonNull
                                     ContentCustomization contentCustomization)
        Sets the template content customization.
        Since:
        0.6.0
      • getTemplateMode

        TemplateMode getTemplateMode()
        Controls if the template should be rendered in compact mode or not.

        By default, for backward compatibility the compact mode is turned off.

        Since:
        0.6.0
      • setTemplateMode

        void setTemplateMode​(TemplateMode templateMode)
        Sets the template mode.
        Since:
        0.6.0