Some test text!

Android SDK

Downloads

FAQ

API

Samples

Changelog

Demo

Guides

Android / Guides / Default style properties

Customize default annotation tool style in Android

## Programmatically 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](https://developer.android.com/reference/android/content/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:

RectCreate tool = (RectCreate) toolManager.createTool(ToolManager.ToolMode.RECT_CREATE, null);
tool.setupAnnotProperty(
    Color.GREEN,
    ToolStyleConfig.getInstance().getCustomOpacity(pdfViewCtrl.getContext(), Annot.e_Square, ""),
    ToolStyleConfig.getInstance().getCustomThickness(pdfViewCtrl.getContext(), Annot.e_Square, ""),
    Color.RED,
    null,
    null
);

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.

XML attributes

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.

However the effect will only take place when the app is first loaded.

Set a tool's default style

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

<style name="ShapeProperty">
    <!-- border color -->
    <item name="annot_color">@android:color/white</item>
    <!-- fill color -->
    <item name="annot_fill_color">@android:color/white</item>
    <!-- thickness -->
    <item name="annot_thickness">1.0</item>
    <!-- opacity -->
    <item name="annot_opacity">1.0</item>
</style>

2. Add the style resource to [`ToolStyleConfig`](/api/android/javadoc/reference/com/pdftron/pdf/config/ToolStyleConfig.html) by calling [`addDefaultStyleMap(int, int styleRes)`](/api/android/javadoc/reference/com/pdftron/pdf/config/ToolStyleConfig.html#addDefaultStyleMap(int,%20int)).

<div class='info'>
<div class='body'>The first parameter of addDefaultStyleMap is an annotation type. You can determine the annotation type from the creator tool by referring to the <a href="@@tools.tool-manager-android.annot-list">Table of annotations and its creation tool</a>.</div>
</div>

```java //@data {"m":true}// // Add the R.style.ShapeProperty to RectCreate tool. // Since the RectCreate tool creates a Square annotation, the annotation type of a Square // annotation is Annot.e_Square ToolStyleConfig.getInstance().addDefaultStyleMap(Annot.e_Square, R.style.ShapeProperty); ```

Override an existing tool's default style

You can also override existing tool's default styles:

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

Tool	Style attribute resource	Default style resource
TextHighlightCreate	`R.attr.highlight_default_style`	`R.style.HighlightPresetStyle1`
TextUnderlineCreate	`R.attr.underline_default_style`	`R.style.TextMarkupStyle1`
TextStrikeoutCreate	`R.attr.strikeout_default_style`	`R.style.TextMarkupStyle1`
TextSquigglyCreate	`R.attr.squiggly_default_style`	`R.style.TextMarkupStyle1`
RectLinkCreate	`R.attr.link_default_style`	`R.style.TextMarkupStyle1`
RulerCreate	`R.attr.ruler_default_style`	`R.style.RulerStyle1`
FreeTextCreate	`R.attr.free_text_default_style`	`R.style.FreeTextPresetStyle1`
StickyNoteCreate	`R.attr.sticky_note_default_style`	`R.style.AnnotPresetStyle1`
Signature	`R.attr.signature_default_style`	`R.style.SignaturePresetStyle1`
FreehandCreate	`R.attr.freehand_default_style`	`R.style.AnnotPresetStyle4`
Other	`R.attr.other_default_style`	`R.style.AnnotPresetStyle4`

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.
```
<style name="CustomizedToolStyle" parent="AnnotPresetStyle4">
    <item name="annot_color">@android:color/white</item>
</style>
```
To learn about style inheritance, see: Defining styles and inheritance.
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.
```
<style name="PDFTronAppTheme" parent="PDFTronAppThemeBase">
    <item name="freehand_default_style">@style/CustomizedToolStyle</item>
</style>
```
To learn about applying custom themes to your application, see: Applying a Theme to an Activity or Application.

Tool style attributes

####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

`annot_fill_color`

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

format: color

`annot_font_size`

Annotation font size. Used for FreeText annotations.

format: float

`annot_text_size_max`

Represents a FreeText annotation's maximum font size.

format: float

`annot_text_size_min`

Represents a FreeText annotation's minimum font size.

format: float

`annot_thickness`

Annotation thickness for border style

format: float

`annot_thickness_max`

Annotation maximum thickness

format: float

`annot_thickness_min`

Annotation minimum thickness

format: float

`annot_font`

Annotation font. Used for FreeText annotations.

format: string

`annot_opacity`

Annotation opacity

format: float

`annot_icon`

Annotation icon. Used for Text annotations.

format: string

Trial setup questions? Ask experts on Discord
Need other help? Contact Support
Pricing or product questions? Contact Sales

Did you find this guide helpful?

Yes