Java Doc for PDAnnotationMarkup.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
      org.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

All known Subclasses:   org.pdfbox.pdmodel.interactive.annotation.PDAnnotationRubberStamp,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationLine,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationTextMarkup,  org.pdfbox.pdmodel.interactive.annotation.PDAnnotationText,
PDAnnotationMarkup
abstract public class PDAnnotationMarkup extends PDAnnotation (Code)
This class represents the additonal fields of a Markup type Annotation.
author:
   Paul King
version:
   $Revision: 1.1 $


Field Summary
final public static  StringRT_GROUP
     Constant for an annotation reply type.
final public static  StringRT_REPLY
     Constant for an annotation reply type.

Constructor Summary
public  PDAnnotationMarkup()
     Constructor.
public  PDAnnotationMarkup(COSDictionary dict)
     Constructor.

Method Summary
public  floatgetConstantOpacity()
     This will retrieve the constant opacity value used when rendering the annotation (excluing any popup).
public  CalendargetCreationDate()
     This will retrieve the date and time the annotation was created.
public  PDAnnotationgetInReplyTo()
     This will retrieve the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
public  StringgetIntent()
     This will retrieve the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
public  PDAnnotationPopupgetPopup()
     This will retrieve the popup annotation used for entering/editing the text for this annotation.
public  StringgetReplyType()
     This will retrieve the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
public  PDTextStreamgetRichContents()
     This will retrieve the rich text stream which is displayed in the popup window.
public  StringgetSubject()
     This will retrieve the short description of the subject of the annotation.
public  StringgetTitlePopup()
     Retrieve the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
public  voidsetConstantOpacity(float ca)
     This will set the constant opacity value used when rendering the annotation (excluing any popup).
public  voidsetCreationDate(Calendar creationDate)
     This will set the the date and time the annotation was created.
public  voidsetInReplyTo(PDAnnotation irt)
     This will set the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
public  voidsetIntent(String it)
     This will set the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
public  voidsetPopup(PDAnnotationPopup popup)
     This will set the popup annotation used for entering/editing the text for this annotation.
public  voidsetReplyType(String rt)
     This will set the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
public  voidsetRichContents(PDTextStream rc)
     This will set the rich text stream which is displayed in the popup window.
public  voidsetSubject(String subj)
     This will set the short description of the subject of the annotation.
public  voidsetTitlePopup(String t)
     Set the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).

Field Detail
RT_GROUP
final public static String RT_GROUP(Code)
Constant for an annotation reply type.



RT_REPLY
final public static String RT_REPLY(Code)
Constant for an annotation reply type.




Constructor Detail
PDAnnotationMarkup
public PDAnnotationMarkup()(Code)
Constructor.



PDAnnotationMarkup
public PDAnnotationMarkup(COSDictionary dict)(Code)
Constructor.
Parameters:
  dict - The annotations dictionary.




Method Detail
getConstantOpacity
public float getConstantOpacity()(Code)
This will retrieve the constant opacity value used when rendering the annotation (excluing any popup). the constant opacity value.



getCreationDate
public Calendar getCreationDate() throws IOException(Code)
This will retrieve the date and time the annotation was created. the creation date/time.
throws:
  IOException - if there is a format problem when converting the date.



getInReplyTo
public PDAnnotation getInReplyTo() throws IOException(Code)
This will retrieve the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry. the other annotation.
throws:
  IOException - if there is an error with the annotation.



getIntent
public String getIntent()(Code)
This will retrieve the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes. the intent



getPopup
public PDAnnotationPopup getPopup()(Code)
This will retrieve the popup annotation used for entering/editing the text for this annotation. the popup annotation.



getReplyType
public String getReplyType()(Code)
This will retrieve the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values. the relationship.



getRichContents
public PDTextStream getRichContents()(Code)
This will retrieve the rich text stream which is displayed in the popup window. the rich text stream.



getSubject
public String getSubject()(Code)
This will retrieve the short description of the subject of the annotation. the subject.



getTitlePopup
public String getTitlePopup()(Code)
Retrieve the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation). The title of the popup.



setConstantOpacity
public void setConstantOpacity(float ca)(Code)
This will set the constant opacity value used when rendering the annotation (excluing any popup).
Parameters:
  ca - the constant opacity value.



setCreationDate
public void setCreationDate(Calendar creationDate)(Code)
This will set the the date and time the annotation was created.
Parameters:
  creationDate - the date and time the annotation was created.



setInReplyTo
public void setInReplyTo(PDAnnotation irt)(Code)
This will set the annotation to which this one is "In Reply To" the actual relationship is specified by the RT entry.
Parameters:
  irt - the annotation this one is "In Reply To".



setIntent
public void setIntent(String it)(Code)
This will set the intent of the annotation The values and meanings are specific to the actual annotation See the IT_* constants for the annotation classes.
Parameters:
  it - the intent



setPopup
public void setPopup(PDAnnotationPopup popup)(Code)
This will set the popup annotation used for entering/editing the text for this annotation.
Parameters:
  popup - the popup annotation.



setReplyType
public void setReplyType(String rt)(Code)
This will set the Reply Type (relationship) with the annotation in the IRT entry See the RT_* constants for the available values.
Parameters:
  rt - the reply type.



setRichContents
public void setRichContents(PDTextStream rc)(Code)
This will set the rich text stream which is displayed in the popup window.
Parameters:
  rc - the rich text stream.



setSubject
public void setSubject(String subj)(Code)
This will set the short description of the subject of the annotation.
Parameters:
  subj - short description of the subject.



setTitlePopup
public void setTitlePopup(String t)(Code)
Set the string used as the title of the popup window shown when open and active (by convention this identifies who added the annotation).
Parameters:
  t - The title of the popup.



Fields inherited from org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
final public static int FLAG_HIDDEN(Code)(Java Doc)
final public static int FLAG_INVISIBLE(Code)(Java Doc)
final public static int FLAG_LOCKED(Code)(Java Doc)
final public static int FLAG_NO_ROTATE(Code)(Java Doc)
final public static int FLAG_NO_VIEW(Code)(Java Doc)
final public static int FLAG_NO_ZOOM(Code)(Java Doc)
final public static int FLAG_PRINTED(Code)(Java Doc)
final public static int FLAG_READ_ONLY(Code)(Java Doc)
final public static int FLAG_TOGGLE_NO_VIEW(Code)(Java Doc)

Methods inherited from org.pdfbox.pdmodel.interactive.annotation.PDAnnotation
public static PDAnnotation createAnnotation(COSBase base) throws IOException(Code)(Java Doc)
public PDAction getAction() throws IOException(Code)(Java Doc)
public PDAdditionalActions getActions()(Code)(Java Doc)
public int getAnnotationFlags()(Code)(Java Doc)
public String getAnnotationName()(Code)(Java Doc)
public PDAppearanceDictionary getAppearance()(Code)(Java Doc)
public String getAppearanceStream()(Code)(Java Doc)
public PDBorderStyleDictionary getBoderStyle()(Code)(Java Doc)
public COSBase getCOSObject()(Code)(Java Doc)
public PDGamma getColour()(Code)(Java Doc)
public String getContents()(Code)(Java Doc)
public COSDictionary getDictionary()(Code)(Java Doc)
public String getModifiedDate()(Code)(Java Doc)
public PDRectangle getRectangle()(Code)(Java Doc)
public boolean isHidden()(Code)(Java Doc)
public boolean isInvisible()(Code)(Java Doc)
public boolean isLocked()(Code)(Java Doc)
public boolean isNoRotate()(Code)(Java Doc)
public boolean isNoView()(Code)(Java Doc)
public boolean isNoZoom()(Code)(Java Doc)
public boolean isPrinted()(Code)(Java Doc)
public boolean isReadOnly()(Code)(Java Doc)
public boolean isToggleNoView()(Code)(Java Doc)
public void setAction(PDAction action)(Code)(Java Doc)
public void setActions(PDAdditionalActions actions)(Code)(Java Doc)
public void setAnnotationFlags(int flags)(Code)(Java Doc)
public void setAnnotationName(String nm)(Code)(Java Doc)
public void setAppearance(PDAppearanceDictionary appearance)(Code)(Java Doc)
public void setAppearanceStream(String as)(Code)(Java Doc)
public void setBorderStyle(PDBorderStyleDictionary bs)(Code)(Java Doc)
public void setColour(PDGamma c)(Code)(Java Doc)
public void setContents(String value)(Code)(Java Doc)
public void setHidden(boolean hidden)(Code)(Java Doc)
public void setInvisible(boolean invisible)(Code)(Java Doc)
public void setLocked(boolean locked)(Code)(Java Doc)
public void setModifiedDate(String m)(Code)(Java Doc)
public void setNoRotate(boolean noRotate)(Code)(Java Doc)
public void setNoView(boolean noView)(Code)(Java Doc)
public void setNoZoom(boolean noZoom)(Code)(Java Doc)
public void setPrinted(boolean printed)(Code)(Java Doc)
public void setReadOnly(boolean readOnly)(Code)(Java Doc)
public void setRectangle(PDRectangle rectangle)(Code)(Java Doc)
public void setToggleNoView(boolean toggleNoView)(Code)(Java Doc)

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)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.