Apache POI - Common 5.3.0 · org.apache.poi.ss.usermodel.PageMargin

Field Summary

Modifier and Type	Field and Description
public static final PageMargin	BOTTOM Bottom margin, the empty space on the bottom of displayed worksheet data when printing
public static final PageMargin	FOOTER Footer margin, the empty space between the footer and the bottom of the page when printing
public static final PageMargin	HEADER Header margin, the empty space between the header and the top of the page when printing
public static final PageMargin	LEFT Left margin, the empty space on the left of displayed worksheet data when printing
private final short	legacyApiValue The old API constant value which corresponded to this page margin
private static final Map<Short, PageMargin>	PAGE_MARGIN_BY_LEGACY_API_VALUE Map relating the old API constant values to their corresponding enumeration value
public static final PageMargin	RIGHT Right margin, the empty space on the right of displayed worksheet data when printing
public static final PageMargin	TOP Top margin, the empty space on the top of displayed worksheet data when printing

Access	Constructor and Description
private	PageMargin(short The old API constant value which corresponded to this page margin legacyApiValue)

Modifier and Type	Method and Description
public static PageMargin	Returns: The PageMargin enumeration which corresponds to the given value, or null if no corresponding value exists getByShortValue(short An old API margin constant value legacyApiValue) Retrieves the enumeration value which corresponds to a legacy API constant value
public short	getLegacyApiValue()
public static PageMargin	valueOf(String name)
public static PageMargin[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

BOTTOM	back to summary
public static final PageMargin BOTTOM Bottom margin, the empty space on the bottom of displayed worksheet data when printing

FOOTER	back to summary
public static final PageMargin FOOTER Footer margin, the empty space between the footer and the bottom of the page when printing

HEADER	back to summary
public static final PageMargin HEADER Header margin, the empty space between the header and the top of the page when printing

LEFT	back to summary
public static final PageMargin LEFT Left margin, the empty space on the left of displayed worksheet data when printing

legacyApiValue	back to summary
private final short legacyApiValue The old API constant value which corresponded to this page margin

PAGE_MARGIN_BY_LEGACY_API_VALUE	back to summary
private static final Map<Short, PageMargin> PAGE_MARGIN_BY_LEGACY_API_VALUE Map relating the old API constant values to their corresponding enumeration value

RIGHT	back to summary
public static final PageMargin RIGHT Right margin, the empty space on the right of displayed worksheet data when printing

TOP	back to summary
public static final PageMargin TOP Top margin, the empty space on the top of displayed worksheet data when printing

PageMargin	back to summary
private PageMargin(short legacyApiValue) Parameters legacyApiValue:short The old API constant value which corresponded to this page margin

getByShortValue	back to summary
public static PageMargin getByShortValue(short legacyApiValue) Retrieves the enumeration value which corresponds to a legacy API constant value Parameters legacyApiValue:short An old API margin constant value Returns:PageMargin The PageMargin enumeration which corresponds to the given value, or null if no corresponding value exists

getByShortValue

public static PageMargin getByShortValue(short legacyApiValue)

Retrieves the enumeration value which corresponds to a legacy API constant value

Parameters

The PageMargin enumeration which corresponds to the given value, or null if no corresponding value exists

getLegacyApiValue	back to summary
public short getLegacyApiValue()

valueOf	back to summary
public static PageMargin valueOf(String name)

values	back to summary
public static PageMargin[] values()