public class TextMarkupTools extends Object
The Tool's property values can be retrieved and initialized with the methods
toXMLString()
and setFromXML()
in the
AnnotationTools
class. Please see
AnnotationTools
.
Modifier and Type | Field and Description |
---|---|
static int |
SHOW_NOTHING |
static int |
SHOW_POPUP |
static int |
SHOW_PROPS_DIALOG |
Constructor and Description |
---|
TextMarkupTools() |
Modifier and Type | Method and Description |
---|---|
static Color |
getDefaultCrossoutColor()
Returns the default crossout color.
|
static int |
getDefaultCrossoutTransparency()
Returns the default crossout transparency.
|
static Color |
getDefaultHighlightColor()
Returns the default highlight color.
|
static int |
getDefaultHighlightTransparency()
Returns the default highlight transparency.
|
static Color |
getDefaultReplacementColor()
Returns the default replacement color.
|
static int |
getDefaultReplacementTransparency()
Returns the default replacement transparency.
|
static Color |
getDefaultSquigglyColor()
Returns the default squiggly underline color.
|
static int |
getDefaultSquigglyTransparency()
Returns the default squiggly underline transparency.
|
static Color |
getDefaultUnderlineColor()
Returns the default underline color.
|
static int |
getDefaultUnderlineTransparency()
Returns the default underline transparency.
|
static Dimension |
getMinimumAnnotSize()
Gets the minimum size for the annotations created with this Tool.
|
static int |
getShowOptionCrossout()
Returns the option for what this Tool should do after it creates the
annotation.
|
static int |
getShowOptionHighlight()
Returns the option for what this Tool should do after it creates the
annotation.
|
static int |
getShowOptionReplacement()
Returns the option for what this Tool should do after it creates the
annotation.
|
static int |
getShowOptionSquiggly()
Returns the option for what this Tool should do after it creates the
annotation.
|
static int |
getShowOptionUnderline()
Returns the option for what this Tool should do after it creates the
annotation.
|
static boolean |
isCrossoutSticky()
Returns a flag indicating if this tool is sticky.
|
static boolean |
isHighlightSticky()
Returns a flag indicating if this tool is sticky.
|
static boolean |
isReplacementSticky()
Returns a flag indicating if this tool is sticky.
|
static boolean |
isSetContentsFromTextCrossout()
Returns true if a new MarkUpText annotation content should be initialzed
to the text contained within the quadrilaterals.
|
static boolean |
isSetContentsFromTextHighlight()
Returns true if a new MarkUpText annotation content should be initialzed
to the text contained within the quadrilaterals.
|
static boolean |
isSetContentsFromTextReplacement()
Returns true if a new MarkUpText annotation content should be initialzed
to the text contained within the quadrilaterals.
|
static boolean |
isSetContentsFromTextSquiggly()
Returns true if a new MarkUpText annotation content should be initialzed
to the text contained within the quadrilaterals.
|
static boolean |
isSetContentsFromTextUnderline()
Returns true if a new MarkUpText annotation content should be initialzed
to the text contained within the quadrilaterals.
|
static boolean |
isShowPropDialogCrossout()
Deprecated.
use
getShowOptionCrossout instead |
static boolean |
isShowPropDialogHighlight()
Deprecated.
use
getShowOptionHighlight instead |
static boolean |
isShowPropDialogReplacement()
Deprecated.
use
getShowOptionReplacement instead |
static boolean |
isShowPropDialogSquiggly()
Deprecated.
use
getShowOptionSquiggly instead |
static boolean |
isShowPropDialogUnderline()
Deprecated.
use
getShowOptionUnderline instead |
static boolean |
isSquigglySticky()
Returns a flag indicating if this tool is sticky.
|
static boolean |
isUnderlineSticky()
Returns a flag indicating if this tool is sticky.
|
static void |
setContentsFromTextCrossout(boolean setContentsFromText)
Sets the MarkUpText annotation content to the text contained within the
quadrilaterals when creating a new MarkUpText annotation.
|
static void |
setContentsFromTextHighlight(boolean setContentsFromText)
Sets the MarkUpText annotation content to the text contained within the
quadrilaterals when creating a new MarkUpText annotation.
|
static void |
setContentsFromTextReplacement(boolean setContentsFromText)
Sets the MarkUpText annotation content to the text contained within the
quadrilaterals when creating a new MarkUpText annotation.
|
static void |
setContentsFromTextSquiggly(boolean setContentsFromText)
Sets the MarkUpText annotation content to the text contained within the
quadrilaterals when creating a new MarkUpText annotation.
|
static void |
setContentsFromTextUnderline(boolean setContentsFromText)
Sets the MarkUpText annotation content to the text contained within the
quadrilaterals when creating a new MarkUpText annotation.
|
static void |
setCrossoutSticky(boolean sticky)
Sets the flag that indicates whether this tool is sticky or not.
|
static void |
setDefaultCrossoutColor(Color defaultCrossoutColor)
Sets the default crossout color.
|
static void |
setDefaultCrossoutTransparency(int defaultCrossoutTransparency)
Sets the default crossout transparency.
|
static void |
setDefaultHighlightColor(Color defaultHighlightColor)
Sets the default highlight color.
|
static void |
setDefaultHighlightTransparency(int defaultHighlightTransparency)
Sets the default highlight transparency.
|
static void |
setDefaultReplacementColor(Color defaultReplacementColor)
Sets the default replacement color.
|
static void |
setDefaultReplacementTransparency(int defaultReplacementTransparency)
Sets the default replacement transparency.
|
static void |
setDefaultSquigglyColor(Color defaultSquigglyColor)
Sets the default squiggly underline color.
|
static void |
setDefaultSquigglyTransparency(int defaultSquigglyTransparency)
Sets the default squiggly underline transparency.
|
static void |
setDefaultUnderlineColor(Color defaultUnderlineColor)
Sets the default underline color.
|
static void |
setDefaultUnderlineTransparency(int defaultUnderlineTransparency)
Sets the default underline transparency.
|
static void |
setHighlightSticky(boolean sticky)
Sets the flag that indicates whether this tool is sticky or not.
|
static void |
setMinimumAnnotSize(Dimension minimumAnnotSize)
Sets the minimum size for the annotations created with this Tool.
|
static void |
setReplacementSticky(boolean sticky)
Sets the flag that indicates whether this tool is sticky or not.
|
static void |
setShowOptionCrossout(int option)
Sets the option for what this Tool should do after it creates the
annotation.
|
static void |
setShowOptionHighlight(int option)
Sets the option for what this Tool should do after it creates the
annotation.
|
static void |
setShowOptionReplacement(int option)
Sets the option for what this Tool should do after it creates the
annotation.
|
static void |
setShowOptionSquiggly(int option)
Sets the option for what this Tool should do after it creates the
annotation.
|
static void |
setShowOptionUnderline(int option)
Sets the option for what this Tool should do after it creates the
annotation.
|
static void |
setShowPropDialogCrossout(boolean showPropDialogCrossout)
Deprecated.
use
setShowOptionCrossout instead |
static void |
setShowPropDialogHighlight(boolean showPropDialogHighlight)
Deprecated.
use
setShowOptionHighlight instead |
static void |
setShowPropDialogReplacement(boolean showPropDialogReplacement)
Deprecated.
use
setShowOptionReplacement instead |
static void |
setShowPropDialogSquiggly(boolean showPropDialogSquiggly)
Deprecated.
use
setShowOptionSquiggly instead |
static void |
setShowPropDialogUnderline(boolean showPropDialogUnderline)
Deprecated.
use
setShowOptionUnderline instead |
static void |
setSquigglySticky(boolean sticky)
Sets the flag that indicates whether this tool is sticky or not.
|
static void |
setUnderlineSticky(boolean sticky)
Sets the flag that indicates whether this tool is sticky or not.
|
public static int SHOW_NOTHING
public static int SHOW_PROPS_DIALOG
public static int SHOW_POPUP
public static Color getDefaultHighlightColor()
public static void setDefaultHighlightColor(Color defaultHighlightColor)
defaultHighlightColor
- The new value of the default highlight color to setpublic static Color getDefaultUnderlineColor()
public static void setDefaultUnderlineColor(Color defaultUnderlineColor)
defaultUnderlineColor
- The new value of the default underline color to setpublic static Color getDefaultCrossoutColor()
public static void setDefaultCrossoutColor(Color defaultCrossoutColor)
defaultCrossoutColor
- The new value of the default crossout color to setpublic static Color getDefaultSquigglyColor()
public static void setDefaultSquigglyColor(Color defaultSquigglyColor)
defaultSquigglyColor
- The new value of the default squiggly underline color to setpublic static Color getDefaultReplacementColor()
public static void setDefaultReplacementColor(Color defaultReplacementColor)
defaultReplacementColor
- The new value of the default replacement color to setpublic static int getDefaultHighlightTransparency()
public static void setDefaultHighlightTransparency(int defaultHighlightTransparency)
defaultHighlightTransparency
- The new value of the default highlight transparency to setpublic static int getDefaultUnderlineTransparency()
public static void setDefaultUnderlineTransparency(int defaultUnderlineTransparency)
defaultUnderlineTransparency
- The new value of the default underline transparency to setpublic static int getDefaultCrossoutTransparency()
public static void setDefaultCrossoutTransparency(int defaultCrossoutTransparency)
defaultCrossoutTransparency
- The new value of the default crossout transparency to setpublic static int getDefaultSquigglyTransparency()
public static void setDefaultSquigglyTransparency(int defaultSquigglyTransparency)
defaultSquigglyTransparency
- The new value of the default squiggly underline transparency to setpublic static int getDefaultReplacementTransparency()
public static void setDefaultReplacementTransparency(int defaultReplacementTransparency)
defaultReplacementTransparency
- The new value of the default replacement transparency to set@Deprecated public static boolean isShowPropDialogHighlight()
getShowOptionHighlight
instead@Deprecated public static void setShowPropDialogHighlight(boolean showPropDialogHighlight)
setShowOptionHighlight
insteadshowPropDialogHighlight
- the showPropDialogHighlight to set@Deprecated public static boolean isShowPropDialogUnderline()
getShowOptionUnderline
instead@Deprecated public static void setShowPropDialogUnderline(boolean showPropDialogUnderline)
setShowOptionUnderline
insteadshowPropDialogUnderline
- the showPropDialogUnderline to set@Deprecated public static boolean isShowPropDialogCrossout()
getShowOptionCrossout
instead@Deprecated public static void setShowPropDialogCrossout(boolean showPropDialogCrossout)
setShowOptionCrossout
insteadshowPropDialogCrossout
- the showPropDialogCrossout to set@Deprecated public static boolean isShowPropDialogSquiggly()
getShowOptionSquiggly
instead@Deprecated public static void setShowPropDialogSquiggly(boolean showPropDialogSquiggly)
setShowOptionSquiggly
insteadshowPropDialogSquiggly
- the showPropDialogSquiggly to set@Deprecated public static boolean isShowPropDialogReplacement()
getShowOptionReplacement
instead@Deprecated public static void setShowPropDialogReplacement(boolean showPropDialogReplacement)
setShowOptionReplacement
insteadshowPropDialogReplacement
- the showPropDialogReplacement to setpublic static int getShowOptionHighlight()
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.public static void setShowOptionHighlight(int option)
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.option
- public static int getShowOptionUnderline()
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.public static void setShowOptionUnderline(int option)
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.option
- public static int getShowOptionCrossout()
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.public static void setShowOptionCrossout(int option)
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.option
- public static int getShowOptionSquiggly()
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.public static void setShowOptionSquiggly(int option)
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.option
- public static int getShowOptionReplacement()
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.public static void setShowOptionReplacement(int option)
SHOW_NOTHING
, SHOW_PROPS_DIALOG
, or
.option
- public static Dimension getMinimumAnnotSize()
public static void setMinimumAnnotSize(Dimension minimumAnnotSize)
minimumAnnotSize
- the minimumAnnotSize to setpublic static void setContentsFromTextHighlight(boolean setContentsFromText)
setContentsFromText
- if true, the MarkUpText annotation content will be initialized to
the text within the quadrilateralspublic static boolean isSetContentsFromTextHighlight()
public static void setContentsFromTextUnderline(boolean setContentsFromText)
setContentsFromText
- if true, the MarkUpText annotation content will be initialized to
the text within the quadrilateralspublic static boolean isSetContentsFromTextUnderline()
public static void setContentsFromTextCrossout(boolean setContentsFromText)
setContentsFromText
- if true, the MarkUpText annotation content will be initialized to
the text within the quadrilateralspublic static boolean isSetContentsFromTextCrossout()
public static void setContentsFromTextSquiggly(boolean setContentsFromText)
setContentsFromText
- if true, the MarkUpText annotation content will be initialized to
the text within the quadrilateralspublic static boolean isSetContentsFromTextSquiggly()
public static void setContentsFromTextReplacement(boolean setContentsFromText)
setContentsFromText
- if true, the MarkUpText annotation content will be initialized to
the text within the quadrilateralspublic static boolean isSetContentsFromTextReplacement()
public static boolean isHighlightSticky()
public static void setHighlightSticky(boolean sticky)
sticky
- The new value of the sticky flag.public static boolean isUnderlineSticky()
public static void setUnderlineSticky(boolean sticky)
sticky
- The new value of the sticky flag.public static boolean isCrossoutSticky()
public static void setCrossoutSticky(boolean sticky)
sticky
- The new value of the sticky flag.public static boolean isSquigglySticky()
public static void setSquigglySticky(boolean sticky)
sticky
- The new value of the sticky flag.public static boolean isReplacementSticky()
public static void setReplacementSticky(boolean sticky)
sticky
- The new value of the sticky flag.