# PDAnnotationText.java

    /*
     * Licensed to the Apache Software Foundation (ASF) under one or more
     * contributor license agreements.  See the NOTICE file distributed with
     * this work for additional information regarding copyright ownership.
     * The ASF licenses this file to You under the Apache License, Version 2.0
     * (the "License"); you may not use this file except in compliance with
     * the License.  You may obtain a copy of the License at
     *
     *      http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    package org.apache.pdfbox.pdmodel.interactive.annotation;

    import org.apache.pdfbox.cos.COSDictionary;
    import org.apache.pdfbox.cos.COSName;
    import org.apache.pdfbox.pdmodel.PDDocument;
    import org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDAppearanceHandler;
    import org.apache.pdfbox.pdmodel.interactive.annotation.handlers.PDTextAppearanceHandler;

    /**
     * This is the class that represents a text annotation.
     *
     * @author Paul King
     */
    public class PDAnnotationText extends PDAnnotationMarkup
    {
        private PDAppearanceHandler customAppearanceHandler;

        /*
         * The various values of the Text as defined in the PDF 1.7 reference Table 172
         */

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_COMMENT = "Comment";

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_KEY = "Key";

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_NOTE = "Note";

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_HELP = "Help";

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_NEW_PARAGRAPH = "NewParagraph";

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_PARAGRAPH = "Paragraph";

        /**
         * Constant for the name of a text annotation.
         */
        public static final String NAME_INSERT = "Insert";

        /**
         * Constant for the name of a circle annotation.
         */
        public static final String NAME_CIRCLE = "Circle";

        /**
         * Constant for the name of a cross annotation.
         */
        public static final String NAME_CROSS = "Cross";

        /**
         * Constant for the name of a star annotation.
         */
        public static final String NAME_STAR = "Star";

        /**
         * Constant for the name of a check annotation.
         */
        public static final String NAME_CHECK = "Check";

        /**
         * Constant for the name of a right arrow annotation.
         */
        public static final String NAME_RIGHT_ARROW = "RightArrow";

        /**
         * Constant for the name of a right pointer annotation.
         */
        public static final String NAME_RIGHT_POINTER = "RightPointer";

        /**
         * Constant for the name of a crosshairs annotation.
         */
        public static final String NAME_UP_ARROW = "UpArrow";

        /**
         * Constant for the name of a crosshairs annotation.
         */
        public static final String NAME_UP_LEFT_ARROW = "UpLeftArrow";

        /**
         * Constant for the name of a crosshairs annotation.
         */
        public static final String NAME_CROSS_HAIRS = "CrossHairs";

        /**
         * The type of annotation.
         */
        public static final String SUB_TYPE = "Text";

        /**
         * Constructor.
         */
        public PDAnnotationText()
        {
            getCOSObject().setName(COSName.SUBTYPE, SUB_TYPE);
        }

        /**
         * Creates a Text annotation from a COSDictionary, expected to be a correct object definition.
         *
         * @param field the PDF object to represent as a field.
         */
        public PDAnnotationText(COSDictionary field)
        {
            super(field);
        }

        /**
         * This will set initial state of the annotation, open or closed.
         *
         * @param open Boolean value, true = open false = closed
         */
        public void setOpen(boolean open)
        {
            getCOSObject().setBoolean(COSName.getPDFName("Open"), open);
        }

        /**
         * This will retrieve the initial state of the annotation, open Or closed (default closed).
         *
         * @return The initial state, true = open false = closed
         */
        public boolean getOpen()
        {
            return getCOSObject().getBoolean(COSName.getPDFName("Open"), false);
        }

        /**
         * This will set the name (and hence appearance, AP taking precedence) For this annotation. See the NAME_XXX
         * constants for valid values.
         *
         * @param name The name of the annotation
         */
        public void setName(String name)
        {
            getCOSObject().setName(COSName.NAME, name);
        }

        /**
         * This will retrieve the name (and hence appearance, AP taking precedence) For this annotation. The default is
         * NOTE.
         *
         * @return The name of this annotation, see the NAME_XXX constants.
         */
        public String getName()
        {
            return getCOSObject().getNameAsString(COSName.NAME, NAME_NOTE);
        }

        /**
         * This will retrieve the annotation state.
         *
         * @return the annotation state
         */
        public String getState()
        {
            return this.getCOSObject().getString(COSName.STATE);
        }

        /**
         * This will set the annotation state.
         *
         * @param state the annotation state
         */
        public void setState(String state)
        {
            this.getCOSObject().setString(COSName.STATE, state);
        }

        /**
         * This will retrieve the annotation state model.
         *
         * @return the annotation state model
         */
        public String getStateModel()
        {
            return this.getCOSObject().getString(COSName.STATE_MODEL);
        }

        /**
         * This will set the annotation state model. Allowed values are "Marked" and "Review"
         *
         * @param stateModel the annotation state model
         */
        public void setStateModel(String stateModel)
        {
            this.getCOSObject().setString(COSName.STATE_MODEL, stateModel);
        }

        /**
         * Set a custom appearance handler for generating the annotations appearance streams.
         *
         * @param appearanceHandler
         */
        public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)
        {
            customAppearanceHandler = appearanceHandler;
        }

        @Override
        public void constructAppearances()
        {
            this.constructAppearances(null);
        }

        @Override
        public void constructAppearances(PDDocument document)
        {
            if (customAppearanceHandler == null)
            {
                PDTextAppearanceHandler appearanceHandler = new PDTextAppearanceHandler(this, document);
                appearanceHandler.generateAppearanceStreams();
            }
            else
            {
                customAppearanceHandler.generateAppearanceStreams();
            }
        }
    }