Class AbstractListPlus
java.lang.Object
com.aquima.interactions.framework.container.listplus.AbstractListPlus
- Direct Known Subclasses:
AbstractProcessListPlus
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 Summary
FieldsModifier and TypeFieldDescriptionstatic final String
protected final IContainerContext
protected DataType
static final String
static final String
static final String
Container Namesstatic final String
Content Stylesstatic final Logger
static final String
Messages Keysstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
The simple search presentation style for filtering on list columns.protected int
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
addLimitContainer
(Container container, boolean limitReached, int total) protected void
addNoInvalidInputTextItem
(Container container, DataType dataType) void
checkSimpleFiltering
(Container container) This method checks if the simple filtering style is found on the container.protected Element
createActionButton
(IListColumn listColumn, boolean readOnly) protected Element
createActionButton
(IListColumn listColumn, boolean readOnly, Button button) protected Element
protected Element
createContent
(IListColumn listColumn, IValue value) Create the content element.protected Element
createContentWithDomain
(IListColumn listColumn, IValue value, IDomainDefinition domainDefinition) Create the content element that is part of a domain of values.protected final IPrimitiveValue[]
createDomainWithOptionalMask
(IDomainDefinition domainDefinition, String maskCallName) Creates a domain with a mask applied to each value in the domain.protected Element
createListFooter
(int displayedRecordCount) protected Element
createListHeader
(boolean limitReached, int total) protected abstract TypedSearchField
createSearchFieldByColumnType
(IListColumn column, Container container) protected void
createTableHeader
(TableBuilder builder, ColumnDefinition[] columns) protected abstract void
createTableRows
(TableBuilder builder, IViewResult result) protected abstract ListConfiguration
protected String
getDisplayValue
(IMaskCall mask, IPrimitiveValue value) protected abstract IMultilingualText
protected boolean
protected void
initialize
(IListColumn[] columns, ListState state)
-
Field Details
-
LOG
-
MESSAGE_CLEAR
Messages Keys- See Also:
-
MESSAGE_SHOW_ALL
- See Also:
-
MESSAGE_SHOW_UNKNOWN
- See Also:
-
MESSAGE_SHOW_TRUE
- See Also:
-
MESSAGE_SHOW_FALSE
- See Also:
-
MESSAGE_SELECT_ALL
- See Also:
-
MESSAGE_TODAY
- See Also:
-
MESSAGE_NOW
- See Also:
-
MESSAGE_FEEDBACK
- See Also:
-
MESSAGE_LIMIT_APPLIED_BUTTON
- See Also:
-
MESSAGE_LIMIT_IGNORED_FEEDBACK
- See Also:
-
MESSAGE_LIMIT_IGNORED_BUTTON
- See Also:
-
MESSAGE_INVALID_FORMAT_CURRENCY
- See Also:
-
MESSAGE_INVALID_FORMAT_INTEGER
- See Also:
-
MESSAGE_INVALID_FORMAT_NUMBER
- See Also:
-
MESSAGE_INVALID_FORMAT_PERCENTAGE
- See Also:
-
LIST_HEADER
Container Names- See Also:
-
LIST_BODY
- See Also:
-
LIST_FOOTER
- See Also:
-
LISTPLUS_FOOTER
Content Styles- See Also:
-
CONTAINER_NAME
- See Also:
-
SIMPLE_FILTERING
The simple search presentation style for filtering on list columns.- See Also:
-
context
-
visibleColumnCount
protected int visibleColumnCount -
errorType
-
-
Constructor Details
-
Method Details
-
initialize
- Parameters:
columns
- A list of objects that describes the configuration per column.state
- An object that remembers the state of the list.
-
createListHeader
- 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
- Parameters:
builder
- Builder object responsible for creating structures that represent tables.result
- The corresponding view result.
-
createTableHeader
- Parameters:
builder
- Builder object responsible for creating structures that represent tables.columns
- A list of table column definitions.
-
createActionButton
- 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
- 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
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
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
-
addLimitContainer
-
getLimitAppliedMessage
- Returns:
- The message that should be displayed if the limit is applied.
-
checkSimpleFiltering
This method checks if the simple filtering style is found on the container.- Parameters:
container
- The container to be checked
-
createAssetFromText
- Parameters:
text
- The multi-lingual text.- Returns:
- The asset element.
-
addNoInvalidInputTextItem
-
hasInvalidInput
protected boolean hasInvalidInput() -
getConfiguration
- Returns:
- The list configuration.
-
createSearchFieldByColumnType
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
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 maskmaskCallName
- the name of the mask call- Returns:
- a domain with the mask applied to each value in the domain
-