Package com.storedobject.ui

Class DataGrid<T>

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>

All Implemented Interfaces:

Executable, Reentrant, HasLogic, 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, List<T>, SequencedCollection<T>

Direct Known Subclasses:

AbstractEditableGrid, LocateItem, ManageSalutation, ManageSuffix, ObjectHistoryGrid, ObjectListGrid, StatusGrid, XGrid

public class DataGrid<T>
extends ListGrid<T>
implements ViewFilterSupport<T>, Transactional

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>

Constructor Summary

Constructors

Constructor	Description
DataGrid(Class<T> objectClass)
DataGrid(Class<T> objectClass, Filtered<T> list, Iterable<String> columns)
DataGrid(Class<T> objectClass, Iterable<String> columns)

Method Summary

Modifier and Type	Method	Description
boolean	actionAllowed(String action)	Check whether a specific action is allowed or not.
void	append(T object)	Inform the grid that we have appended an item.
final boolean	canAllowAction(String action)	Same as actionAllowed(String) except that this shows a message to the user about it if the action is not allowed.
protected com.vaadin.flow.data.provider.ListDataProvider<T>	createListDataProvider(DataList<T> data)	Create an instance of ListDataProvider for the given data.
protected void	doAppendAction(T object)	Carry out the append action for the object.
protected void	doDeleteAction(T object)	Carry out the delete action for the object.
protected void	doInsertAction(T object)	Carry out the insert action for the object.
protected void	doReloadAction(T object)	Carry out the reload action for the object.
protected void	doReloadAllAction()	Carry out the "reload all" action.
protected void	doUndeleteAction(T object)	Carry out the undelete action for the object.
protected void	doUpdateAction(T object)	Carry out the update action for the object.
protected String	getActionPrefix()	Prefix string that is added to the "action" string to determine the actual UIAction to be checked.
AbstractListProvider<T>	getDataProvider()
final Class<T>	getObjectClass()
protected boolean	isValid(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)
final void	itemAppended(T object)	Inform the grid that we have appended an item.
final void	itemDeleted(T object)	Inform the grid that we have deleted an item.
final void	itemInserted(T object)	Inform the grid that we have inserted a new item.
final void	itemReloaded(T object)	Inform the grid that we have reloaded an item.
final void	itemUndeleted(T object)	Inform the grid that we have undeleted an item.
final void	itemUpdated(T object)	Inform the grid that we have updated an item.
void	load(Collection<T> items)
void	load(T... items)
T	selected()	Get the currently selected instance.
protected T	selected(com.vaadin.flow.component.grid.editor.Editor<T> editor)
final com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>	setItems(com.vaadin.flow.data.provider.BackEndDataProvider<T,Void> dataProvider)
final com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>	setItems(com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback<T,Void> fetchCallback)
final com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>	setItems(com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback<T,Void> fetchCallback, com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback<T,Void> countCallback)
final com.vaadin.flow.component.grid.dataview.GridDataView<T>	setItems(com.vaadin.flow.data.provider.DataProvider<T,Void> dataProvider)
final com.vaadin.flow.component.grid.dataview.GridDataView<T>	setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<T> inMemoryDataProvider)
final com.vaadin.flow.component.grid.dataview.GridListDataView<T>	setItems(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)
final com.vaadin.flow.component.grid.dataview.GridListDataView<T>	setItems(Collection<T> items)
final com.vaadin.flow.component.grid.dataview.GridListDataView<T>	setItems(T... items)
final void	sort(Comparator<? super T> comparator)
final void	sort(List<com.vaadin.flow.component.grid.GridSortOrder<T>> order)
protected void	validateAppend(T object)	This is invoked when an item is being appended.
protected void	validateDelete(T object)	This is invoked when an item is being deleted.
protected void	validateInsert(T object)	This is invoked when a newly created item is being inserted.
protected void	validateReload(T object)	This is invoked when an item is being undeleted.
protected void	validateUndelete(T object)	This is invoked when an item is being undeleted.
protected void	validateUpdate(T object)	This is invoked when an item is being updated.

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, setViewFilter, 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, createEditor, 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 com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.common.Executable

act

Methods inherited from interface com.storedobject.vaadin.ExecutableView

abort, clean, clicked, close, 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.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

addItemSelectedListener, addItemsSelectedListener, appendHeader, clearAlerts, compact, configure, constructed, createColumn, createColumn, createColumn, createColumn, createColumn, createComponentColumn, createDecoratedWindow, createFooters, createHeader, 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, getTextAlign, getView, getViewComponent, ignoreCaseForColumnSorting, includeColumn, isColumnFrozen, isColumnResizable, isColumnSortable, isColumnVisible, prependFooter, prependHeader, refresh, refresh, refresh, removeItemSelectedListener, render, select, select, setCaption, setColumnFrozen, setColumnResizable, setColumnVisible, setMethodHandlerHost, sort, sort, sortOrder, sortOrder, 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.common.Reentrant

isReentrant

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

createWindow

Methods inherited from interface com.storedobject.ui.Transactional

commit, execute, getLogic, getTransactionManager, run, setLogic, transact, transact, transactControl, transactControl

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

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

configure, configure, configure, configureMatch, filterView, getViewFilter

Constructor Details

DataGrid

public DataGrid(Class<T> objectClass)

DataGrid

public DataGrid(Class<T> objectClass,
 Iterable<String> columns)

DataGrid

public DataGrid(Class<T> objectClass,
 Filtered<T> list,
 Iterable<String> columns)

Method Details

isValid

protected boolean isValid(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)

createListDataProvider

protected com.vaadin.flow.data.provider.ListDataProvider<T> createListDataProvider(DataList<T> data)

Description copied from class: ListGrid

Create an instance of ListDataProvider for the given data. The default implementation creates an instance of Vaadin's implementation. However, a modified implementation can be provided instead.

Overrides:

createListDataProvider in class ListGrid<T>

Parameters:

data - Data for which data provider needs to be created.

Returns:

An instance of the ListDataProvider.

getDataProvider

public AbstractListProvider<T> getDataProvider()

Specified by:

getDataProvider in interface ViewFilterSupport<T>

Overrides:

getDataProvider in class ListGrid<T>

setItems

public final com.vaadin.flow.component.grid.dataview.GridListDataView<T> setItems(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>

Overrides:

setItems in class com.vaadin.flow.component.grid.Grid<T>

setItems

public final com.vaadin.flow.component.grid.dataview.GridLazyDataView<T> setItems(com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback<T,Void> fetchCallback)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>

setItems

public final com.vaadin.flow.component.grid.dataview.GridDataView<T> setItems(com.vaadin.flow.data.provider.DataProvider<T,Void> dataProvider)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridDataView<T>>

Overrides:

setItems in class com.vaadin.flow.component.grid.Grid<T>

setItems

public final com.vaadin.flow.component.grid.dataview.GridDataView<T> setItems(com.vaadin.flow.data.provider.InMemoryDataProvider<T> inMemoryDataProvider)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridDataView<T>>

Overrides:

setItems in class com.vaadin.flow.component.grid.Grid<T>

setItems

public final com.vaadin.flow.component.grid.dataview.GridLazyDataView<T> setItems(com.vaadin.flow.data.provider.CallbackDataProvider.FetchCallback<T,Void> fetchCallback,
 com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback<T,Void> countCallback)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>

setItems

public final com.vaadin.flow.component.grid.dataview.GridLazyDataView<T> setItems(com.vaadin.flow.data.provider.BackEndDataProvider<T,Void> dataProvider)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasLazyDataView<T,Void,com.vaadin.flow.component.grid.dataview.GridLazyDataView<T>>

Overrides:

setItems in class com.vaadin.flow.component.grid.Grid<T>

setItems

@SafeVarargs
public final com.vaadin.flow.component.grid.dataview.GridListDataView<T> setItems(T... items)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>

setItems

public final com.vaadin.flow.component.grid.dataview.GridListDataView<T> setItems(Collection<T> items)

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.grid.dataview.GridListDataView<T>>

load

public void load(T... items)

load

public void load(Collection<T> items)

selected

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

selected

public T selected()

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

Returns:

Selected instance or null.

sort

public final void sort(Comparator<? super T> comparator)

Specified by:

sort in interface List<T>

Overrides:

sort in class ListGrid<T>

sort

public final void sort(List<com.vaadin.flow.component.grid.GridSortOrder<T>> order)

Overrides:

sort in class com.vaadin.flow.component.grid.Grid<T>

getObjectClass

public final Class<T> getObjectClass()

Specified by:

getObjectClass in interface ViewFilterSupport<T>

itemAppended

public final void itemAppended(T object)

Inform the grid that we have appended an item. It will append the item to the grid only if validateAppend(Object) doesn't raise any exception. For appending the item, it invokes doAppendAction(Object) method.

Parameters:

object - Item that is newly added.

doAppendAction

protected void doAppendAction(T object)

Carry out the append action for the object. The object is already validated.

Parameters:

object - Item that is appended.

validateAppend

protected void validateAppend(T object)
                       throws Exception

This is invoked when an item is being appended. The item is appended only if this method doesn't raise any exception.

Parameters:

object - Item that is appended.

Throws:

Exception - The exception should be a user-friendly one because it will be displayed on the screen.

itemInserted

public final void itemInserted(T object)

Inform the grid that we have inserted a new item. It will add the item to the grid only if validateInsert(Object) doesn't raise any exception. For adding the item, it invokes doInsertAction(Object) method.

Parameters:

object - Item that is newly added.

append

public void append(T object)

Inform the grid that we have appended an item. It will append the item to the grid only if validateAppend(Object) doesn't raise any exception. For appending the item, it invokes doAppendAction(Object) method.

Note: This method is an alias to itemAppended(Object) method.

Parameters:

object - Item that is newly added.

doInsertAction

protected void doInsertAction(T object)

Carry out the insert action for the object. The object is already validated.

Parameters:

object - Item that is newly added.

validateInsert

protected void validateInsert(T object)
                       throws Exception

This is invoked when a newly created item is being inserted. The item is added only if this method doesn't raise any exception.

Parameters:

object - Item that is newly added.

Throws:

Exception - The exception should be a user-friendly one because it will be displayed on the screen.

itemUpdated

public final void itemUpdated(T object)

Inform the grid that we have updated an item. It will update the item on the grid only if validateUpdate(Object) doesn't raise any exception. For updating the item, it invokes doUpdateAction(Object) method.

Parameters:

object - Item that is updated.

doUpdateAction

protected void doUpdateAction(T object)

Carry out the update action for the object. The object is already validated.

Parameters:

object - Item that is updated.

validateUpdate

protected void validateUpdate(T object)
                       throws Exception

This is invoked when an item is being updated. The item is updated only if this method doesn't raise any exception.

Parameters:

object - Item that is updated.

Throws:

Exception - The exception should be a user-friendly one because it will be displayed on the screen.

itemDeleted

public final void itemDeleted(T object)

Inform the grid that we have deleted an item. It will delete the item from the grid only if validateDelete(Object) doesn't raise any exception. For deleting the item, it invokes doDeleteAction(Object) method.

Parameters:

object - Item that is deleted.

doDeleteAction

protected void doDeleteAction(T object)

Carry out the delete action for the object. The object is already validated.

Parameters:

object - Item that is deleted.

validateDelete

protected void validateDelete(T object)
                       throws Exception

This is invoked when an item is being deleted. The item is deleted only if this method doesn't raise any exception.

Parameters:

object - Item that is deleted.

Throws:

Exception - The exception should have a user-friendly message because it will be displayed on the screen.

itemUndeleted

public final void itemUndeleted(T object)

Inform the grid that we have undeleted an item. It will undelete the item from the grid only if validateUndelete(Object) doesn't raise any exception. For undeleting the item, it invokes doUndeleteAction(Object) method.

Parameters:

object - Item that is deleted.

doUndeleteAction

protected void doUndeleteAction(T object)

Carry out the undelete action for the object. The object is already validated.

Parameters:

object - Item that is undeleted.

validateUndelete

protected void validateUndelete(T object)
                         throws Exception

This is invoked when an item is being undeleted. The item is undeleted only if this method doesn't raise any exception.

Parameters:

object - Item that is undeleted.

Throws:

Exception - The exception should be a user-friendly one because it will be displayed on the screen.

itemReloaded

public final void itemReloaded(T object)

Inform the grid that we have reloaded an item. It will reload the item from the grid only if validateReload(Object) doesn't raise any exception. For reloading the item, it invokes doReloadAction(Object) method.

Parameters:

object - Item that is deleted.

doReloadAction

protected void doReloadAction(T object)

Carry out the reload action for the object. The object is already validated.

Parameters:

object - Item that is undeleted.

doReloadAllAction

protected void doReloadAllAction()

Carry out the "reload all" action. All validation are already done before invoking this.

validateReload

protected void validateReload(T object)
                       throws Exception

This is invoked when an item is being undeleted. The item is undeleted only if this method doesn't raise any exception.

Parameters:

object - Item that is undeleted.

Throws:

Exception - The exception should be a user-friendly one because it will be displayed on the screen.

getActionPrefix

protected String getActionPrefix()

Prefix string that is added to the "action" string to determine the actual UIAction to be checked. See actionAllowed(String). For example, POBrowser returns the value "PO" for this method.

Returns:

Prefix string. Default implementation returns null unless a static public method named "actionPrefixForUI" exists in the object class. If the method exists, its return value is returned. Returning a null means that all the actions are allowed.

actionAllowed

public boolean actionAllowed(String action)

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 getActionPrefix() + "-" + action in order to allow that action.

Parameters:

action - Action string.

Returns:

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

canAllowAction

public final boolean canAllowAction(String action)

Same as actionAllowed(String) except that this shows a message to the user about it if the action is not allowed.

Parameters:

action - Action string.

Returns:

True/false.