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

Optional content group [PDF:1.7:4.10.1]. More...

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

List of all members.

Classes
class	LayersLocation
	Sublayers location within a configuration structure.
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 ()
	Layer (Document context, string title)
override string	ToString ()
Static Public Member Functions
static PdfDirectObject	GetBaseObject (PdfObjectWrapper wrapper)
	Gets the PDF object backing the specified wrapper.
static new Layer	Wrap (PdfDirectObject baseObject)
	Wraps the specified base object into a property list object.
Static Public Attributes
static readonly PdfName	TypeName = PdfName.OCG
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
PdfDirectObject	BaseObject [get]
	Gets the underlying reference object, if available; otherwise, gets the underlying data object.
virtual PdfDirectObject	BaseObject [get, set]
PdfIndirectObject	Container [get]
	Gets the indirect object containing the base object.
string	ContentType [get, set]
	Gets/Sets the name of the type of content controlled by the group.
string	Creator [get, set]
	Gets/Sets the name of the application that created this layer.
PdfIndirectObject	DataContainer [get]
	Gets the indirect object containing the base data object.
Document	Document [get]
	Gets the document context.
bool	Exportable [get, set]
	Gets/Sets whether this layer is visible when the document is saved by a viewer application to a format that does not support optional content.
File	File [get]
	Gets the file context.
string	Language [get, set]
	Gets/Sets the language (and possibly locale) of the content controlled by this layer.
Layers	Layers [get, set]
	Gets/Sets the sublayers.
bool	Locked [get, set]
	Gets/Sets whether the default visibility of this layer cannot be changed through the user interface of a viewer application.
override LayerMembership	Membership [get]
	Gets the default membership.
bool	Printable [get, set]
	Gets/Sets whether this layer is visible when the document is printed from a viewer application.
string	Title [get, set]
	Gets/Sets the text label.
bool	Viewable [get, set]
	Gets/Sets whether this layer is visible when the document is opened in a viewer application.
override IList< Layer >	VisibilityLayers [get]
	Gets the layers whose states determine the visibility of content controlled by this entity.
override VisibilityPolicyEnum	VisibilityPolicy [get, set]
	Gets/Sets the visibility policy of this entity.
bool	Visible [get, set]
	Gets/Sets whether this layer is initially visible.
Interval< double >	ZoomRange [get, set]
	Gets/Sets the range of magnifications at which the content in this layer is best viewed.

---

Optional content group [PDF:1.7:4.10.1].

---

Member Enumeration Documentation

enum org::pdfclown::documents::contents::layers::LayerEntity::VisibilityPolicyEnum [inherited]

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.Layer.Layer	(	Document	context,
		string	title
	)

References org.pdfclown.objects.PdfArray.Add(), and org.pdfclown.documents.Document.Layer.

---

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.

override string org.pdfclown.documents.contents.layers.Layer.ToString

(

)

static new Layer org.pdfclown.documents.contents.layers.Layer.Wrap

(

PdfDirectObject

baseObject

)

[static]

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

---

Member Data Documentation

readonly PdfName org.pdfclown.documents.contents.layers.Layer.TypeName = PdfName.OCG [static]

---

Property Documentation

PdfDirectObject org.pdfclown.objects.IPdfObjectWrapper.BaseObject [get, inherited]

Gets the underlying reference object, if available; otherwise, gets the underlying data object.

Implemented in org.pdfclown.objects.PdfObjectWrapper.

Referenced by org.pdfclown.documents.interaction.actions.SetLayerState.LayerStates.Add(), and org.pdfclown.documents.interaction.actions.SetLayerState.LayerStates.Insert().

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.

string org.pdfclown.documents.contents.layers.Layer.ContentType [get, set]

Gets/Sets the name of the type of content controlled by the group.

string org.pdfclown.documents.contents.layers.Layer.Creator [get, set]

Gets/Sets the name of the application that created this layer.

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.

bool org.pdfclown.documents.contents.layers.Layer.Exportable [get, set]

Gets/Sets whether this layer is visible when the document is saved by a viewer application to a format that does not support optional content.

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

Gets the file context.

string org.pdfclown.documents.contents.layers.Layer.Language [get, set]

Gets/Sets the language (and possibly locale) of the content controlled by this layer.

Layers org.pdfclown.documents.contents.layers.Layer.Layers [get, set]

Gets/Sets the sublayers.

Implements org.pdfclown.documents.contents.layers.ILayerNode.

bool org.pdfclown.documents.contents.layers.Layer.Locked [get, set]

Gets/Sets whether the default visibility of this layer cannot be changed through the user interface of a viewer application.

override LayerMembership org.pdfclown.documents.contents.layers.Layer.Membership [get]

Gets the default membership.

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

Reimplemented from org.pdfclown.documents.contents.layers.LayerEntity.

bool org.pdfclown.documents.contents.layers.Layer.Printable [get, set]

Gets/Sets whether this layer is visible when the document is printed from a viewer application.

string org.pdfclown.documents.contents.layers.Layer.Title [get, set]

Gets/Sets the text label.

Implements org.pdfclown.documents.contents.layers.ILayerNode.

bool org.pdfclown.documents.contents.layers.Layer.Viewable [get, set]

Gets/Sets whether this layer is visible when the document is opened in a viewer application.

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

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

Reimplemented from org.pdfclown.documents.contents.layers.LayerEntity.

override VisibilityPolicyEnum org.pdfclown.documents.contents.layers.Layer.VisibilityPolicy [get, set]

Gets/Sets the visibility policy of this entity.

Reimplemented from org.pdfclown.documents.contents.layers.LayerEntity.

bool org.pdfclown.documents.contents.layers.Layer.Visible [get, set]

Gets/Sets whether this layer is initially visible.

Interval<double> org.pdfclown.documents.contents.layers.Layer.ZoomRange [get, set]

Gets/Sets the range of magnifications at which the content in this layer is best viewed.