Class PDBorderEffectDictionary
java.lang.Object
org.apache.pdfbox.pdmodel.interactive.annotation.PDBorderEffectDictionary
- All Implemented Interfaces:
COSObjectable
This class represents a PDF /BE entry the border effect dictionary.
- Version:
- $Revision: 1.1 $
- Author:
- Paul King
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructor.Constructor. -
Method Summary
Modifier and TypeMethodDescriptionreturns the dictionary.returns the dictionary.float
This will retrieve the intensity of the applied effect.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
This will set the border effect, see the STYLE_* constants for valid values.
-
Field Details
-
STYLE_SOLID
Constant for the name for no effect.- See Also:
-
STYLE_CLOUDY
Constant for the name of a cloudy effect.- See Also:
-
-
Constructor Details
-
PDBorderEffectDictionary
public PDBorderEffectDictionary()Constructor. -
PDBorderEffectDictionary
Constructor.- Parameters:
dict
- a border style dictionary.
-
-
Method Details
-
getDictionary
returns the dictionary.- Returns:
- the dictionary
-
getCOSObject
returns the dictionary.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- the dictionary
-
setIntensity
public void setIntensity(float i) This will set the intensity of the applied effect.- Parameters:
i
- the intensity of the effect values 0 to 2
-
getIntensity
public float getIntensity()This will retrieve the intensity of the applied effect.- Returns:
- the intensity value 0 to 2
-
setStyle
This will set the border effect, see the STYLE_* constants for valid values.- Parameters:
s
- the border effect to use
-
getStyle
This will retrieve the border effect, see the STYLE_* constants for valid values.- Returns:
- the effect of the border or
STYLE_SOLID
if none is found.
-