com.technia.tvc.structurebrowser.render

Class Disposition

java.lang.Object

com.technia.tvc.structurebrowser.render.Disposition

public class Disposition
extends java.lang.Object

The disposition refers to either the right or the left side of the table, or both or none.

Since:

6.1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Disposition.DefaultFinder
static interface	Disposition.Finder

Field Summary

Fields

Modifier and Type	Field and Description
static Disposition	ALL_RIGHT A special disposition that returns all cells/columns, but marks them as being rendered in the right side.
static Disposition	LEFT Refers to the left side of the table.
static Disposition	LEFT_AND_RIGHT Refers to the left and the right side of the table.
static Disposition	NONE Disposition that refers to nothing.
static Disposition	NONE_LEFT This disposition is used to force the disposition to act on the left side, but will NOT return any cells/columns.
static Disposition	PRINTER_FRIENDLY Disposition used for printerfriendly pages.
static Disposition	RIGHT Refers to the right side of the table.
static Disposition	SIDEPANEL Disposition used for sidepanel rendering
static Disposition	SIDEPANEL_LEFT_AND_RIGHT

Constructor Summary

Constructors

Constructor and Description
Disposition(java.lang.String s, Disposition.Finder f, boolean l, boolean r)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Iterator<Cell>	getCells(TableData data, int tableMode) Returns the cells in the table that belongs in the current disposition.
java.util.Iterator<Column>	getColumns(TableBean<?> table, int tableMode) Returns the columns in the table that belongs in the current disposition.
boolean	isLeft()
boolean	isLeftAndRight()
boolean	isRight()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LEFT

public static final Disposition LEFT

Refers to the left side of the table.

RIGHT

public static final Disposition RIGHT

Refers to the right side of the table.

LEFT_AND_RIGHT

public static final Disposition LEFT_AND_RIGHT

Refers to the left and the right side of the table.

ALL_RIGHT

public static final Disposition ALL_RIGHT

A special disposition that returns all cells/columns, but marks them as being rendered in the right side.

SIDEPANEL

public static final Disposition SIDEPANEL

Disposition used for sidepanel rendering

SIDEPANEL_LEFT_AND_RIGHT

public static final Disposition SIDEPANEL_LEFT_AND_RIGHT

PRINTER_FRIENDLY

public static final Disposition PRINTER_FRIENDLY

Disposition used for printerfriendly pages.

NONE

public static final Disposition NONE

Disposition that refers to nothing. Note that the left and right flags are set to false!

NONE_LEFT

public static final Disposition NONE_LEFT

This disposition is used to force the disposition to act on the left side, but will NOT return any cells/columns. This one is typically used when the table only contains fixed columns, but they will be forced to render in the right side.

Constructor Detail

Disposition

public Disposition(java.lang.String s,
           Disposition.Finder f,
           boolean l,
           boolean r)

Method Detail

getCells

public java.util.Iterator<Cell> getCells(TableData data,
                                int tableMode)

Returns the cells in the table that belongs in the current disposition.

Parameters:

data - The table data. I.e., the row.

tableMode - The mode of the table.

Returns:

Returns the appropriate cells.

See Also:

ModeUtils.getMode(TableBean)

getColumns

public java.util.Iterator<Column> getColumns(TableBean<?> table,
                                    int tableMode)

Returns the columns in the table that belongs in the current disposition.

Parameters:

table - The table.

tableMode - The mode of the table.

Returns:

Returns the appropriate columns.

See Also:

ModeUtils.getMode(TableBean)

isLeft

public boolean isLeft()

Returns:

Returns true if this refers to the left side of the table. This method will return true for LEFT and LEFT_AND_RIGHT.

Since:

6.1.4

isLeftAndRight

public boolean isLeftAndRight()

Returns:

Returns true if this refers to the left and right side of the table. This method will only return true for LEFT_AND_RIGHT.

Since:

6.1.4

isRight

public boolean isRight()

Returns:

Returns true if this refers to the right side of the table. This method will return true for RIGHT and LEFT_AND_RIGHT.

Since:

6.1.4

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object