Customize annotation style properties

AnnotEdit tool class can edit the style of a selected annotation easily by using annotation style dialog . You can set AnnotEdit tool to ToolManager as described here: change tool mode .

With Apryse library, you can change annotation styles such as border color, border thickness, fill color, etc. To change annotation style, you must lock PDF document first. For more information about locking document, see: document locking.

Changing an annotation border thickness

To change an annotation border thickness:

1. Get the BorderStyle from the annotation by calling annot.getBorderStyle().
2. Set thickness to the BorderSytle by calling borderStyle.setWidth(double).
3. Refresh the annotation appearance by calling annot.refreshAppearance().
4. Update the PDFViewCtrl contents by calling pdfViewCtrl.update().

Java

void changeAnnotThickness(final PDFViewCtrl pdfViewCtrl, final Annot annot, final double thickness) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            Annot.BorderStyle borderStyle = annot.getBorderStyle();
            borderStyle.setWidth(thickness);

            annot.refreshAppearance();
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeAnnotThickness(pdfViewCtrl: PDFViewCtrl, annot: Annot, thickness: Double) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        val borderStyle = annot.borderStyle
        borderStyle.width = thickness
        annot.refreshAppearance()
        pdfViewCtrl.update()
    }
}

To make annotation border invisible, call borderStyle.setWidth(0).

Changing an annotation border color.

If there is a FreeText annotation, to set the border color of the annotation, call [freeText.setLineColor(ColorPt, int)](https://sdk.apryse.com/api/android/javadoc/reference/com/pdftron/pdf/annots/FreeText.html#setLineColor(com.pdftron.pdf.ColorPt, int)). To set the border color of the other annotation types, call [annot.setColor(ColorPt, int)](https://sdk.apryse.com/api/android/javadoc/reference/com/pdftron/pdf/Annot.html#setColor(com.pdftron.pdf.ColorPt, int)).

Java

void changeAnnotBorderColor(final PDFViewCtrl pdfViewCtrl, final Annot annot, final @ColorInt int color) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            ColorPt colorPt = Utils.color2ColorPt(color);
            // if color is transparent, then color component number is 0.
            int colorCompNum = color == Color.TRANSPARENT ? 0 : 3;
            // if the annotation is a FreeText annotation
            if (annot.getType() == Annot.e_FreeText) {
                FreeText freeText = new FreeText(annot);
                freeText.setLineColor(colorPt, colorCompNum);
            } else {
                annot.setColor(colorPt, colorCompNum);
            }

            annot.refreshAppearance();
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeAnnotBorderColor(pdfViewCtrl: PDFViewCtrl, annot: Annot, @ColorInt color: Int) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, object : LockRunnable {
        @Throws(Exception::class)
        override fun run() {
            val colorPt: ColorPt = Utils.color2ColorPt(color)
            // if color is transparent, then color component number is 0.
            val colorCompNum: Int = if (color == Color.TRANSPARENT) 0 else 3
            // if the annotation is a FreeText annotation
            if (annot.type == Annot.e_FreeText) {
                val freeText = FreeText(annot)
                freeText.setLineColor(colorPt, colorCompNum)
            } else {
                annot.setColor(colorPt, colorCompNum)
            }
            annot.refreshAppearance()
            pdfViewCtrl.update()
        }
    })
}

To set the color of a Text annotation, call annot.setColor(ColorPt, int).

Changing an annotation opacity

To change the opacity of a Markup annotation, callMarkup.setOpacity(double):

Java

void changeAnnotOpacity(final PDFViewCtrl pdfViewCtrl, final Annot annot, final double opacity) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            // if the annotation is a markup annotation,
            // set opacity to the annotation
            if (annot.isMarkup()) {
            Markup markup = new Markup(annot);
            markup.setOpacity(opacity);
            }
            
            annot.refreshAppearance();
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeAnnotOpacity(pdfViewCtrl: PDFViewCtrl, annot: Annot, opacity: Double) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        // if the annotation is a markup annotation,
        // set opacity to the annotation
        if (annot.isMarkup) {
            val markup = Markup(annot)
            markup.opacity = opacity
        }
        annot.refreshAppearance()
        pdfViewCtrl.update()
    }
}

Changing an annotation fill color

To set the fill color of a Markup annotation, call [Markup.setInteriorColor(ColorPt, int)](https://sdk.apryse.com/api/android/javadoc/reference/com/pdftron/pdf/annots/Markup.html#setInteriorColor(com.pdftron.pdf.ColorPt, int)).

Java

void changeAnnotInteriorColor(final PDFViewCtrl pdfViewCtrl, final Annot annot, @ColorInt final int color) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            ColorPt colorPt = Utils.color2ColorPt(color);
            // if color is transparent, then color component number is 0.
            int colorCompNum = color == Color.TRANSPARENT ? 0 : 3;
            // if the annotation is a Markup annotation,
            // set interior color to the annotation.
            if (annot.isMarkup()) {
                Markup markup = new Markup(annot);
                markup.setInteriorColor(colorPt, colorCompNum);
            }
            // refresh the annotation appearch
            annot.refreshAppearance();
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeAnnotInteriorColor(pdfViewCtrl: PDFViewCtrl, annot: Annot, @ColorInt color: Int) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        val colorPt = Utils.color2ColorPt(color)
        // if color is transparent, then color component number is 0.
        val colorCompNum = if (color == Color.TRANSPARENT) 0 else 3
        // if the annotation is a Markup annotation,
        // set interior color to the annotation.
        if (annot.isMarkup) {
            val markup = Markup(annot)
            markup.setInteriorColor(colorPt, colorCompNum)
        }
        // refresh the annotation appearch
        annot.refreshAppearance()
        pdfViewCtrl.update()
    }
}

Changing a Text annotation icon

To change a Text annotation icon, call Text.setIcon(String). After changing the icon, you must refresh the annotation appearance by calling [AnnotUtils.refreshStickyNoteAppearance(Annot, PDFViewCtrl)](https://sdk.apryse.com/api/android/javadoc/reference/com/pdftron/pdf/utils/AnnotUtils.html#refreshStickyNoteAppearance(Annot, PDFViewCtrl)).

For available icons, see: default icons table .

Java

void changeAnnotInteriorColor(final PDFViewCtrl pdfViewCtrl, final Annot annot, final String icon) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            Text text = new Text(annot);
            text.setIcon(icon);
            // refresh the annotation appearch
            AnnotUtils.refreshStickyNoteAppearance(annot, pdfViewCtrl);
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeAnnotInteriorColor(pdfViewCtrl: PDFViewCtrl, annot: Annot?, icon: String?) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        val text = Text(annot)
        text.setIcon(icon)
        // refresh the annotation appearch
        AnnotUtils.refreshStickyNoteAppearance(annot, pdfViewCtrl)
        pdfViewCtrl.update()
    }
}

Changing a FreeText annotation text color

To change the text color of a FreeText annotation, call [FreeText.setTextColor(ColorPt, int)](https://sdk.apryse.com/api/android/javadoc/reference/com/pdftron/pdf/annots/FreeText.html#setTextColor(com.pdftron.pdf.ColorPt, int)).

Java

void changeFreeTextColor(final PDFViewCtrl pdfViewCtrl, final Annot annot, @ColorInt final int color) throws Exception {

    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            ColorPt colorPt = Utils.color2ColorPt(color);
            // set FreeText annotation text color
            FreeText freeText = new FreeText(annot);
            freeText.setTextColor(colorPt, 3);

            annot.refreshAppearance();
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeFreeTextColor(pdfViewCtrl: PDFViewCtrl, annot: Annot, @ColorInt color: Int) {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        val colorPt = Utils.color2ColorPt(color)
        // set FreeText annotation text color
        val freeText = FreeText(annot)
        freeText.setTextColor(colorPt, 3)
        annot.refreshAppearance()
        pdfViewCtrl.update()
    }
}

Changing a FreeText annotation text size

To change the text size of a FreeText annotation, call FreeText.setFontSize(double).

Java

void changeFreeTextSize(final PDFViewCtrl pdfViewCtrl, final Annot annot, final double textSize) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            // set FreeText annotation text color
            FreeText freeText = new FreeText(annot);
            freeText.setFontSize(textSize);
            // refresh the annotation appearance
            annot.refreshAppearance();
            pdfViewCtrl.update();
        }
    });
}

Kotlin

fun changeFreeTextSize(pdfViewCtrl: PDFViewCtrl, annot: Annot, textSize: Double) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        // set FreeText annotation text color
        val freeText = FreeText(annot)
        freeText.fontSize = textSize
        // refresh the annotation appearance
        annot.refreshAppearance()
        pdfViewCtrl.update()
    }
}

Changing a FreeText annotation font

The follow code snippet shows how to set the font to a FreeText annotation:

Java

void changeFreeTextFont(final PDFViewCtrl pdfViewCtrl, final Annot annot, final String fontStr) throws Exception {
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true, new PDFViewCtrl.LockRunnable() {
        @Override
        public void run() throws Exception {
            // set FreeText annotation text color
            FreeText textAnnot = new FreeText(annot);
            String fontDRName = "F0";

            // Create a DR entry for embedding the font
            Obj annotObj = textAnnot.getSDFObj();
            Obj drDict = annotObj.putDict("DR");
            Obj fontDict = drDict.putDict("Font");

            // Embed the font
            Font font = Font.create(pdfViewCtrl.getDoc(), fontStr, textAnnot.getContents());
            fontDict.put(fontDRName, font.GetSDFObj());
            String fontName = font.getName();

            // Set DA string
            String DA = textAnnot.getDefaultAppearance();
            int slashPosition = DA.indexOf("/", 0);

            // if DR string contains '/' which it always should.
            if (slashPosition > 0) {
                String beforeSlash = DA.substring(0, slashPosition);
                String afterSlash = DA.substring(slashPosition);
                String afterFont = afterSlash.substring(afterSlash.indexOf(" "));
                String updatedDA = beforeSlash + "/" + fontDRName + afterFont;

                textAnnot.setDefaultAppearance(updatedDA);

                // refresh text annotation appearance
                textAnnot.refreshAppearance();
                pdfViewCtrl.update();
            }
        }
    });
}

Kotlin

fun changeFreeTextFont(pdfViewCtrl: PDFViewCtrl, annot: Annot?, fontStr: String?) { 
    // Locks the document first as accessing annotation/doc
    // information isn't thread safe.
    pdfViewCtrl.docLock(true) {
        // set FreeText annotation text color
        val textAnnot = FreeText(annot)
        val fontDRName = "F0"
        // Create a DR entry for embedding the font
        val annotObj = textAnnot.sdfObj
        val drDict = annotObj.putDict("DR")
        val fontDict = drDict.putDict("Font")
        // Embed the font
        val font = Font.create(pdfViewCtrl.doc, fontStr, textAnnot.contents)
        fontDict.put(fontDRName, font.GetSDFObj())
        val fontName = font.name
        // Set DA string
        val DA = textAnnot.defaultAppearance
        val slashPosition = DA.indexOf("/", 0)
        // if DR string contains '/' which it always should.
        if (slashPosition > 0) {
            val beforeSlash = DA.substring(0, slashPosition)
            val afterSlash = DA.substring(slashPosition)
            val afterFont = afterSlash.substring(afterSlash.indexOf(" "))
            val updatedDA = "$beforeSlash/$fontDRName$afterFont"
            textAnnot.defaultAppearance = updatedDA
            // refresh text annotation appearance
            textAnnot.refreshAppearance()
            pdfViewCtrl.update()
        }
    }
}