Package com.storedobject.ui

Class ObjectList

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<Object>

com.storedobject.vaadin.DataForm

com.storedobject.ui.ObjectList

All Implemented Interfaces:

ClickHandler, ExecutableView, HasContainer, ValueChangeHandler, com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.ClickEvent<? extends com.vaadin.flow.component.Component>>, com.vaadin.flow.component.HasValue.ValueChangeListener, Serializable, Runnable, EventListener

public class ObjectList
extends DataForm

A list report that lists StoredObjects. The object class to be listed can be defined using a ReportDefinition or directly specified as the data class name. Attribute filters defined in the ReportDefinition instance is processed and filter variable values are accepted and applied while generating the output.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.vaadin.AbstractDataForm

AbstractDataForm.FieldError

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

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

Field Summary

Fields inherited from class com.storedobject.vaadin.DataForm

buttonPanel, cancel, ok

Fields inherited from class com.storedobject.vaadin.AbstractDataForm

form

Constructor Summary

Constructors

Constructor	Description
ObjectList(ReportDefinition definition)	Constructor.
ObjectList(String report)	Constructor.

Method Summary

Modifier and Type	Method	Description
ReportDefinition	getDefinition()	Get the definition associated with this list.
String	getExtraCondition()	Specify extra condition to be applied while retrieving the data.
protected boolean	process()	This method is invoked if the "Ok" button is pressed and there is no error raised by DataForm.validateData() method.

Methods inherited from class com.storedobject.vaadin.DataForm

buildButtons, buildFields, cancel, clicked, getMaximumContentHeight, getMaximumContentWidth, getMinimumContentHeight, getMinimumContentWidth, initUI, setButtonsAtTop, setCloseable, setWindowMode, sizeSet, skipFirstFocus, validateData

Methods inherited from class com.storedobject.vaadin.AbstractDataForm

add, addConstructedListener, addField, addField, addIncludeFieldChecker, addValidator, addValidator, attachField, clean, clearAlerts, clearError, clearErrors, clearFields, commit, connect, connect, connect, createButtonLayout, createField, createField, createFieldContainer, createLayout, detachField, fieldAttached, fieldDetached, fireFormConstructed, formConstructed, getColumns, getColumnSpan, getContainer, getContent, getData, getErrorDisplay, getField, getFieldLabel, getFieldLabel, getFieldName, getFieldNames, getForm, getLabel, isFieldEditable, isFieldEditable, isFieldVisible, isFieldVisible, isReadOnly, load, markError, newLine, remove, removeAll, removeField, removeField, removeField, setColumns, setColumnSpan, setErrorDisplay, setFieldContainerProvider, setFieldCustomizer, setFieldEditable, setFieldEditable, setFieldHidden, setFieldHidden, setFieldLabel, setFieldLabel, setFieldReadOnly, setFieldReadOnly, setFieldReadOnly, setFieldReadOnly, setFieldVisible, setFieldVisible, setFieldVisible, setFieldVisible, setIncludeFieldChecker, setReadOnly, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, setRequired, streamFieldNamesCreated, streamFieldsCreated

Methods inherited from class com.storedobject.vaadin.View

abort, aborted, addClosedListener, addOpenedListener, close, createCloseableView, createWindow, decorateComponent, execute, execute, execute, executing, focus, focus, focusAny, getApplication, getCaption, getComponent, getCreatedBy, getEmbeddedView, getMenuItem, getMenuItem, getView, invoke, isFullScreen, isScrollable, isWindowMode, select, setCaption, setComponent, setCreatedBy, setDefaultPadding, setEmbeddedView, setFirstFocus, setFullScreen, setScrollable

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface com.storedobject.vaadin.ExecutableView

createMenuItem, error, getMenuIconName, getView, isCloseable, isHomeView, log, log, message, returnedFrom, run, setClickable, speak, trackValueChange, tray, valueChanged, warning

Methods inherited from interface com.storedobject.vaadin.ValueChangeHandler

valueChanged

Constructor Details

ObjectList

public ObjectList(String report)

Constructor.

The parameter should contain the name of the report (as specified in the ReportDefinition. However, you may use the fully qualified name of the data class instead of the report definition name and in that case, a default report definition will be generated.

Parameters:

report - Report name.

ObjectList

public ObjectList(ReportDefinition definition)

Constructor.

Type Parameters:

T - Type of objects to list.

Parameters:

definition - Report definition.

Method Details

process

protected boolean process()

Description copied from class: DataForm

This method is invoked if the "Ok" button is pressed and there is no error raised by DataForm.validateData() method. This method has to return true in order to close the "data entry screen".

Specified by:

process in class DataForm

Returns:

True or false.

getExtraCondition

public String getExtraCondition()

Specify extra condition to be applied while retrieving the data. This condition is in addition to the condition generated for the filters and defined in the report definition itself.

Returns:

Extra condition.

getDefinition

public ReportDefinition getDefinition()

Get the definition associated with this list.

Returns:

Definition.