com.qoppa.pdf

Class Layer

java.lang.Object

com.qoppa.pdf.Layer

public abstract class Layer
extends Object

This class represents a PDF 'Layer'.

Author:

Qoppa Software

Field Summary

Fields

Modifier and Type	Field and Description
static int	STATE_OFF
static int	STATE_ON

Constructor Summary

Constructors

Constructor and Description
Layer()

Method Summary

Modifier and Type	Method and Description
abstract void	addLayerListener(LayerListener l) Adds an object that will listen to changes in the layer's visible state.
abstract int	getDefaultState() Returns the default state for this layer.
abstract String	getName() Returns the name of this layer.
abstract boolean	isLocked() Returns whether this layer is locked.
abstract boolean	isVisible() Returns whether this layer is currently visible.
abstract void	removeLayerListener(LayerListener l) Removes a layer listener from the list of active listeners.
abstract void	setDefaultState(int state) Sets the default state for this layer.
abstract void	setLocked(boolean locked) Sets the locked state of the layer.
abstract void	setName(String name) Sets the name of this layer.
abstract void	setVisible(boolean visible) Sets the visibility for this layer.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_OFF

public static final int STATE_OFF

See Also:

Constant Field Values

STATE_ON

public static final int STATE_ON

See Also:

Constant Field Values

Constructor Detail

Layer

public Layer()

Method Detail

getName

public abstract String getName()

Returns the name of this layer.

Returns:

The name of the layer.

setName

public abstract void setName(String name)

Sets the name of this layer.

isVisible

public abstract boolean isVisible()

Returns whether this layer is currently visible.

Returns:

Layer's visibility.

setVisible

public abstract void setVisible(boolean visible)

Sets the visibility for this layer.

Parameters:

visible - The new visibility.

getDefaultState

public abstract int getDefaultState()

Returns the default state for this layer. One of Layer.STATE_OFF or Layer.STATE_ON.

Returns:

Layer's initial visibility.

setDefaultState

public abstract void setDefaultState(int state)

Sets the default state for this layer. Should be one of Layer.STATE_OFF or Layer.STATE_ON.

Parameters:

state - The new initial visibility.

isLocked

public abstract boolean isLocked()

Returns whether this layer is locked.

Returns:

Layer's locked state.

setLocked

public abstract void setLocked(boolean locked)

Sets the locked state of the layer.

Parameters:

locked - The new locked state.

addLayerListener

public abstract void addLayerListener(LayerListener l)

Adds an object that will listen to changes in the layer's visible state. All listeners will be notified when a layer is made visible or invisible.

Parameters:

l - The new layer listener.

removeLayerListener

public abstract void removeLayerListener(LayerListener l)

Removes a layer listener from the list of active listeners.

Parameters:

l - The listener to remove.