Package io.jmix.dynattrflowui.panel

Class DynamicAttributesPanel

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>

io.jmix.dynattrflowui.panel.DynamicAttributesPanel

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, ComponentContainer, Serializable

public class DynamicAttributesPanel
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>
implements com.vaadin.flow.component.HasSize, ComponentContainer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JmixComboBox<Category>	categoryField
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	categoryFieldBox
protected com.vaadin.flow.component.html.H3	categoryFieldLabel
static final String	DEFAULT_FIELD_WIDTH
protected final DynAttrMetadata	dynAttrMetadata
protected String	fieldWidth
protected InstanceContainer<?>	instanceContainer
protected final Messages	messages
static final String	NAME
protected JmixFormLayout	propertiesForm
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	rootPanel
protected final UiComponents	uiComponents
protected final UiComponentsGenerator	uiComponentsGenerator
protected final ViewValidation	viewValidation

Constructor Summary

Constructors

Constructor	Description
DynamicAttributesPanel(UiComponentsGenerator uiComponentsGenerator, UiComponents uiComponents, Messages messages, DynAttrMetadata dynAttrMetadata, ViewValidation viewValidation)

Method Summary

Modifier and Type	Method	Description
protected void	addFieldsToForm(com.vaadin.flow.component.formlayout.FormLayout newPropertiesForm, Map<AttributeDefinition,com.vaadin.flow.component.Component> fields)
Optional<com.vaadin.flow.component.Component>	findOwnComponent(String id)	Finds a component within immediate children of the container by its unique identifier.
protected com.vaadin.flow.component.Component	generateFieldComponent(AttributeDefinition attribute)
protected Collection<AttributeDefinition>	getAttributesByCategory()
protected List<Category>	getCategoriesOptionsList()
protected Collection<CategoryDefinition>	getCategoryDefinitions()
protected Category	getDefaultCategory()
Collection<com.vaadin.flow.component.Component>	getOwnComponents()	Returns a collection of components that are direct children (immediate descendants) of the container.
protected void	initCategoryField(InstanceContainer<?> instanceContainer)
protected com.vaadin.flow.component.orderedlayout.VerticalLayout	initContent()
protected void	initPropertiesForm()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onInstanceContainerItemChangeEvent(InstanceContainer.ItemChangeEvent<?> event)
protected void	onValidation(StandardDetailView.ValidationEvent validationEvent)
void	setCategoryFieldVisible(boolean visible)	Sets the visibility of the category field.
void	setFieldWidth(String fieldWidth)	Sets the width of the fields.
void	setInstanceContainer(InstanceContainer<Object> container)	Defines InstanceContainer for DynamicAttributesPanel.
protected void	setWidth(com.vaadin.flow.component.Component component, AttributeDefinition attribute)

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

getChildren, getContent, getElement

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

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, 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 io.jmix.flowui.component.ComponentContainer

findComponent, getComponent, getComponents, getOwnComponent

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

addDetachListener

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

getElement

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_FIELD_WIDTH

public static final String DEFAULT_FIELD_WIDTH

uiComponentsGenerator

protected final UiComponentsGenerator uiComponentsGenerator

uiComponents

protected final UiComponents uiComponents

messages

protected final Messages messages

dynAttrMetadata

protected final DynAttrMetadata dynAttrMetadata

viewValidation

protected final ViewValidation viewValidation

instanceContainer

protected InstanceContainer<?> instanceContainer

fieldWidth

protected String fieldWidth

rootPanel

protected com.vaadin.flow.component.orderedlayout.VerticalLayout rootPanel

categoryFieldBox

protected com.vaadin.flow.component.orderedlayout.VerticalLayout categoryFieldBox

categoryFieldLabel

protected com.vaadin.flow.component.html.H3 categoryFieldLabel

categoryField

protected JmixComboBox<Category> categoryField

propertiesForm

protected JmixFormLayout propertiesForm

Constructor Details

DynamicAttributesPanel

public DynamicAttributesPanel(UiComponentsGenerator uiComponentsGenerator,
 UiComponents uiComponents,
 Messages messages,
 DynAttrMetadata dynAttrMetadata,
 ViewValidation viewValidation)

Method Details

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

onValidation

protected void onValidation(StandardDetailView.ValidationEvent validationEvent)

initContent

protected com.vaadin.flow.component.orderedlayout.VerticalLayout initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.orderedlayout.VerticalLayout>

initPropertiesForm

protected void initPropertiesForm()

addFieldsToForm

protected void addFieldsToForm(com.vaadin.flow.component.formlayout.FormLayout newPropertiesForm,
 Map<AttributeDefinition,com.vaadin.flow.component.Component> fields)

getAttributesByCategory

protected Collection<AttributeDefinition> getAttributesByCategory()

generateFieldComponent

protected com.vaadin.flow.component.Component generateFieldComponent(AttributeDefinition attribute)

setWidth

protected void setWidth(com.vaadin.flow.component.Component component,
 AttributeDefinition attribute)

initCategoryField

protected void initCategoryField(InstanceContainer<?> instanceContainer)

getDefaultCategory

@Nullable
protected Category getDefaultCategory()

getCategoryDefinitions

protected Collection<CategoryDefinition> getCategoryDefinitions()

getCategoriesOptionsList

protected List<Category> getCategoriesOptionsList()

onInstanceContainerItemChangeEvent

protected void onInstanceContainerItemChangeEvent(InstanceContainer.ItemChangeEvent<?> event)

findOwnComponent

public Optional<com.vaadin.flow.component.Component> findOwnComponent(String id)

Description copied from interface: ComponentContainer

Finds a component within immediate children of the container by its unique identifier.

Specified by:

findOwnComponent in interface ComponentContainer

Parameters:

id - the unique identifier of the component to find

Returns:

an Optional containing the found component if it exists within the immediate children of the container, or an empty Optional if no component with the given identifier is found

getOwnComponents

public Collection<com.vaadin.flow.component.Component> getOwnComponents()

Description copied from interface: ComponentContainer

Returns a collection of components that are direct children (immediate descendants) of the container.

Specified by:

getOwnComponents in interface ComponentContainer

Returns:

a collection of Component instances representing the immediate children of the container, or an empty collection if no such components exist

setCategoryFieldVisible

public void setCategoryFieldVisible(boolean visible)

Sets the visibility of the category field.

Parameters:

visible - true to make the category field visible, false otherwise

setInstanceContainer

public void setInstanceContainer(InstanceContainer<Object> container)

Defines InstanceContainer for DynamicAttributesPanel.

Parameters:

container - InstanceContainer object with editing entity

setFieldWidth

public void setFieldWidth(String fieldWidth)

Sets the width of the fields. This parameter is used if some dynamic attribute does not have own width value.

Parameters:

fieldWidth - width of the fields