|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface AuthorCalloutsController
The callouts are representations of Track Changes insert and delete highlights,
review comment highlights and custom review highlights in the Author mode on a side bar.
This controller can be used to decide what types of callouts must be presented in
Author mode. It must be provided through AuthorReviewController.getAuthorCalloutsController()
method.
To render a custom highlight as a callout in Author mode, a callout information
provider must be set from
setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider)
method.
By default, the callouts visibility in Author mode is controlled from Oxygen
Preferences but it can be changed by using the methods in this class.
The Preferences will not be affected by the API.
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.
Method Summary | |
---|---|
Rectangle |
getCalloutRectangle(AuthorPersistentHighlight persistentHighlight)
Retrieves the bounds of the callout box associated with an Author persistent highlight. |
boolean |
isShowingCommentsCallouts()
Check if the callouts corresponding to review comments and Change Tracking deletions and insertions with comments are visible in Author mode. |
boolean |
isShowingDeletionsCallouts()
Check if the callouts corresponding to Change Tracking deletions are visible in Author mode. |
boolean |
isShowingInsertionsCallouts()
Check if the callouts corresponding to Change Tracking insertions are visible in Author mode. |
void |
setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider provider)
Set the provider for data that will be rendered as a callout, in Author mode, for a specific highlight. |
void |
setShowCommentsCallouts(java.lang.Boolean showCommentsCallouts)
The Track Changes insert and delete markers, the review comment markers and the custom review markers can be presented in Author mode as callouts. |
void |
setShowDeletionsCallouts(java.lang.Boolean showDeletionsCallouts)
The Track Changes insert and delete markers, the review comment markers and the custom review markers can be presented in Author mode as callouts. |
void |
setShowInsertionsCallouts(java.lang.Boolean showInsertionsCallouts)
The Track Changes insert and delete markers, the review comment markers and the custom review markers can be presented in Author mode as callouts. |
Method Detail |
---|
boolean isShowingCommentsCallouts()
setShowCommentsCallouts(Boolean)
method.
true
if the callouts with comments are visible.void setShowCommentsCallouts(java.lang.Boolean showCommentsCallouts)
showCommentsCallouts
- If true
, the review callouts with comments
are displayed in Author mode. The callouts with comments are hidden when the provided
value is false
.
null
, the option from Oxygen Preferences
is taken into consideration.boolean isShowingDeletionsCallouts()
setShowDeletionsCallouts(Boolean)
method.
true
if the Track Changes deletions callouts are
displayed in Author mode.void setShowDeletionsCallouts(java.lang.Boolean showDeletionsCallouts)
showDeletionsCallouts
- If true
, the Track Changes deletions callouts
are displayed in Author mode. The deletions callouts are hidden when the provided value is false
.
null
, the option from Oxygen Preferences
is taken into consideration.boolean isShowingInsertionsCallouts()
setShowInsertionsCallouts(Boolean)
method.
true
if the Track Changes insertions callouts are visible.void setShowInsertionsCallouts(java.lang.Boolean showInsertionsCallouts)
showInsertionsCallouts
- If true
, the Track Changes insertions callouts
are displayed in Author mode. The insertions callouts are hidden when the provided value is false
.
null
, the option from Oxygen Preferences
is taken into consideration.void setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider provider)
AuthorCalloutsController
methods.
provider
- The highlights callout rendering information provider.
java.lang.IllegalArgumentException
- Thrown when a property name is not a valid XML attribute name.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.
Rectangle getCalloutRectangle(AuthorPersistentHighlight persistentHighlight)
persistentHighlight
- The Author persistent highlight.
null
if there is no corresponding
callout box.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.
|
Oxygen XML Editor 14.2 Author API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |