Package io.jmix.dynattrui.panel

Class DynamicAttributesPanel

java.lang.Object

io.jmix.ui.component.CompositeComponent<VBoxLayout>

io.jmix.dynattrui.panel.DynamicAttributesPanel

All Implemented Interfaces:

AttachNotifier, Component, Component.BelongToFrame, HasDebugId, HasHtmlSanitizer, Validatable

@StudioComponent(category="Components",
                 unsupportedProperties={"enable","responsive"},
                 xmlns="http://jmix.io/schema/dynattr/ui",
                 xmlnsAlias="dynattr",
                 icon="io/jmix/dynattrui/icon/component/dynamicAttributesPanel.svg",
                 canvasIcon="io/jmix/dynattrui/icon/component/dynamicAttributesPanel_canvas.svg",
                 canvasIconSize=LARGE)
public class DynamicAttributesPanel
extends CompositeComponent<VBoxLayout>
implements Validatable

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.CompositeComponent

CompositeComponent.CreateEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field	Description
protected ComboBox<Category>	categoryField
protected HBoxLayout	categoryFieldBox
protected Integer	cols
static final String	DEFAULT_FIELD_WIDTH
protected DynAttrMetadata	dynAttrMetadata
protected String	fieldCaptionWidth
protected String	fieldWidth
protected InstanceContainer<?>	instanceContainer
protected Messages	messages
static final String	NAME
protected Form	propertiesForm
protected Integer	rows
protected UiComponents	uiComponents
protected UiComponentsGenerator	uiComponentsGenerator

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
DynamicAttributesPanel()

Method Summary

Modifier and Type	Method	Description
protected void	addFieldsToForm(Form newPropertiesForm, Map<AttributeDefinition,Component> fields)
protected Component	generateFieldComponent(AttributeDefinition attribute)
protected Collection<AttributeDefinition>	getAttributesByCategory()
protected List<Category>	getCategoriesOptionsList()
protected Collection<CategoryDefinition>	getCategoryDefinitions()
protected Category	getDefaultCategory()
protected int	getRowsPerColumn(int propertiesCount)
protected void	initCategoryField(InstanceContainer<?> instanceContainer)
protected void	initFieldCaptionWidth(Form newRuntimeForm)
protected void	initPropertiesForm()
boolean	isValid()
protected void	onCreate(CompositeComponent.CreateEvent createEvent)
protected void	onInstanceContainerItemChangeEvent(InstanceContainer.ItemChangeEvent<?> event)
void	setCategoryFieldVisible(boolean visible)	Sets visibility of the CategoryField component.
void	setColumnsCount(Integer cols)	Sets the number of columns.
void	setFieldCaptionWidth(String fieldCaptionWidth)	Sets the width of the fields caption.
void	setFieldWidth(String fieldWidth)	Sets the width of the fields.
void	setInstanceContainer(InstanceContainer<Object> container)	Defines InstanceContainer for DynamicAttributesPanel.
void	setRowsCount(Integer rows)	Sets the number of rows.
protected void	setWidth(Component component, AttributeDefinition attribute)
void	validate()

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getStyleName, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setStyleName, setUiEventListeners, setVisible, setWidth, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.Component

setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

Methods inherited from interface io.jmix.ui.component.Validatable

isValidateOnCommit

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_FIELD_WIDTH

public static final String DEFAULT_FIELD_WIDTH

uiComponentsGenerator

@Autowired
protected UiComponentsGenerator uiComponentsGenerator

uiComponents

@Autowired
protected UiComponents uiComponents

messages

@Autowired
protected Messages messages

dynAttrMetadata

@Autowired
protected DynAttrMetadata dynAttrMetadata

instanceContainer

protected InstanceContainer<?> instanceContainer

cols

protected Integer cols

rows

protected Integer rows

fieldWidth

protected String fieldWidth

fieldCaptionWidth

protected String fieldCaptionWidth

propertiesForm

protected Form propertiesForm

categoryFieldBox

protected HBoxLayout categoryFieldBox

categoryField

protected ComboBox<Category> categoryField

Constructor Details

DynamicAttributesPanel

public DynamicAttributesPanel()

Method Details

onCreate

protected void onCreate(CompositeComponent.CreateEvent createEvent)

initPropertiesForm

protected void initPropertiesForm()

addFieldsToForm

protected void addFieldsToForm(Form newPropertiesForm,
 Map<AttributeDefinition,Component> fields)

getRowsPerColumn

protected int getRowsPerColumn(int propertiesCount)

getAttributesByCategory

protected Collection<AttributeDefinition> getAttributesByCategory()

generateFieldComponent

protected Component generateFieldComponent(AttributeDefinition attribute)

setWidth

protected void setWidth(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()

initFieldCaptionWidth

protected void initFieldCaptionWidth(Form newRuntimeForm)

onInstanceContainerItemChangeEvent

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

setInstanceContainer

@StudioProperty(name="dataContainer",
                type=DATACONTAINER_REF,
                required=true)
public void setInstanceContainer(InstanceContainer<Object> container)

Defines InstanceContainer for DynamicAttributesPanel.

Parameters:

container - InstanceContainer object with editing entity

setColumnsCount

@StudioProperty(name="cols")
@Positive
public void setColumnsCount(Integer cols)

Sets the number of columns. If null value is passed, columns count will be determined based on the rows parameter.

Parameters:

cols - positive integer or null

setRowsCount

@StudioProperty(name="rows")
@Positive
public void setRowsCount(Integer rows)

Sets the number of rows. This parameter will only be taken into account if cols == null.

Parameters:

rows - positive integer or null

setFieldWidth

@StudioProperty(type=SIZE)
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

setFieldCaptionWidth

@StudioProperty(type=SIZE)
public void setFieldCaptionWidth(String fieldCaptionWidth)

Sets the width of the fields caption. fieldCaptionWidth with '%' unit is unsupported.

Parameters:

fieldCaptionWidth - width of the fields caption

setCategoryFieldVisible

public void setCategoryFieldVisible(boolean visible)

Sets visibility of the CategoryField component.

Parameters:

visible - visibility flag

isValid

public boolean isValid()

Specified by:

isValid in interface Validatable

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Validatable

Throws:

ValidationException