Module org.controlsfx.controls

Package org.controlsfx.control.spreadsheet

Enum SpreadsheetView.SpanType

java.lang.Object

java.lang.Enum<SpreadsheetView.SpanType>

org.controlsfx.control.spreadsheet.SpreadsheetView.SpanType

All Implemented Interfaces:

Serializable, Comparable<SpreadsheetView.SpanType>

Enclosing class:

SpreadsheetView

public static enum SpreadsheetView.SpanType
extends Enum<SpreadsheetView.SpanType>

The SpanType describes in which state each cell can be. When a spanning is occurring, one cell is becoming larger and the others are becoming invisible. Thus, that particular cell is masking the others.

But the SpanType cannot be known in advance because it's evolving for each cell during the lifetime of the SpreadsheetView. Suppose you have a cell spanning in row, the first one is in a ROW_VISIBLE state, and all the other below are in a ROW_SPAN_INVISIBLE state. But if the user is scrolling down, the first will go out of sight. At that moment, the second cell is switching from ROW_SPAN_INVISIBLE state to ROW_VISIBLE state.

Refer to SpreadsheetView for more information.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH_INVISIBLE	Invisible cell situated in diagonal of a cell in a ROW_VISIBLE state.
COLUMN_SPAN_INVISIBLE	Invisible cell because a cell in a NORMAL_CELL state on the left is covering it.
NORMAL_CELL	Visible cell, can be a unique cell (no span) or the first one inside a column spanning cell.
ROW_SPAN_INVISIBLE	Invisible cell because a cell in a ROW_VISIBLE state on the top is covering it.
ROW_VISIBLE	Visible Cell but has some cells below in a ROW_SPAN_INVISIBLE state.

Method Summary

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

NORMAL_CELL

public static final SpreadsheetView.SpanType NORMAL_CELL

Visible cell, can be a unique cell (no span) or the first one inside a column spanning cell.

COLUMN_SPAN_INVISIBLE

public static final SpreadsheetView.SpanType COLUMN_SPAN_INVISIBLE

Invisible cell because a cell in a NORMAL_CELL state on the left is covering it.

ROW_SPAN_INVISIBLE

public static final SpreadsheetView.SpanType ROW_SPAN_INVISIBLE

Invisible cell because a cell in a ROW_VISIBLE state on the top is covering it.

ROW_VISIBLE

public static final SpreadsheetView.SpanType ROW_VISIBLE

Visible Cell but has some cells below in a ROW_SPAN_INVISIBLE state.

BOTH_INVISIBLE

public static final SpreadsheetView.SpanType BOTH_INVISIBLE

Invisible cell situated in diagonal of a cell in a ROW_VISIBLE state.

Method Detail

values

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

Returns:

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

valueOf

public static SpreadsheetView.SpanType 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