Oxygen XML Editor 11.2 Author API

ro.sync.ecss.extensions.dita.id
Class DITAUniqueAttributesRecognizer

java.lang.Object
  extended by ro.sync.ecss.extensions.commons.id.DefaultUniqueAttributesRecognizer
      extended by ro.sync.ecss.extensions.dita.id.DITAUniqueAttributesRecognizer
All Implemented Interfaces:
AuthorExtensionStateListener, Extension, UniqueAttributesRecognizer

public class DITAUniqueAttributesRecognizer
extends DefaultUniqueAttributesRecognizer

Unique attributes recognizer for DITA.


Field Summary
static GenerateIDElementsInfo GENERATE_ID_DEFAULTS
          List of elements for which to generate IDs, comma separated
 
Fields inherited from class ro.sync.ecss.extensions.commons.id.DefaultUniqueAttributesRecognizer
authorAccess, idAttrQname
 
Constructor Summary
DITAUniqueAttributesRecognizer()
          Constructor
 
Method Summary
 boolean copyAttributeOnSplit(String attrQName, AuthorElement element)
          Check if the attribute specified by QName can be considered as a valid attribute to copy when the element is split.
protected  GenerateIDElementsInfo getDefaultOptions()
           
 String getDescription()
           
protected  String getGenerateIDAttributeQName(AuthorElement element, String[] elemsWithAutoGeneration, boolean forceGeneration)
           
 
Methods inherited from class ro.sync.ecss.extensions.commons.id.DefaultUniqueAttributesRecognizer
activated, assignUniqueIDs, deactivated, generateUniqueIDFor, getGenerateIDElementsInfo, isAutoIDGenerationActive
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GENERATE_ID_DEFAULTS

public static GenerateIDElementsInfo GENERATE_ID_DEFAULTS
List of elements for which to generate IDs, comma separated

Constructor Detail

DITAUniqueAttributesRecognizer

public DITAUniqueAttributesRecognizer()
Constructor

Method Detail

copyAttributeOnSplit

public boolean copyAttributeOnSplit(String attrQName,
                                    AuthorElement element)
Description copied from interface: UniqueAttributesRecognizer
Check if the attribute specified by QName can be considered as a valid attribute to copy when the element is split.

Specified by:
copyAttributeOnSplit in interface UniqueAttributesRecognizer
Overrides:
copyAttributeOnSplit in class DefaultUniqueAttributesRecognizer
Parameters:
attrQName - The attribute qualified name
element - The element
Returns:
true if the attribute should be copied when Split is performed.
See Also:
DefaultUniqueAttributesRecognizer.copyAttributeOnSplit(java.lang.String, ro.sync.ecss.extensions.api.node.AuthorElement)

getDescription

public String getDescription()
Returns:
The description of the extension.
See Also:
Extension.getDescription()

getDefaultOptions

protected GenerateIDElementsInfo getDefaultOptions()
Specified by:
getDefaultOptions in class DefaultUniqueAttributesRecognizer
Returns:
The default generation options
See Also:
DefaultUniqueAttributesRecognizer.getDefaultOptions()

getGenerateIDAttributeQName

protected String getGenerateIDAttributeQName(AuthorElement element,
                                             String[] elemsWithAutoGeneration,
                                             boolean forceGeneration)
Overrides:
getGenerateIDAttributeQName in class DefaultUniqueAttributesRecognizer
Parameters:
element - The current element.
elemsWithAutoGeneration - The array of elements for which generation is activated
forceGeneration - Force ID generation if there is no selection.
Returns:
The name of the attribute for which to generate the ID or null (default behavior).
See Also:
DefaultUniqueAttributesRecognizer.getGenerateIDAttributeQName(ro.sync.ecss.extensions.api.node.AuthorElement, java.lang.String[], boolean)

Oxygen XML Editor 11.2 Author API

© Copyright SyncRO Soft SRL 2002 - 2010.