com.oracle.outsidein.annotations

Class HighlightTextAnnotation

java.lang.Object

com.oracle.outsidein.annotations.HighlightTextAnnotation

public class HighlightTextAnnotation
extends java.lang.Object

Describes text highlights to apply to a run of text content in the destination document.

See Also:

Annotatable.addTextHighlight(HighlightTextAnnotation)

Constructor Summary

Constructors

Constructor and Description
HighlightTextAnnotation(long startCharCount, long endCharCount, ColorInfo foreground, ColorInfo background) Creates a text annotation with a specific foreground and background color.
HighlightTextAnnotation(long startCharCount, long endCharCount, ColorInfo foreground, ColorInfo background, java.util.EnumSet<CharAttributeValues> charAttrs, java.util.EnumSet<CharAttributeValues> charMask) Creates a text annotation that changes the character attributes and applies a specific foreground and background color to the specified text.
HighlightTextAnnotation(long startCharCount, long endCharCount, java.util.EnumSet<CharAttributeValues> charAttrs, java.util.EnumSet<CharAttributeValues> charMask) Creates a text annotation that changes the character attributes of the specified text.

Method Summary

Modifier and Type	Method and Description
net.bitform.oilink.OILinkMessages.HiliteText	getOILinkHiliteText() Used internally by the Outside In API and not to be used externally.

Methods inherited from class java.lang.Object

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

Constructor Detail

HighlightTextAnnotation

public HighlightTextAnnotation(long startCharCount,
                               long endCharCount,
                               ColorInfo foreground,
                               ColorInfo background)

Creates a text annotation with a specific foreground and background color.

Parameters:

startCharCount - the character count of the starting position

endCharCount - the character count of the end position

foreground - the text color of the highlight

background - the background color of the highlight

HighlightTextAnnotation

public HighlightTextAnnotation(long startCharCount,
                               long endCharCount,
                               java.util.EnumSet<CharAttributeValues> charAttrs,
                               java.util.EnumSet<CharAttributeValues> charMask)

Creates a text annotation that changes the character attributes of the specified text.

Parameters:

startCharCount - the character count of the starting position

endCharCount - the character count of the end position

charAttrs - the set of character attributes that are "on"

charMask - the character attributes to apply. If the mask set contains an attribute that is not in the charAttrs set, then that attribute will be set to "off"

HighlightTextAnnotation

public HighlightTextAnnotation(long startCharCount,
                               long endCharCount,
                               ColorInfo foreground,
                               ColorInfo background,
                               java.util.EnumSet<CharAttributeValues> charAttrs,
                               java.util.EnumSet<CharAttributeValues> charMask)

Creates a text annotation that changes the character attributes and applies a specific foreground and background color to the specified text.

Parameters:

startCharCount - the character count of the starting position

endCharCount - the character count of the end position

foreground - the text color of the highlight

background - the background color of the highlight

charAttrs - the set of character attributes that are "on"

charMask - the character attributes to apply. If the mask set contains an attribute that is not in the charAttrs set, then that attribute will be set to "off"

Method Detail

getOILinkHiliteText

public net.bitform.oilink.OILinkMessages.HiliteText getOILinkHiliteText()

Used internally by the Outside In API and not to be used externally.