org.pdfclown.documents.interaction.annotations.AnnotationActions Class Reference
Annotation actions [PDF:1.6:8.5.2]. More...
Public Member Functions | |
| void | Add (PdfName key, Action value) |
| AnnotationActions (Annotation parent) | |
| void | Clear () |
| virtual object | Clone (Document context) |
| Gets a clone of the object, registered inside the given document context. | |
| override object | Clone (Document context) |
| bool | ContainsKey (PdfName key) |
| void | CopyTo (KeyValuePair< PdfName, Action >[] entries, int index) |
| virtual bool | Delete () |
| Removes the object from its document context. | |
| override bool | Equals (object obj) |
| override int | GetHashCode () |
| bool | Remove (KeyValuePair< PdfName, Action > entry) |
| bool | Remove (PdfName key) |
| bool | TryGetValue (PdfName key, out Action value) |
Static Public Member Functions | |
| static PdfDirectObject | GetBaseObject (PdfObjectWrapper wrapper) |
| Gets the PDF object backing the specified wrapper. | |
Protected Member Functions | |
| void | CheckCompatibility (object feature) |
| Checks whether the specified feature is compatible with the document's conformance version. | |
| virtual PdfString | RetrieveName () |
| Retrieves the name possibly associated to this object, walking through the document's name dictionary. | |
| PdfDirectObject | RetrieveNamedBaseObject () |
| Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject. | |
Properties | |
| virtual PdfDirectObject | BaseObject [get, set] |
| PdfIndirectObject | Container [get] |
| Gets the indirect object containing the base object. | |
| int | Count [get] |
| PdfIndirectObject | DataContainer [get] |
| Gets the indirect object containing the base data object. | |
| Document | Document [get] |
| Gets the document context. | |
| File | File [get] |
| Gets the file context. | |
| bool | IsReadOnly [get] |
| ICollection< PdfName > | Keys [get] |
| Action | OnActivate [get, set] |
| Gets/Sets the action to be performed when the annotation is activated. | |
| Action | OnEnter [get, set] |
| Gets/Sets the action to be performed when the cursor enters the annotation's active area. | |
| Action | OnExit [get, set] |
| Gets/Sets the action to be performed when the cursor exits the annotation's active area. | |
| Action | OnMouseDown [get, set] |
| Gets/Sets the action to be performed when the mouse button is pressed inside the annotation's active area. | |
| Action | OnMouseUp [get, set] |
| Gets/Sets the action to be performed when the mouse button is released inside the annotation's active area. | |
| Action | OnPageClose [get, set] |
| Gets/Sets the action to be performed when the page containing the annotation is closed. | |
| Action | OnPageInvisible [get, set] |
| Gets/Sets the action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface. | |
| Action | OnPageOpen [get, set] |
| Gets/Sets the action to be performed when the page containing the annotation is opened. | |
| Action | OnPageVisible [get, set] |
| Gets/Sets the action to be performed when the page containing the annotation becomes visible in the viewer application's user interface. | |
| Action | this [PdfName key] [get, set] |
| ICollection< Action > | Values [get] |
Annotation actions [PDF:1.6:8.5.2].
Constructor & Destructor Documentation
| org.pdfclown.documents.interaction.annotations.AnnotationActions.AnnotationActions | ( | Annotation | parent | ) |
Member Function Documentation
| void org.pdfclown.documents.interaction.annotations.AnnotationActions.Add | ( | PdfName | key, | |
| Action | value | |||
| ) |
References org.pdfclown.objects.PdfObjectWrapper.BaseObject.
| void org.pdfclown.objects.PdfObjectWrapper.CheckCompatibility | ( | object | feature | ) | [protected, inherited] |
Checks whether the specified feature is compatible with the document's conformance version.
- Parameters:
-
feature Entity whose compatibility has to be checked. Supported types: - VersionEnum
- Property name resolvable to an annotated getter method
- MemberInfo
| void org.pdfclown.documents.interaction.annotations.AnnotationActions.Clear | ( | ) |
| virtual object org.pdfclown.objects.PdfObjectWrapper.Clone | ( | Document | context | ) | [virtual, inherited] |
Gets a clone of the object, registered inside the given document context.
- Parameters:
-
context Which document the clone has to be registered in.
| override object org.pdfclown.documents.interaction.annotations.AnnotationActions.Clone | ( | Document | context | ) |
Reimplemented in org.pdfclown.documents.interaction.annotations.WidgetActions.
| bool org.pdfclown.documents.interaction.annotations.AnnotationActions.ContainsKey | ( | PdfName | key | ) |
| void org.pdfclown.documents.interaction.annotations.AnnotationActions.CopyTo | ( | KeyValuePair< PdfName, Action >[] | entries, | |
| int | index | |||
| ) |
| virtual bool org.pdfclown.objects.PdfObjectWrapper.Delete | ( | ) | [virtual, inherited] |
Removes the object from its document context.
The object is no more usable after this method returns.
- Returns:
- Whether the object was actually decontextualized (only indirect objects can be decontextualize).
Reimplemented in org.pdfclown.documents.interaction.annotations.Annotation, org.pdfclown.documents.interaction.navigation.page.Article, and org.pdfclown.documents.interaction.navigation.page.ArticleElement.
| override bool org.pdfclown.objects.PdfObjectWrapper.Equals | ( | object | obj | ) | [inherited] |
Reimplemented in org.pdfclown.documents.contents.fonts.Font.
| static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject | ( | PdfObjectWrapper< PdfDictionary > | wrapper | ) | [static, inherited] |
Gets the PDF object backing the specified wrapper.
- Parameters:
-
wrapper Object to extract the base from.
| override int org.pdfclown.objects.PdfObjectWrapper.GetHashCode | ( | ) | [inherited] |
Reimplemented in org.pdfclown.documents.contents.fonts.Font.
| bool org.pdfclown.documents.interaction.annotations.AnnotationActions.Remove | ( | KeyValuePair< PdfName, Action > | entry | ) |
| bool org.pdfclown.documents.interaction.annotations.AnnotationActions.Remove | ( | PdfName | key | ) |
| virtual PdfString org.pdfclown.objects.PdfObjectWrapper.RetrieveName | ( | ) | [protected, virtual, inherited] |
Retrieves the name possibly associated to this object, walking through the document's name dictionary.
Reimplemented in org.pdfclown.documents.multimedia.Rendition.
| PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.RetrieveNamedBaseObject | ( | ) | [protected, inherited] |
Retrieves the object name, if available; otherwise, behaves like PdfObjectWrapper.BaseObject.
| bool org.pdfclown.documents.interaction.annotations.AnnotationActions.TryGetValue | ( | PdfName | key, | |
| out Action | value | |||
| ) |
Property Documentation
virtual PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.BaseObject [get, set, inherited] |
Gets the underlying reference object, if available; otherwise, gets the underlying data object.
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited] |
Gets the indirect object containing the base object.
int org.pdfclown.documents.interaction.annotations.AnnotationActions.Count [get] |
PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited] |
Gets the indirect object containing the base data object.
Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited] |
Gets the document context.
File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited] |
Gets the file context.
bool org.pdfclown.documents.interaction.annotations.AnnotationActions.IsReadOnly [get] |
ICollection<PdfName> org.pdfclown.documents.interaction.annotations.AnnotationActions.Keys [get] |
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnActivate [get, set] |
Gets/Sets the action to be performed when the annotation is activated.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnEnter [get, set] |
Gets/Sets the action to be performed when the cursor enters the annotation's active area.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnExit [get, set] |
Gets/Sets the action to be performed when the cursor exits the annotation's active area.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnMouseDown [get, set] |
Gets/Sets the action to be performed when the mouse button is pressed inside the annotation's active area.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnMouseUp [get, set] |
Gets/Sets the action to be performed when the mouse button is released inside the annotation's active area.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnPageClose [get, set] |
Gets/Sets the action to be performed when the page containing the annotation is closed.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnPageInvisible [get, set] |
Gets/Sets the action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnPageOpen [get, set] |
Gets/Sets the action to be performed when the page containing the annotation is opened.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.OnPageVisible [get, set] |
Gets/Sets the action to be performed when the page containing the annotation becomes visible in the viewer application's user interface.
Action org.pdfclown.documents.interaction.annotations.AnnotationActions.this[PdfName key] [get, set] |
ICollection<Action> org.pdfclown.documents.interaction.annotations.AnnotationActions.Values [get] |
