org.jpedal.objects.layers

Class PdfLayerList

java.lang.Object

org.jpedal.objects.layers.PdfLayerList

public class PdfLayerList
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static char	deliminator

Constructor Summary

Constructors

Constructor and Description
PdfLayerList()

Method Summary

Modifier and Type	Method and Description
void	addJScommand(String name, String js)
boolean	decodeLayer(String name, boolean isID) Used internally only.
boolean	getChangesMade() show if decoded version match visibility flags which can be altered by user
Object[]	getDisplayTree()
Iterator<String>	getJSCommands()
int	getLayersCount() number of layers setup.
Map<String,String>	getMetaData()
String	getNameFromRef(String ref)
Object[]	getOCGs() JS Gets an array of OCG objects found on a specified page.
int	getOCpageNumber()
void	init(PdfObject OCProperties, PdfObject PropertiesObj, PdfObjectReader currentPdfFile, int pageNumber) add layers and settings to list
boolean	isLayerName(String name) show if is name of layer (as opposed to just label).
boolean	isLocked(String layerName)
boolean	isVisible(PdfObject XObject)
boolean	isVisible(String layerName)
void	setChangesMade(boolean flag) used by Javascript to flag that state has changed
void	setVisibleLayers(String[] layerNames) will display only these layers and hide all others and will override any constraints.
void	setVisiblity(String layerName, boolean isVisible)
boolean	setZoom(float scaling) Switch on/off layers based on Zoom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

deliminator

public static final char deliminator

See Also:

Constant Field Values

Constructor Detail

PdfLayerList

public PdfLayerList()

Method Detail

init

public void init(PdfObject OCProperties,
                 PdfObject PropertiesObj,
                 PdfObjectReader currentPdfFile,
                 int pageNumber)

add layers and settings to list

Parameters:

OCProperties - is of type PdfObject

PropertiesObj - is of type PdfObject

currentPdfFile - is of type PdfObjectReader

pageNumber - is of type int

setChangesMade

public void setChangesMade(boolean flag)

used by Javascript to flag that state has changed

Parameters:

flag - is of type boolean

getMetaData

public Map<String,String> getMetaData()

getDisplayTree

public Object[] getDisplayTree()

setVisibleLayers

public void setVisibleLayers(String[] layerNames)

will display only these layers and hide all others and will override any constraints. If you pass null in, all layers will be removed

Parameters:

layerNames - is of type String[]

decodeLayer

public boolean decodeLayer(String name,
                           boolean isID)

Used internally only. takes name in Stream (ie MC7 and works out if we need to decode) if isID==true.

Parameters:

name - is of type String

isID - is of type boolean

Returns:

type boolean

setZoom

public boolean setZoom(float scaling)

Switch on/off layers based on Zoom.

Parameters:

scaling - is of type float

Returns:

is of type boolean

isVisible

public boolean isVisible(String layerName)

setVisiblity

public void setVisiblity(String layerName,
                         boolean isVisible)

isVisible

public boolean isVisible(PdfObject XObject)

isLocked

public boolean isLocked(String layerName)

getChangesMade

public boolean getChangesMade()

show if decoded version match visibility flags which can be altered by user

Returns:

type boolean

isLayerName

public boolean isLayerName(String name)

show if is name of layer (as opposed to just label).

Parameters:

name - is of type String

Returns:

is of type boolean

getLayersCount

public int getLayersCount()

number of layers setup.

Returns:

is of type int.

getNameFromRef

public String getNameFromRef(String ref)

getOCGs

public Object[] getOCGs()

JS Gets an array of OCG objects found on a specified page.

Returns:

- An array of OCG objects or null if no OCGs are present.

addJScommand

public void addJScommand(String name,
                         String js)

getJSCommands

public Iterator<String> getJSCommands()

getOCpageNumber

public int getOCpageNumber()