TextHorizontalOverflow (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.apache.poi.xssf.usermodel
Enum TextHorizontalOverflow

java.lang.Object
  java.lang.Enum<TextHorizontalOverflow>
      org.apache.poi.xssf.usermodel.TextHorizontalOverflow

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<TextHorizontalOverflow>

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

Text Horizontal Overflow

Enum Constant Summary
`CLIP` When a big character does not fit into a line, clip it at the proper horizontal overflow.
`OVERFLOW` When a big character does not fit into a line, allow a horizontal overflow.

Method Summary
`static TextHorizontalOverflow`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TextHorizontalOverflow[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Enum Constant Detail

OVERFLOW

public static final TextHorizontalOverflow OVERFLOW

When a big character does not fit into a line, allow a horizontal overflow.

CLIP

public static final TextHorizontalOverflow CLIP

When a big character does not fit into a line, clip it at the proper horizontal overflow.

Method Detail

values

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

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

valueOf

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