Package io.jmix.reports.entity

Enum Class Orientation

java.lang.Object

java.lang.Enum<Orientation>

io.jmix.reports.entity.Orientation

All Implemented Interfaces:

EnumClass<Integer>, Serializable, Comparable<Orientation>, Constable

public enum Orientation
extends Enum<Orientation>
implements EnumClass<Integer>

Band orientation. Relevant only for spreadsheet-like output types (XLS, XLSX). Determines direction where data entries are copied on the sheet.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CROSS	Band entries are copied to the right and downwards as a matrix.
HORIZONTAL	Band entries are copied downwards.
VERTICAL	Band entries are copied to the right.

Method Summary

Modifier and Type	Method	Description
static Orientation	fromBandOrientation(BandOrientation orientation)
static Orientation	fromId(Integer id)
BandOrientation	getBandOrientation()
Integer	getId()
static Orientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Orientation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HORIZONTAL

public static final Orientation HORIZONTAL

Band entries are copied downwards.

VERTICAL

public static final Orientation VERTICAL

Band entries are copied to the right.

CROSS

public static final Orientation CROSS

Band entries are copied to the right and downwards as a matrix. The band must contain three datasets:

• ${band_name}_dynamic_header - the data from this dataset is copied to the right like a vertical band with table columns header
• ${band_name}_master_data - the data from this dataset is copied downwards like a horizontal band with table rows header
• ${band_name} - the dataset named the same as the band, it belongs to; it is the main content band that will fulfill the matrix cells.

Method Details

values

public static Orientation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Orientation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getId

public Integer getId()

Specified by:

getId in interface EnumClass<Integer>

getBandOrientation

public BandOrientation getBandOrientation()

fromId

public static Orientation fromId(Integer id)

fromBandOrientation

public static Orientation fromBandOrientation(BandOrientation orientation)