org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject Class Reference

Icon fit [PDF:1.6:8.6.6]. More...

Inheritance diagram for org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject:

List of all members.

Public Types
enum	ScaleModeEnum { Always, Bigger, Smaller, Never }
	Scaling mode [PDF:1.6:8.6.6]. More...
enum	ScaleTypeEnum { Anamorphic, Proportional }
	Scaling type [PDF:1.6:8.6.6]. 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 ()
	IconFitObject (Document context)
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]
bool	BorderExcluded [get, set]
	Gets/Sets whether not to take into consideration the line width of the border.
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
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.
ScaleModeEnum	ScaleMode [get, set]
	Gets/Sets the circumstances under which the icon should be scaled inside the annotation box.
ScaleTypeEnum	ScaleType [get, set]
	Gets/Sets the type of scaling to use.
XAlignmentEnum	XAlignment [get, set]
	Gets/Sets the horizontal alignment of the icon inside the annotation box.
YAlignmentEnum	YAlignment [get, set]
	Gets/Sets the vertical alignment of the icon inside the annotation box.

---

Icon fit [PDF:1.6:8.6.6].

---

Member Enumeration Documentation

enum org::pdfclown::documents::interaction::annotations::AppearanceCharacteristics::IconFitObject::ScaleModeEnum

Scaling mode [PDF:1.6:8.6.6].

Enumerator:

Always	Always scale.
Bigger	Scale only when the icon is bigger than the annotation box.
Smaller	Scale only when the icon is smaller than the annotation box.
Never	Never scale.

enum org::pdfclown::documents::interaction::annotations::AppearanceCharacteristics::IconFitObject::ScaleTypeEnum

Scaling type [PDF:1.6:8.6.6].

Enumerator:

Anamorphic	Scale the icon to fill the annotation box exactly, without regard to its original aspect ratio.
Proportional	Scale the icon to fit the width or height of the annotation box, while maintaining the icon's original aspect ratio.

---

Constructor & Destructor Documentation

org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject.IconFitObject

(

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.

---

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.annotations.AppearanceCharacteristics.IconFitObject.BorderExcluded [get, set]

Gets/Sets whether not to take into consideration the line width of the border.

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.

Document org.pdfclown.objects.PdfObjectWrapper.Document [get, inherited]

Gets the document context.

File org.pdfclown.objects.PdfObjectWrapper.File [get, inherited]

Gets the file context.

ScaleModeEnum org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject.ScaleMode [get, set]

Gets/Sets the circumstances under which the icon should be scaled inside the annotation box.

ScaleTypeEnum org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject.ScaleType [get, set]

Gets/Sets the type of scaling to use.

XAlignmentEnum org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject.XAlignment [get, set]

Gets/Sets the horizontal alignment of the icon inside the annotation box.

YAlignmentEnum org.pdfclown.documents.interaction.annotations.AppearanceCharacteristics.IconFitObject.YAlignment [get, set]

Gets/Sets the vertical alignment of the icon inside the annotation box.