org.pdfclown.documents.interaction.forms.FieldWidgets Class Reference

Field widget annotations [PDF:1.6:8.6]. More...

Inheritance diagram for org.pdfclown.documents.interaction.forms.FieldWidgets:

List of all members.

Public Member Functions
void	Add (Widget value)
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	Contains (Widget value)
void	CopyTo (Widget[] values, int index)
virtual bool	Delete ()
	Removes the object from its document context.
override bool	Equals (object obj)
override int	GetHashCode ()
int	IndexOf (Widget value)
void	Insert (int index, Widget value)
bool	Remove (Widget value)
void	RemoveAt (int index)
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.
Field	Field [get]
	Gets the field associated to these widgets.
File	File [get]
	Gets the file context.
bool	IsReadOnly [get]
Widget	this [int index] [get, set]

---

Field widget annotations [PDF:1.6:8.6].

---

Member Function Documentation

void org.pdfclown.documents.interaction.forms.FieldWidgets.Add

(

Widget

value

)

References org.pdfclown.objects.PdfObjectWrapper.BaseObject.

Referenced by org.pdfclown.documents.interaction.forms.RadioButton.RadioButton().

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.forms.FieldWidgets.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.forms.FieldWidgets.Clone

(

Document

context

)

bool org.pdfclown.documents.interaction.forms.FieldWidgets.Contains

(

Widget

value

)

References org.pdfclown.objects.PdfObjectWrapper.BaseObject.

void org.pdfclown.documents.interaction.forms.FieldWidgets.CopyTo	(	Widget[]	values,
		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).

override bool org.pdfclown.objects.PdfObjectWrapper.Equals

(

object

obj

)

[inherited]

Reimplemented in org.pdfclown.documents.contents.colorSpaces.LeveledColor.

static PdfDirectObject org.pdfclown.objects.PdfObjectWrapper.GetBaseObject

(

PdfObjectWrapper< PdfDataObject >

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.colorSpaces.LeveledColor.

int org.pdfclown.documents.interaction.forms.FieldWidgets.IndexOf

(

Widget

value

)

References org.pdfclown.objects.PdfObjectWrapper.BaseObject.

void org.pdfclown.documents.interaction.forms.FieldWidgets.Insert	(	int	index,
		Widget	value
	)

References org.pdfclown.objects.PdfObjectWrapper.BaseObject.

bool org.pdfclown.documents.interaction.forms.FieldWidgets.Remove

(

Widget

value

)

References org.pdfclown.objects.PdfObjectWrapper.BaseObject.

void org.pdfclown.documents.interaction.forms.FieldWidgets.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.

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.

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

Gets the indirect object containing the base object.

int org.pdfclown.documents.interaction.forms.FieldWidgets.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.

Field org.pdfclown.documents.interaction.forms.FieldWidgets.Field [get]

Gets the field associated to these widgets.

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

Gets the file context.

bool org.pdfclown.documents.interaction.forms.FieldWidgets.IsReadOnly [get]

Widget org.pdfclown.documents.interaction.forms.FieldWidgets.this[int index] [get, set]