import { ObjectManager } from "../../ObjectManager"; import { MarkupAnnotation, type MarkupAnnotationProperties } from "./MarkupAnnotation"; /** * Specifies the possible icons used to display a {@link TextAnnotation}. */ export type TextAnnotationIcon = "Note" | "Comment" | "Key" | "Help" | "NewParagraph" | "Paragraph" | "Insert"; /** * Defines properties of a sticky note attached to a point in a PDF document. * @see {@link TextAnnotation} */ export type TextAnnotationProperties = MarkupAnnotationProperties & { type: "text"; /** * A flag specifying whether the annotation should initially be displayed open. */ open?: boolean; /** * The type of the icon used to display the annotation, possible values: * "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert". */ icon?: TextAnnotationIcon; /** * The state to which the original annotation shall be set. * The following describes the predefined combinations of State and StateModel, and their meanings: * * 1. StateModel "Marked", State "Marked" * The annotation has been marked by the user. * 2. StateModel "Marked", State "Unmarked" * The annotation has not been marked by the user (the default). * 3. StateModel "Review", State "Accepted" * The user agrees with the change. * 4. StateModel "Review", State "Rejected" * The user disagrees with the change. * 5. StateModel "Review", State "Cancelled" * The change has been cancelled. * 6. StateModel "Review", State "Completed" * The change has been completed. * 7. StateModel "Review", State "None" * The user has indicated nothing about the change (the default). * * See PDF specification for more details. */ state?: string; /** * The state model corresponding to 'State'. * * See 'State' and PDF specification for details. */ stateModel?: string; }; /** * Represents a sticky note attached to a point in a PDF document. */ export declare class TextAnnotation extends MarkupAnnotation { /** * Creates a new {@link TextAnnotation}. * * @param om - {@link ObjectManager} that controls the lifetime of the {@link TextAnnotation}. */ constructor(om: ObjectManager); /** * Creates a new {@link TextAnnotation}. */ constructor(); /** * Gets or sets a flag specifying whether the annotation should initially be displayed open. */ get open(): boolean; /** * Gets or sets a flag specifying whether the annotation should initially be displayed open. */ set open(value: boolean); /** * Gets or sets the type of the icon used to display the annotation, possible values: * "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert". */ get icon(): string; /** * Gets or sets the type of the icon used to display the annotation, possible values: * "Note", "Comment", "Key", "Help", "NewParagraph", "Paragraph", "Insert". */ set icon(value: TextAnnotationIcon); /** * Gets or sets the state to which the original annotation shall be set. * The following describes the predefined combinations of State and StateModel, and their meanings: * * 1. StateModel "Marked", State "Marked" * The annotation has been marked by the user. * 2. StateModel "Marked", State "Unmarked" * The annotation has not been marked by the user (the default). * 3. StateModel "Review", State "Accepted" * The user agrees with the change. * 4. StateModel "Review", State "Rejected" * The user disagrees with the change. * 5. StateModel "Review", State "Cancelled" * The change has been cancelled. * 6. StateModel "Review", State "Completed" * The change has been completed. * 7. StateModel "Review", State "None" * The user has indicated nothing about the change (the default). * * See PDF specification for more details. */ get state(): string; /** * Gets or sets the state to which the original annotation shall be set. * The following describes the predefined combinations of State and StateModel, and their meanings: * * 1. StateModel "Marked", State "Marked" * The annotation has been marked by the user. * 2. StateModel "Marked", State "Unmarked" * The annotation has not been marked by the user (the default). * 3. StateModel "Review", State "Accepted" * The user agrees with the change. * 4. StateModel "Review", State "Rejected" * The user disagrees with the change. * 5. StateModel "Review", State "Cancelled" * The change has been cancelled. * 6. StateModel "Review", State "Completed" * The change has been completed. * 7. StateModel "Review", State "None" * The user has indicated nothing about the change (the default). * * See PDF specification for more details. */ set state(value: string); /** * Gets or sets the state model corresponding to 'State'. * * See 'State' and PDF specification for details. */ get stateModel(): string; /** * Gets or sets the state model corresponding to 'State'. * * See 'State' and PDF specification for details. */ set stateModel(value: string); }