Java Doc for PDAnnotation.java in » PDF » jPod » de » intarsys » pdf » pd » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » jPod » de.intarsys.pdf.pd

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

de.intarsys.pdf.cos .COSBasedObject

de.intarsys.pdf.pd .PDObject

de.intarsys.pdf.pd .PDAnnotation

All known Subclasses:   de.intarsys.pdf.pd .PDMarkupAnnotation,  de.intarsys.pdf.pd .PDWidgetAnnotation,  de.intarsys.pdf.pd .PDAnyAnnotation,  de.intarsys.pdf.pd .PDLinkAnnotation,  de.intarsys.pdf.pd .PDPopupAnnotation,
PDAnnotation
abstract public class PDAnnotation extends PDObject implements IAdditionalActionSupport(Code)
An Annotation is an abstract object that allows a PDF document to be changed and extended in a variety of ways. Annotations are recorded with a page in the PDF document. The behavior of an annotation depends on the subtype.

Inner Class :public static class MetaClass extends PDObject.MetaClass

Field Summary
final public static Set ANNOTATION_ACTION_TRIGGERS

final public static COSName CN_Type_Annot

final public static COSName DK_A

final public static COSName DK_AP

final public static COSName DK_AS

final public static COSName DK_BS

final public static COSName DK_Border

final public static COSName DK_C

final public static COSName DK_CA

final public static COSName DK_Contents

final public static COSName DK_F
     The name for the F entry.
final public static COSName DK_IC

final public static COSName DK_M

final public static COSName DK_NM

final public static COSName DK_OC

final public static COSName DK_P

final public static COSName DK_Rect

final public static COSName DK_StructParent

final public static MetaClass META


Constructor Summary
protected PDAnnotation(COSObject object)
     Create the receiver class from an already defined COSDictionary .

Method Summary
public void addAction(PDAction newAction)
     Add a PDAction to be executed when this is "activated".
public int basicGetFlags()
     The annotation flags in its integer representation.
public void basicSetFlags(int newFlags)
     Assign the annotation flags in integer representation.
public boolean canReceiveFocus()
     true if this can receive the focus in an interactive viewer.
public PDAnnotation copy()
     Create a copy of the receiver.
protected static COSDictionary copyAppearanceDict(COSDictionary appDict)
     Copy the receivers appearance dictionary.
Parameters:
  appDict - THe appearance dictionary.
protected static COSDictionary copyAppearanceDictInner(COSDictionary stateDict)
     When the appearance dictionary has multiple states, this methos copies the inner appearance dictionaries.
Parameters:
  stateDict - An inner appearance dictionary.
protected COSName cosGetExpectedType()

public void dispose()

public PDAction getAction()
     The PDAction to be executed when this is "activated".
public PDAdditionalActions getAdditionalActions()

public PDAppearance getAppearance()
     The visual appearance of this.
public COSName getAppearanceState()
     The visual appearance state of this.
public Set getAppearanceStates()
     All defined appearance states in this.
public PDBorderStyle getBorderStyle()
     The annotations border style.
public COSName getBorderStyleName()
     The name of the border style.
public float getBorderStyleWidth()
     The width of the annotations border.
public float[] getColor()
     The color values for this.
public String getContents()
     The contents String for this.
public AnnotationFlags getFlags()
     The annotation flags.
public CDSDate getModified()
     The last modification date.
public String getName()
     The annotations name.
public CDSRectangle getNormalizedRectangle()
     Convenience method to access a normalized copy of the receivers rectangle.
public PDPage getPage()
     Try to access the PDPage we are on.
public CDSRectangle getRectangle()
     The CDSRectangle for the visual appearance of this.
protected Integer getStructParent()

abstract public String getSubtypeLabel()
     A String representation of this.
public Set getSupportedTriggerEvents()

protected void initializeFromScratch()

public void invalidateCaches()

public boolean isHidden()
     Convenience method to access "Hidden" flag.
public boolean isInvisible()
     Convenience method to access "Invisible" flag.
public boolean isLocked()
     Convenience method to access "Locked" flag.
public boolean isMarkupAnnotation()
     true if this is a PDMarkupAnnotation .
public boolean isNoRotate()
     Convenience method to access "NoRotate" flag.
public boolean isNoView()
     Convenience method to access "NoView" flag.
public boolean isNoZoom()
     Convenience method to access "NoZoom" flag.
public boolean isPrint()
     Convenience method to access "Print" flag.
public boolean isReadOnly()
     Convenience method to access "ReadOnly" flag.
public boolean isToggleNoView()
     Convenience method to access "ToggleNoView" flag.
public boolean isWidgetAnnotation()
     true if this is a PDWidgetAnnotation .
public void setAction(PDAction newAction)
     Set the PDAction for the "activation" of this.
public void setAdditionalActions(PDAdditionalActions actions)

public void setAppearance(PDAppearance newAppearance)
     Assign a PDAppearance to this.
public void setAppearanceState(COSName newAppearanceState)
     Select a concrete PDForm from the PDAppearance .
public void setBorderStyle(PDBorderStyle newBorderStyle)
     Assign a PDBorderStyle .
public void setBorderStyleName(COSName newStyle)
     Assign a border style name.
public void setBorderStyleWidth(float newWidth)
     Assign a border width.
public void setColor(float[] color)
     Assign a color.
public void setContents(String newContents)
     Assign a content String .
public void setHidden(boolean f)
     Convenience method to access "Hidden" flag.
public void setInvisible(boolean f)
     Convenience method to access "Invisible" flag.
public void setLocked(boolean f)
     Convenience method to access "Locked" flag.
protected void setModified(String newModified)

public void setName(String newName)
     Assign a name.
public void setNoRotate(boolean f)
     Convenience method to access "NoRotate" flag.
public void setNoView(boolean f)
     Convenience method to access "NoView" flag.
public void setNoZoom(boolean f)
     Convenience method to access "NoZoom" flag.
protected void setPage(PDPage newPage)

public void setPrint(boolean f)
     Convenience method to access "Print" flag.
public void setReadOnly(boolean readOnly)
     Convenience method to access "ReadOnly" flag.
public void setRectangle(CDSRectangle newRectangle)
     Assign a CDSRectangle for the visual appearance of this.
protected void setStructParent(Integer newStructParent)

public void setToggleNoView(boolean f)
     Convenience method to access "ToggleNoView" flag.
public boolean supportsPrint()
     true if print flag can be selected/changed for this kind of annotation.
public String toString()

public void touch()
     Assign the current date as the date of last modification.

Field Detail
ANNOTATION_ACTION_TRIGGERS
final public static Set ANNOTATION_ACTION_TRIGGERS(Code)
supported additional action triggers

CN_Type_Annot
final public static COSName CN_Type_Annot(Code)

DK_A
final public static COSName DK_A(Code)

DK_AP
final public static COSName DK_AP(Code)

DK_AS
final public static COSName DK_AS(Code)

DK_BS
final public static COSName DK_BS(Code)

DK_Border
final public static COSName DK_Border(Code)

DK_C
final public static COSName DK_C(Code)

DK_CA
final public static COSName DK_CA(Code)

DK_Contents
final public static COSName DK_Contents(Code)

DK_F
final public static COSName DK_F(Code)
The name for the F entry.
Currently:

Bit 1: Invisible
Bit 2: Hidden
Bit 3: Print
Bit 4: NoZoom
Bit 5: NoRotate
Bit 6: NoView
Bit 7: ReadOnly
Bit 8: Locked
Bit 9: ToggleNoView

DK_IC
final public static COSName DK_IC(Code)

DK_M
final public static COSName DK_M(Code)

DK_NM
final public static COSName DK_NM(Code)

DK_OC
final public static COSName DK_OC(Code)

DK_P
final public static COSName DK_P(Code)

DK_Rect
final public static COSName DK_Rect(Code)

DK_StructParent
final public static COSName DK_StructParent(Code)

META
final public static MetaClass META(Code)
The meta class instance

Constructor Detail
PDAnnotation
protected PDAnnotation(COSObject object)(Code)
Create the receiver class from an already defined COSDictionary . NEVER use the constructor directly.
Parameters:
  object - the PDDocument containing the new object

Method Detail
addAction
public void addAction(PDAction newAction)(Code)
Add a PDAction to be executed when this is "activated".
Parameters:
  newAction - The PDAction to be executed.

basicGetFlags
public int basicGetFlags()(Code)
The annotation flags in its integer representation. The annotation flags in its integer representation.

basicSetFlags
public void basicSetFlags(int newFlags)(Code)
Assign the annotation flags in integer representation.
Parameters:
  newFlags - The new annotation flags.

canReceiveFocus
public boolean canReceiveFocus()(Code)
true if this can receive the focus in an interactive viewer. true if this can receive the focus in aninteractive viewer.

copy
public PDAnnotation copy()(Code)
Create a copy of the receiver. A copy of the receiver.

copyAppearanceDict
protected static COSDictionary copyAppearanceDict(COSDictionary appDict)(Code)
Copy the receivers appearance dictionary.
Parameters:
  appDict - THe appearance dictionary. A copy of the appearance dictionary.

copyAppearanceDictInner
protected static COSDictionary copyAppearanceDictInner(COSDictionary stateDict)(Code)
When the appearance dictionary has multiple states, this methos copies the inner appearance dictionaries.
Parameters:
  stateDict - An inner appearance dictionary. A copy of the inner appearance dict.

cosGetExpectedType
protected COSName cosGetExpectedType()(Code)

dispose
public void dispose()(Code)

getAction
public PDAction getAction()(Code)
The PDAction to be executed when this is "activated". The PDAction to be executed when this is "activated".

getAdditionalActions
public PDAdditionalActions getAdditionalActions()(Code)

getAppearance
public PDAppearance getAppearance()(Code)
The visual appearance of this. The PDAction to be executed when this is "activated".

getAppearanceState
public COSName getAppearanceState()(Code)
The visual appearance state of this. This state selects an appearance within its PDAppearance . The visual appearance state of this.

getAppearanceStates
public Set getAppearanceStates()(Code)
All defined appearance states in this. All defined appearance states in this.

getBorderStyle
public PDBorderStyle getBorderStyle()(Code)
The annotations border style. The annotations border style.

getBorderStyleName
public COSName getBorderStyleName()(Code)
The name of the border style. The name of the border style.

getBorderStyleWidth
public float getBorderStyleWidth()(Code)
The width of the annotations border. The width of the annotations border.

getColor
public float[] getColor()(Code)
The color values for this. The color values for this.

getContents
public String getContents()(Code)
The contents String for this. The contents String for this.

getFlags
public AnnotationFlags getFlags()(Code)
The annotation flags. The annotation flags.

getModified
public CDSDate getModified()(Code)
The last modification date. The last modification date.

getName
public String getName()(Code)
The annotations name. The annotations name.

getNormalizedRectangle
public CDSRectangle getNormalizedRectangle()(Code)
Convenience method to access a normalized copy of the receivers rectangle.

getPage
public PDPage getPage()(Code)
Try to access the PDPage we are on. This may return null, as this reference is not required by the spec. Try to access the PDPage we are on.

getRectangle
public CDSRectangle getRectangle()(Code)
The CDSRectangle for the visual appearance of this. The CDSRectangle for the visual appearance of this.

getStructParent
protected Integer getStructParent()(Code)

getSubtypeLabel
abstract public String getSubtypeLabel()(Code)
A String representation of this. A String representation of this.

getSupportedTriggerEvents
public Set getSupportedTriggerEvents()(Code)

initializeFromScratch
protected void initializeFromScratch()(Code)

invalidateCaches
public void invalidateCaches()(Code)

isHidden
public boolean isHidden()(Code)
Convenience method to access "Hidden" flag.

isInvisible
public boolean isInvisible()(Code)
Convenience method to access "Invisible" flag.

isLocked
public boolean isLocked()(Code)
Convenience method to access "Locked" flag.

isMarkupAnnotation
public boolean isMarkupAnnotation()(Code)
true if this is a PDMarkupAnnotation . true if this is a PDMarkupAnnotation.

isNoRotate
public boolean isNoRotate()(Code)
Convenience method to access "NoRotate" flag.

isNoView
public boolean isNoView()(Code)
Convenience method to access "NoView" flag.

isNoZoom
public boolean isNoZoom()(Code)
Convenience method to access "NoZoom" flag.

isPrint
public boolean isPrint()(Code)
Convenience method to access "Print" flag.

isReadOnly
public boolean isReadOnly()(Code)
Convenience method to access "ReadOnly" flag.

isToggleNoView
public boolean isToggleNoView()(Code)
Convenience method to access "ToggleNoView" flag.

isWidgetAnnotation
public boolean isWidgetAnnotation()(Code)
true if this is a PDWidgetAnnotation . true if this is a PDWidgetAnnotation.

setAction
public void setAction(PDAction newAction)(Code)
Set the PDAction for the "activation" of this.
Parameters:
  newAction - Set the PDAction for the "activation" of this.

setAdditionalActions
public void setAdditionalActions(PDAdditionalActions actions)(Code)

setAppearance
public void setAppearance(PDAppearance newAppearance)(Code)
Assign a PDAppearance to this.
Parameters:
  newAppearance - The new PDAppearance.

setAppearanceState
public void setAppearanceState(COSName newAppearanceState)(Code)
Select a concrete PDForm from the PDAppearance .
Parameters:
  newAppearanceState - The new state name.

setBorderStyle
public void setBorderStyle(PDBorderStyle newBorderStyle)(Code)
Assign a PDBorderStyle .
Parameters:
  newBorderStyle - The new PDBorderStyle

setBorderStyleName
public void setBorderStyleName(COSName newStyle)(Code)
Assign a border style name.
Parameters:
  newStyle - The new border style name.

setBorderStyleWidth
public void setBorderStyleWidth(float newWidth)(Code)
Assign a border width.
Parameters:
  newWidth - The new Border width.

setColor
public void setColor(float[] color)(Code)
Assign a color.
Parameters:
  color - The new color values.

setContents
public void setContents(String newContents)(Code)
Assign a content String .
Parameters:
  newContents - The new content String.

setHidden
public void setHidden(boolean f)(Code)
Convenience method to access "Hidden" flag.

setInvisible
public void setInvisible(boolean f)(Code)
Convenience method to access "Invisible" flag.

setLocked
public void setLocked(boolean f)(Code)
Convenience method to access "Locked" flag.

setModified
protected void setModified(String newModified)(Code)

setName
public void setName(String newName)(Code)
Assign a name.
Parameters:
  newName - The new name.

setNoRotate
public void setNoRotate(boolean f)(Code)
Convenience method to access "NoRotate" flag.

setNoView
public void setNoView(boolean f)(Code)
Convenience method to access "NoView" flag.

setNoZoom
public void setNoZoom(boolean f)(Code)
Convenience method to access "NoZoom" flag.

setPage
protected void setPage(PDPage newPage)(Code)

setPrint
public void setPrint(boolean f)(Code)
Convenience method to access "Print" flag.

setReadOnly
public void setReadOnly(boolean readOnly)(Code)
Convenience method to access "ReadOnly" flag.

setRectangle
public void setRectangle(CDSRectangle newRectangle)(Code)
Assign a CDSRectangle for the visual appearance of this.
Parameters:
  newRectangle - Assign a CDSRectangle for the visual appearance ofthis.

setStructParent
protected void setStructParent(Integer newStructParent)(Code)

setToggleNoView
public void setToggleNoView(boolean f)(Code)
Convenience method to access "ToggleNoView" flag.

supportsPrint
public boolean supportsPrint()(Code)
true if print flag can be selected/changed for this kind of annotation. true if print flag can be selected/changed forthis kind of annotation.

toString
public String toString()(Code)

touch
public void touch()(Code)
Assign the current date as the date of last modification.

Fields inherited from de.intarsys.pdf.pd.PDObject
final public static COSName DK_Subtype(Code)(Java Doc)
final public static COSName DK_Type(Code)(Java Doc)
final public static MetaClass META(Code)(Java Doc)

Methods inherited from de.intarsys.pdf.pd.PDObject
protected COSName cosGetExpectedSubtype()(Code)(Java Doc)
protected COSName cosGetExpectedType()(Code)(Java Doc)
public COSObject cosGetFieldDescendant(COSName name)(Code)(Java Doc)
public COSObject cosGetFieldInheritable(COSName name)(Code)(Java Doc)
public COSObject cosGetFieldInherited(COSName name)(Code)(Java Doc)
final public COSName cosGetSubtype()(Code)(Java Doc)
final public COSName cosGetType()(Code)(Java Doc)
public COSObject cosRemoveFieldInheritable(COSName name)(Code)(Java Doc)
public COSObject cosSetFieldInheritable(COSName name, COSObject cosObj)(Code)(Java Doc)
final public COSName cosSetSubtype(COSName newType)(Code)(Java Doc)
final public COSName cosSetType(COSName newType)(Code)(Java Doc)
public PDDocument getDoc()(Code)(Java Doc)
public List getGenericChildren()(Code)(Java Doc)
public PDObject getGenericParent()(Code)(Java Doc)
protected List getPDObjects(COSName key, COSBasedObject.MetaClass metaclass, boolean addListener)(Code)(Java Doc)
protected void initializeFromScratch()(Code)(Java Doc)
public void setGenericParent(PDObject parent)(Code)(Java Doc)
protected void setPDObjects(COSName key, List list)(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Fields inherited from de.intarsys.pdf.cos.COSBasedObject
final public static MetaClass META(Code)(Java Doc)

Methods inherited from de.intarsys.pdf.cos.COSBasedObject
public void changed(COSObject pObject, Object slot, Object oldValue, Object newValue)(Code)(Java Doc)
public COSArray cosGetArray()(Code)(Java Doc)
public COSDictionary cosGetDict()(Code)(Java Doc)
public COSDocument cosGetDoc()(Code)(Java Doc)
public COSObject cosGetField(COSName name)(Code)(Java Doc)
public COSObject cosGetObject()(Code)(Java Doc)
public COSStream cosGetStream()(Code)(Java Doc)
public boolean cosHasField(COSName name)(Code)(Java Doc)
public COSObject cosRemoveField(COSName name)(Code)(Java Doc)
public COSObject cosSetField(COSName name, COSObject cosObj)(Code)(Java Doc)
public Object getAttribute(Object key)(Code)(Java Doc)
public boolean getFieldBoolean(COSName name, boolean defaultValue)(Code)(Java Doc)
public CDSDate getFieldDate(COSName name, CDSDate defaultValue)(Code)(Java Doc)
public float getFieldFixed(COSName name, float defaultValue)(Code)(Java Doc)
public float[] getFieldFixedArray(COSName name, float[] defaultValue)(Code)(Java Doc)
public int getFieldInt(COSName name, int defaultValue)(Code)(Java Doc)
public String getFieldMLString(COSName name, String defaultValue)(Code)(Java Doc)
public String getFieldString(COSName name, String defaultValue)(Code)(Java Doc)
protected void initializeFromCos()(Code)(Java Doc)
protected void initializeFromScratch()(Code)(Java Doc)
public void invalidateCaches()(Code)(Java Doc)
public Object removeAttribute(Object key)(Code)(Java Doc)
public Object setAttribute(Object key, Object value)(Code)(Java Doc)
public void setFieldBoolean(COSName name, boolean value)(Code)(Java Doc)
public void setFieldFixed(COSName name, float value)(Code)(Java Doc)
protected void setFieldFixedArray(COSName key, float[] array)(Code)(Java Doc)
public void setFieldInt(COSName name, int value)(Code)(Java Doc)
public void setFieldMLString(COSName name, String value)(Code)(Java Doc)
public void setFieldName(COSName name, String value)(Code)(Java Doc)
public void setFieldObject(COSName name, COSBasedObject value)(Code)(Java Doc)
public void setFieldString(COSName name, String value)(Code)(Java Doc)
public String toString()(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

All other trademarks are property of their respective owners.