Package com.storedobject.ui.common

Class EntityRoleEditor<T extends EntityRole>

java.lang.Object

com.storedobject.vaadin.View

com.storedobject.vaadin.AbstractDataForm<T>

com.storedobject.vaadin.AbstractDataEditor<T>

com.storedobject.ui.ObjectEditor<T>

com.storedobject.ui.common.EntityRoleEditor<T>

Type Parameters:

T - Type of Entity Role.

All Implemented Interfaces:

Executable, Reentrant, HasLogic, ObjectSetter<T>, AlertHandler, ObjectChangedListener<T>, ObjectEditorListener, ObjectProvider<T>, Transactional, TransactionCreator, 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, Consumer<T>

public class EntityRoleEditor<T extends EntityRole>
extends ObjectEditor<T>

An editor for EntityRole in which the fields of the Entity get merged seamlessly with the fields of the EntityRole.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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

AbstractDataEditor.DForm

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

add, audit, buttonPanel, cancel, delete, edit, exit, ledger, print, report, save, search

Fields inherited from class com.storedobject.vaadin.AbstractDataForm

form

Constructor Summary

Constructors

Constructor	Description
EntityRoleEditor(Class<T> objectClass)	Constructor.
EntityRoleEditor(Class<T> objectClass, int actions)	Constructor.
EntityRoleEditor(Class<T> objectClass, int actions, String caption)	Constructor.
EntityRoleEditor(String className)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canEditEntity()	Can new entities can be created or existing entities can be edited?
protected com.vaadin.flow.component.HasValue<?,?>	createField(String fieldName, String label)	Create the field for a particular "field name".
void	createNewEntityOnAdd()	If this method is invoked, a new entity will be created for every role added (means, the feature that asks to choose the entity when adding a role will be switched off).
protected T	createObjectInstance()	Create an instance of the object.
void	doAdd()	This is equivalent to pressing the "Add" button.
ObjectField.Type	getObjectFieldType(String fieldName)	Get the ObjectField.Type for a given field.

Methods inherited from class com.storedobject.ui.ObjectEditor

acceptValueChange, actionAllowed, add, addExtraButtons, addExtraEditingButtons, addObject, addObject, addObject, addObjectChangedListener, addObjectEditorListener, addValidator, allowedActions, anchorFieldsCreated, anchorsCancelled, anchorsSet, attachField, attachLinkField, canAdd, canAllowAction, canDelete, canEdit, canPostLedger, canSearch, canViewLedger, clean, clicked, create, create, create, create, createExtraButtons, createFormFieldEditor, createLinkFieldGrid, createNewInstance, customizeLinkField, delete, deleted, deleteObject, deleteObject, doAudit, doCancel, doDelete, doEdit, doReport, doSave, doSearch, editingCancelled, editingEnded, editingStarted, editObject, editObject, editObject, enablePrintButtons, executeAnchorForm, executeAnchorForm, extraInfoCreated, extraInfoLoaded, extraLinks, fieldAttached, filterActions, getActionPrefix, getAlertCaption, getAlertIcon, getAnchorField, getAnchorFilter, getApplication, getAttachmentField, getContactField, getContainer, getExtraInfoField, getField, getFieldName, getGrid, getLinkField, getLogic, getObject, getParentLinkType, getParentObject, getSearcher, getTabName, getTransaction, handleAlert, handleValueSetError, initUI, inserted, isBuffered, isDoNotSaveAllowed, isEditing, isFieldEditable, isReadOnly, isViewOnly, linkFields, postLedger, postLedger, refreshMe, reload, remove, removeObjectChangedListener, removeObjectEditorListener, removeSetNotAllowed, removeValidator, resetAnchor, save, save, saveObject, savingExtraInfo, setAllowDoNotSave, setAnchorFieldReadOnly, setBuffered, setCaption, setColumns, setContactData, setDeleter, setDoNotSave, setExtraInfo, setFieldContainerProvider, setLogic, setNewObjectGenerator, setNoTab, setObject, setParentObject, setRawObject, setSaver, setSearchFilter, setSearchFilter, setSetNotAllowed, setTab, setTransactionCreator, skipFirstFocus, trackValueChange, updated, validateAnchorValues, validateData, viewLedger, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject, viewObject

Methods inherited from class com.storedobject.vaadin.AbstractDataEditor

addField, addField, addField, addField, addField, addField, addField, addField, constructField, createField, customizeField, getDataClass, getFieldCreator, getFieldGetMethod, getFieldNames, getFieldOrder, getFieldSetMethod, getForm, getObjectClass, includeField, isFieldIncluded, newObject, setFixedValue, setFixedValue, setFixedValues, setObject

Methods inherited from class com.storedobject.vaadin.AbstractDataForm

addConstructedListener, addField, addField, addIncludeFieldChecker, addValidator, addValidator, clearAlerts, clearError, clearErrors, clearFields, commit, connect, connect, connect, createButtonLayout, createField, createFieldContainer, createLayout, detachField, fieldDetached, fireFormConstructed, formConstructed, getColumns, getColumnSpan, getContent, getData, getErrorDisplay, getFieldLabel, getFieldLabel, getFieldName, getLabel, isFieldEditable, isFieldVisible, isFieldVisible, load, markError, newLine, removeAll, removeField, removeField, removeField, setColumnSpan, setErrorDisplay, 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, getCaption, getComponent, getCreatedBy, getEmbeddedView, getMenuItem, getMenuItem, getView, invoke, isFullScreen, isScrollable, isWindowMode, select, setComponent, setCreatedBy, setDefaultPadding, setEmbeddedView, setFirstFocus, setFullScreen, setScrollable, setWindowMode

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.ui.AlertHandler

handleAlert

Methods inherited from interface com.storedobject.vaadin.ClickHandler

clicked, doubleClicked, onComponentEvent, rightClicked

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface com.storedobject.common.Executable

act

Methods inherited from interface com.storedobject.vaadin.ExecutableView

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

Methods inherited from interface com.storedobject.ui.ObjectChangedListener

saved, undeleted

Methods inherited from interface com.storedobject.ui.ObjectProvider

getObjectClass, getObjectId

Methods inherited from interface com.storedobject.core.ObjectSetter

accept, getObjectClass, isAllowAny, setObject

Methods inherited from interface com.storedobject.common.Reentrant

isReentrant

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

Constructor Details

EntityRoleEditor

public EntityRoleEditor(Class<T> objectClass)

Constructor.

Parameters:

objectClass - Entity role class.

EntityRoleEditor

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

Constructor.

Parameters:

objectClass - Entity role class.

actions - Actions allowed (ORed values of EditorAction).

EntityRoleEditor

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

Constructor.

Parameters:

objectClass - Entity role class.

actions - Actions allowed (ORed values of EditorAction).

caption - Caption.

EntityRoleEditor

public EntityRoleEditor(String className)
                 throws Exception

Constructor.

Parameters:

className - Name of the Entity role class.

Throws:

Exception

Method Details

createField

protected com.vaadin.flow.component.HasValue<?,?> createField(String fieldName,
 String label)

Description copied from class: AbstractDataForm

Create the field for a particular "field name".

Overrides:

createField in class AbstractDataForm<T extends EntityRole>

Parameters:

fieldName - Field name

label - Label for the field

Returns:

Field created.

getObjectFieldType

public ObjectField.Type getObjectFieldType(String fieldName)

Description copied from class: ObjectEditor

Get the ObjectField.Type for a given field. This method is invoked while building the fields to determine the field type.

Overrides:

getObjectFieldType in class ObjectEditor<T extends EntityRole>

Parameters:

fieldName - Name of the field.

Returns:

ObjectField.Type. The default value is ObjectField.Type.AUTO.

canEditEntity

public boolean canEditEntity()

Can new entities can be created or existing entities can be edited?

Returns:

True/false.

createObjectInstance

protected T createObjectInstance()

Description copied from class: AbstractDataEditor

Create an instance of the object. Default implementation tries to invoke the default constructor to create an instance and fixed values will be set if defined.

Overrides:

createObjectInstance in class ObjectEditor<T extends EntityRole>

Returns:

Newly created object.

doAdd

public void doAdd()

Description copied from class: ObjectEditor

This is equivalent to pressing the "Add" button.

Overrides:

doAdd in class ObjectEditor<T extends EntityRole>

createNewEntityOnAdd

public void createNewEntityOnAdd()

If this method is invoked, a new entity will be created for every role added (means, the feature that asks to choose the entity when adding a role will be switched off).