@API(type=EXTENDABLE, src=PUBLIC) public interface AuthorReferenceResolver extends Extension
Modifier and Type | Method and Description |
---|---|
default boolean |
allowsValidatationForEditableReference(java.lang.String systemID,
AuthorNode referenceNodeParent)
Check if the editable node reference can be validated by Oxygen on its own, when modified, based on its own schema information.
|
java.lang.String |
getDisplayName(AuthorNode node)
Returns the name of the node that contains the expanded referred content.
|
java.lang.String |
getReferenceSystemID(AuthorNode node,
AuthorAccess authorAccess)
Return the systemID of the referred content.
|
java.lang.String |
getReferenceUniqueID(AuthorNode node)
Get an unique identifier for the node reference.
|
default boolean |
hasEditableReference(java.lang.String systemID,
AuthorNode referenceNodeParent)
Check if the node is editable.
|
boolean |
hasReferences(AuthorNode node)
Verifies if the handler considers the node to have references.
|
boolean |
isReferenceChanged(AuthorNode node,
java.lang.String attributeName)
Verifies if the references of the given node must be refreshed
when the attribute with the specified name has changed.
|
default void |
replaceReference(AuthorDocumentProvider targetProvider,
AuthorAccess authorAccess,
AuthorReferenceNode referenceNode)
Replace the content of the referenced node from the target document with the
modified content inside the reference node.
|
javax.xml.transform.sax.SAXSource |
resolveReference(AuthorNode node,
java.lang.String systemID,
AuthorAccess authorAccess,
org.xml.sax.EntityResolver entityResolver)
Resolve the references of the node.
|
getDescription
boolean hasReferences(AuthorNode node)
true
for
a DITA element that has conref
attribute set.node
- The node to be analyzed.true
if it has references.boolean isReferenceChanged(AuthorNode node, java.lang.String attributeName)
true
when the attribute name is equal to 'conref'
.node
- The AuthorNode
with the references.attributeName
- The name of the changed attribute.true
if the references must be refreshed.javax.xml.transform.sax.SAXSource resolveReference(AuthorNode node, java.lang.String systemID, AuthorAccess authorAccess, org.xml.sax.EntityResolver entityResolver) throws ReferenceResolverException
SAXSource
will be used for creating the referred content
using the parser and the source inside it.
conref
attribute.node
- The node which has references.systemID
- The system ID of the node with references.authorAccess
- The author access implementation.
Provides access to specific informations and actions for
editor, document, workspace, tables, change tracking, utility a.s.o.entityResolver
- The entity resolver that can be used to resolve:
InputSource
will contain the editor content.SAXSource
including the parser and the parser's InputSource
.
ReferenceResolverException
- If something goes wrong when resolving the references.java.lang.String getDisplayName(AuthorNode node)
conref
attribute is returned
by the DITA implementation.node
- The node that contains references.java.lang.String getReferenceUniqueID(AuthorNode node)
conref
attribute as the unique identifier.node
- The node that has reference.java.lang.String getReferenceSystemID(AuthorNode node, AuthorAccess authorAccess)
node
- The reference node.authorAccess
- The author access. It provides access to specific
informations and actions for editor, document, workspace, tables,
change tracking, utility a.s.o.default boolean hasEditableReference(java.lang.String systemID, AuthorNode referenceNodeParent)
systemID
- System ID of the document in which the current node is located.referenceNodeParent
- The parent of the future referene nodetrue
if the node is editable.Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
default boolean allowsValidatationForEditableReference(java.lang.String systemID, AuthorNode referenceNodeParent)
systemID
- System ID of the document in which the current node is located.referenceNodeParent
- The parent of the future reference nodetrue
if the editable node reference can be validated by Oxygen on its own, based on its own schema information.Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
default void replaceReference(AuthorDocumentProvider targetProvider, AuthorAccess authorAccess, AuthorReferenceNode referenceNode) throws java.io.IOException
targetProvider
- The provider if the target document.authorAccess
- Access to the current document.referenceNode
- The reference node to get the modified content from.java.io.IOException
- If the save process failsPlease note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
© Copyright Syncro Soft SRL 2002 - 2021. All rights reserved.