org.pdfbox.pdmodel.interactive.annotation
Class PDBorderEffectDictionary
java.lang.Object
org.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
- COSObjectable
public class PDBorderEffectDictionary
extends java.lang.Object
This class represents a PDF /BE entry the border effect dictionary.
static String | STYLE_CLOUDY - Constant for the name of a cloudy effect.
|
static String | STYLE_SOLID - Constant for the name for no effect.
|
COSBase | getCOSObject() - returns the dictionary.
|
COSDictionary | getDictionary() - returns the dictionary.
|
float | getIntensity() - This will retrieve the intensity of the applied effect.
|
String | getStyle() - This will retrieve the border effect, see the STYLE_* constants for valid
values.
|
void | setIntensity(float i) - This will set the intensity of the applied effect.
|
void | setStyle(String s) - This will set the border effect, see the STYLE_* constants for valid values.
|
STYLE_CLOUDY
public static final String STYLE_CLOUDY
Constant for the name of a cloudy effect.
STYLE_SOLID
public static final String STYLE_SOLID
Constant for the name for no effect.
PDBorderEffectDictionary
public PDBorderEffectDictionary()
Constructor.
PDBorderEffectDictionary
public PDBorderEffectDictionary(COSDictionary dict)
Constructor.
dict
- a border style dictionary.
getDictionary
public COSDictionary getDictionary()
returns the dictionary.
getIntensity
public float getIntensity()
This will retrieve the intensity of the applied effect.
- the intensity value 0 to 2
getStyle
public String getStyle()
This will retrieve the border effect, see the STYLE_* constants for valid
values.
setIntensity
public void setIntensity(float i)
This will set the intensity of the applied effect.
i
- the intensity of the effect values 0 to 2
setStyle
public void setStyle(String s)
This will set the border effect, see the STYLE_* constants for valid values.
s
- the border effect to use