Package com.itextpdf.pdfocr

Enum ScaleMode

java.lang.Object

java.lang.Enum<ScaleMode>

com.itextpdf.pdfocr.ScaleMode

All Implemented Interfaces:

Serializable, Comparable<ScaleMode>, java.lang.constant.Constable

       public enum ScaleMode extends Enum<ScaleMode>
      

Enumeration of the possible scale modes for input images.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SCALE_HEIGHT	Only height of the image will be proportionally scaled to fit required size that is set using OcrPdfCreatorProperties.setPageSize(Rectangle) method.
SCALE_TO_FIT	The image will be scaled to fit within the page width and height dimensions that are set using OcrPdfCreatorProperties.setPageSize(Rectangle) method.
SCALE_WIDTH	Only width of the image will be proportionally scaled to fit required size that is set using OcrPdfCreatorProperties.setPageSize(Rectangle) method.

Method Summary

Modifier and Type	Method	Description
static ScaleMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ScaleMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SCALE_WIDTH

             public static final ScaleMode SCALE_WIDTH
            

Only width of the image will be proportionally scaled to fit required size that is set using OcrPdfCreatorProperties.setPageSize(Rectangle) method. Height will be equal to the page height that was set using OcrPdfCreatorProperties.setPageSize(Rectangle) method and width will be proportionally scaled to keep the original aspect ratio.

SCALE_HEIGHT

             public static final ScaleMode SCALE_HEIGHT
            

Only height of the image will be proportionally scaled to fit required size that is set using OcrPdfCreatorProperties.setPageSize(Rectangle) method. Width will be equal to the page width that was set using OcrPdfCreatorProperties.setPageSize(Rectangle) method and height will be proportionally scaled to keep the original aspect ratio.

SCALE_TO_FIT

             public static final ScaleMode SCALE_TO_FIT
            

The image will be scaled to fit within the page width and height dimensions that are set using OcrPdfCreatorProperties.setPageSize(Rectangle) method. Original aspect ratio of the image stays unchanged.

Method Details

values

             public static ScaleMode[] values()
            

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

             public static ScaleMode valueOf
             (String name)
            

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null