org.pdfclown.documents.interaction.viewer.ViewerPreferences Class Reference

Viewer preferences [PDF:1.6:8.1]. More...

Inheritance diagram for org.pdfclown.documents.interaction.viewer.ViewerPreferences:

List of all members.

Public Types
enum	DirectionEnum { LeftToRight, RightToLeft }
	Predominant reading order for text [PDF:1.6:8.1]. More...
Public Member Functions
virtual object	Clone (Document context)
	Gets a clone of the object, registered inside the given document context.
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
	ViewerPreferences (Document context)
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static ViewerPreferences	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]
bool	CenterWindow [get, set]
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
PdfIndirectObject	DataContainer [get]
	Gets the indirect object containing the base data object.
DirectionEnum	Direction [get, set]
bool	DisplayDocTitle [get, set]
Document	Document [get]
	Gets the document context.
File	File [get]
	Gets the file context.
bool	FitWindow [get, set]
bool	HideMenubar [get, set]
bool	HideToolbar [get, set]
bool	HideWindowUI [get, set]

---

Viewer preferences [PDF:1.6:8.1].

---

Member Enumeration Documentation

enum org::pdfclown::documents::interaction::viewer::ViewerPreferences::DirectionEnum

Predominant reading order for text [PDF:1.6:8.1].

Enumerator:

LeftToRight	Left to right.
RightToLeft	Right to left.

---

Constructor & Destructor Documentation

org.pdfclown.documents.interaction.viewer.ViewerPreferences.ViewerPreferences

(

Document

context

)

---

Member Function Documentation

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

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.

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.

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 ViewerPreferences org.pdfclown.documents.interaction.viewer.ViewerPreferences.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.

bool org.pdfclown.documents.interaction.viewer.ViewerPreferences.CenterWindow [get, set]

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.Container [get, inherited]

Gets the indirect object containing the base object.

PdfIndirectObject org.pdfclown.objects.PdfObjectWrapper.DataContainer [get, inherited]

Gets the indirect object containing the base data object.

DirectionEnum org.pdfclown.documents.interaction.viewer.ViewerPreferences.Direction [get, set]

bool org.pdfclown.documents.interaction.viewer.ViewerPreferences.DisplayDocTitle [get, set]

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.viewer.ViewerPreferences.FitWindow [get, set]

bool org.pdfclown.documents.interaction.viewer.ViewerPreferences.HideMenubar [get, set]

bool org.pdfclown.documents.interaction.viewer.ViewerPreferences.HideToolbar [get, set]

bool org.pdfclown.documents.interaction.viewer.ViewerPreferences.HideWindowUI [get, set]