Home » pdfbox-1.1.0-src » org.apache.pdfbox.pdmodel.interactive.annotation » [javadoc | source]
org.apache.pdfbox.pdmodel.interactive.annotation
public class: PDAnnotationWidget [javadoc | source]
java.lang.Object
   org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation
      org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget

All Implemented Interfaces:
    COSObjectable

This is the class that represents a widget.
Field Summary
public static final  String SUB_TYPE    The type of annotation. 
Fields inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
FLAG_INVISIBLE,  FLAG_HIDDEN,  FLAG_PRINTED,  FLAG_NO_ZOOM,  FLAG_NO_ROTATE,  FLAG_NO_VIEW,  FLAG_READ_ONLY,  FLAG_LOCKED,  FLAG_TOGGLE_NO_VIEW
Constructor:
 public PDAnnotationWidget() 
 public PDAnnotationWidget(COSDictionary field) 
    Creates a PDWidget from a COSDictionary, expected to be a correct object definition for a field in PDF.
    Parameters:
    field - the PDF objet to represent as a field.
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget Summary:
getAction,   getActions,   getAppearanceCharacteristics,   getBorderStyle,   getHighlightingMode,   setAction,   setActions,   setAppearanceCharacteristics,   setBorderStyle,   setHighlightingMode
Methods from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation:
createAnnotation,   getAnnotationFlags,   getAnnotationName,   getAppearance,   getAppearanceStream,   getCOSObject,   getColour,   getContents,   getDictionary,   getModifiedDate,   getPage,   getRectangle,   getSubtype,   isHidden,   isInvisible,   isLocked,   isNoRotate,   isNoView,   isNoZoom,   isPrinted,   isReadOnly,   isToggleNoView,   setAnnotationFlags,   setAnnotationName,   setAppearance,   setAppearanceStream,   setColour,   setContents,   setHidden,   setInvisible,   setLocked,   setModifiedDate,   setNoRotate,   setNoView,   setNoZoom,   setPrinted,   setReadOnly,   setRectangle,   setToggleNoView
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget Detail:
 public PDAction getAction() throws IOException 
    Get the action to be performed when this annotation is to be activated.
 public PDAnnotationAdditionalActions getActions() 
    Get the additional actions for this field. This will return null if there are no additional actions for this field. As of PDF 1.6 this is only used for Widget Annotations.
 public PDAppearanceCharacteristicsDictionary getAppearanceCharacteristics() 
    Returns the appearance characteristics dictionary.
 public PDBorderStyleDictionary getBorderStyle() 
    This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line.
 public String getHighlightingMode() 
    Returns the highlighting mode. Default value: I
    N
    (None) No highlighting.
    I
    (Invert) Invert the contents of the annotation rectangle.
    O
    (Outline) Invert the annotation's border.
    P
    (Push) Display the annotation's down appearance, if any. If no down appearance is defined, the contents of the annotation rectangle shall be offset to appear as if it were pushed below the surface of the page
    T
    (Toggle) Same as P (which is preferred).
 public  void setAction(PDAction action) 
    Set the annotation action. As of PDF 1.6 this is only used for Widget Annotations
 public  void setActions(PDAnnotationAdditionalActions actions) 
    Set the actions of the field.
 public  void setAppearanceCharacteristics(PDAppearanceCharacteristicsDictionary appearanceCharacteristics) 
    Sets the appearance characteristics dictionary.
 public  void setBorderStyle(PDBorderStyleDictionary bs) 
    This will set the border style dictionary, specifying the width and dash pattern used in drawing the line.
 public  void setHighlightingMode(String highlightingMode) 
    Sets the highlighting mode.
    N
    (None) No highlighting.
    I
    (Invert) Invert the contents of the annotation rectangle.
    O
    (Outline) Invert the annotation's border.
    P
    (Push) Display the annotation's down appearance, if any. If no down appearance is defined, the contents of the annotation rectangle shall be offset to appear as if it were pushed below the surface of the page
    T
    (Toggle) Same as P (which is preferred).