Package org.apache.poi.sl.usermodel
Enum Class TextShape.TextPlaceholder
- All Implemented Interfaces:
Serializable
,Comparable<TextShape.TextPlaceholder>
,Constable
This enum represents a compromise for the handling of
HSLF run types (see org.apache.poi.hslf.record.TextHeaderAtom) and
XSLF placeholders (see org.apache.poi.xslf.usermodel.Placeholder).
When a shape is considered a placeholder by the generating application
it can have special properties to alert the user that they may enter content into the shape.
This enum and the handling around it may change significantly in future releases
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionBody placeholder shape textCenter body placeholder shape textCenter title placeholder shape textHalf-sized body placeholder shape textNotes placeholder shape textAny other textQuarter-sized body placeholder shape textTitle placeholder shape text -
Method Summary
Modifier and TypeMethodDescriptionstatic TextShape.TextPlaceholder
Returns the enum constant of this class with the specified name.static TextShape.TextPlaceholder[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
TITLE
Title placeholder shape text -
BODY
Body placeholder shape text -
CENTER_TITLE
Center title placeholder shape text -
CENTER_BODY
Center body placeholder shape text -
HALF_BODY
Half-sized body placeholder shape text -
QUARTER_BODY
Quarter-sized body placeholder shape text -
NOTES
Notes placeholder shape text -
OTHER
Any other text
-
-
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
-