Class ListImpl
java.lang.Object
com.aquima.interactions.framework.container.list.ListImpl
- Direct Known Subclasses:
InstanceListImpl
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final IContainerContext
static final String
protected int
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addBody
(Container container, IListRowData[] rows, ListState state, ListConfiguration configuration) protected void
addFooter
(Container container, ListState state, ListConfiguration configuration) protected void
addHeader
(Container container, ListState state, ListConfiguration configuration) Adds a container before the tabular content.protected void
addTableHeaders
(TableBuilder tableBuilder, ListState state, ListConfiguration configuration) protected abstract void
addTableRows
(TableBuilder tableBuilder, IListRowData[] rows) protected ListRowDataComparator
createListRowDataComparator
(List<Sorting> sorting) protected Button
createSortButton
(int columnIndex, ListConfiguration configuration) protected void
createTable
(Container container, IListRowData[] rows, ListState state, ListConfiguration configuration) Creates the entire table, in the formatprotected Element
createText
(IMultilingualText text) protected Element
createText
(String text) protected IValue
createValue
(String[] values) protected IMultilingualText
formatValue
(IListColumn column, IValue value) protected String
getId()
Gets the identifier for this container implementation.protected IProcessEngine
void
initialize
(IListColumn[] listColumns, ListState state) protected abstract boolean
isValidDataType
(IListColumn column, DataType dataType) Verifies that a data type corresponds with the column definition.protected void
postProcessTable
(Container container, IListRowData[] rows) protected abstract IValue
processColumnValue
(IListColumn column, IListRowData row) Retrieves the value at the intersection of a column and a row, for data that is to be used in search functionality.protected IListRowData[]
processRows
(IListRowData[] rows, ListState state, ListConfiguration configuration)
-
Field Details
-
MESSAGE_SEARCH
- See Also:
-
PAGINATION
- See Also:
-
context
-
numberOfVisibleColumns
protected int numberOfVisibleColumns
-
-
Constructor Details
-
ListImpl
-
-
Method Details
-
initialize
-
createTable
protected void createTable(Container container, IListRowData[] rows, ListState state, ListConfiguration configuration) throws Exception Creates the entire table, in the format+======================+ | headers | +----------------------+ | table headers | + body | | table rows | +----------------------+ | footers | +======================+
- Parameters:
container
- the containerrows
- the rowsstate
- the stateconfiguration
- the configuration- Throws:
Exception
- when something goes wrong
-
addHeader
Adds a container before the tabular content. Includes search functionality.- Parameters:
container
- the containerstate
- the stateconfiguration
- the configuration
-
addBody
protected void addBody(Container container, IListRowData[] rows, ListState state, ListConfiguration configuration) throws Exception - Throws:
Exception
-
addTableHeaders
protected void addTableHeaders(TableBuilder tableBuilder, ListState state, ListConfiguration configuration) throws Exception - Throws:
Exception
-
processRows
protected IListRowData[] processRows(IListRowData[] rows, ListState state, ListConfiguration configuration) -
createListRowDataComparator
-
createSortButton
-
formatValue
-
createValue
-
getProcessEngine
-
createText
-
createText
-
getId
Gets the identifier for this container implementation.- Returns:
- Id, can be null.
-
postProcessTable
-
addTableRows
protected abstract void addTableRows(TableBuilder tableBuilder, IListRowData[] rows) throws Exception - Throws:
Exception
-
isValidDataType
Verifies that a data type corresponds with the column definition.- Parameters:
column
- The column definition (cannot be null)dataType
- the type to verify (cannot be null)- Returns:
- true when the column definition corresponds with the data type, false otherwise.
-
processColumnValue
Retrieves the value at the intersection of a column and a row, for data that is to be used in search functionality.- Parameters:
column
- The column from which to obtain a value (cannot be null)row
- The row from which to obtain a value (cannot be null)- Returns:
- a value, possibly null.
-