Package com.storedobject.ui

Class ObjectSearchBrowser<T extends StoredObject>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.grid.Grid<T>

com.storedobject.vaadin.DataGrid<T>

com.storedobject.vaadin.ListGrid<T>

com.storedobject.ui.DataGrid<T>

com.storedobject.ui.ObjectListGrid<T>

com.storedobject.ui.ObjectGrid<T>

com.storedobject.ui.ObjectBrowser<T>

com.storedobject.ui.ObjectSearchBrowser<T>

Type Parameters:

T - Type of object to search for.

All Implemented Interfaces:

Executable, Reentrant, FilterMethods<T>, HasLogic, ObjectLoader<T>, ObjectSearcher<T>, ObjectSetter<T>, ObjectsSetter<T>, EditableDataGrid<T>, ObjectEditorListener, ObjectGridData<T,T>, ObjectLoader<T>, Transactional, ViewFilterSupport<T>, ClickHandler, ExecutableView, HasColumns<T>, SupportWindowMode, ValueChangeHandler, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.grid.Grid<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValue.ValueChangeListener, com.vaadin.flow.data.event.SortEvent.SortNotifier<com.vaadin.flow.component.grid.Grid<T>,com.vaadin.flow.component.grid.GridSortOrder<T>>, com.vaadin.flow.data.provider.HasDataGenerators<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridDataView<T>>, com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>, Serializable, Iterable<T>, Runnable, Collection<T>, EventListener, Consumer<T>, List<T>, SequencedCollection<T>

public class ObjectSearchBrowser<T extends StoredObject>
extends ObjectBrowser<T>

A grid-view that is typically used for searching and setting a particular instance of a StoredObject. Instead of using the constructors directly, static create methods are available for creating an instance of this view - create(Class, String, Consumer), create(Class, Iterable, String, Consumer).

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.grid.Grid

com.vaadin.flow.component.grid.Grid.AbstractGridExtension<T>, com.vaadin.flow.component.grid.Grid.Column<T>, com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder<T,U extends com.vaadin.flow.data.provider.ArrayUpdater>, com.vaadin.flow.component.grid.Grid.MultiSortPriority, com.vaadin.flow.component.grid.Grid.NestedNullBehavior, com.vaadin.flow.component.grid.Grid.SelectionMode, com.vaadin.flow.component.grid.Grid.SpringData, com.vaadin.flow.component.grid.Grid.UpdateQueue

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.storedobject.vaadin.ClickHandler

ClickHandler.ModifiedClickEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.storedobject.vaadin.HasColumns

HasColumns.SOGrid<T>

Field Summary

Fields inherited from class com.storedobject.ui.ObjectBrowser

add, audit, buttonPanel, cancel, delete, edit, excel, exit, filter, ledger, load, print, report, save, search, view

Constructor Summary

Constructors

Constructor	Description
ObjectSearchBrowser(Class<T> objectClass)	Constructor.
ObjectSearchBrowser(Class<T> objectClass, Iterable<String> browseColumns)	Constructor.
ObjectSearchBrowser(Class<T> objectClass, Iterable<String> browseColumns, Iterable<String> filterColumns)	Constructor.
ObjectSearchBrowser(Class<T> objectClass, Iterable<String> browseColumns, Iterable<String> filterColumns, String caption)	Constructor.
ObjectSearchBrowser(Class<T> objectClass, Iterable<String> browseColumns, String caption)	Constructor.
ObjectSearchBrowser(Class<T> objectClass, String caption)	Constructor.
ObjectSearchBrowser(String className)	Constructor.

Method Summary

Modifier and Type	Method	Description
static <O extends StoredObject> ObjectSearchBrowser<O>	create(Class<O> objectClass, Iterable<String> browseColumns, String caption, Consumer<O> objectConsumer)	Create a searcher from the given parameters.
static <O extends StoredObject> ObjectSearchBrowser<O>	create(Class<O> objectClass, String caption, Consumer<O> objectConsumer)	Create a searcher from the given parameters.
com.vaadin.flow.component.Component	createHeader()	You can have a "header row" (as the first row) that covers the whole grid.
View	getView(boolean create)	Get the View.

Methods inherited from class com.storedobject.ui.ObjectBrowser

actionAllowed, addExtraButtons, anchorFieldsCreated, anchorsCancelled, anchorsSet, canAdd, cancelRowEdit, canRowEdit, clicked, close, constructObjectEditor, create, create, create, create, create, create, create, createEditor, createExtraButtons, createObjectEditor, doAdd, doDelete, doEdit, doView, editRow, executeAnchorForm, extraInfoCreated, extraInfoLoaded, filterActions, getEditingItem, getLogic, getObjectEditor, getRowEditor, getSearchBuilder, getViewComponent, isColumnEditable, isReadOnly, isSearchMode, listMoreButtons, load, load, postLedger, resetAnchor, rowDoubleClicked, saveEditedRow, savingExtraInfo, selected, setCaption, setLogic, setObjectEditor, setReadOnly, setSplitView, streamEditableFields, validateAnchorValues

Methods inherited from class com.storedobject.ui.ObjectGrid

search, setObjectSetter

Methods inherited from class com.storedobject.ui.ObjectListGrid

addObjectChangedListener, configure, createListDataProvider, doDeleteAction, doInsertAction, doUndeleteAction, doUpdateAction, getApplication, getDataProvider, getDelegatedLoader, isValid, load, load, loaded, removeObjectChangedListener, setProcessor, setViewFilter

Methods inherited from class com.storedobject.ui.DataGrid

append, canAllowAction, doAppendAction, doReloadAction, doReloadAllAction, getActionPrefix, getObjectClass, itemAppended, itemDeleted, itemInserted, itemReloaded, itemUndeleted, itemUpdated, load, selected, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, sort, sort, validateAppend, validateDelete, validateInsert, validateReload, validateUndelete, validateUpdate

Methods inherited from class com.storedobject.vaadin.ListGrid

add, add, addAll, addAll, addViewFilter, clear, clearViewFilters, contains, containsAll, get, getData, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, onAttach, onDetach, remove, remove, removeAll, removeIf, replaceAll, retainAll, set, setData, size, subList, toArray, toArray

Methods inherited from class com.storedobject.vaadin.DataGrid

addConstructedListener, appendFooter, clearConstructedListeners, getColumnByKey, getColumns, getSOGrid, isColumnReorderingAllowed, setColumnReorderingAllowed, streamConstructedListeners

Methods inherited from class com.vaadin.flow.component.grid.Grid

addCellFocusListener, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnReorderListener, addColumnResizeListener, addColumns, addComponentColumn, addContextMenu, addDataGenerator, addDragEndListener, addDragStartListener, addDropListener, addFirstHeaderRow, addItemClickListener, addItemDoubleClickListener, addSelectionListener, addSortListener, addThemeVariants, addValueProvider, appendFooterRow, appendHeaderRow, asMultiSelect, asSingleSelect, compareMaybeComparables, configureBeanType, createColumn, createColumnId, createDefaultArrayUpdater, createSortingComparator, deselect, deselectAll, getAriaLabel, getArrayUpdater, getBeanType, getClassNameGenerator, getColumnLayers, getColumnRendering, getDataCommunicator, getDefaultColumnFactory, getDefaultHeaderRow, getDragFilter, getDropFilter, getDropMode, getEditor, getEmptyStateComponent, getEmptyStateText, getFooterRows, getGenericDataView, getHeaderRows, getLazyDataView, getListDataView, getNestedNullBehavior, getPageSize, getPartNameGenerator, getPropertySet, getSelectedItems, getSelectionMode, getSelectionModel, getSelectionPreservationMode, getSortOrder, getTooltipPosition, getUniqueKeyProperty, getUniqueKeyProvider, initConnector, insertColumnLayer, isAllRowsVisible, isDetailsVisible, isDetailsVisibleOnClick, isMultiSort, isRowsDraggable, onDataProviderChange, onEnabledStateChanged, prependFooterRow, prependHeaderRow, recalculateColumnWidths, removeAllColumns, removeAllFooterRows, removeAllHeaderRows, removeColumn, removeColumnByKey, removeColumnLayer, removeColumns, removeFooterRow, removeHeaderRow, removeThemeVariants, scrollToEnd, scrollToIndex, scrollToItem, scrollToStart, select, setAllRowsVisible, setAriaLabel, setClassNameGenerator, setColumnKey, setColumnOrder, setColumnOrder, setColumnRendering, setColumns, setDataProvider, setDefaultMultiSortPriority, setDetailsVisible, setDetailsVisibleOnClick, setDragDataGenerator, setDragFilter, setDropFilter, setDropMode, setEmptyStateComponent, setEmptyStateText, setItemDetailsRenderer, setItemSelectableProvider, setItemsPageable, setItemsPageable, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, setTooltipPosition, setUniqueKeyProperty, setUniqueKeyProvider, updateSelectionModeOnClient

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.ui.EditableDataGrid

canDelete, canEdit, canPostLedger, canViewLedger

Methods inherited from interface com.storedobject.common.Executable

act

Methods inherited from interface com.storedobject.vaadin.ExecutableView

abort, clean, createMenuItem, error, execute, execute, getMenuIconName, getMenuItem, getView, invoke, isCloseable, isFullScreen, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.core.FilterMethods

getFilterCondition, setFilter, setFilter, setFilter, setFilter, setFilter, setFilter, setLoadFilter, setLoadFilter, setViewFilter, setViewFilter

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.storedobject.vaadin.HasColumns

addConstructedListener, addItemSelectedListener, addItemsSelectedListener, appendFooter, appendHeader, clearAlerts, clearConstructedListeners, compact, configure, constructed, createColumn, createColumn, createColumn, createColumn, createColumn, createComponentColumn, createDecoratedWindow, createFooters, createHeaders, createHierarchyColumn, createHTMLColumn, createHTMLHierarchyColumn, createView, customizeColumn, customizeRenderer, deselect, deselect, executing, getApplication, getCaption, getColumn, getColumnCaption, getColumnCount, getColumnDetail, getColumnFunction, getColumnHeaderComponent, getColumnMethodName, getColumnNames, getColumnOrder, getColumnSorter, getColumnTemplate, getConfigureButton, getDataClass, getDefinedColumnCount, getFixedColumnWidth, getMenuItem, getObjectRendered, getObjectUnwrapped, getRelativeColumnWidth, getSelected, getSOGrid, getTextAlign, ignoreCaseForColumnSorting, includeColumn, isColumnFrozen, isColumnResizable, isColumnSortable, isColumnVisible, prependFooter, prependHeader, refresh, refresh, refresh, removeItemSelectedListener, render, select, select, setColumnFrozen, setColumnResizable, setColumnVisible, setMethodHandlerHost, sort, sort, sortOrder, sortOrder, streamConstructedListeners, unwrap

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, reversed, spliterator

Methods inherited from interface com.storedobject.ui.ObjectEditorListener

editingCancelled, editingEnded, editingStarted

Methods inherited from interface com.storedobject.ui.ObjectGridData

canSearch, convert, createSearchBuilder, deselect, deselectAll, doLoad, getEntityFilter, getItem, getLoadFilter, getObjectClass, getObjectCount, getSelectionModel, isAllowAny, populate, populate, populate, resetSearch, scrollTo, search, search, search, select, setLoadFilter, setObject, setObjectConsumer, setObjectConsumer, setObjects, setSelectionMode, validateFilterCondition

Methods inherited from interface com.storedobject.core.ObjectLoader

applyFilter, canContain, clear, getAllowAny, getLinkType, getMaster, getObjectClass, getOrderBy, isAllowAny, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, load, reload, setLinkType, setLinkType, setMaster, setMaster, setOrderBy, setOrderBy

Methods inherited from interface com.storedobject.ui.ObjectLoader

addDataLoadedListener, applyFilterPredicate, clear, get, getCacheLevel, getDelegatedLoader, getEffectiveCondition, getFixedFilter, getLoadFilter, getObjectCount, indexOf, load, setExtraFilter, setExtraFilter, setFilter, setFilter, setFixedFilter, setFixedFilter, setFixedFilter, setFixedFilter, size, streamAll, streamFiltered

Methods inherited from interface com.storedobject.core.ObjectSetter

accept, setObject

Methods inherited from interface com.storedobject.common.Reentrant

isReentrant

Methods inherited from interface com.storedobject.vaadin.util.SupportWindowMode

createWindow

Methods inherited from interface com.storedobject.ui.Transactional

commit, execute, getTransactionManager, run, transact, transact, transactControl, transactControl

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Methods inherited from interface com.storedobject.ui.util.ViewFilterSupport

configure, configure, configureMatch, filterView, getViewFilter

Constructor Details

ObjectSearchBrowser

public ObjectSearchBrowser(Class<T> objectClass)

Constructor.

Parameters:

objectClass - Class of the object type.

ObjectSearchBrowser

public ObjectSearchBrowser(Class<T> objectClass,
 String caption)

Constructor.

Parameters:

objectClass - Class of the object type.

caption - Caption of the view.

ObjectSearchBrowser

public ObjectSearchBrowser(Class<T> objectClass,
 Iterable<String> browseColumns)

Constructor.

Parameters:

objectClass - Class of the object type.

browseColumns - Browse columns.

ObjectSearchBrowser

public ObjectSearchBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 Iterable<String> filterColumns)

Constructor.

Parameters:

objectClass - Class of the object type.

browseColumns - Browse columns.

filterColumns - Filter columns.

ObjectSearchBrowser

public ObjectSearchBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 String caption)

Constructor.

Parameters:

objectClass - Class of the object type.

browseColumns - Browse columns.

caption - Caption of the view.

ObjectSearchBrowser

public ObjectSearchBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 Iterable<String> filterColumns,
 String caption)

Constructor.

Parameters:

objectClass - Class of the object type.

browseColumns - Browse columns.

filterColumns - Filter columns.

caption - Caption of the view.

ObjectSearchBrowser

public ObjectSearchBrowser(String className)
                    throws Exception

Constructor.

Parameters:

className - Name of the object class.

Throws:

Exception

Method Details

create

public static <O extends StoredObject>
ObjectSearchBrowser<O> create(Class<O> objectClass,
 String caption,
 Consumer<O> objectConsumer)

Create a searcher from the given parameters. The returned class may be a customized version of the searcher if one exists.

Type Parameters:

O - Type of the object class.

Parameters:

objectClass - Class of the object type.

caption - Caption of the view.

objectConsumer - Consumer of the search result. (Could be null and can be set later via ObjectGridData.setObjectConsumer(Consumer)).

Returns:

An instance of the searcher.

create

public static <O extends StoredObject>
ObjectSearchBrowser<O> create(Class<O> objectClass,
 Iterable<String> browseColumns,
 String caption,
 Consumer<O> objectConsumer)

Create a searcher from the given parameters. The returned class may be a customized version of the searcher if one exists.

Type Parameters:

O - Type of the object class.

Parameters:

objectClass - Class of the object type.

browseColumns - Browse columns.

caption - Caption of the view.

objectConsumer - Consumer of the search result. (Could be null and can be set later via ObjectGridData.setObjectConsumer(Consumer)).

Returns:

An instance of the searcher.

getView

public View getView(boolean create)

Description copied from interface: ExecutableView

Get the View. Create it if it doesn't exist.

Parameters:

create - Whether to create or not.

Returns:

View.

createHeader

public com.vaadin.flow.component.Component createHeader()

Description copied from interface: HasColumns

You can have a "header row" (as the first row) that covers the whole grid. Typically, such a row is to show your own buttons or components to customize the grid. The default implementation returns null and thus, no such row is created. (Please note that HasColumns.createHeaders()} is invoked before this method for adding other header rows just above the main header row. This may be used for column grouping etc.)

Specified by:

createHeader in interface HasColumns<T extends StoredObject>

Overrides:

createHeader in class ObjectBrowser<T extends StoredObject>

Returns:

Component to be used as the "header row".