TextShape.TextAutofit (POI API Documentation)

Overview

Package

Class

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.sl.usermodel
Enum TextShape.TextAutofit

java.lang.Object
  java.lang.Enum<TextShape.TextAutofit>
      org.apache.poi.sl.usermodel.TextShape.TextAutofit

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

Enclosing interface:: TextShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>

public static enum TextShape.TextAutofit
extends java.lang.Enum<TextShape.TextAutofit>
extends java.lang.Enum<TextShape.TextAutofit>

Specifies alist of auto-fit types.

Autofit specofies that a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside

Enum Constant Summary
`NONE` Specifies that text within the text body should not be auto-fit to the bounding box.
`NORMAL` Specifies that text within the text body should be normally auto-fit to the bounding box.
`SHAPE` Specifies that a shape should be auto-fit to fully contain the text described within it.

Method Summary
`static TextShape.TextAutofit`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static TextShape.TextAutofit[]`	`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

NONE

public static final TextShape.TextAutofit NONE

Specifies that text within the text body should not be auto-fit to the bounding box. Auto-fitting is when text within a text box is scaled in order to remain inside the text box.

NORMAL

public static final TextShape.TextAutofit NORMAL

Specifies that text within the text body should be normally auto-fit to the bounding box. Autofitting is when text within a text box is scaled in order to remain inside the text box.

Example: Consider the situation where a user is building a diagram and needs to have the text for each shape that they are using stay within the bounds of the shape. An easy way this might be done is by using NORMAL autofit

SHAPE

public static final TextShape.TextAutofit SHAPE

Specifies that a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside.

Method Detail

values

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

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

valueOf

public static TextShape.TextAutofit 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