org.pdfclown.documents.contents.layers.LayerEntity Class Reference

Layer entity. More...

Inheritance diagram for org.pdfclown.documents.contents.layers.LayerEntity:

List of all members.

Public Types
enum	VisibilityPolicyEnum { AllOn, AnyOn, AnyOff, AllOff }
	Membership visibility policy [PDF:1.7:4.10.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 ()
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static PropertyList	Wrap (PdfDirectObject baseObject)
	Wraps the specified base object into a property list object.
Protected Member Functions
void	CheckCompatibility (object feature)
	Checks whether the specified feature is compatible with the document's conformance version.
	LayerEntity (PdfDirectObject baseObject)
	LayerEntity (Document context, PdfName typeName)
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.
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.
virtual LayerMembership	Membership [get]
	Gets the default membership.
virtual IList< Layer >	VisibilityLayers [get]
	Gets the layers whose states determine the visibility of content controlled by this entity.
virtual VisibilityPolicyEnum	VisibilityPolicy [get, set]
	Gets/Sets the visibility policy of this entity.

---

Layer entity.

---

Member Enumeration Documentation

enum org::pdfclown::documents::contents::layers::LayerEntity::VisibilityPolicyEnum

Membership visibility policy [PDF:1.7:4.10.1].

Enumerator:

AllOn	Visible only if all of the visibility layers are ON.
AnyOn	Visible if any of the visibility layers are ON.
AnyOff	Visible if any of the visibility layers are OFF.
AllOff	Visible only if all of the visibility layers are OFF.

---

Constructor & Destructor Documentation

org.pdfclown.documents.contents.layers.LayerEntity.LayerEntity	(	Document	context,
		PdfName	typeName
	)			[protected]

org.pdfclown.documents.contents.layers.LayerEntity.LayerEntity

(

PdfDirectObject

baseObject

)

[protected]

---

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 PropertyList org.pdfclown.documents.contents.PropertyList.Wrap

(

PdfDirectObject

baseObject

)

[static, inherited]

Wraps the specified base object into a property list object.

Parameters:

baseObject

Base object of a property list object.

Returns:

Property list object corresponding to the base object.

Reimplemented in org.pdfclown.documents.contents.layers.Layer, and org.pdfclown.documents.contents.layers.LayerMembership.

References org.pdfclown.objects.PdfObject.Resolve().

---

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.

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.

virtual LayerMembership org.pdfclown.documents.contents.layers.LayerEntity.Membership [get]

Gets the default membership.

This collection corresponds to the hierarchical relation between this layer entity and its ascendants.

Reimplemented in org.pdfclown.documents.contents.layers.Layer, and org.pdfclown.documents.contents.layers.LayerMembership.

Referenced by org.pdfclown.documents.contents.composition.PrimitiveComposer.BeginLayer().

virtual IList<Layer> org.pdfclown.documents.contents.layers.LayerEntity.VisibilityLayers [get]

Gets the layers whose states determine the visibility of content controlled by this entity.

Reimplemented in org.pdfclown.documents.contents.layers.Layer, and org.pdfclown.documents.contents.layers.LayerMembership.

virtual VisibilityPolicyEnum org.pdfclown.documents.contents.layers.LayerEntity.VisibilityPolicy [get, set]

Gets/Sets the visibility policy of this entity.

Reimplemented in org.pdfclown.documents.contents.layers.Layer, and org.pdfclown.documents.contents.layers.LayerMembership.