stormify/onl.ycode.stormify.biglist/Column

Column

Represents a column in a PagedListBase — the unit of filtering and sorting.

A column can contain one or more field paths. When multiple fields are present, filtering uses OR logic between them (e.g., searching "firstName" OR "lastName"), while filtering between different columns uses AND logic.

Columns are defined at setup time via PagedListBase.addColumn or PagedListBase.addRawColumn. After setup, the user activates/deactivates filters and sorting at runtime.

Types

Companion

object Companion

Exposes column Type and SortState constants as short aliases (e.g. Column.TEXT, Column.ASCENDING).

Type

enum Type : Enum<Column.Type>

The type of a column, which determines how filter values are interpreted and converted to SQL conditions.

Properties

filter

var filter: String?

The current filter value, or null if no filter is active.

inputParser

var inputParser: InputParser?

Parser that transforms user input before it reaches the database. Used for locale-aware parsing of numbers, dates, etc.

isCaseSensitive

var isCaseSensitive: Boolean

Whether the filter is case-sensitive. Only relevant for Type.TEXT columns. Default is false (case-insensitive).

sort

var sort: SortState?

The current sort state, or null if this column is not sorted.

Functions

clearFilter

fun clearFilter()

Clears the filter on this column.

clearSort

fun clearSort()

Clears sorting on this column.

getFilterValues

fun getFilterValues(): FilterValues

Returns the distinct values available for this column, filtered by the active filters of other columns and the list constraints.