Customize default annotation tool style in Android

When creating a new annotation, the initial properties (such as line thickness, fill color, opacity, etc.) are set to the last value that the user selected for an annotation of that type. For example, if the user changes an ellipse annotation's stroke color from green to red, the next ellipse annotation that the user creates would have a stroke color of red. These default properties are saved in the app's SharedPreferences.

These default properties can be changed programmatically and will take effect the next time when the annotation is created.

For example, to change style properties of a rectangle:

1RectCreate tool = (RectCreate) toolManager.createTool(ToolManager.ToolMode.RECT_CREATE, null);
2tool.setupAnnotProperty(
3    Color.GREEN,
4    ToolStyleConfig.getInstance().getCustomOpacity(pdfViewCtrl.getContext(), Annot.e_Square, ""),
5    ToolStyleConfig.getInstance().getCustomThickness(pdfViewCtrl.getContext(), Annot.e_Square, ""),
6    Color.RED,
7    null,
8    null
9);

1val tool = toolManager.createTool(ToolManager.ToolMode.RECT_CREATE, null) as RectCreate
2tool.setupAnnotProperty(
3  Color.GREEN,
4  ToolStyleConfig.getInstance().getCustomOpacity(pdfViewCtrl.getContext(), Annot.e_Square, ""),
5  ToolStyleConfig.getInstance().getCustomThickness(pdfViewCtrl.getContext(), Annot.e_Square, ""),
6  Color.RED,
7  null, null
8)

where toolManager is an instance of ToolManager.

A table for annotation type and tool mode mapping can be found here: annotation and its creation tool.

Each annotation has a default style that is defined by its creation tool. For example, when you create a Square annotation using the RectCreate tool for the first time, the default behavior to draw a rectangle with a red border and a transparent fill color. These default colors can changed through XML attributes.

1. Add a style to your styles.xml file. For details on supported style attributes, see Tool Style Attributes.

1<style name="ShapeProperty"> 
2    <!-- border color --> 
3    <item name="annot_color">@android:color/white</item> 
4    <!-- fill color --> 
5    <item name="annot_fill_color">@android:color/white</item> 
6    <!-- thickness --> 
7    <item name="annot_thickness">1.0</item> 
8    <!-- opacity --> 
9    <item name="annot_opacity">1.0</item> 
10</style>

2. Add the style resource to ToolStyleConfig by calling addDefaultStyleMap(int, int styleRes)

1// Add the R.style.ShapeProperty to RectCreate tool. 
2// Since the RectCreate tool creates a Square annotation, the annotation type of a Square 
3// annotation is Annot.e_Square 
4ToolStyleConfig.getInstance().addDefaultStyleMap(Annot.e_Square, R.style.ShapeProperty);

1 // Add the R.style.ShapeProperty to RectCreate tool.
2    // Since the RectCreate tool creates a Square annotation, the annotation type of a Square
3    // annotation is Annot.e_Square
4    ToolStyleConfig.getInstance().addDefaultStyleMap(Annot.e_Square, R.style.ShapeProperty)

You can also override existing tool's default styles:

1. Identify the tool whose style you want to override by consulting the following table.

1. Create a custom tool style that inherits from the default tool style resource in styles.xml. For example, if you want to override the FreehandCreate tool style, your custom tool style should inherit from AnnotPresetStyle4.

1<style name="CustomizedToolStyle" parent="AnnotPresetStyle4"> <item name="annot_color">@android:color/white</item> </style>

1. In your application theme, set your custom tool style (CustomizedToolStyle) to the tool style attribute that corresponds to the tool style you wish to override. For example, if you want to the override FreehandCreate tool style, set CustomizedToolStyle to the attribute freehand_default_style.

1<style name="PDFTronAppTheme" parent="PDFTronAppThemeBase"> <item name="freehand_default_style">@style/CustomizedToolStyle</item> </style>

####annot_color Annotation color. For annotations that have an annot_fill_color, it represents stroke color.

format: color

####annot_text_color Annotation text color. Used for FreeText annotations.

format: color

Annotation fill color. Used for annotations that have fill colors, including Square, Circle, and FreeText.

format: color

Annotation font size. Used for FreeText annotations.

format: float

Represents a FreeText annotation's maximum font size.

format: float

Represents a FreeText annotation's minimum font size.

format: float

Annotation thickness for border style

format: float

Annotation maximum thickness

format: float

Annotation minimum thickness

format: float

Annotation font. Used for FreeText annotations.

format: string

Annotation opacity

format: float

Annotation icon. Used for Text annotations.

format: string