Class PDFAnnotation

All Implemented Interfaces:
NSCoding, NSObjectProtocol, ObjCProtocol

public class PDFAnnotation
extends NSObject
implements NSCoding
Since:
Available in iOS 11.0 and later.
  • Constructor Details

    • PDFAnnotation

      public PDFAnnotation()
    • PDFAnnotation

      protected PDFAnnotation​(NSObject.Handle h, long handle)
    • PDFAnnotation

      protected PDFAnnotation​(NSObject.SkipInit skipInit)
    • PDFAnnotation

      public PDFAnnotation​(CGRect bounds, String annotationType, NSDictionary<?,​?> properties)
      Since:
      Available in iOS 11.0 and later.
    • PDFAnnotation

      public PDFAnnotation​(NSCoder coder)
  • Method Details

    • getPage

      public PDFPage getPage()
    • setPage

      public void setPage​(PDFPage v)
    • getType

      public String getType()
    • setType

      public void setType​(String v)
    • getBounds

      public CGRect getBounds()
    • setBounds

      public void setBounds​(CGRect v)
    • shouldDisplay

      public boolean shouldDisplay()
    • setShouldDisplay

      public void setShouldDisplay​(boolean v)
    • shouldPrint

      public boolean shouldPrint()
    • setShouldPrint

      public void setShouldPrint​(boolean v)
    • getModificationDate

      public NSDate getModificationDate()
      Since:
      Available in iOS 11.0 and later.
    • setModificationDate

      public void setModificationDate​(NSDate v)
      Since:
      Available in iOS 11.0 and later.
    • getUserName

      public String getUserName()
      Since:
      Available in iOS 11.0 and later.
    • setUserName

      public void setUserName​(String v)
      Since:
      Available in iOS 11.0 and later.
    • getPopup

      public PDFAnnotation getPopup()
      Since:
      Available in iOS 11.0 and later.
    • setPopup

      public void setPopup​(PDFAnnotation v)
      Since:
      Available in iOS 11.0 and later.
    • getBorder

      public PDFBorder getBorder()
      Since:
      Available in iOS 11.0 and later.
    • setBorder

      public void setBorder​(PDFBorder v)
      Since:
      Available in iOS 11.0 and later.
    • getColor

      public UIColor getColor()
      Since:
      Available in iOS 11.0 and later.
    • setColor

      public void setColor​(UIColor v)
      Since:
      Available in iOS 11.0 and later.
    • getContents

      public String getContents()
      Since:
      Available in iOS 11.0 and later.
    • setContents

      public void setContents​(String v)
      Since:
      Available in iOS 11.0 and later.
    • getAction

      public PDFAction getAction()
      Since:
      Available in iOS 11.0 and later.
    • setAction

      public void setAction​(PDFAction v)
      Since:
      Available in iOS 11.0 and later.
    • hasAppearanceStream

      public boolean hasAppearanceStream()
    • isHighlighted

      public boolean isHighlighted()
      Since:
      Available in iOS 11.0 and later.
    • setHighlighted

      public void setHighlighted​(boolean v)
      Since:
      Available in iOS 11.0 and later.
    • getAnnotationKeyValues

      public NSDictionary<?,​?> getAnnotationKeyValues()
      Since:
      Available in iOS 11.0 and later.
    • getFont

      public UIFont getFont()
    • setFont

      public void setFont​(UIFont v)
    • getFontColor

      public UIColor getFontColor()
    • setFontColor

      public void setFontColor​(UIColor v)
    • getInteriorColor

      public UIColor getInteriorColor()
    • setInteriorColor

      public void setInteriorColor​(UIColor v)
    • getAlignment

      public NSTextAlignment getAlignment()
    • setAlignment

      public void setAlignment​(NSTextAlignment v)
    • getStartPoint

      public CGPoint getStartPoint()
    • setStartPoint

      public void setStartPoint​(CGPoint v)
    • getEndPoint

      public CGPoint getEndPoint()
    • setEndPoint

      public void setEndPoint​(CGPoint v)
    • getStartLineStyle

      public PDFLineStyle getStartLineStyle()
    • setStartLineStyle

      public void setStartLineStyle​(PDFLineStyle v)
    • getEndLineStyle

      public PDFLineStyle getEndLineStyle()
    • setEndLineStyle

      public void setEndLineStyle​(PDFLineStyle v)
    • getIconType

      public PDFTextAnnotationIconType getIconType()
    • setIconType

      public void setIconType​(PDFTextAnnotationIconType v)
    • getQuadrilateralPoints

      public NSArray<NSValue> getQuadrilateralPoints()
    • setQuadrilateralPoints

      public void setQuadrilateralPoints​(NSArray<NSValue> v)
    • getMarkupType

      public PDFMarkupType getMarkupType()
    • setMarkupType

      public void setMarkupType​(PDFMarkupType v)
    • getWidgetFieldType

      public String getWidgetFieldType()
    • setWidgetFieldType

      public void setWidgetFieldType​(String v)
    • getWidgetControlType

      public PDFWidgetControlType getWidgetControlType()
    • setWidgetControlType

      public void setWidgetControlType​(PDFWidgetControlType v)
    • isMultiline

      public boolean isMultiline()
    • setMultiline

      public void setMultiline​(boolean v)
    • isPasswordField

      public boolean isPasswordField()
    • isComb

      public boolean isComb()
    • setComb

      public void setComb​(boolean v)
    • getMaximumLength

      public long getMaximumLength()
    • setMaximumLength

      public void setMaximumLength​(long v)
    • getWidgetStringValue

      public String getWidgetStringValue()
    • setWidgetStringValue

      public void setWidgetStringValue​(String v)
    • getWidgetDefaultStringValue

      public String getWidgetDefaultStringValue()
    • setWidgetDefaultStringValue

      public void setWidgetDefaultStringValue​(String v)
    • allowsToggleToOff

      public boolean allowsToggleToOff()
    • setAllowsToggleToOff

      public void setAllowsToggleToOff​(boolean v)
    • isRadiosInUnison

      public boolean isRadiosInUnison()
    • setRadiosInUnison

      public void setRadiosInUnison​(boolean v)
    • isReadOnly

      public boolean isReadOnly()
    • setReadOnly

      public void setReadOnly​(boolean v)
    • isListChoice

      public boolean isListChoice()
    • setListChoice

      public void setListChoice​(boolean v)
    • getChoices

      public NSArray<NSString> getChoices()
    • setChoices

      public void setChoices​(NSArray<NSString> v)
    • getValues

      public NSArray<NSString> getValues()
    • setValues

      public void setValues​(NSArray<NSString> v)
    • getButtonWidgetState

      public PDFWidgetCellState getButtonWidgetState()
    • setButtonWidgetState

      public void setButtonWidgetState​(PDFWidgetCellState v)
    • getButtonWidgetStateString

      public String getButtonWidgetStateString()
    • setButtonWidgetStateString

      public void setButtonWidgetStateString​(String v)
    • isOpen

      public boolean isOpen()
    • setOpen

      public void setOpen​(boolean v)
    • getPaths

      public NSArray<UIBezierPath> getPaths()
    • getDestination

      public PDFDestination getDestination()
    • setDestination

      public void setDestination​(PDFDestination v)
    • getURL

      public NSURL getURL()
    • setURL

      public void setURL​(NSURL v)
    • getFieldName

      public String getFieldName()
    • setFieldName

      public void setFieldName​(String v)
    • getCaption

      public String getCaption()
    • setCaption

      public void setCaption​(String v)
    • getBackgroundColor

      public UIColor getBackgroundColor()
    • setBackgroundColor

      public void setBackgroundColor​(UIColor v)
    • getStampName

      public String getStampName()
    • setStampName

      public void setStampName​(String v)
    • init

      protected long init​(CGRect bounds, String annotationType, NSDictionary<?,​?> properties)
      Since:
      Available in iOS 11.0 and later.
    • draw

      public void draw​(PDFDisplayBox box, CGContext context)
      Since:
      Available in iOS 11.0 and later.
    • setValue

      public boolean setValue​(NSObject value, String key)
      Since:
      Available in iOS 11.0 and later.
    • setBoolean

      public boolean setBoolean​(boolean value, String key)
      Since:
      Available in iOS 11.0 and later.
    • setRect

      public boolean setRect​(CGRect value, String key)
      Since:
      Available in iOS 11.0 and later.
    • valueForAnnotationKey

      public NSObject valueForAnnotationKey​(String key)
      Since:
      Available in iOS 11.0 and later.
    • removeValueForAnnotationKey

      public void removeValueForAnnotationKey​(String key)
      Since:
      Available in iOS 11.0 and later.
    • addBezierPath

      public void addBezierPath​(UIBezierPath path)
    • removeBezierPath

      public void removeBezierPath​(UIBezierPath path)
    • lineStyleFromName

      public static PDFLineStyle lineStyleFromName​(String name)
    • nameForLineStyle

      public static String nameForLineStyle​(PDFLineStyle style)
    • encode

      public void encode​(NSCoder coder)
      Specified by:
      encode in interface NSCoding
    • init

      protected long init​(NSCoder coder)