RevisionOptions

Inheritance: java.lang.Object

All Implemented Interfaces: java.lang.Cloneable

public class RevisionOptions implements Cloneable

Allows to control how document revisions are handled during layout process.

To learn more, visit the Converting to Fixed-page Format documentation article.

Methods

Method Description
equals(Object arg0)
getClass()
getCommentColor() Allows to specify the color to be used for comments.
getDeletedTextColor() Allows to specify the color to be used for deleted content RevisionType.DELETION.
getDeletedTextEffect() Allows to specify the effect to be applied to the deleted content RevisionType.DELETION.
getInsertedTextColor() Allows to specify the color to be used for inserted content RevisionType.INSERTION.
getInsertedTextEffect() Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION.
getMeasurementUnit() Allows to specify the measurement units for revision comments.
getMovedFromTextColor() Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING.
getMovedFromTextEffect() Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING.
getMovedToTextColor() Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING.
getMovedToTextEffect() Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING.
getRevisedPropertiesColor() Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT.
getRevisedPropertiesEffect() Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE RevisionTextEffect.HIDDEN is not allowed and will cause java.lang.IllegalArgumentException.
getRevisionBarsColor() Allows to specify the color to be used for side bars that identify document lines containing revised information.
getRevisionBarsPosition() Gets rendering position of revision bars.
getRevisionBarsWidth() Gets width of revision bars, points.
getShowInBalloons() Allows to specify whether the revisions are rendered in the balloons.
getShowOriginalRevision() Allows to specify whether the original text should be shown instead of revised one.
getShowRevisionBars() Allows to specify whether revision bars should be rendered near lines containing revised content.
getShowRevisionMarks() Allow to specify whether revision text should be marked with special formatting markup.
hashCode()
notify()
notifyAll()
setCommentColor(int value) Allows to specify the color to be used for comments.
setDeletedTextColor(int value) Allows to specify the color to be used for deleted content RevisionType.DELETION.
setDeletedTextEffect(int value) Allows to specify the effect to be applied to the deleted content RevisionType.DELETION.
setInsertedTextColor(int value) Allows to specify the color to be used for inserted content RevisionType.INSERTION.
setInsertedTextEffect(int value) Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION.
setMeasurementUnit(int value) Allows to specify the measurement units for revision comments.
setMovedFromTextColor(int value) Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING.
setMovedFromTextEffect(int value) Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING.
setMovedToTextColor(int value) Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING.
setMovedToTextEffect(int value) Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING.
setRevisedPropertiesColor(int value) Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT.
setRevisedPropertiesEffect(int value) Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE RevisionTextEffect.HIDDEN is not allowed and will cause java.lang.IllegalArgumentException.
setRevisionBarsColor(int value) Allows to specify the color to be used for side bars that identify document lines containing revised information.
setRevisionBarsPosition(int value) Sets rendering position of revision bars.
setRevisionBarsWidth(float value) Sets width of revision bars, points.
setShowInBalloons(int value) Allows to specify whether the revisions are rendered in the balloons.
setShowOriginalRevision(boolean value) Allows to specify whether the original text should be shown instead of revised one.
setShowRevisionBars(boolean value) Allows to specify whether revision bars should be rendered near lines containing revised content.
setShowRevisionMarks(boolean value) Allow to specify whether revision text should be marked with special formatting markup.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter Type Description
arg0 java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCommentColor()

public int getCommentColor()

Allows to specify the color to be used for comments. Default value is RevisionColor.RED. If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getDeletedTextColor()

public int getDeletedTextColor()

Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getDeletedTextEffect()

public int getDeletedTextEffect()

Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. Default value is RevisionTextEffect.STRIKE_THROUGH

Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.

getInsertedTextColor()

public int getInsertedTextColor()

Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getInsertedTextEffect()

public int getInsertedTextEffect()

Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE. Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause java.lang.IllegalArgumentException.

Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.

getMeasurementUnit()

public int getMeasurementUnit()

Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERS

Returns: int - The corresponding int value. The returned value is one of MeasurementUnits constants.

getMovedFromTextColor()

public int getMovedFromTextColor()

Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getMovedFromTextEffect()

public int getMovedFromTextEffect()

Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_STRIKE_THROUGH

Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.

getMovedToTextColor()

public int getMovedToTextColor()

Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getMovedToTextEffect()

public int getMovedToTextEffect()

Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_UNDERLINE Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause java.lang.IllegalArgumentException.

Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.

getRevisedPropertiesColor()

public int getRevisedPropertiesColor()

Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getRevisedPropertiesEffect()

public int getRevisedPropertiesEffect()

Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE RevisionTextEffect.HIDDEN is not allowed and will cause java.lang.IllegalArgumentException.

Returns: int - The corresponding int value. The returned value is one of RevisionTextEffect constants.

getRevisionBarsColor()

public int getRevisionBarsColor()

Allows to specify the color to be used for side bars that identify document lines containing revised information. Default value is RevisionColor.RED. Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.

Returns: int - The corresponding int value. The returned value is one of RevisionColor constants.

getRevisionBarsPosition()

public int getRevisionBarsPosition()

Gets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. Values of HorizontalAlignment.CENTER and HorizontalAlignment.INSIDE are not allowed and will cause java.lang.IllegalArgumentException.

Returns: int - Rendering position of revision bars. The returned value is one of HorizontalAlignment constants.

getRevisionBarsWidth()

public float getRevisionBarsWidth()

Gets width of revision bars, points.

Returns: float - Width of revision bars, points.

getShowInBalloons()

public int getShowInBalloons()

Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE. Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.

Returns: int - The corresponding int value. The returned value is one of ShowInBalloons constants.

getShowOriginalRevision()

public boolean getShowOriginalRevision()

Allows to specify whether the original text should be shown instead of revised one. Default value is False.

Returns: boolean - The corresponding boolean value.

getShowRevisionBars()

public boolean getShowRevisionBars()

Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is True.

Returns: boolean - The corresponding boolean value.

getShowRevisionMarks()

public boolean getShowRevisionMarks()

Allow to specify whether revision text should be marked with special formatting markup. Default value is True.

Returns: boolean - The corresponding boolean value.

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setCommentColor(int value)

public void setCommentColor(int value)

Allows to specify the color to be used for comments. Default value is RevisionColor.RED. If set this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values, as the result this property will be set to default color.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setDeletedTextColor(int value)

public void setDeletedTextColor(int value)

Allows to specify the color to be used for deleted content RevisionType.DELETION. Default value is RevisionColor.BY_AUTHOR.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setDeletedTextEffect(int value)

public void setDeletedTextEffect(int value)

Allows to specify the effect to be applied to the deleted content RevisionType.DELETION. Default value is RevisionTextEffect.STRIKE_THROUGH

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionTextEffect constants.

setInsertedTextColor(int value)

public void setInsertedTextColor(int value)

Allows to specify the color to be used for inserted content RevisionType.INSERTION. Default value is RevisionColor.BY_AUTHOR.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setInsertedTextEffect(int value)

public void setInsertedTextEffect(int value)

Allows to specify the effect to be applied to the inserted content RevisionType.INSERTION. Default value is RevisionTextEffect.UNDERLINE. Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause java.lang.IllegalArgumentException.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionTextEffect constants.

setMeasurementUnit(int value)

public void setMeasurementUnit(int value)

Allows to specify the measurement units for revision comments. Default value is MeasurementUnits.CENTIMETERS

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of MeasurementUnits constants.

setMovedFromTextColor(int value)

public void setMovedFromTextColor(int value)

Allows to specify the color to be used for areas where content was moved from RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setMovedFromTextEffect(int value)

public void setMovedFromTextEffect(int value)

Allows to specify the effect to be applied to the areas where content was moved from RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_STRIKE_THROUGH

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionTextEffect constants.

setMovedToTextColor(int value)

public void setMovedToTextColor(int value)

Allows to specify the color to be used for areas where content was moved to RevisionType.MOVING. Default value is RevisionColor.BY_AUTHOR.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setMovedToTextEffect(int value)

public void setMovedToTextEffect(int value)

Allows to specify the effect to be applied to the areas where content was moved to RevisionType.MOVING. Default value is RevisionTextEffect.DOUBLE_UNDERLINE Values of RevisionTextEffect.HIDDEN and RevisionTextEffect.DOUBLE_STRIKE_THROUGH are not allowed and will cause java.lang.IllegalArgumentException.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionTextEffect constants.

setRevisedPropertiesColor(int value)

public void setRevisedPropertiesColor(int value)

Allows to specify the color to be used for content with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionColor.NO_HIGHLIGHT.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setRevisedPropertiesEffect(int value)

public void setRevisedPropertiesEffect(int value)

Allows to specify the effect for content areas with changes of formatting properties RevisionType.FORMAT_CHANGE Default value is RevisionTextEffect.NONE RevisionTextEffect.HIDDEN is not allowed and will cause java.lang.IllegalArgumentException.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionTextEffect constants.

setRevisionBarsColor(int value)

public void setRevisionBarsColor(int value)

Allows to specify the color to be used for side bars that identify document lines containing revised information. Default value is RevisionColor.RED. Setting this property to RevisionColor.BY_AUTHOR or RevisionColor.NO_HIGHLIGHT values will result in hiding revision bars from the layout.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of RevisionColor constants.

setRevisionBarsPosition(int value)

public void setRevisionBarsPosition(int value)

Sets rendering position of revision bars. Default value is HorizontalAlignment.OUTSIDE. Values of HorizontalAlignment.CENTER and HorizontalAlignment.INSIDE are not allowed and will cause java.lang.IllegalArgumentException.

Parameters:

Parameter Type Description
value int Rendering position of revision bars. The value must be one of HorizontalAlignment constants.

setRevisionBarsWidth(float value)

public void setRevisionBarsWidth(float value)

Sets width of revision bars, points.

Parameters:

Parameter Type Description
value float Width of revision bars, points.

setShowInBalloons(int value)

public void setShowInBalloons(int value)

Allows to specify whether the revisions are rendered in the balloons. Default value is ShowInBalloons.NONE. Note that revisions are not rendered in balloons for CommentDisplayMode.SHOW_IN_ANNOTATIONS.

Parameters:

Parameter Type Description
value int The corresponding int value. The value must be one of ShowInBalloons constants.

setShowOriginalRevision(boolean value)

public void setShowOriginalRevision(boolean value)

Allows to specify whether the original text should be shown instead of revised one. Default value is False.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setShowRevisionBars(boolean value)

public void setShowRevisionBars(boolean value)

Allows to specify whether revision bars should be rendered near lines containing revised content. Default value is True.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

setShowRevisionMarks(boolean value)

public void setShowRevisionMarks(boolean value)

Allow to specify whether revision text should be marked with special formatting markup. Default value is True.

Parameters:

Parameter Type Description
value boolean The corresponding boolean value.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter Type Description
arg0 long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter Type Description
arg0 long
arg1 int