LayerDefinition (PDF Clown 0.1.2 API Reference)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PDF Clown
0.1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.pdfclown.documents.contents.layers
Class LayerDefinition

java.lang.Object
  org.pdfclown.objects.PdfObjectWrapper<PdfDictionary>
      org.pdfclown.documents.contents.layers.LayerDefinition

All Implemented Interfaces:: Cloneable, ILayerConfiguration, IPdfObjectWrapper

Optional content properties [PDF:1.7:4.10.3].

Constructor Summary
`LayerDefinition(Document context)`

Method Summary
`LayerDefinition`	`clone(Document context)` Gets a clone of the object, registered inside the given document context.
`Array<LayerConfiguration>`	`getAlternateConfigurations()` Gets the layer configurations used under particular circumstances.
`String`	`getCreator()` Gets the name of the application or feature that created this configuration.
`LayerConfiguration`	`getDefaultConfiguration()` Gets the default layer configuration, that is the initial state of the optional content groups when a document is first opened.
`Layers`	`getLayers()` Gets the layer structure.
`ListModeEnum`	`getListMode()` Gets the list mode specifying which layers should be displayed to the user.
`Array<LayerGroup>`	`getOptionGroups()` Gets the groups of layers whose states are intended to follow a radio button paradigm (that is exclusive visibility within the same group).
`String`	`getTitle()` Gets the configuration name.
`Boolean`	`isVisible()` Gets whether all the layers in the document are initialized to be visible when this configuration is applied.
`void`	`setAlternateConfigurations(Array<LayerConfiguration> value)`
`void`	`setCreator(String value)`
`void`	`setDefaultConfiguration(LayerConfiguration value)`
`void`	`setLayers(Layers value)`
`void`	`setListMode(ListModeEnum value)`
`void`	`setTitle(String value)`
`void`	`setVisible(Boolean value)`
`static LayerDefinition`	`wrap(PdfDirectObject baseObject)`

Methods inherited from class org.pdfclown.objects.PdfObjectWrapper
`checkCompatibility, delete, equals, exists, getBaseDataObject, getBaseObject, getBaseObject, getContainer, getDataContainer, getDocument, getFile, getMetadata, retrieveName, retrieveNamedBaseObject, setBaseObject, setMetadata`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.pdfclown.objects.IPdfObjectWrapper
`getBaseObject`

Constructor Detail

public LayerDefinition(Document context)

Method Detail

public static LayerDefinition wrap(PdfDirectObject baseObject)

public LayerDefinition clone(Document context)

Description copied from class: PdfObjectWrapper

Gets a clone of the object, registered inside the given document context.

public Array<LayerConfiguration> getAlternateConfigurations()

Gets the layer configurations used under particular circumstances.

public LayerConfiguration getDefaultConfiguration()

Gets the default layer configuration, that is the initial state of the optional content groups when a document is first opened.

public void setAlternateConfigurations(Array<LayerConfiguration> value)

public void setDefaultConfiguration(LayerConfiguration value)