com.whitestein.lsps.vaadin.ui.components

Interface UIComponentShowingRecords

All Superinterfaces:

Serializable, UIComponent

All Known Implementing Classes:

UICalendar, UIGroupingTable, UIHorizontalRepeater, UILazyTable, UIPagedTable, UIRepeater, UISimpleTable, UITableBase, UITreeTable2, UIVerticalRepeater

public interface UIComponentShowingRecords
extends UIComponent

Some components, such as tables and repeaters, shows multitude of records. This information may help validator to bind validation errors to the components, for example a record-wide validation error may be displayed on a table which is currently showing given record.

Author:

mvy

Method Summary

Modifier and Type	Method and Description
Set<RecordHolder>	getShownRecords() Lists record instances currently displayed in the component's selection.

Methods inherited from interface com.whitestein.lsps.vaadin.ui.components.UIComponent

getComponentData, getWidget, refresh

Method Detail

getShownRecords

Set<RecordHolder> getShownRecords()

Lists record instances currently displayed in the component's selection.

Used for validation purposes, to match record-level validation errors to components. E.g. the validation error may be displayed on a Table if the table is currently displaying given record.

Some rules for the method:

• The table component should return only records which are currently displayed. For example, the paging table should return only records currently being shown on the current table page.
• Repeater should return all records (there is no paging)
• Calendar should only return records which are displayed in the current date range.
• Combobox should not return anything. Theoretically it could return currently selected record, but this record is accessible via the BINDING field, therefore it is not necessary to return this information through this method.
• Generally, the method should return data for Tables, Tree tables, Repeaters and Calendars only.

Returns:

record instances currently displayed in the component's selection. May return null or empty list. The list may be immutable.