Package org.apache.pdfbox.pdmodel.fdf
Class FDFIconFit
java.lang.Object
org.apache.pdfbox.pdmodel.fdf.FDFIconFit
- All Implemented Interfaces:
COSObjectable
This represents an Icon fit dictionary for an FDF field.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate COSDictionary
static final String
A scale option.static final String
A scale option.static final String
A scale option.static final String
A scale option.static final String
Scale to fill with of annotation, disregarding aspect ratio.static final String
Scale to fit width or height, smaller of two, while retaining aspect ration. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionConvert this standard java object to a COS object.This is guaranteed to never return null.
To quote the PDF Spec "An array of two numbers between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the icon.This will get the scale option.This will get the scale type.void
This will set frational space to allocate.void
setScaleOption
(String option) This will set the scale option for the icon.void
setScaleToFitAnnotation
(boolean value) This will tell the icon to scale.void
setScaleType
(String scale) This will set the scale type.boolean
This will tell if the icon should scale to fit the annotation bounds.
-
Field Details
-
fit
-
SCALE_OPTION_ALWAYS
A scale option.- See Also:
-
SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER
A scale option.- See Also:
-
SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER
A scale option.- See Also:
-
SCALE_OPTION_NEVER
A scale option.- See Also:
-
SCALE_TYPE_ANAMORPHIC
Scale to fill with of annotation, disregarding aspect ratio.- See Also:
-
SCALE_TYPE_PROPORTIONAL
Scale to fit width or height, smaller of two, while retaining aspect ration.- See Also:
-
-
Constructor Details
-
FDFIconFit
public FDFIconFit()Default constructor. -
FDFIconFit
Constructor.- Parameters:
f
- The icon fit dictionary.
-
-
Method Details
-
getCOSObject
Convert this standard java object to a COS object.- Specified by:
getCOSObject
in interfaceCOSObjectable
- Returns:
- The cos object that matches this Java object.
-
getScaleOption
This will get the scale option. See the SCALE_OPTION_XXX constants. This is guaranteed to never return null. Default: Always- Returns:
- The scale option.
-
setScaleOption
This will set the scale option for the icon. Set the SCALE_OPTION_XXX constants.- Parameters:
option
- The scale option.
-
getScaleType
This will get the scale type. See the SCALE_TYPE_XXX constants. This is guaranteed to never return null. Default: Proportional- Returns:
- The scale type.
-
setScaleType
This will set the scale type. See the SCALE_TYPE_XXX constants.- Parameters:
scale
- The scale type.
-
getFractionalSpaceToAllocate
This is guaranteed to never return null.
To quote the PDF Spec "An array of two numbers between 0.0 and 1.0 indicating the fraction of leftover space to allocate at the left and bottom of the icon. A value of [0.0 0.0] positions the icon at the bottom-left corner of the annotation rectangle; a value of [0.5 0.5] centers it within the rectangle. This entry is used only if the icon is scaled proportionally. Default value: [0.5 0.5]."- Returns:
- The fractional space to allocate.
-
setFractionalSpaceToAllocate
This will set frational space to allocate.- Parameters:
space
- The space to allocate.
-
shouldScaleToFitAnnotation
public boolean shouldScaleToFitAnnotation()This will tell if the icon should scale to fit the annotation bounds. Default: false- Returns:
- A flag telling if the icon should scale.
-
setScaleToFitAnnotation
public void setScaleToFitAnnotation(boolean value) This will tell the icon to scale.- Parameters:
value
- The flag value.
-