com.pspdfkit.annotations.defaults.AnnotationPreferencesManager |
Manager providing access to annotation editing preferences.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract float |
getAlpha(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation alpha from preferences.
| ||||||||||
abstract float |
getAlpha(AnnotationTool annotationTool)
Gets last configured annotation alpha from preferences.
| ||||||||||
abstract String |
getAnnotationCreator()
Retrieve annotation creator from
PSPDFKitPreferences . | ||||||||||
abstract BorderStylePreset |
getBorderStylePreset(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation border preset from preferences.
| ||||||||||
abstract BorderStylePreset |
getBorderStylePreset(AnnotationTool annotationTool)
Gets last configured annotation border preset from preferences.
| ||||||||||
abstract int |
getColor(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Retrieve last configured color from preferences.
| ||||||||||
abstract int |
getColor(AnnotationTool annotationTool)
Retrieve last configured color from preferences.
| ||||||||||
abstract int |
getFillColor(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Retrieve last configured fill color from preferences.
| ||||||||||
abstract int |
getFillColor(AnnotationTool annotationTool)
Retrieve last configured fill color from preferences.
| ||||||||||
abstract FloatPrecision |
getFloatPrecision(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation precision from preferences.
| ||||||||||
abstract FloatPrecision |
getFloatPrecision(AnnotationTool annotationTool)
Gets last configured annotation precision from preferences.
| ||||||||||
abstract Font |
getFont(AnnotationTool annotationTool)
Gets last configured annotation font from preferences.
| ||||||||||
abstract Font |
getFont(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation font from preferences.
| ||||||||||
abstract Pair<LineEndType, LineEndType> |
getLineEnds(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation line ends types from preferences.
| ||||||||||
abstract Pair<LineEndType, LineEndType> |
getLineEnds(AnnotationTool annotationTool)
Gets last configured annotation line ends types from preferences.
| ||||||||||
abstract Scale |
getMeasurementScale(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation scale from preferences.
| ||||||||||
abstract Scale |
getMeasurementScale(AnnotationTool annotationTool)
Gets last configured annotation scale from preferences.
| ||||||||||
abstract String |
getNoteAnnotationIcon(AnnotationTool annotationTool)
Gets last configured annotation icon from preferences.
| ||||||||||
abstract String |
getNoteAnnotationIcon(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation icon from preferences.
| ||||||||||
abstract int |
getOutlineColor(AnnotationTool annotationTool)
Retrieve last configured outline color from preferences.
| ||||||||||
abstract int |
getOutlineColor(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Retrieve last configured outline color from preferences.
| ||||||||||
abstract String |
getOverlayText(AnnotationTool annotationTool)
Gets last configured overlay text from preferences.
| ||||||||||
abstract String |
getOverlayText(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured overlay text from preferences.
| ||||||||||
abstract boolean |
getRepeatOverlayText(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured repeat overlay text setting from preferences.
| ||||||||||
abstract boolean |
getRepeatOverlayText(AnnotationTool annotationTool)
Gets last configured repeat overlay text setting from preferences.
| ||||||||||
abstract float |
getTextSize(AnnotationTool annotationTool)
Gets last configured text size from preferences.
| ||||||||||
abstract float |
getTextSize(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured text size from preferences.
| ||||||||||
abstract float |
getThickness(AnnotationTool annotationTool, AnnotationToolVariant toolVariant)
Gets last configured annotation thickness from preferences.
| ||||||||||
abstract float |
getThickness(AnnotationTool annotationTool)
Gets last configured annotation thickness from preferences.
| ||||||||||
abstract boolean |
isAnnotationCreatorSet()
Checks if the annotation creator has been set.
| ||||||||||
abstract boolean |
isMeasurementSnappingEnabled()
Returns
true if snapping to page graphics for measurement tools is enabled. | ||||||||||
abstract void |
setAlpha(AnnotationTool annotationTool, float alpha)
Sets annotation alpha to preferences.
| ||||||||||
abstract void |
setAlpha(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, float alpha)
Sets annotation alpha to preferences.
| ||||||||||
abstract void |
setBorderStylePreset(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, BorderStylePreset borderStylePreset)
Sets annotation border preset to preferences.
| ||||||||||
abstract void |
setBorderStylePreset(AnnotationTool annotationTool, BorderStylePreset borderStylePreset)
Sets annotation border preset to preferences.
| ||||||||||
abstract void |
setColor(AnnotationTool annotationTool, int color)
Sets annotation color to preferences.
| ||||||||||
abstract void |
setColor(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, int color)
Sets annotation color to preferences.
| ||||||||||
abstract void |
setFillColor(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, int color)
Sets annotation fill color to preferences.
| ||||||||||
abstract void |
setFillColor(AnnotationTool annotationTool, int color)
Sets annotation fill color to preferences.
| ||||||||||
abstract void |
setFloatPrecision(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, FloatPrecision precision)
Sets annotation precision to preferences.
| ||||||||||
abstract void |
setFloatPrecision(AnnotationTool annotationTool, FloatPrecision precision)
Sets annotation precision to preferences.
| ||||||||||
abstract void |
setFont(AnnotationTool annotationTool, Font font)
Sets annotation font to preferences.
| ||||||||||
abstract void |
setFont(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, Font font)
Sets annotation font to preferences.
| ||||||||||
abstract void |
setLineEnds(AnnotationTool annotationTool, LineEndType lineEnd1, LineEndType lineEnd2)
Sets line end types to preferences.
| ||||||||||
abstract void |
setLineEnds(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, LineEndType lineEnd1, LineEndType lineEnd2)
Sets line end types to preferences.
| ||||||||||
abstract void |
setMeasurementScale(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, Scale measurementScale)
Sets annotation scale to preferences.
| ||||||||||
abstract void |
setMeasurementScale(AnnotationTool annotationTool, Scale measurementScale)
Sets annotation scale to preferences.
| ||||||||||
abstract void |
setMeasurementSnappingEnabled(boolean enabled)
Enables snapping to page graphics for measurement tools.
| ||||||||||
abstract void |
setNoteAnnotationIcon(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, String iconName)
Sets annotation icon name to preferences.
| ||||||||||
abstract void |
setNoteAnnotationIcon(AnnotationTool annotationTool, String iconName)
Sets annotation icon name to preferences.
| ||||||||||
abstract void |
setOutlineColor(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, int color)
Sets annotation outline color to preferences.
| ||||||||||
abstract void |
setOutlineColor(AnnotationTool annotationTool, int color)
Sets annotation outline color to preferences.
| ||||||||||
abstract void |
setOverlayText(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, String overlayText)
Sets the overlay text to preferences.
| ||||||||||
abstract void |
setOverlayText(AnnotationTool annotationTool, String overlayText)
Sets the overlay text to preferences.
| ||||||||||
abstract void |
setRepeatOverlayText(AnnotationTool annotationTool, boolean repeatOverlayText)
Sets the last configured repeat overlay text setting to preferences.
| ||||||||||
abstract void |
setRepeatOverlayText(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, boolean repeatOverlayText)
Sets the last configured repeat overlay text setting to preferences.
| ||||||||||
abstract void |
setTextSize(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, float textSize)
Sets text size to preferences.
| ||||||||||
abstract void |
setTextSize(AnnotationTool annotationTool, float textSize)
Sets text size to preferences.
| ||||||||||
abstract void |
setThickness(AnnotationTool annotationTool, float thickness)
Sets annotation thickness to preferences.
| ||||||||||
abstract void |
setThickness(AnnotationTool annotationTool, AnnotationToolVariant toolVariant, float thickness)
Sets annotation thickness to preferences.
|
Gets last configured annotation alpha from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation alpha from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Retrieve annotation creator from PSPDFKitPreferences
.
Gets last configured annotation border preset from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation border preset from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Retrieve last configured color from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Retrieve last configured color from preferences. Uses default tool variant.
annotationTool | Annotation tool for which we need the preferences. |
---|
Retrieve last configured fill color from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Retrieve last configured fill color from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured annotation precision from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation precision from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured annotation font from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured annotation font from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation line ends types from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation line ends types from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured annotation scale from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation scale from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured annotation icon from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured annotation icon from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Retrieve last configured outline color from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Retrieve last configured outline color from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured overlay text from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured overlay text from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured repeat overlay text setting from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured repeat overlay text setting from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured text size from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Gets last configured text size from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation thickness from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
Gets last configured annotation thickness from preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|
Checks if the annotation creator has been set.
false
if the annotation creator has not been set, true
otherwise.
Returns true
if snapping to page graphics for measurement tools is enabled.
This is a global setting and is not tied to any particular annotation.
true
if snapping is enabled, false
otherwise.
Sets annotation alpha to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
alpha | Thickness in pt. |
Sets annotation alpha to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
alpha | Thickness in pt. |
Sets annotation border preset to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
borderStylePreset | Border style preset to set. |
Sets annotation border preset to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
borderStylePreset | Border style preset to set. |
Sets annotation color to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
color | Color to set. |
Sets annotation color to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
color | Color to set. |
Sets annotation fill color to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
color | Color to set. |
Sets annotation fill color to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
color | Color to set. |
Sets annotation precision to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
precision | Float value decimal place precision. |
Sets annotation precision to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
precision | Float value decimal place precision. |
Sets annotation font to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
font | Font to set. |
Sets annotation font to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
font | Font to set. |
Sets line end types to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
lineEnd1 | LineEndType for start of the line. |
lineEnd2 | LineEndType for end of the line.
|
Sets line end types to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
lineEnd1 | LineEndType for start of the line. |
lineEnd2 | LineEndType for end of the line.
|
Sets annotation scale to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
measurementScale | Scale object with values to set measurement scale. |
Sets annotation scale to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
measurementScale | Scale object with values to set measurement scale. |
Enables snapping to page graphics for measurement tools. This is a global setting and is not tied to any particular annotation.
enabled | true to enable measurement snapping, false to disable it.
|
---|
Sets annotation icon name to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
iconName | Name of the icon. |
Sets annotation icon name to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
iconName | Name of the icon. |
Sets annotation outline color to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
color | Color to set. |
Sets annotation outline color to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
color | Color to set. |
Sets the overlay text to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
overlayText | The overlay text to set. |
Sets the overlay text to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
overlayText | The overlay text to set. |
Sets the last configured repeat overlay text setting to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
repeatOverlayText | The repeat overlay text setting to set. |
Sets the last configured repeat overlay text setting to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
repeatOverlayText | The repeat overlay text setting to set. |
Sets text size to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
textSize | Text size in pt. |
Sets text size to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
textSize | Text size in pt. |
Sets annotation thickness to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
thickness | Thickness in pt. |
Sets annotation thickness to preferences.
annotationTool | Annotation tool for which we need the preferences. |
---|---|
toolVariant | Variant of the annotation tool. |
thickness | Thickness in pt. |