Package org.apache.poi.ss.usermodel
Enum Class BorderExtent
- All Implemented Interfaces:
Serializable
,Comparable<BorderExtent>
,Constable
The enumeration value indicating which borders to draw in a Property Template
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAll borders, that is top, bottom, left and right, including interior borders for the range.This is just the bottom border for the range.This is all horizontal borders for the range, including interior and outside borders.All inside borders.This is just the interior horizontal borders for the range.This is just the interior vertical borders for the range.This is just the left border for the range, no interior borders will be produced.No properties defined.All outside borders.This is just the outside horizontal borders for the range.This is just the outside vertical borders for the range.This is just the right border for the range, no interior borders will be produced.This is just the top border for the range.This is all vertical borders for the range, including interior and outside borders. -
Method Summary
Modifier and TypeMethodDescriptionstatic BorderExtent
Returns the enum constant of this class with the specified name.static BorderExtent[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
NONE
No properties defined. This can be used to remove existing properties from the PropertyTemplate. -
ALL
All borders, that is top, bottom, left and right, including interior borders for the range. Does not include diagonals which are different and not implemented here. -
INSIDE
All inside borders. This is top, bottom, left, and right borders, but restricted to the interior borders for the range. For a range of one cell, this will produce no borders. -
OUTSIDE
All outside borders. That is top, bottom, left and right borders that bound the range only. -
TOP
This is just the top border for the range. No interior borders will be produced. -
BOTTOM
This is just the bottom border for the range. No interior borders will be produced. -
LEFT
This is just the left border for the range, no interior borders will be produced. -
RIGHT
This is just the right border for the range, no interior borders will be produced. -
HORIZONTAL
This is all horizontal borders for the range, including interior and outside borders. -
INSIDE_HORIZONTAL
This is just the interior horizontal borders for the range. -
OUTSIDE_HORIZONTAL
This is just the outside horizontal borders for the range. -
VERTICAL
This is all vertical borders for the range, including interior and outside borders. -
INSIDE_VERTICAL
This is just the interior vertical borders for the range. -
OUTSIDE_VERTICAL
This is just the outside vertical borders for the range.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-