The Filter Manager allows the administration of the grid filters. There are two components that form together the Filter Manager.

Filter Manager Screen

In order to set the Filter Manager Screen for a specific Grid, the Grid’s panelMenu attribute needs to have this menuStructure set: gridPanelFilter#NoDropDown. This will set the Filter icon in the Grid panel header.

On click on this icon, the Filter Manager screen will open and will contain a Grid, a Form and a Toolbar. In the Grid the corresponding filters are displayed. When selecting a row in the Grid, the filter details are displayed in the Form.

Using the Toolbar, the user can add/save/setAsDefault/rename/refresh/remove filters.

The following naming will be used further in order to avoid confusion:

• CallerGrid – The Grid from where the FilterManager was launched
• FilterGrid – The Grid inside the FilterManager screen, which contains the filters

AddFilter – This option will add a new filter. The definition for this filter will be automatically set with the existing filters from the CallerGrid.

SaveFilter – The selected filter in the FilterGrid will be saved. Its definition will be automatically set with the existing filters from the Caller Grid.

RenameFilter – The selected filter in the FilterGrid will be renamed. A modal will appear for a new name.

SetAsDefaultFitler – The selected filter in the FilterGrid will be set as default.

RefreshFilters – The FilterGrid will be refreshed

RemoveFilter – The selected filter in the FilterGrid will be removed. If the removed filter is the default one, then there will be no default filter anymore.

DynSelect Filter in Panel Header

In order to set the DynSelect Filter for a specific Grid, the Grid’s panelMenu attribute needs to have this menuStructure set: gridFilterDynSelect.

The dynSelect filter will have the default filter already set. When opening the dynSelect, the corresponding filters are displayed and on click on an item, the filter will be selected and the Grid automatically filtered.

The dynSelect filter and its dropdown can also be styled using the corresponding classes:

• ‘dynSelectPanelHeader’ for the actual dynSelect
• ‘akPanelDynSelectDropdown’ for the dynSelect dropdown

Currently the dynSelect filter will not function independently. The Filter Manager screen needs to be set as well in the panelMenu attribute, for the dynSelect to work.

The old FilterMaintenance menuStructure (filterListBT) should be removed from the Grid panelMenu attribute if the new Filter Manager is also set.

Checkbox Filtering

For additional filter-conditions, you can add checkboxes with labels in the panel, acting like predefined filters.

In order to add a new checkbox in the grid panel a Menu Function and a Menu Structure should be created at first for each checkbox in the panel.

Checkbox-type Menu Function

Name: Custom naming

Function Code: Custom naming

Small Image:  Can’t change, will be set from framework

Large Image:  Can’t change, will be set from framework

(MANDATORY)Action Type: RUN

(MANDATORY)Action Parameter: $akioma.toggleFilter(self,event)

(MANDATORY)Action Options: FilterExtension followed by an array of objects {“field”:”nameOfDBField”,”operator”:”operatorValue”,”value”:”filterValue”}

Ex: {"FilterExtension":[{"field":"state","operator":"eq","value":"H"},{"field":"state","operator":"eq","value":"A"},{"field": "selfno", "operator": "beginsmatches", "value": "10"}]}

(MANDATORY)Visualization Type: CHECKBOX

Checkbox-type Menu Structure

A checkbox Menu Structure should only contain one checkbox Menu Function.

The Name(Label) attribute of the menu structure will be displayed in the grid panel next to the checkbox so the user will know what the checkbox will filter.

After creating the Menu Structure , the Menu Function will be added to it.

UI Grid Panel

In order for the checkbox to be displayed in the grid panel, the Grid’s panelMenu attribute needs to have the menuStructure set followed by #NoDropDown.

Ex:  gridPanelToggleFilter3#NoDropDown

In the end, a check box followed by the name of the menuStructure should be displayed on the grid panel.