Top Description Fields Constructors Methods
org.apache.poi.ss.usermodel

public final Enum HorizontalAlignment

extends Enum<HorizontalAlignment>
Class Inheritance

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.

Field Summary

Modifier and TypeField and Description
public static final HorizontalAlignment
CENTER

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

public static final HorizontalAlignment
CENTER_SELECTION

The horizontal alignment is centered across multiple cells.

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.

public static final HorizontalAlignment
FILL

Indicates that the value of the cell should be filled across the entire width of the cell.

public static final HorizontalAlignment
GENERAL

The horizontal alignment is general-aligned.

public static final HorizontalAlignment
JUSTIFY

The horizontal alignment is justified (flush left and right).

public static final HorizontalAlignment
LEFT

The horizontal alignment is left-aligned, even in Rightto-Left mode.

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.

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static HorizontalAlignment
forInt(int code)

public short
public static HorizontalAlignment
public static HorizontalAlignment[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

CENTERback to summary
public static final HorizontalAlignment CENTER

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

CENTER_SELECTIONback to summary
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.

DISTRIBUTEDback to summary
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.

FILLback to summary
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.
GENERALback to summary
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.

JUSTIFYback to summary
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.

LEFTback to summary
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.

Constructor Detail

HorizontalAlignmentback to summary
private HorizontalAlignment()

Method Detail

forIntback to summary
public static HorizontalAlignment forInt(int code)
getCodeback to summary
public short getCode()
valueOfback to summary
public static HorizontalAlignment valueOf(String name)
valuesback to summary
public static HorizontalAlignment[] values()