Class SAIDElementsCustomizer


  • @API(type=INTERNAL,
         src=PUBLIC)
    public class SAIDElementsCustomizer
    extends java.lang.Object
    Customize the list of elements for auto ID generation. It is used on standalone implementation.
    • Constructor Detail

      • SAIDElementsCustomizer

        public SAIDElementsCustomizer()
    • Method Detail

      • customizeIDElements

        public GenerateIDElementsInfo customizeIDElements​(AuthorAccess authorAccess,
                                                          GenerateIDElementsInfo autoIDElementsInfo,
                                                          java.lang.String listMessage)
        Ask the user to customize the ID elements.
        Parameters:
        authorAccess - Access to author functionality.
        autoIDElementsInfo - Information about for what elements should IDs be generated.
        listMessage - The label used on the dialog before the list
        Returns:
        The initial list of elements for which to generate IDs.
      • customizeIDElements

        public GenerateIDElementsInfo customizeIDElements​(AuthorAccess authorAccess,
                                                          GenerateIDElementsInfo autoIDElementsInfo,
                                                          java.lang.String listMessage,
                                                          java.lang.String helpPageID)
        Ask the user to customize the ID elements.
        Parameters:
        authorAccess - Access to author functionality.
        autoIDElementsInfo - Information about for what elements should IDs be generated.
        listMessage - The label used on the dialog before the list
        helpPageID - The ID of the help page which will be opened when users invoke help in the dialog.
        Returns:
        The initial list of elements for which to generate IDs.
      • customizeIDElements

        public GenerateIDElementsInfo customizeIDElements​(AuthorAccess authorAccess,
                                                          GenerateIDElementsInfo autoIDElementsInfo,
                                                          java.lang.String listMessage,
                                                          java.lang.String helpPageID,
                                                          boolean isDocBook)
        Ask the user to customize the ID elements.
        Parameters:
        authorAccess - Access to author functionality.
        autoIDElementsInfo - Information about for what elements should IDs be generated.
        listMessage - The label used on the dialog before the list
        helpPageID - The ID of the help page which will be opened when users invoke help in the dialog.
        isDocBook - true if we are in DocBook.
        Returns:
        The initial list of elements for which to generate IDs.