report-engine/org.octavius.report.column.type/StringColumn

StringColumn

class StringColumn(header: String, width: Float = 1.0f, sortable: Boolean = true, filterable: Boolean = true) : ReportColumn

Kolumna do wyświetlania danych tekstowych w raporcie. Obsługuje filtrowanie tekstowe.

Parameters

header

Nagłówek kolumny

width

Względna szerokość kolumny (domyślnie 1.0)

sortable

Czy kolumna obsługuje sortowanie (domyślnie true)

filterable

Czy kolumna obsługuje filtrowanie (domyślnie true)

Constructors

StringColumn

constructor(header: String, width: Float = 1.0f, sortable: Boolean = true, filterable: Boolean = true)

Properties

filter

val filter: Filter<*>?

Leniwa inicjalizacja filtra dla kolumny. Filtr jest tworzony tylko jeśli kolumna obsługuje filtrowanie.

filterable

val filterable: Boolean

header

val header: String

sortable

val sortable: Boolean

width

val width: ColumnWidth

Functions

asList

fun ReportColumn.asList(maxVisibleItems: Int = 3): MultiRowColumn

Przekształca dowolną kolumnę w kolumnę wyświetlającą listę wartości.

createFilter

open override fun createFilter(): Filter<*>

Tworzy instancję filtra odpowiedniego dla typu danych tej kolumny. Musi być zaimplementowana przez klasy potomne.

createFilterAndFilterData

fun createFilterAndFilterData(): FilterData?

Tworzy filtr i odpowiadające mu dane filtra. Używane przy inicjalizacji filtrów w tabeli.

createFilterData

protected open fun createFilterData(filter: Filter<*>): FilterData

Tworzy domyślne dane filtra dla danego filtra. Może być nadpisana przez klasy potomne dla zmiany domyślnego działania.

RenderCell

@Composable

open override fun RenderCell(item: Any?, modifier: Modifier)

Renderuje zawartość komórki dla danego elementu danych. Musi być zaimplementowana przez klasy potomne.

RenderFilter

@Composable

private fun <T : FilterData> RenderFilter(onEvent: (ReportEvent) -> Unit, columnKey: String, filter: Filter<T>, data: FilterData)

Funkcja renderująca filtr - zmienia * w T dla typu generycznego. Wymagana aby zadowolić kompilator przy obsłudze typów generycznych.

RenderHeader

@Composable

fun RenderHeader(onEvent: (ReportEvent) -> Unit, columnKey: String, reportState: ReportState, modifier: Modifier = Modifier)

Renderuje nagłówek kolumny z obsługą menu filtrowania. Automatycznie wyświetla ikone aktywnego filtra i obsługuje kliknięcia w nagłówek.