ro.sync.ecss.extensions.api
Class ProfilingConditionalTextProvider

java.lang.Object
  ro.sync.ecss.extensions.api.ProfilingConditionalTextProvider

@API(type=EXTENDABLE,
     src=PUBLIC)
public class ProfilingConditionalTextProvider
extends java.lang.Object

Profiling/Conditional Text is a way to mark elements meant to appear in some renditions of the document, but not in others. It differs from one variant of the document to another, while unconditional elements appear in all document versions.
This class provides custom support for Profiling/Conditional Text.

Since:

13.2

Constructor Summary

ProfilingConditionalTextProvider()

Method Summary

java.lang.String

getXMLFragmentForContentProfiling(int startOffset, int endOffset, AuthorAccess authorAccess) This method is used when the document content between startOffset and endOffset must be profiled.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfilingConditionalTextProvider

public ProfilingConditionalTextProvider()

Method Detail

getXMLFragmentForContentProfiling

public java.lang.String getXMLFragmentForContentProfiling(int startOffset,
                                                          int endOffset,
                                                          AuthorAccess authorAccess)

This method is used when the document content between startOffset and endOffset must be profiled. The returned XML fragment is used to wrap the content included in the given offset interval.
The first leaf of the XML fragment will be the destination of the text to surround. The profiling attributes will be set on the first element of the XML fragment.

Parameters:

startOffset - The start offset of the document content that must be profiled.

endOffset - The end offset of the document content that must be profiled.

authorAccess - Access class to the author functions.

Returns:

The XML fragment to wrap the profiled document content with. If this fragment is null the interval will not be profiled.

Since:

13.2