com.pspdfkit.ui.special_mode.controller.AnnotationCreationController |
Default controller given when entering annotation creation mode. Used to control annotation creation mode properties and actions.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
abstract void |
bindAnnotationInspectorController(AnnotationInspectorController annotationInspectorController)
Binds to the annotation inspector controller for managing annotation inspector.
| ||||||||||
abstract void |
changeAnnotationCreationMode(AnnotationTool annotationTool, AnnotationToolVariant annotationToolVariant)
Starts an annotation creation mode with different annotation tool selected.
| ||||||||||
abstract AnnotationTool |
getActiveAnnotationTool()
Returns annotation creation tool that is currently active.
| ||||||||||
abstract AnnotationToolVariant |
getActiveAnnotationToolVariant()
Returns the variant of the annotation creation tool that is currently active.
| ||||||||||
abstract float |
getAlpha()
Get alpha set to the annotation creation mode.
| ||||||||||
abstract AnnotationManager |
getAnnotationManager()
Returns an annotation manager which you can use to register listeners from the controller.
| ||||||||||
abstract AnnotationPreferencesManager |
getAnnotationPreferences()
Returns an annotation editing preferences.
| ||||||||||
abstract BorderStylePreset |
getBorderStylePreset()
Gets border style preset set to the annotation creation mode.
| ||||||||||
abstract int |
getColor()
Get current color set to the annotation creation mode.
| ||||||||||
abstract PdfConfiguration |
getConfiguration()
Returns an active configuration.
| ||||||||||
abstract int |
getFillColor()
Get fill color set to the annotation creation mode.
| ||||||||||
abstract Font |
getFont()
Get the font set to the annotation creation mode.
| ||||||||||
abstract Pair<LineEndType, LineEndType> |
getLineEnds()
Returns current line ending styles for drawn lines.
| ||||||||||
abstract int |
getOutlineColor()
Get outline color set to the annotation creation mode.
| ||||||||||
abstract String |
getOverlayText()
Gets the overlay text set to the annotation creation mode.
| ||||||||||
abstract boolean |
getRepeatOverlayText()
Returns whether the overlay text should be repeated or not.
| ||||||||||
abstract float |
getTextSize()
Get text size set to the annotation creation mode.
| ||||||||||
abstract float |
getThickness()
Get thickness set to the annotation creation mode.
| ||||||||||
abstract void |
setAlpha(float alpha)
Set alpha to the annotation creation mode.
| ||||||||||
abstract void |
setBorderStylePreset(BorderStylePreset borderPreset)
Sets border preset to the annotation creation mode.
| ||||||||||
abstract void |
setColor(int color)
Set color for the annotation creation mode.
| ||||||||||
abstract void |
setFillColor(int fillColor)
Set fill color for the annotation creation mode.
| ||||||||||
abstract void |
setFont(Font font)
Set the font to the annotation creation mode.
| ||||||||||
abstract void |
setLineEnds(LineEndType lineEnd1, LineEndType lineEnd2)
Sets line ending style for drawn lines.
| ||||||||||
abstract void |
setOutlineColor(int outlineColor)
Set outline color for the annotation creation mode.
| ||||||||||
abstract void |
setOverlayText(String overlayText)
Sets the overlay text to the annotation creation mode.
| ||||||||||
abstract void |
setRepeatOverlayText(boolean repeatOverlayText)
Sets if the overlay text should be repeated.
| ||||||||||
abstract void |
setTextSize(float textSize)
Set text size to the annotation creation mode.
| ||||||||||
abstract void |
setThickness(float thickness)
Set thickness to the annotation creation mode.
| ||||||||||
abstract boolean |
shouldDisplayPicker()
Whether annotation inspector toolbar icon should be visible.
| ||||||||||
abstract void |
showAnnotationEditor(Annotation annotation)
Shows annotation editor for the passed annotation.
| ||||||||||
abstract void |
toggleAnnotationInspector()
Displays/hides an annotation inspector for the selected annotation type.
| ||||||||||
abstract void |
unbindAnnotationInspectorController()
Unbinds from previously bound annotation inspector controller.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Binds to the annotation inspector controller for managing annotation inspector.
annotationInspectorController | Controller for managing annotation inspector. |
---|
Starts an annotation creation mode with different annotation tool selected.
annotationTool | New annotation tool. |
---|---|
annotationToolVariant | Variant of the annotation tool to start. |
Returns annotation creation tool that is currently active.
NONE
if annotation creation mode is active but no annotation tool is selected, null
if annotation creation mode is inactive.
Returns the variant of the annotation creation tool that is currently active.
Get alpha set to the annotation creation mode.
Returns an annotation manager which you can use to register listeners from the controller.
Returns an annotation editing preferences.
Gets border style preset set to the annotation creation mode.
Get current color set to the annotation creation mode.
Returns an active configuration.
Get fill color set to the annotation creation mode.
Get the font set to the annotation creation mode.
Returns current line ending styles for drawn lines.
NONE
.
Get outline color set to the annotation creation mode.
Gets the overlay text set to the annotation creation mode.
Returns whether the overlay text should be repeated or not.
Get text size set to the annotation creation mode.
Get thickness set to the annotation creation mode.
FREETEXT
annotations).
Set alpha to the annotation creation mode.
alpha | Alpha in percent from 0 to 1. |
---|
Sets border preset to the annotation creation mode.
borderPreset | Required border style preset. |
---|
Set color for the annotation creation mode.
color | Annotation creation mode color. |
---|
Set fill color for the annotation creation mode.
fillColor | Annotation creation mode fill color. |
---|
Set the font to the annotation creation mode.
font | The font to use. |
---|
Sets line ending style for drawn lines.
lineEnd1 | LineEndType for start of the line. |
---|---|
lineEnd2 | LineEndType for end of the line.
|
Set outline color for the annotation creation mode.
outlineColor | Annotation creation mode outline color. |
---|
Sets the overlay text to the annotation creation mode.
overlayText | The overlay text to use. |
---|
Sets if the overlay text should be repeated.
repeatOverlayText | If the overlay text should be repeated. |
---|
Set text size to the annotation creation mode.
textSize | Text size in PDF points. |
---|
Set thickness to the annotation creation mode.
thickness | Thickness in PDF points (font size for FREETEXT annotations).
|
---|
Whether annotation inspector toolbar icon should be visible.
Shows annotation editor for the passed annotation.
annotation | Annotation for which to show the editor. |
---|
Displays/hides an annotation inspector for the selected annotation type.
Unbinds from previously bound annotation inspector controller.