com.grapecity.documents.excel

Enum PageBreakExtent

java.lang.Object

java.lang.Enum<PageBreakExtent>

com.grapecity.documents.excel.PageBreakExtent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PageBreakExtent>

public enum PageBreakExtent
extends java.lang.Enum<PageBreakExtent>

Specifies whether a page break is full screen or applies only within the print area.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PageBreakFull Specifies the page break is full screen.
PageBreakPartial Specifies the page break is only within print area.

Method Summary

Modifier and Type	Method and Description
static PageBreakExtent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PageBreakExtent[]	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

PageBreakFull

public static final PageBreakExtent PageBreakFull

Specifies the page break is full screen.

PageBreakPartial

public static final PageBreakExtent PageBreakPartial

Specifies the page break is only within print area.

Method Detail

values

public static PageBreakExtent[] 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 (PageBreakExtent c : PageBreakExtent.values())
    System.out.println(c);

Returns:

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

valueOf

public static PageBreakExtent 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