Package org.apache.poi.xwpf.usermodel
Enum Class UnderlinePatterns
- All Implemented Interfaces:
Serializable
,Comparable<UnderlinePatterns>
,Constable
Specifies the types of patterns which may be used to create the underline
applied beneath the text in a run.
- Author:
- Gisella Bronzetti
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionSpecifies an underline consisting of a dashed line beneath all characters in this run.Specifies an underline consisting of a series of thick dash, dot, dot characters beneath all characters in this run.Specifies an underline consisting of a series of thick dash, dot characters beneath all characters in this run.Specifies an underline consisting of long dashed characters beneath all characters in this run.Specifies an underline consisting of thick long dashed characters beneath all characters in this run.Specifies an underline consisting of a series of thick dashes beneath all characters in this run.Specifies an underline consisting of a series of dash, dot characters beneath all characters in this run.Specifies an underline consisting of a series of dash, dot, dot characters beneath all characters in this run.Specifies an underline consisting of a series of dot characters beneath all characters in this run.Specifies an underline consisting of a series of thick dot characters beneath all characters in this run.Specifies an underline consisting of two lines beneath all characters in this runSpecifies no underline beneath this run.Specifies an underline consisting of a single line beneath all characters in this run.Specifies an underline consisting of a single thick line beneath all characters in this run.Specifies an underline consisting of a single wavy line beneath all characters in this run.Specifies an underline consisting of a pair of wavy lines beneath all characters in this run.Specifies an underline consisting of a single thick wavy line beneath all characters in this run.Specifies an underline consisting of a single line beneath all non-space characters in the run. -
Method Summary
Modifier and TypeMethodDescriptionint
getValue()
static UnderlinePatterns
valueOf
(int type) Returns the enum constant of this class with the specified name.static UnderlinePatterns
Returns the enum constant of this class with the specified name.static UnderlinePatterns[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SINGLE
Specifies an underline consisting of a single line beneath all characters in this run. -
WORDS
Specifies an underline consisting of a single line beneath all non-space characters in the run. There shall be no underline beneath any space character (breaking or non-breaking). -
DOUBLE
Specifies an underline consisting of two lines beneath all characters in this run -
THICK
Specifies an underline consisting of a single thick line beneath all characters in this run. -
DOTTED
Specifies an underline consisting of a series of dot characters beneath all characters in this run. -
DOTTED_HEAVY
Specifies an underline consisting of a series of thick dot characters beneath all characters in this run. -
DASH
Specifies an underline consisting of a dashed line beneath all characters in this run. -
DASHED_HEAVY
Specifies an underline consisting of a series of thick dashes beneath all characters in this run. -
DASH_LONG
Specifies an underline consisting of long dashed characters beneath all characters in this run. -
DASH_LONG_HEAVY
Specifies an underline consisting of thick long dashed characters beneath all characters in this run. -
DOT_DASH
Specifies an underline consisting of a series of dash, dot characters beneath all characters in this run. -
DASH_DOT_HEAVY
Specifies an underline consisting of a series of thick dash, dot characters beneath all characters in this run. -
DOT_DOT_DASH
Specifies an underline consisting of a series of dash, dot, dot characters beneath all characters in this run. -
DASH_DOT_DOT_HEAVY
Specifies an underline consisting of a series of thick dash, dot, dot characters beneath all characters in this run. -
WAVE
Specifies an underline consisting of a single wavy line beneath all characters in this run. -
WAVY_HEAVY
Specifies an underline consisting of a single thick wavy line beneath all characters in this run. -
WAVY_DOUBLE
Specifies an underline consisting of a pair of wavy lines beneath all characters in this run. -
NONE
Specifies no underline beneath this run.
-
-
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
-
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:
type
- 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
-
getValue
public int getValue()
-