com.compdfkit.core.document

Enum CPDFDocument.PDFDocumentImageMode

java.lang.Object

java.lang.Enum<CPDFDocument.PDFDocumentImageMode>

com.compdfkit.core.document.CPDFDocument.PDFDocumentImageMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CPDFDocument.PDFDocumentImageMode>

Enclosing class:

CPDFDocument

public static enum CPDFDocument.PDFDocumentImageMode
extends java.lang.Enum<CPDFDocument.PDFDocumentImageMode>

Options to specify how a view adjusts its content when its size changes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PDFDocumentImageModeBottom Center the content aligned at the bottom in the view’s bounds
PDFDocumentImageModeBottomLeft Align the content in the bottom-left corner of the view
PDFDocumentImageModeBottomRight Align the content in the bottom-right corner of the view
PDFDocumentImageModeCenter Scale the content to fill the size of the view.
PDFDocumentImageModeLeft Align the content on the left of the view
PDFDocumentImageModeRight Align the content on the right of the view
PDFDocumentImageModeScaleAspectFill Scale the content to fit the size of the view by maintaining the aspect ratio
PDFDocumentImageModeScaleAspectFit Scale the content to fit the size of itself by changing the aspect ratio of the content if necessary.
PDFDocumentImageModeScaleToFill Fits the view to screen dimensions so that the full page is visible
PDFDocumentImageModeTop Center the content aligned at the top in the view’s bounds
PDFDocumentImageModeTopLeft Align the content in the top-left corner of the view
PDFDocumentImageModeTopRight Align the content in the top-right corner of the view

Field Summary

Fields

Modifier and Type	Field and Description
int	id

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PDFDocumentImageModeScaleToFill

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeScaleToFill

Fits the view to screen dimensions so that the full page is visible

PDFDocumentImageModeScaleAspectFit

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeScaleAspectFit

Scale the content to fit the size of itself by changing the aspect ratio of the content if necessary.

PDFDocumentImageModeScaleAspectFill

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeScaleAspectFill

Scale the content to fit the size of the view by maintaining the aspect ratio

PDFDocumentImageModeCenter

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeCenter

Scale the content to fill the size of the view. Some portion of the content may be clipped to fill the view’s bounds

PDFDocumentImageModeTop

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeTop

Center the content aligned at the top in the view’s bounds

PDFDocumentImageModeBottom

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeBottom

Center the content aligned at the bottom in the view’s bounds

PDFDocumentImageModeLeft

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeLeft

Align the content on the left of the view

PDFDocumentImageModeRight

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeRight

Align the content on the right of the view

PDFDocumentImageModeTopLeft

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeTopLeft

Align the content in the top-left corner of the view

PDFDocumentImageModeTopRight

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeTopRight

Align the content in the top-right corner of the view

PDFDocumentImageModeBottomLeft

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeBottomLeft

Align the content in the bottom-left corner of the view

PDFDocumentImageModeBottomRight

public static final CPDFDocument.PDFDocumentImageMode PDFDocumentImageModeBottomRight

Align the content in the bottom-right corner of the view

Field Detail

id

public int id

Method Detail

values

public static CPDFDocument.PDFDocumentImageMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CPDFDocument.PDFDocumentImageMode c : CPDFDocument.PDFDocumentImageMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static CPDFDocument.PDFDocumentImageMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

valueOf

public static CPDFDocument.PDFDocumentImageMode valueOf(int id)