eu.easyrpa.openframework.google.sheets.constants

Enum WrapStrategy

java.lang.Object

java.lang.Enum<WrapStrategy>

eu.easyrpa.openframework.google.sheets.constants.WrapStrategy

All Implemented Interfaces:

Serializable, Comparable<WrapStrategy>

public enum WrapStrategy
extends Enum<WrapStrategy>

Helps to identify how to wrap text in a cell.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIP Lines that are longer than the cell width will be clipped.
LEGACY_WRAP This wrap strategy represents the old Google Sheets wrap strategy where words that are longer than a line are clipped rather than broken.
OVERFLOW_CELL Lines that are longer than the cell width will be written in the next cell over, so long as that cell is empty.
UNSPECIFIED The wrap strategy is not specified.
WRAP Words that are longer than a line are wrapped at the character level rather than clipped.

Method Summary

Modifier and Type	Method and Description
static WrapStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static WrapStrategy[]	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

UNSPECIFIED

public static final WrapStrategy UNSPECIFIED

The wrap strategy is not specified.

OVERFLOW_CELL

public static final WrapStrategy OVERFLOW_CELL

Lines that are longer than the cell width will be written in the next cell over, so long as that cell is empty. If the next cell over is non-empty, this behaves the same as CLIP. The text will never wrap to the next line unless the user manually inserts a new line.

Example:

 | First sentence. |
 | Manual newline that is very long. <- Text continues into next cell
 | Next newline.   |
 

LEGACY_WRAP

public static final WrapStrategy LEGACY_WRAP

This wrap strategy represents the old Google Sheets wrap strategy where words that are longer than a line are clipped rather than broken. This strategy is not supported on all platforms and is being phased out.

Example:

 | Cell has a |
 | loooooooooo| <- Word is clipped.
 | word.      |
 

CLIP

public static final WrapStrategy CLIP

Lines that are longer than the cell width will be clipped. The text will never wrap to the next line unless the user manually inserts a new line.

Example:

 | First sentence. |
 | Manual newline t| <- Text is clipped
 | Next newline.   |
 

WRAP

public static final WrapStrategy WRAP

Words that are longer than a line are wrapped at the character level rather than clipped.

Example:

 | Cell has a |
 | loooooooooo| <- Word is broken.
 | ong word.  |
 

Method Detail

values

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

Returns:

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

valueOf

public static WrapStrategy valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null