Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.annotation

public Class PDBorderEffectDictionary

extends Object
implements COSObjectable
Class Inheritance
All Implemented Interfaces
org.apache.pdfbox.pdmodel.common.COSObjectable
Imports
org.apache.pdfbox.cos.COSDictionary, org.apache.pdfbox.pdmodel.common.COSObjectable
This class represents a PDF /BE entry the border effect dictionary.
Author
Paul King

Field Summary

Modifier and TypeField and Description
private final COSDictionary
dictionary

public static final String
STYLE_CLOUDY

Constant for the name of a cloudy effect.

public static final String
STYLE_SOLID

Constant for the name for no effect.

Constructor Summary

AccessConstructor and Description
public
PDBorderEffectDictionary()

Constructor.

public
PDBorderEffectDictionary(COSDictionary
a border style dictionary.
dict)

Constructor.

Method Summary

Modifier and TypeMethod and Description
public COSDictionary

Returns:

the dictionary
getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

returns the dictionary.

public float

Returns:

the intensity value 0 to 2
getIntensity()

This will retrieve the intensity of the applied effect.

public String

Returns:

the effect of the border or STYLE_SOLID if none is found.
getStyle()

This will retrieve the border effect, see the STYLE_* constants for valid values.

public void
setIntensity(float
the intensity of the effect values 0 to 2
i)

This will set the intensity of the applied effect.

public void
setStyle(String
the border effect to use
s)

This will set the border effect, see the STYLE_* constants for valid values.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

dictionaryback to summary
private final COSDictionary dictionary
STYLE_CLOUDYback to summary
public static final String STYLE_CLOUDY

Constant for the name of a cloudy effect.

STYLE_SOLIDback to summary
public static final String STYLE_SOLID

Constant for the name for no effect.

Constructor Detail

PDBorderEffectDictionaryback to summary
public PDBorderEffectDictionary()

Constructor.

PDBorderEffectDictionaryback to summary
public PDBorderEffectDictionary(COSDictionary dict)

Constructor.

Parameters
dict:COSDictionary

a border style dictionary.

Method Detail

getCOSObjectback to summary
public COSDictionary getCOSObject()

Implements org.apache.pdfbox.pdmodel.common.COSObjectable.getCOSObject.

returns the dictionary.

Returns:COSDictionary

the dictionary

Annotations
@Override
getIntensityback to summary
public float getIntensity()

This will retrieve the intensity of the applied effect.

Returns:float

the intensity value 0 to 2

getStyleback to summary
public String getStyle()

This will retrieve the border effect, see the STYLE_* constants for valid values.

Returns:String

the effect of the border or STYLE_SOLID if none is found.

setIntensityback to summary
public void setIntensity(float i)

This will set the intensity of the applied effect.

Parameters
i:float

the intensity of the effect values 0 to 2

setStyleback to summary
public void setStyle(String s)

This will set the border effect, see the STYLE_* constants for valid values.

Parameters
s:String

the border effect to use