org.apache.poi.ss.usermodel

Enum HorizontalAlignment

java.lang.Object

java.lang.Enum<HorizontalAlignment>

org.apache.poi.ss.usermodel.HorizontalAlignment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<HorizontalAlignment>

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

The enumeration value indicating horizontal alignment of a cell, i.e., whether it is aligned general, left, right, horizontally centered, filled (replicated), justified, centered across multiple cells, or distributed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER The horizontal alignment is centered, meaning the text is centered across the cell.
CENTER_SELECTION The horizontal alignment is centered across multiple cells.
DISTRIBUTED Indicates that each 'word' in each line of text inside the cell is evenly distributed across the width of the cell, with flush right and left margins.
FILL Indicates that the value of the cell should be filled across the entire width of the cell.
GENERAL The horizontal alignment is general-aligned.
JUSTIFY The horizontal alignment is justified (flush left and right).
LEFT The horizontal alignment is left-aligned, even in Rightto-Left mode.
RIGHT The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell, even in Right-to-Left mode.

Method Summary

Modifier and Type	Method and Description
static HorizontalAlignment	forInt(int code)
short	getCode()
static HorizontalAlignment	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static HorizontalAlignment[]	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

GENERAL

public static final HorizontalAlignment GENERAL

The horizontal alignment is general-aligned. Text data is left-aligned. Numbers, dates, and times are rightaligned. Boolean types are centered. Changing the alignment does not change the type of data.

LEFT

public static final HorizontalAlignment LEFT

The horizontal alignment is left-aligned, even in Rightto-Left mode. Aligns contents at the left edge of the cell. If an indent amount is specified, the contents of the cell is indented from the left by the specified number of character spaces. The character spaces are based on the default font and font size for the workbook.

CENTER

public static final HorizontalAlignment CENTER

The horizontal alignment is centered, meaning the text is centered across the cell.

RIGHT

public static final HorizontalAlignment RIGHT

The horizontal alignment is right-aligned, meaning that cell contents are aligned at the right edge of the cell, even in Right-to-Left mode.

FILL

public static final HorizontalAlignment FILL

Indicates that the value of the cell should be filled across the entire width of the cell. If blank cells to the right also have the fill alignment, they are also filled with the value, using a convention similar to centerContinuous.

Additional rules:

1. Only whole values can be appended, not partial values.
2. The column will not be widened to 'best fit' the filled value
3. If appending an additional occurrence of the value exceeds the boundary of the cell left/right edge, don't append the additional occurrence of the value.
4. The display value of the cell is filled, not the underlying raw number.

JUSTIFY

public static final HorizontalAlignment JUSTIFY

The horizontal alignment is justified (flush left and right). For each line of text, aligns each line of the wrapped text in a cell to the right and left (except the last line). If no single line of text wraps in the cell, then the text is not justified.

CENTER_SELECTION

public static final HorizontalAlignment CENTER_SELECTION

The horizontal alignment is centered across multiple cells. The information about how many cells to span is expressed in the Sheet Part, in the row of the cell in question. For each cell that is spanned in the alignment, a cell element needs to be written out, with the same style Id which references the centerContinuous alignment.

DISTRIBUTED

public static final HorizontalAlignment DISTRIBUTED

Indicates that each 'word' in each line of text inside the cell is evenly distributed across the width of the cell, with flush right and left margins.

When there is also an indent value to apply, both the left and right side of the cell are padded by the indent value.

A 'word' is a set of characters with no space character in them.

Two lines inside a cell are separated by a carriage return.

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public short getCode()

forInt

public static HorizontalAlignment forInt(int code)