Package com.aquima.interactions.framework.container.listplus

Class AbstractListPlus

java.lang.Object
com.aquima.interactions.framework.container.listplus.AbstractListPlus
Direct Known Subclasses:
AbstractProcessListPlus
public abstract class AbstractListPlus extends Object
This class represents an abstract implementation of the list plus. All common methods should be written here.

List plus is the type of list that supports paging, filtering and sorting.

Since:
9.9
Author:
M.Orsan, V.Moldovan

  • Field Details Link icon

  • Constructor Details Link icon

  • Method Details Link icon

    • initialize Link icon

      protected void initialize(IListColumn[] columns, ListState state)
      Parameters:
      columns - A list of objects that describes the configuration per column.
      state - An object that remembers the state of the list.

    • createListHeader Link icon

      protected Element createListHeader(boolean limitReached, int total)
      Parameters:
      limitReached - Boolean flag indicating if the number of records exceeds the limit, if any limit is set.
      total - The total number of records.
      Returns:
      The list header element.

    • createTableRows Link icon

      protected abstract void createTableRows(TableBuilder builder, IViewResult result)
      Parameters:
      builder - Builder object responsible for creating structures that represent tables.
      result - The corresponding view result.

    • createListFooter Link icon

      protected Element createListFooter(int displayedRecordCount)
      Parameters:
      displayedRecordCount - The number of displayed records.
      Returns:
      The list footer element.

    • createTableHeader Link icon

      protected void createTableHeader(TableBuilder builder, ColumnDefinition[] columns)
      Parameters:
      builder - Builder object responsible for creating structures that represent tables.
      columns - A list of table column definitions.

    • createActionButton Link icon

      protected Element createActionButton(IListColumn listColumn, boolean readOnly)
      Parameters:
      listColumn - The column configuration that should contain the button.
      readOnly - Flag indicating if the button should be read only.
      Returns:
      The action button element.

    • createActionButton Link icon

      protected Element createActionButton(IListColumn listColumn, boolean readOnly, Button button)
      Parameters:
      listColumn - The column configuration that should contain the button.
      readOnly - Flag indicating if the button should be read only.
      button - The action button element on which properties are set.
      Returns:
      The action button element.

    • createContent Link icon

      protected Element createContent(IListColumn listColumn, IValue value)
      Create the content element.
      Parameters:
      listColumn - The column configuration that should contain the contet.
      value - The actual value that should be displayed as content.
      Returns:
      The content element.

    • createContentWithDomain Link icon

      protected Element createContentWithDomain(IListColumn listColumn, IValue value, IDomainDefinition domainDefinition)
      Create the content element that is part of a domain of values.
      Parameters:
      listColumn - The column configuration that should contain the contet.
      value - The actual value that should be displayed as content.
      domainDefinition - The domain of definition for the value that is going to be displayed as content.
      Returns:
      The content element.

    • getDisplayValue Link icon

      protected String getDisplayValue(IMaskCall mask, IPrimitiveValue value)

    • addLimitContainer Link icon

      protected abstract void addLimitContainer(Container container, boolean limitReached, int total)

    • getLimitAppliedMessage Link icon

      protected abstract IMultilingualText getLimitAppliedMessage()
      Returns:
      The message that should be displayed if the limit is applied.

    • checkSimpleFiltering Link icon

      public void checkSimpleFiltering(Container container)
      This method checks if the simple filtering style is found on the container.
      Parameters:
      container - The container to be checked

    • createAssetFromText Link icon

      protected Element createAssetFromText(IMultilingualText text)
      Parameters:
      text - The multi-lingual text.
      Returns:
      The asset element.

    • addNoInvalidInputTextItem Link icon

      protected void addNoInvalidInputTextItem(Container container, DataType dataType)

    • hasInvalidInput Link icon

      protected boolean hasInvalidInput()

    • getConfiguration Link icon

      protected abstract ListConfiguration getConfiguration()
      Returns:
      The list configuration.

    • createSearchFieldByColumnType Link icon

      protected abstract TypedSearchField createSearchFieldByColumnType(IListColumn column, Container container)
      Parameters:
      column - The column configuration.
      container - The container that contains the search field.
      Returns:
      The typed search field.

    • createDomainWithOptionalMask Link icon

      protected final IPrimitiveValue[] createDomainWithOptionalMask(IDomainDefinition domainDefinition, String maskCallName)
      Creates a domain with a mask applied to each value in the domain. If no mask is provided the domain remains unchanged.
      Parameters:
      domainDefinition - the domain on which the apply the mask
      maskCallName - the name of the mask call
      Returns:
      a domain with the mask applied to each value in the domain