|
| |
|
| java.lang.Object
 org.pdfbox.pdmodel.fdf.FDFIconFit
| FDFIconFit | | public class FDFIconFit implements COSObjectable(Code) | | This represents an Icon fit dictionary for an FDF field.
author:
Ben Litchfield
version:
$Revision: 1.3 $ |
| SCALE_OPTION_ALWAYS | | final public static String SCALE_OPTION_ALWAYS(Code) | | A scale option.
|
| SCALE_OPTION_NEVER | | final public static String SCALE_OPTION_NEVER(Code) | | A scale option.
|
| SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER | | final public static String SCALE_OPTION_ONLY_WHEN_ICON_IS_BIGGER(Code) | | A scale option.
|
| SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER | | final public static String SCALE_OPTION_ONLY_WHEN_ICON_IS_SMALLER(Code) | | A scale option.
|
| SCALE_TYPE_ANAMORPHIC | | final public static String SCALE_TYPE_ANAMORPHIC(Code) | | Scale to fill with of annotation, disregarding aspect ratio.
|
| SCALE_TYPE_PROPORTIONAL | | final public static String SCALE_TYPE_PROPORTIONAL(Code) | | Scale to fit width or height, smaller of two, while retaining aspect ration.
|
| FDFIconFit | | public FDFIconFit()(Code) | | Default constructor.
|
| FDFIconFit | | public FDFIconFit(COSDictionary f)(Code) | | Constructor.
Parameters:
f - The icon fit dictionary. |
| getCOSDictionary | | public COSDictionary getCOSDictionary()(Code) | | Convert this standard java object to a COS object.
The cos object that matches this Java object. |
| getCOSObject | | public COSBase getCOSObject()(Code) | | Convert this standard java object to a COS object.
The cos object that matches this Java object. |
| getFractionalSpaceToAllocate | | public PDRange getFractionalSpaceToAllocate()(Code) | | 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]."
The fractional space to allocate. |
| getScaleOption | | public String getScaleOption()(Code) | | This will get the scale option. See the SCALE_OPTION_XXX constants. This
is guaranteed to never return null. Default: Always
The scale option. |
| getScaleType | | public String getScaleType()(Code) | | This will get the scale type. See the SCALE_TYPE_XXX constants. This is
guaranteed to never return null. Default: Proportional
The scale type. |
| setFractionalSpaceToAllocate | | public void setFractionalSpaceToAllocate(PDRange space)(Code) | | This will set frational space to allocate.
Parameters:
space - The space to allocate. |
| setScaleOption | | public void setScaleOption(String option)(Code) | | This will set the scale option for the icon. Set the SCALE_OPTION_XXX constants.
Parameters:
option - The scale option. |
| setScaleToFitAnnotation | | public void setScaleToFitAnnotation(boolean value)(Code) | | This will tell the icon to scale.
Parameters:
value - The flag value. |
| setScaleType | | public void setScaleType(String scale)(Code) | | This will set the scale type. See the SCALE_TYPE_XXX constants.
Parameters:
scale - The scale type. |
| shouldScaleToFitAnnotation | | public boolean shouldScaleToFitAnnotation()(Code) | | This will tell if the icon should scale to fit the annotation bounds. Default: false
A flag telling if the icon should scale. |
|
|
|