|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object ro.sync.ecss.extensions.api.callouts.AuthorCalloutRenderingInformation
@API(type=EXTENDABLE, src=PUBLIC) public abstract class AuthorCalloutRenderingInformation
The callouts are representations of Track Changes insert and delete highlights,
review comment highlights and custom review highlights in Author mode.
By default, the callouts visibility in Author mode is controlled from Oxygen
Preferences but it can be changed by using the AuthorCalloutsController
methods.
The AuthorReviewCalloutInformation object holds the data that will be rendered
as a callout, in Author mode.
To render a custom highlight as a callout in Author mode, a callouts information
provider must be set from
AuthorCalloutsController.setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider)
method.
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.
Constructor Summary | |
---|---|
AuthorCalloutRenderingInformation()
|
Method Summary | |
---|---|
abstract java.util.Map<java.lang.String,java.lang.String> |
getAdditionalData()
Provides the review additional data that will be presented in the callout content part. |
abstract java.lang.String |
getAuthor()
Provides the reviewer author name that will be presented in the callout header part. |
abstract java.lang.String |
getCalloutType()
Provides a human readable string representing the callout type that will be rendered as a description of the callout, in the header part. |
abstract Color |
getColor()
Provides color for styling the associated callout box. |
abstract java.lang.String |
getComment(int limit)
Provides the review comment that will be presented in the callout content part. |
abstract java.lang.String |
getContentFromTarget(int limit)
Provides a section from the document content that is covered by this callout. |
abstract long |
getTimestamp()
Provides the review creation or modification time. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AuthorCalloutRenderingInformation()
Method Detail |
---|
public abstract java.lang.String getAuthor()
null
if the author is not relevant.public abstract long getTimestamp()
Can be -1
if the modification time was not set. In this case,
the callout will not present any information regarding the review creation or
modification time.
public abstract java.lang.String getComment(int limit)
limit
- the suggested text limit (in characters). This value comes from the
Callouts Options (user preferences). Examples: 80 or 160 characters.
null
if a comment is not available for this callout.public abstract java.lang.String getContentFromTarget(int limit)
limit
- the suggested text limit (in characters). This value comes from the
Callouts Options (user preferences). Examples: 80 or 160 characters.
null
if the
content is not relevant for the callout.public abstract java.util.Map<java.lang.String,java.lang.String> getAdditionalData()
null
if there is no additional information available for this review.public abstract java.lang.String getCalloutType()
null
if the type is not relevant.public abstract Color getColor()
null
for the default.
|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |