PDF4Java Reference Documentation
com.o2sol.pdf4java.annotations Package / PDFAnnotation Class


In This Topic
    PDFAnnotation Class Methods
    In This Topic

    For a list of all members of this type, see PDFAnnotation members.

    Public Methods
     NameDescription
    Public MethodbeginInitSignals the start of the initialization of annotation's properties.
    The annotation appearance is not updated while properties are initialized. When initialization is completed, call to signal the end of initialization and update the annotation appearance.  
    Public MethodcanRotateGets a value indicating whether the annotation should be rotated when the page is rotated.  
    Public MethodcreateAnnotationAppearanceCreates the visual appearance for the annotation.
    This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodcreateAppearanceCreates the visual appearance for the annotation.
    This method supports the internal library infrastructure and should not be used by external client code.  
    Public Methodstatic (Shared in Visual Basic)createFromCosAnnotationThis method supports the internal library infrastructure and should not be used by external client code.  
    Public Methodstatic (Shared in Visual Basic)createFromXFDFThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodendInitSignals the end of the initialization of annotation's properties.
    The annotation appearance is updated when the initialization ends.  
    Public MethodexportAsXFDFThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodflattenOverloaded. Merges the annotation appearance with the page content stream.
    After the annotation is flattened, it is removed from the page's annotations collection.  
    Public MethodgetContentsGets the annotation contents.  
    Public MethodgetCosAnnotationGets the COS annotation.  
    Public MethodgetCreationDateGets the annotation creation date.  
    Public MethodgetDisplayRectangleGets the display rectangle of this annotation.  
    Public MethodgetIDGets the annotation ID.  
    Public MethodgetModifiedDateGets the annotation modified date.  
    Public MethodgetMouseDownActionGets the mouse down action.  
    Public MethodgetMouseEnterActionGets the mouse enter action.  
    Public MethodgetMouseLeaveActionGets the mouse leave action.  
    Public MethodgetMouseUpActionGets the mouse up action.  
    Public MethodgetNormalAppearanceGets the annotation normal appearance.  
    Public MethodgetPageGets the page that contains this annotation..  
    Public MethodgetPageCloseActionGets the page close action.  
    Public MethodgetPageInvisibleActionGets the page invisible action.  
    Public MethodgetPageOpenActionGets the page open action.  
    Public MethodgetPageVisibleActionGets the page visible action.  
    Public MethodgetPDFRectangleGets the annotation rectangle in standard PDF coordinates.  
    Public MethodgetPopupGets the associated popup annotation.  
    Public MethodgetRotationGets the annotation rotation angle.  
    Public MethodgetToggleNoViewGets a value indicating whether the interpretation of isViewable method should be reversed.  
    Public MethodgetTypeGets the type of the annotation.  
    Public MethodimportFromXFDFThis method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodisHiddenGets a value indicating whether to display the annotation or not.  
    Public MethodisInvisibleGets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types.  
    Public MethodisLockedGets a value indicating whether the annotation should be modified.  
    Public MethodisLockedContentsGets a value indicating whether the annotation contents should be modified.  
    Public MethodisPrintableGets a value indicating whether the annotation should be printed.  
    Public MethodisReadOnlyGets a value indicating whether the annotation is read only.  
    Public MethodisViewableGets a value indicating whether the annotation should be displayed.  
    Public MethodisZoomableGets a value indicating whether the annotation should be scaled to current page zoom.  
    Public MethodsetCanRotateSets a value indicating whether the annotation should be rotated when the page is rotated.  
    Public MethodsetContentsSets the annotation contents.  
    Public MethodsetCreationDateSets the annotation creation date.  
    Public MethodsetDisplayRectangleOverloaded. Sets the display rectangle of this annotation.  
    Public MethodsetIDSets the annotation ID.  
    Public MethodsetIsHiddenSets a value indicating whether to display the annotation or not.  
    Public MethodsetIsInvisibleSets a value indicating whether the annotation should be displayed if it does not belong to one of the standard annotation types.  
    Public MethodsetIsLockedSets a value indicating whether the annotation should be modified.  
    Public MethodsetIsLockedContentsSets a value indicating whether the annotation contents should be modified.  
    Public MethodsetIsPrintableSets a value indicating whether the annotation should be printed.  
    Public MethodsetIsReadOnlySets a value indicating whether the annotation is read only.  
    Public MethodsetIsViewableSets a value indicating whether the annotation should be displayed.  
    Public MethodsetIsZoomableSets a value indicating whether the annotation should be scaled to current page zoom.  
    Public MethodsetModifiedDateSets the annotation modified date.  
    Public MethodsetMouseDownActionSets the mouse down action.  
    Public MethodsetMouseEnterActionSets the mouse enter action.  
    Public MethodsetMouseLeaveActionSets the mouse leave action.  
    Public MethodsetMouseUpActionSets the mouse up action.  
    Public MethodsetNormalAppearanceSets the annotation normal appearance.  
    Public MethodsetPageCloseActionSets the page close action.  
    Public MethodsetPageInvisibleActionSets the page invisible action.  
    Public MethodsetPageOpenActionSets the page open action.  
    Public MethodsetPageVisibleActionSets the page visible action.  
    Public MethodsetPDFRectangleSets the annotation rectangle in standard PDF coordinates.  
    Public MethodsetPopupSets the associated popup annotation.  
    Public MethodsetRotationSets the annotation rotation angle.
    The accepted values for this property are 0, 90, 180 and 270 degrees.  
    Public MethodsetToggleNoViewSets a value indicating whether the interpretation of isViewable method should be reversed.  
    Public MethodzInternalMethod1This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod2This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod3This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod4This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod5This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod6This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod7This method supports the internal library infrastructure and should not be used by external client code.  
    Public MethodzInternalMethod8This method supports the internal library infrastructure and should not be used by external client code.  
    Top
    Protected Methods
     NameDescription
    Protected MethodinitActionsThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodinitAdditionalActionThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodinitAppearanceThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodsetActionThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodwriteXFDFAttributesThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodwriteXFDFChildNodesThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodwriteXFDFEndElementThis method supports the internal library infrastructure and should not be used by external client code.  
    Protected MethodwriteXFDFStartElementThis method supports the internal library infrastructure and should not be used by external client code.  
    Top
    See Also

    Reference

    PDFAnnotation Class
    com.o2sol.pdf4java.annotations Package

     

     

    © 2024 O2 Solutions All Rights Reserved.

    Send comments on this topic.