COSObjectable
public class FDFIconFit extends java.lang.Object implements COSObjectable
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
SCALE_OPTION_ALWAYS |
A scale option.
|
static java.lang.String |
SCALE_OPTION_NEVER |
A scale option.
|
static java.lang.String |
SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER |
A scale option.
|
static java.lang.String |
SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER |
A scale option.
|
static java.lang.String |
SCALE_TYPE_ANAMORPHIC |
Scale to fill with of annotation, disregarding aspect ratio.
|
static java.lang.String |
SCALE_TYPE_PROPORTIONAL |
Scale to fit width or height, smaller of two, while retaining aspect ration.
|
Constructor | Description |
---|---|
FDFIconFit() |
Default constructor.
|
FDFIconFit(COSDictionary f) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
COSDictionary |
getCOSDictionary() |
Convert this standard java object to a COS object.
|
COSBase |
getCOSObject() |
Convert this standard java object to a COS object.
|
PDRange |
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. |
java.lang.String |
getScaleOption() |
This will get the scale option.
|
java.lang.String |
getScaleType() |
This will get the scale type.
|
void |
setFractionalSpaceToAllocate(PDRange space) |
This will set frational space to allocate.
|
void |
setScaleOption(java.lang.String option) |
This will set the scale option for the icon.
|
void |
setScaleToFitAnnotation(boolean value) |
This will tell the icon to scale.
|
void |
setScaleType(java.lang.String scale) |
This will set the scale type.
|
boolean |
shouldScaleToFitAnnotation() |
This will tell if the icon should scale to fit the annotation bounds.
|
public static final java.lang.String SCALE_OPTION_ALWAYS
public static final java.lang.String SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER
public static final java.lang.String SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER
public static final java.lang.String SCALE_OPTION_NEVER
public static final java.lang.String SCALE_TYPE_ANAMORPHIC
public static final java.lang.String SCALE_TYPE_PROPORTIONAL
public FDFIconFit()
public FDFIconFit(COSDictionary f)
f
- The icon fit dictionary.public COSBase getCOSObject()
getCOSObject
in interface COSObjectable
public COSDictionary getCOSDictionary()
public java.lang.String getScaleOption()
public void setScaleOption(java.lang.String option)
option
- The scale option.public java.lang.String getScaleType()
public void setScaleType(java.lang.String scale)
scale
- The scale type.public PDRange getFractionalSpaceToAllocate()
public void setFractionalSpaceToAllocate(PDRange space)
space
- The space to allocate.public boolean shouldScaleToFitAnnotation()
public void setScaleToFitAnnotation(boolean value)
value
- The flag value.