| Method Summary |
|
| public FieldFilterHelper | addField(String id, String label)
Adds a list field. |
| public FieldFilterHelper | addField(String id, String label, boolean orderable)
Adds a list field.
Parameters:
id - list field Id.
Parameters:
label - list field label.
Parameters:
orderable - whether this list field should be orderable or not. |
| public FieldFilterHelper | addField(String id, String label, Class type)
Adds a list field. |
| public FieldFilterHelper | addField(String id, String label, Class type, boolean orderable)
Adds a list field.
Parameters:
id - list field Id.
Parameters:
label - list field label.
Parameters:
type - list field type.
Parameters:
orderable - whether this list field should be orderable or not. |
| public void | addFilter(FieldOrder order)
Adds a list field order. |
| public void | addFilter(ListFilter filter)
Adds a list filter. |
| public void | addInitEvent(Event event)
|
| protected boolean | checkChanged()
|
| protected void | clearFilter()
Handles filter clearing. |
| public void | clearFilters()
Removes all list filters. |
| protected static void | clearForm(FormWidget compositeFormElement)
|
| public void | clearOrders()
Removes all list orders. |
| protected FilterHelper | createFilterHelper()
|
| protected ListStructure | createListStructure()
|
| protected SequenceHelper | createSequenceHelper()
|
| protected TypeHelper | createTypeHelper()
|
| protected void | destroy()
Destoys the list and contained data provider and filter form. |
| protected void | filter()
Handles filtering. |
| protected void | fireChange()
|
| public long | getCurrentPageFirstItemIndex()
Gets first item to be displayed on the current page. |
| public long | getCurrentPageLastItemIndex()
Gets last item to be displayed on the current page. |
| public ListDataProvider | getDataProvider()
Returns the
ListDataProvider used to fill the list with data. |
| public ListField | getField(String id)
Returns
ListField .
Parameters:
id - ListFieldidentifier. |
| public Comparator | getFieldComparator(String fieldId)
Returns
Comparator for the specified field. |
| public String | getFieldLabel(String columnId)
Returns label of
ListField .
Parameters:
columnId - ListField identifier. |
| public Class | getFieldType(String fieldId)
Returns type of list field. |
| public List | getFields()
Returns
ListField s. |
| public FilterHelper | getFilterHelper()
Returns the
FilterHelper used to help with adding filters. |
| public FieldFilterHelper | getFilterHelper(String fieldId)
Returns the
FieldFilterHelper used to help with adding filters
for specified field. |
| public Map | getFilterInfo()
Returns the filter information from filter form. |
| public FormWidget | getForm()
Returns the filter form. |
| public List | getItemRange()
Returns the current item range. |
| public long | getItemsOnPage()
Returns how many items will be displayed on one page. |
| public ListStructure | getListStructure()
Returns the
ListStructure used to describe the list. |
| public Locale | getLocale()
Returns the Locale used by memory-based filters and orders. |
| public OrderInfo | getOrderInfo()
Returns the order info. |
| public Object | getRowFromRequestId(String requestId)
Returns row object according to the request identifier.
Parameters:
requestId - request identifier. |
| public SequenceHelper | getSequenceHelper()
Returns the
SequenceHelper used to output pages. |
| public TypeHelper | getTypeHelper()
Returns the
TypeHelper used to help with field types. |
| public Object | getViewModel()
Returns
ViewModel - list widget view model. |
| protected void | init()
Initilizes the list, initializing contained filter form and the
ListDataProvider and
getting the initial item range. |
| protected void | initDataProvider()
|
| protected void | initFilterForm()
|
| protected void | initSequenceHelper()
|
| public boolean | isIgnoreCase()
Returns whether new filters and orders are case insensitive. |
| public boolean | isOrderableByDefault()
Returns true if all fields are added orderable by default. |
| protected void | makeRequestIdToRowMapping()
Creates mapping between rows and request ids. |
| protected void | order(String fieldName)
Handles single column ordering. |
| protected void | propagateListDataProviderWithOrderInfo(OrderInfo orderInfo)
|
| public void | refresh()
Forces the list data provider to refresh the data. |
| public void | refreshCurrentItemRange()
Refreshes the current item range, reloading the shown items. |
| public void | resetSequence()
Resets the sequence, starting at first page with all defaults. |
| protected void | runInitEvents()
|
| public void | setCurrentPage(long currentPage)
Sets the page which will be displayed. |
| public void | setDataProvider(ListDataProvider dataProvider)
Sets the
ListDataProvider used to fill the list with data. |
| public void | setFilterButtonLabel(String label)
Sets the filter button label. |
| public void | setFilterHelper(FilterHelper filterHelper)
Sets the
FilterHelper used to help with adding filters. |
| public void | setFilterInfo(Map filterInfo)
Sets the filter information to list data provider and filter form. |
| public void | setFilterResetButtonLabel(String label)
Sets the filter reset button label. |
| public void | setForm(FormWidget form)
Saves the filter form. |
| public void | setInitialOrder(String fieldId, boolean ascending)
Sets the initial order of the list. |
| public void | setItemsOnPage(long itemsOnPage)
Sets how many items will be displayed on one page. |
| public void | setListStructure(ListStructure listStructure)
Saves the
ListStructure used to fill the list with data. |
| public void | setOrderInfo(OrderInfo orderInfo)
Sets the order information to list data provider and list widget. |
| public void | setOrderableByDefault(boolean orderableByDefault)
Sets whether all fields are added orderable by default. |
| public void | setTypeHelper(TypeHelper typeHelper)
Sets the
TypeHelper used to help with field types. |
| public void | showDefaultPages()
Collapses the list, showing only the current page. |
| public void | showFullPages()
Expands the list showing all items. |
