Package ro.sync.ecss.extensions.commons.id

Class SAIDElementsCustomizer

java.lang.Object

ro.sync.ecss.extensions.commons.id.SAIDElementsCustomizer

@API(type=INTERNAL,
     src=PUBLIC)
public class SAIDElementsCustomizer
extends Object

Customize the list of elements for auto ID generation. It is used on standalone implementation.

Constructor Summary

Constructors

Constructor	Description
SAIDElementsCustomizer()

Method Summary

Modifier and Type	Method	Description
GenerateIDElementsInfo	customizeIDElements(AuthorAccess authorAccess, GenerateIDElementsInfo autoIDElementsInfo, String listMessage)	Ask the user to customize the ID elements.
GenerateIDElementsInfo	customizeIDElements(AuthorAccess authorAccess, GenerateIDElementsInfo autoIDElementsInfo, String listMessage, String helpPageID)	Ask the user to customize the ID elements.
GenerateIDElementsInfo	customizeIDElements(AuthorAccess authorAccess, GenerateIDElementsInfo autoIDElementsInfo, String listMessage, String helpPageID, boolean isDocBook)	Ask the user to customize the ID elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SAIDElementsCustomizer

public SAIDElementsCustomizer()

Method Details

customizeIDElements

public GenerateIDElementsInfo customizeIDElements(AuthorAccess authorAccess,
 GenerateIDElementsInfo autoIDElementsInfo,
 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,
 String listMessage,
 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,
 String listMessage,
 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.