org.pdfclown.documents.interaction.navigation.document.Bookmarks Class Reference

Collection of bookmarks [PDF:1.6:8.2.2]. More...

Inheritance diagram for org.pdfclown.documents.interaction.navigation.document.Bookmarks:

List of all members.

Public Member Functions
void	Add (Bookmark bookmark)
	Bookmarks (Document context)
void	Clear ()
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
bool	Contains (Bookmark bookmark)
void	CopyTo (Bookmark[] bookmarks, int index)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
int	IndexOf (Bookmark bookmark)
void	Insert (int index, Bookmark bookmark)
bool	Remove (Bookmark bookmark)
void	RemoveAt (int index)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static Bookmarks	Wrap (PdfDirectObject baseObject)
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]
Bookmark	this [int index] [get, set]

---

Collection of bookmarks [PDF:1.6:8.2.2].

---

Constructor & Destructor Documentation

org.pdfclown.documents.interaction.navigation.document.Bookmarks.Bookmarks

(

Document

context

)

---

Member Function Documentation

void org.pdfclown.documents.interaction.navigation.document.Bookmarks.Add

(

Bookmark

bookmark

)

References org.pdfclown.objects.PdfObjectWrapper.BaseObject, org.pdfclown.objects.PdfReference.DataObject, org.pdfclown.objects.PdfInteger.IntValue, and org.pdfclown.objects.IPdfSimpleObject.Value.

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.navigation.document.Bookmarks.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.

bool org.pdfclown.documents.interaction.navigation.document.Bookmarks.Contains

(

Bookmark

bookmark

)

void org.pdfclown.documents.interaction.navigation.document.Bookmarks.CopyTo	(	Bookmark[]	bookmarks,
		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.

int org.pdfclown.documents.interaction.navigation.document.Bookmarks.IndexOf

(

Bookmark

bookmark

)

void org.pdfclown.documents.interaction.navigation.document.Bookmarks.Insert	(	int	index,
		Bookmark	bookmark
	)

bool org.pdfclown.documents.interaction.navigation.document.Bookmarks.Remove

(

Bookmark

bookmark

)

void org.pdfclown.documents.interaction.navigation.document.Bookmarks.RemoveAt

(

int

index

)

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.

static Bookmarks org.pdfclown.documents.interaction.navigation.document.Bookmarks.Wrap

(

PdfDirectObject

baseObject

)

[static]

---

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.navigation.document.Bookmarks.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.navigation.document.Bookmarks.IsReadOnly [get]

Bookmark org.pdfclown.documents.interaction.navigation.document.Bookmarks.this[int index] [get, set]