java.lang.Object
com.aquima.interactions.framework.container.list.ListImpl
Direct Known Subclasses:
InstanceListImpl

public abstract class ListImpl extends Object
  • Field Details

  • Constructor Details

  • Method Details

    • initialize

      public void initialize(IListColumn[] listColumns, ListState state)
    • 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 container
      rows - the rows
      state - the state
      configuration - the configuration
      Throws:
      Exception - when something goes wrong
    • addHeader

      protected void addHeader(Container container, ListState state, ListConfiguration configuration)
      Adds a container before the tabular content. Includes search functionality.
      Parameters:
      container - the container
      state - the state
      configuration - the configuration
    • addBody

      protected void addBody(Container container, IListRowData[] rows, ListState state, ListConfiguration configuration) throws Exception
      Throws:
      Exception
    • addFooter

      protected void addFooter(Container container, ListState state, ListConfiguration configuration)
    • 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

      protected ListRowDataComparator createListRowDataComparator(List<Sorting> sorting)
    • createSortButton

      protected Button createSortButton(int columnIndex, ListConfiguration configuration)
    • formatValue

      protected IMultilingualText formatValue(IListColumn column, IValue value)
    • createValue

      protected IValue createValue(String[] values)
    • getProcessEngine

      protected IProcessEngine getProcessEngine()
    • createText

      protected Element createText(String text)
    • createText

      protected Element createText(IMultilingualText text)
    • getId

      protected String getId()
      Gets the identifier for this container implementation.
      Returns:
      Id, can be null.
    • postProcessTable

      protected void postProcessTable(Container container, IListRowData[] rows)
    • addTableRows

      protected abstract void addTableRows(TableBuilder tableBuilder, IListRowData[] rows) throws Exception
      Throws:
      Exception
    • isValidDataType

      protected abstract boolean isValidDataType(IListColumn column, DataType dataType)
      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

      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.
      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.