Java Doc for PDAnnotation.java in  » PDF » PDFBox-0.7.3 » org » pdfbox » pdmodel » interactive » annotation » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » PDF » PDFBox 0.7.3 » org.pdfbox.pdmodel.interactive.annotation   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.pdfbox.pdmodel.interactive.annotation.PDAnnotation All known Subclasses:   org.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnknown,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLink,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationPopup,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationFileAttachment, PDAnnotation abstract public class PDAnnotation implements COSObjectable(Code) This class represents a PDF annotation. author:    Ben Litchfield version:    $Revision: 1.14 $ Field Summary final public static  int FLAG_HIDDEN      An annotation flag. final public static  int FLAG_INVISIBLE      An annotation flag. final public static  int FLAG_LOCKED      An annotation flag. final public static  int FLAG_NO_ROTATE      An annotation flag. final public static  int FLAG_NO_VIEW      An annotation flag. final public static  int FLAG_NO_ZOOM      An annotation flag. final public static  int FLAG_PRINTED      An annotation flag. final public static  int FLAG_READ_ONLY      An annotation flag. final public static  int FLAG_TOGGLE_NO_VIEW      An annotation flag. Constructor Summary public   PDAnnotation()      Constructor. public   PDAnnotation(COSDictionary dict)      Constructor. Method Summary public static  PDAnnotation createAnnotation(COSBase base)      Create the correct annotation from the base COS object. Parameters:   base - The COS object that is the annotation. public  PDAction getAction()      Get the action to be performed when this annotation is to be activated. public  PDAdditionalActions getActions()      Get the additional actions for this field. public  int getAnnotationFlags()      This will get the flags for this field. public  String getAnnotationName()      This will get the name, a string intended to uniquely identify each annotatoin within a page. public  PDAppearanceDictionary getAppearance()      This will get the appearance dictionary associated with this annotation. public  String getAppearanceStream()      This will get the name of the current appearance stream if any. public  PDBorderStyleDictionary getBoderStyle()      This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line. public  COSBase getCOSObject()      Interface method for COSObjectable. public  PDGamma getColour()      This will retrieve the colour used in drawing various elements. public  String getContents()      Get the "contents" of the field. public  COSDictionary getDictionary()      returns the dictionary. public  String getModifiedDate()      This will retrieve the date and time the annotation was modified. public  PDRectangle getRectangle()      The annotation rectangle, defining the location of the annotation on the page in default user space units. public  boolean isHidden()      Get the hidden flag. public  boolean isInvisible()      Get the invisible flag. public  boolean isLocked()      Get the locked flag. public  boolean isNoRotate()      Get the noRotate flag. public  boolean isNoView()      Get the noView flag. public  boolean isNoZoom()      Get the noZoom flag. public  boolean isPrinted()      Get the printed flag. public  boolean isReadOnly()      Get the readOnly flag. public  boolean isToggleNoView()      Get the toggleNoView flag. public  void setAction(PDAction action)      Set the annotation action. public  void setActions(PDAdditionalActions actions)      Set the actions of the field. public  void setAnnotationFlags(int flags)      This will set the flags for this field. public  void setAnnotationName(String nm)      This will set the name, a string intended to uniquely identify each annotatoin within a page. public  void setAppearance(PDAppearanceDictionary appearance)      This will set the appearance associated with this annotation. public  void setAppearanceStream(String as)      This will set the annotations appearance stream name. 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 setColour(PDGamma c)      This will set the colour used in drawing various elements. public  void setContents(String value)      Set the "contents" of the field. public  void setHidden(boolean hidden)      Set the hidden flag. public  void setInvisible(boolean invisible)      Set the invisible flag. public  void setLocked(boolean locked)      Set the locked flag. public  void setModifiedDate(String m)      This will set the the date and time the annotation was modified. public  void setNoRotate(boolean noRotate)      Set the noRotate flag. public  void setNoView(boolean noView)      Set the noView flag. public  void setNoZoom(boolean noZoom)      Set the noZoom flag. public  void setPrinted(boolean printed)      Set the printed flag. public  void setReadOnly(boolean readOnly)      Set the readOnly flag. public  void setRectangle(PDRectangle rectangle)      This will set the rectangle for this annotation. public  void setToggleNoView(boolean toggleNoView)      Set the toggleNoView flag. Field Detail FLAG_HIDDEN final public static int FLAG_HIDDEN(Code) An annotation flag. FLAG_INVISIBLE final public static int FLAG_INVISIBLE(Code) An annotation flag. FLAG_LOCKED final public static int FLAG_LOCKED(Code) An annotation flag. FLAG_NO_ROTATE final public static int FLAG_NO_ROTATE(Code) An annotation flag. FLAG_NO_VIEW final public static int FLAG_NO_VIEW(Code) An annotation flag. FLAG_NO_ZOOM final public static int FLAG_NO_ZOOM(Code) An annotation flag. FLAG_PRINTED final public static int FLAG_PRINTED(Code) An annotation flag. FLAG_READ_ONLY final public static int FLAG_READ_ONLY(Code) An annotation flag. FLAG_TOGGLE_NO_VIEW final public static int FLAG_TOGGLE_NO_VIEW(Code) An annotation flag. Constructor Detail PDAnnotation public PDAnnotation()(Code) Constructor. PDAnnotation public PDAnnotation(COSDictionary dict)(Code) Constructor. Parameters:   dict - The annotations dictionary. Method Detail createAnnotation public static PDAnnotation createAnnotation(COSBase base) throws IOException(Code) Create the correct annotation from the base COS object. Parameters:   base - The COS object that is the annotation. The correctly typed annotation object. throws:   IOException - If there is an error while creating the annotation. getAction public PDAction getAction() throws IOException(Code) Get the action to be performed when this annotation is to be activated. The action to be performed when this annotation is activated. throws:   IOException - If there is an error creating the action. getActions public PDAdditionalActions getActions()(Code) 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. The actions of the field. getAnnotationFlags public int getAnnotationFlags()(Code) This will get the flags for this field. flags The set of flags. getAnnotationName public String getAnnotationName()(Code) This will get the name, a string intended to uniquely identify each annotatoin within a page. Not to be confused with some annotations Name entry which impact the default image drawn for them. The identifying name for the Annotion. getAppearance public PDAppearanceDictionary getAppearance()(Code) This will get the appearance dictionary associated with this annotation. This may return null. This annotations appearance. getAppearanceStream public String getAppearanceStream()(Code) This will get the name of the current appearance stream if any. The name of the appearance stream. getBoderStyle public PDBorderStyleDictionary getBoderStyle()(Code) This will retrieve the border style dictionary, specifying the width and dash pattern used in drawing the line. the border style dictionary. getCOSObject public COSBase getCOSObject()(Code) Interface method for COSObjectable. This object as a standard COS object. getColour public PDGamma getColour()(Code) This will retrieve the colour used in drawing various elements. As of PDF 1.6 these are : Background of icon when closed Title bar of popup window Border of a link annotation Colour is in DeviceRGB colourspace PDGamma object representing the colour getContents public String getContents()(Code) Get the "contents" of the field. the value of the contents. getDictionary public COSDictionary getDictionary()(Code) returns the dictionary. the dictionary getModifiedDate public String getModifiedDate()(Code) This will retrieve the date and time the annotation was modified. the modified date/time (often in date format, but can be an arbitary string). getRectangle public PDRectangle getRectangle()(Code) The annotation rectangle, defining the location of the annotation on the page in default user space units. This is usually required and should not return null on valid PDF documents. But where this is a parent form field with children, such as radio button collections then the rectangle will be null. The Rect value of this annotation. isHidden public boolean isHidden()(Code) Get the hidden flag. The hidden flag. isInvisible public boolean isInvisible()(Code) Get the invisible flag. The invisible flag. isLocked public boolean isLocked()(Code) Get the locked flag. The locked flag. isNoRotate public boolean isNoRotate()(Code) Get the noRotate flag. The noRotate flag. isNoView public boolean isNoView()(Code) Get the noView flag. The noView flag. isNoZoom public boolean isNoZoom()(Code) Get the noZoom flag. The noZoom flag. isPrinted public boolean isPrinted()(Code) Get the printed flag. The printed flag. isReadOnly public boolean isReadOnly()(Code) Get the readOnly flag. The readOnly flag. isToggleNoView public boolean isToggleNoView()(Code) Get the toggleNoView flag. The toggleNoView flag. setAction public void setAction(PDAction action)(Code) Set the annotation action. As of PDF 1.6 this is only used for Widget Annotations Parameters:   action - The annotation action. setActions public void setActions(PDAdditionalActions actions)(Code) Set the actions of the field. Parameters:   actions - The field actions. setAnnotationFlags public void setAnnotationFlags(int flags)(Code) This will set the flags for this field. Parameters:   flags - The new flags. setAnnotationName public void setAnnotationName(String nm)(Code) This will set the name, a string intended to uniquely identify each annotatoin within a page. Not to be confused with some annotations Name entry which impact the default image drawn for them. Parameters:   nm - The identifying name for the annotation. setAppearance public void setAppearance(PDAppearanceDictionary appearance)(Code) This will set the appearance associated with this annotation. Parameters:   appearance - The appearance dictionary for this annotation. setAppearanceStream public void setAppearanceStream(String as)(Code) This will set the annotations appearance stream name. Parameters:   as - The name of the appearance stream. setBorderStyle public void setBorderStyle(PDBorderStyleDictionary bs)(Code) This will set the border style dictionary, specifying the width and dash pattern used in drawing the line. Parameters:   bs - the border style dictionary to set. setColour public void setColour(PDGamma c)(Code) This will set the colour used in drawing various elements. As of PDF 1.6 these are : Background of icon when closed Title bar of popup window Border of a link annotation Colour is in DeviceRGB colourspace Parameters:   c - colour in the DeviceRGB colourspace setContents public void setContents(String value)(Code) Set the "contents" of the field. Parameters:   value - the value of the contents. setHidden public void setHidden(boolean hidden)(Code) Set the hidden flag. Parameters:   hidden - The new hidden flag. setInvisible public void setInvisible(boolean invisible)(Code) Set the invisible flag. Parameters:   invisible - The new invisible flag. setLocked public void setLocked(boolean locked)(Code) Set the locked flag. Parameters:   locked - The new locked flag. setModifiedDate public void setModifiedDate(String m)(Code) This will set the the date and time the annotation was modified. Parameters:   m - the date and time the annotation was created. setNoRotate public void setNoRotate(boolean noRotate)(Code) Set the noRotate flag. Parameters:   noRotate - The new noRotate flag. setNoView public void setNoView(boolean noView)(Code) Set the noView flag. Parameters:   noView - The new noView flag. setNoZoom public void setNoZoom(boolean noZoom)(Code) Set the noZoom flag. Parameters:   noZoom - The new noZoom flag. setPrinted public void setPrinted(boolean printed)(Code) Set the printed flag. Parameters:   printed - The new printed flag. setReadOnly public void setReadOnly(boolean readOnly)(Code) Set the readOnly flag. Parameters:   readOnly - The new readOnly flag. setRectangle public void setRectangle(PDRectangle rectangle)(Code) This will set the rectangle for this annotation. Parameters:   rectangle - The new rectangle values. setToggleNoView public void setToggleNoView(boolean toggleNoView)(Code) Set the toggleNoView flag. Parameters:   toggleNoView - The new toggleNoView flag. Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)