Package com.storedobject.ui

Class ObjectBrowser<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>

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>

Direct Known Subclasses:

AbstractInvoiceBrowser, AbstractRequestMaterial, AbstractSendAndReceiveMaterial, ApproveTransaction, CrossServerManager, GRN, JournalVoucherBrowser, ManageBiometric, ObjectBrowserEditor, ObjectBrowserViewer, ObjectSearchBrowser, PackingUnitBrowser, POBrowser, POItemBrowser, RestrictedSystemUserBrowser, SystemUserGroupBrowser, TextContentBrowser, UnitDefinitionBrowser

public class ObjectBrowser<T extends StoredObject>
extends ObjectGrid<T>
implements EditableDataGrid<T>, ObjectEditorListener

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.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

Modifier and Type	Field	Description
protected Button	add
protected Button	audit
protected final ButtonLayout	buttonPanel
protected Button	cancel
protected Button	delete
protected Button	edit
protected Button	excel
protected Button	exit
protected Button	filter
protected Button	ledger
protected Button	load
protected PrintButton	print
protected Button	report
protected Button	save
protected Button	search
protected Button	view

Constructor Summary

Constructors

Modifier	Constructor	Description
	ObjectBrowser(Class<T> objectClass)
	ObjectBrowser(Class<T> objectClass, int actions)
	ObjectBrowser(Class<T> objectClass, int actions, SearchBuilder<T> searchBuilder)
	ObjectBrowser(Class<T> objectClass, int actions, String caption)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, SearchBuilder<T> searchBuilder)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, SearchBuilder<T> searchBuilder, String caption)
protected	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, SearchBuilder<T> searchBuilder, String caption, String allowedActions)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, Iterable<String> filterColumns)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, Iterable<String> filterColumns, String caption)
protected	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, Iterable<String> filterColumns, String caption, String allowedActions)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, int actions, String caption)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, SearchBuilder<T> searchBuilder)
	ObjectBrowser(Class<T> objectClass, Iterable<String> browseColumns, Iterable<String> filterColumns)
	ObjectBrowser(Class<T> objectClass, String caption)
	ObjectBrowser(String className)

Method Summary

Modifier and Type	Method	Description
boolean	actionAllowed(String action)	Check whether a specific action is allowed or not.
protected void	addExtraButtons()
void	anchorFieldsCreated()	This method is invoked when anchor fields are created for the first time.
protected void	anchorsCancelled()	This method will be invoked if the "Cancel" button is pressed on the anchor form.
protected void	anchorsSet()	This method is invoked when anchor values are set via the anchor form and if any exception is thrown from this method, anchor values will be asked again.
protected boolean	canAdd()
void	cancelRowEdit()
boolean	canRowEdit(T item)
void	clicked(com.vaadin.flow.component.Component c)	Default implementation, does nothing.
void	close()	Close this.
protected ObjectEditor<T>	constructObjectEditor()
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass)
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass, int actions)
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass, int actions, String title)
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass, Iterable<String> browseColumns, int actions)
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass, Iterable<String> browseColumns, int actions, Iterable<String> filterColumns)
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass, Iterable<String> browseColumns, int actions, Iterable<String> filterColumns, String title)
static <O extends StoredObject> ObjectBrowser<O>	create(Class<O> objectClass, Iterable<String> browseColumns, int actions, String title)
protected final com.vaadin.flow.component.grid.editor.Editor<T>	createEditor()
protected void	createExtraButtons()
com.vaadin.flow.component.Component	createHeader()	You can have a "header row" (as the first row) that covers the whole grid.
protected ObjectEditor<T>	createObjectEditor()
void	doAdd()
void	doDelete(T object)
void	doEdit(T object)
void	doView(T object)
void	editRow(T item)
void	executeAnchorForm(Runnable action)	Execute the "anchor form" and run some specified action.
void	extraInfoCreated(T object, StoredObject extraInfo)	This is invoked when an "Extra Information" instance is created.
void	extraInfoLoaded(T object, StoredObject extraInfo)	This is invoked when an existing "Extra Information" instance is loaded for the current object.
protected int	filterActions(int actions)
final T	getEditingItem()
final Logic	getLogic()	Get the logic.
final ObjectEditor<T>	getObjectEditor()
final ObjectEditor<T>	getRowEditor()
ObjectSearchBuilder<T>	getSearchBuilder()
com.vaadin.flow.component.Component	getViewComponent()	Get the component for creating the view - See HasColumns.getView(boolean) and ExecutableView.getView().
boolean	isColumnEditable(String columnName)	Whether a given column is editable or not.
final boolean	isReadOnly()
boolean	isSearchMode()
protected List<com.vaadin.flow.component.Component>	listMoreButtons()	List of more buttons to be added to the PrintButton, in addition to the configured buttons.
void	load(int linkType, StoredObject master, String condition, String orderedBy, boolean any)	Load the links of the given "master" instance.
void	load(String condition, String orderedBy, boolean any)	Load the instances.
void	postLedger(T object)
void	resetAnchor()	Reset the anchor values so that it will be asked again for the next add/search actions.
void	rowDoubleClicked(T object)
void	saveEditedRow()
void	savingExtraInfo(T object, StoredObject extraInfo)	This is invoked when an existing "Extra Information" instance is being saved.
T	selected()	Get the currently selected instance.
void	setCaption(String caption)	Set caption used when displaying the grid in a View.
final void	setLogic(Logic logic)	Set the logic.
void	setObjectEditor(ObjectEditor<T> editor)
void	setReadOnly(boolean readOnly)
void	setSplitView()
Stream<com.vaadin.flow.component.HasValue<?,?>>	streamEditableFields()	Get the stream of editable fields of this grid.
void	validateAnchorValues(T object)	Validate the anchor values.

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, 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, setMultiSort, setMultiSort, setMultiSort, setMultiSort, setNestedNullBehavior, setPageSize, setPartNameGenerator, setRowsDraggable, setSelectionDragDetails, setSelectionMode, setSelectionModel, setSelectionPreservationMode, setSortableColumns, setTooltipGenerator, 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, getView, 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

Field Details

buttonPanel

protected final ButtonLayout buttonPanel

print

protected PrintButton print

add

protected Button add

edit

protected Button edit

delete

protected Button delete

search

protected Button search

filter

protected Button filter

load

protected Button load

view

protected Button view

report

protected Button report

excel

protected Button excel

audit

protected Button audit

exit

protected Button exit

save

protected Button save

cancel

protected Button cancel

ledger

protected Button ledger

Constructor Details

ObjectBrowser

public ObjectBrowser(Class<T> objectClass)

ObjectBrowser

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

ObjectBrowser

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

ObjectBrowser

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

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 SearchBuilder<T> searchBuilder)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 int actions)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 int actions,
 SearchBuilder<T> searchBuilder)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 int actions,
 String caption)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 Iterable<String> filterColumns)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 SearchBuilder<T> searchBuilder)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 String caption)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 Iterable<String> filterColumns,
 String caption)

ObjectBrowser

public ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 SearchBuilder<T> searchBuilder,
 String caption)

ObjectBrowser

protected ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 Iterable<String> filterColumns,
 String caption,
 String allowedActions)

ObjectBrowser

protected ObjectBrowser(Class<T> objectClass,
 Iterable<String> browseColumns,
 int actions,
 SearchBuilder<T> searchBuilder,
 String caption,
 String allowedActions)

ObjectBrowser

public ObjectBrowser(String className)
              throws Exception

Throws:

Exception

Method Details

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass)

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass,
 int actions)

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass,
 Iterable<String> browseColumns,
 int actions)

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass,
 Iterable<String> browseColumns,
 int actions,
 Iterable<String> filterColumns)

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass,
 int actions,
 String title)

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass,
 Iterable<String> browseColumns,
 int actions,
 String title)

create

public static <O extends StoredObject>
ObjectBrowser<O> create(Class<O> objectClass,
 Iterable<String> browseColumns,
 int actions,
 Iterable<String> filterColumns,
 String title)

setLogic

public final void setLogic(Logic logic)

Description copied from interface: HasLogic

Set the logic. This will be invoked by the ApplicationServer when the Logic is executed.

Specified by:

setLogic in interface HasLogic

Specified by:

setLogic in interface Transactional

Parameters:

logic - Logic to set

getLogic

public final Logic getLogic()

Description copied from interface: HasLogic

Get the logic.

Specified by:

getLogic in interface HasLogic

Specified by:

getLogic in interface Transactional

Returns:

Logic

setCaption

public void setCaption(String caption)

Description copied from interface: HasColumns

Set caption used when displaying the grid in a View.

Specified by:

setCaption in interface ExecutableView

Specified by:

setCaption in interface HasColumns<T extends StoredObject>

Parameters:

caption - Caption

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>

Returns:

Component to be used as the "header row".

filterActions

protected int filterActions(int actions)

createExtraButtons

protected void createExtraButtons()

addExtraButtons

protected void addExtraButtons()

listMoreButtons

protected List<com.vaadin.flow.component.Component> listMoreButtons()

List of more buttons to be added to the PrintButton, in addition to the configured buttons.

Returns:

List of more buttons to be added. The list could contain any type of components.

canAdd

protected boolean canAdd()

close

public void close()

Description copied from interface: ExecutableView

Close this.

Specified by:

close in interface ExecutableView

selected

public T selected()

Description copied from class: DataGrid

Get the currently selected instance. If nothing is selected, a warning message is displayed and null is returned. (If you simply want to a find the selected instance without displaying a warning message, you may use HasColumns.getSelected()).

Overrides:

selected in class DataGrid<T extends StoredObject>

Returns:

Selected instance or null.

rowDoubleClicked

public void rowDoubleClicked(T object)

clicked

public void clicked(com.vaadin.flow.component.Component c)

Description copied from interface: ExecutableView

Default implementation, does nothing.

Specified by:

clicked in interface ClickHandler

Specified by:

clicked in interface ExecutableView

Parameters:

c - Component

load

public void load(int linkType,
 StoredObject master,
 String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the links of the given "master" instance. Current "load filter" if set will be applied.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

linkType - Link type.

master - Master instance.

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

load

public void load(String condition,
 String orderedBy,
 boolean any)

Description copied from interface: ObjectLoader

Load the instances. Current "load filter" if set will be applied. If "master" is already set, "links" of the "master" will be loaded.

Specified by:

load in interface ObjectLoader<T extends StoredObject>

Parameters:

condition - Filtering condition to be applied.

orderedBy - "ORDER BY" clause to use while loading.

any - Whether instanced of the subclasses to be retrieved or not.

validateAnchorValues

public void validateAnchorValues(T object)
                          throws SOException

Validate the anchor values. This is invoked when anchor values are set while adding a new instance.

Parameters:

object - The instance that contains the currently accepted anchor values.

Throws:

SOException - If thrown, the message is displayed as a warning and the add operation is aborted.

anchorFieldsCreated

public void anchorFieldsCreated()

This method is invoked when anchor fields are created for the first time.

resetAnchor

public void resetAnchor()

Reset the anchor values so that it will be asked again for the next add/search actions.

anchorsSet

protected void anchorsSet()
                   throws Exception

This method is invoked when anchor values are set via the anchor form and if any exception is thrown from this method, anchor values will be asked again.

Throws:

Exception - If anchor values are not acceptable for some reason.

anchorsCancelled

protected void anchorsCancelled()

This method will be invoked if the "Cancel" button is pressed on the anchor form.

executeAnchorForm

public void executeAnchorForm(Runnable action)

Execute the "anchor form" and run some specified action.

Parameters:

action - Action to run.

doAdd

public void doAdd()

doEdit

public void doEdit(T object)

doDelete

public void doDelete(T object)

postLedger

public void postLedger(T object)

doView

public void doView(T object)

getViewComponent

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

Description copied from interface: HasColumns

Get the component for creating the view - See HasColumns.getView(boolean) and ExecutableView.getView().

Specified by:

getViewComponent in interface HasColumns<T extends StoredObject>

Returns:

The component for the view. By default, the grid itself is returned.

setSplitView

public void setSplitView()

getRowEditor

public final ObjectEditor<T> getRowEditor()

setObjectEditor

public void setObjectEditor(ObjectEditor<T> editor)

getObjectEditor

public final ObjectEditor<T> getObjectEditor()

createObjectEditor

protected ObjectEditor<T> createObjectEditor()

constructObjectEditor

protected ObjectEditor<T> constructObjectEditor()

isColumnEditable

public boolean isColumnEditable(String columnName)

Description copied from interface: EditableDataGrid

Whether a given column is editable or not. A field will be created for editing the value only if this method returns true for a particular column.

Specified by:

isColumnEditable in interface EditableDataGrid<T extends StoredObject>

Parameters:

columnName - Column name.

Returns:

True/false.

streamEditableFields

public Stream<com.vaadin.flow.component.HasValue<?,?>> streamEditableFields()

Description copied from interface: EditableDataGrid

Get the stream of editable fields of this grid.

Specified by:

streamEditableFields in interface EditableDataGrid<T extends StoredObject>

Returns:

Stream of editable fields.

isSearchMode

public boolean isSearchMode()

Specified by:

isSearchMode in interface ObjectGridData<T extends StoredObject,T extends StoredObject>

getSearchBuilder

public ObjectSearchBuilder<T> getSearchBuilder()

Specified by:

getSearchBuilder in interface ObjectGridData<T extends StoredObject,T extends StoredObject>

Specified by:

getSearchBuilder in interface ObjectSearcher<T extends StoredObject>

setReadOnly

public void setReadOnly(boolean readOnly)

isReadOnly

public final boolean isReadOnly()

createEditor

protected final com.vaadin.flow.component.grid.editor.Editor<T> createEditor()

Overrides:

createEditor in class com.vaadin.flow.component.grid.Grid<T extends StoredObject>

editRow

public void editRow(T item)

canRowEdit

public boolean canRowEdit(T item)

cancelRowEdit

public void cancelRowEdit()

saveEditedRow

public void saveEditedRow()

getEditingItem

public final T getEditingItem()

extraInfoCreated

public void extraInfoCreated(T object,
 StoredObject extraInfo)

This is invoked when an "Extra Information" instance is created. At this point, you may set your own values if required.

Parameters:

object - The object instance for which the "Extra Information" is created.

extraInfo - Newly created "Extra Information" instance.

extraInfoLoaded

public void extraInfoLoaded(T object,
 StoredObject extraInfo)

This is invoked when an existing "Extra Information" instance is loaded for the current object. At this point, you may set your own values if required.

Parameters:

object - The object instance for which the "Extra Information" is loaded.

extraInfo - The "Extra Information" instance loaded now.

savingExtraInfo

public void savingExtraInfo(T object,
 StoredObject extraInfo)
                     throws Exception

This is invoked when an existing "Extra Information" instance is being saved. At this point, you may set your own values if required. (ObjectEditor.validateData() and StoredObject.validateData(TransactionManager) are be invoked after this).

If an exception is thrown from this method, the save process will not happen.

Parameters:

object - The object instance for which the "Extra Information" is getting saved.

extraInfo - The "Extra Information" instance to be saved.

Throws:

Exception - if any validation error to be notified.

actionAllowed

public boolean actionAllowed(String action)

Description copied from class: DataGrid

Check whether a specific action is allowed or not. An action is defined in the UI logic as a keyword like "SEND-ITEMS", "PLACE-ORDER", "RECEIVE-ITEMS", "PRINT-VOUCHER", etc. and there could be corresponding access control applicable within the logic. The user's groups determine whether that user can carry out that action or not. This method returns true/false to denote that the user can carry out the action or not. However, it is up to the logic to decide the course of action.

The user's groups can be configured to allow various UI actions (UIAction. Each UIAction represents a unique "action" string (UIAction.getAction()) and that value should be equal to DataGrid.getActionPrefix() + "-" + action in order to allow that action.

Overrides:

actionAllowed in class DataGrid<T extends StoredObject>

Parameters:

action - Action string.

Returns:

True/false. Please note that it will always return true if DataGrid.getActionPrefix() returns null.