com.haulmont.cuba.gui.components

Class RuntimePropertiesFrame

java.lang.Object

com.haulmont.cuba.gui.screen.ScreenFragment

com.haulmont.cuba.gui.components.AbstractFrame

com.haulmont.cuba.gui.components.RuntimePropertiesFrame

All Implemented Interfaces:

ActionsHolder, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, ComponentContainer, ExpandingLayout, Frame, Frame.Wrapper, HasMargin, HasSpacing, HasSubParts, HasWindowManager, OrderedContainer, SupportsExpandRatio, LegacyFrame, FrameOwner

public class RuntimePropertiesFrame
extends AbstractFrame

Universal frame for editing dynamic attributes of any Categorized implementations.

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.screen.ScreenFragment

ScreenFragment.AfterInitEvent, ScreenFragment.AttachEvent, ScreenFragment.DetachEvent, ScreenFragment.InitEvent

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Frame

Frame.MessageMode, Frame.MessageType, Frame.NotificationType, Frame.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.ExpandingLayout

ExpandingLayout.ExpandDirection

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Boolean	borderVisible
protected CollectionDatasource	categoriesDs
protected LookupField	categoryField
protected BoxLayout	categoryFieldBox
protected java.lang.String	cols
static java.lang.String	DEFAULT_FIELD_WIDTH
protected DynamicAttributes	dynamicAttributes
protected DynamicAttributesGuiTools	dynamicAttributesGuiTools
protected DynamicAttributesTools	dynamicAttributesTools
protected java.lang.String	fieldCaptionWidth
protected java.lang.String[]	fieldCaptionWidths
protected java.lang.String	fieldWidth
static java.lang.String	NAME
protected RuntimePropsDatasource	rds
protected boolean	requiredControlEnabled
protected java.lang.String	rows
protected Security	security
protected UiComponents	uiComponents

Fields inherited from class com.haulmont.cuba.gui.components.AbstractFrame

frame, messages

Fields inherited from interface com.haulmont.cuba.gui.screen.FrameOwner

NO_OPTIONS, WINDOW_CLOSE_ACTION, WINDOW_COMMIT_AND_CLOSE_ACTION, WINDOW_DISCARD_AND_CLOSE_ACTION

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
RuntimePropertiesFrame()

Method Summary

Modifier and Type	Method and Description
protected void	addFieldsToFieldGroup(FieldGroup newRuntimeFieldGroup, java.util.List<FieldGroup.FieldConfig> fields)
protected java.util.List<FieldGroup.FieldConfig>	createFieldsForAttributes(FieldGroup newRuntimeFieldGroup)
protected FieldGroup	createRuntimeFieldGroup(Datasource ds)
protected java.util.Collection<java.util.function.Consumer<?>>	getValidator(MetaProperty property)
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Called by the framework after creation of all components and before showing the screen.
protected void	initCategoryField()
protected void	initDatasources(java.util.Map<java.lang.String,java.lang.Object> params)
protected void	initFieldCaptionWidth(FieldGroup newRuntimeFieldGroup)
boolean	isRequiredControlEnabled()
protected void	loadComponent(Datasource ds)
protected void	loadEditable(FieldGroup fieldGroup, FieldGroup.FieldConfig field)
protected void	loadRequired(FieldGroup fieldGroup, FieldGroup.FieldConfig field)
protected void	loadValidators(FieldGroup fieldGroup, FieldGroup.FieldConfig field)
void	setCategoryFieldEditable(boolean editable)
void	setCategoryFieldVisible(boolean visible)
void	setRequiredControlEnabled(boolean requiredControlEnabled)

Methods inherited from class com.haulmont.cuba.gui.components.AbstractFrame

add, add, addAction, addAction, addFacet, addStyleName, dispose, expand, expand, formatMessage, getAction, getActions, getAlignment, getCaption, getCompanion, getComponent, getComponent, getComponent, getComponents, getComposition, getContext, getDescription, getDsContext, getExpandDirection, getExpandRatio, getFacet, getFacets, getFrame, getFrameOwner, getHeight, getHeightSizeUnit, getIcon, getMargin, getMessage, getMessagesPack, getOwnComponent, getOwnComponents, getOwnComponentsStream, getParent, getSpacing, getStyleName, getWidth, getWidthSizeUnit, getWindowManager, getWrappedFrame, indexOf, init, isEnabled, isEnabledRecursive, isExpanded, isResponsive, isValid, isVisible, isVisibleRecursive, remove, removeAction, removeAction, removeAll, removeAllActions, removeFacet, removeStyleName, resetExpanded, setAlignment, setCaption, setCompanion, setDescription, setDsContext, setEnabled, setExpandRatio, setFragment, setFrame, setHeight, setIcon, setIconFromSet, setId, setMargin, setMessagesPack, setParent, setResponsive, setSpacing, setStyleName, setVisible, setWidth, setWrappedFrame, showValidationErrors, unwrap, unwrapComposition, validate, validate, validateAll

Methods inherited from class com.haulmont.cuba.gui.screen.ScreenFragment

addAfterInitListener, addAttachEventListener, addDetachEventListener, addInitListener, fireEvent, getBeanLocator, getEventHub, getExtensions, getFragment, getHostController, getHostScreen, getId, getScreenData, getUiEventListeners, init, setBeanLocator, setExtensions, setHostController, setScreenData, setUiEventListeners

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Frame

getFacetNN

Methods inherited from interface com.haulmont.cuba.gui.screen.compatibility.LegacyFrame

getXmlDescriptor, setXmlDescriptor

Methods inherited from interface com.haulmont.cuba.gui.components.ActionsHolder

getActionNN, getSubPart

Methods inherited from interface com.haulmont.cuba.gui.components.HasMargin

setMargin, setMargin

Methods inherited from interface com.haulmont.cuba.gui.components.OrderedContainer

getComponentNN

Methods inherited from interface com.haulmont.cuba.gui.components.ComponentContainer

add, focusFirstComponent, getComponentNN, remove

Methods inherited from interface com.haulmont.cuba.gui.components.Component

getHeightUnits, getId, getWidthUnits, isEnabledItself, isVisibleItself, requestFocus, setHeightAuto, setHeightFull, setSizeAuto, setSizeFull, setWidthAuto, setWidthFull

Methods inherited from interface com.haulmont.cuba.gui.components.HasWindowManager

openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openEditor, openFrame, openFrame, openLookup, openLookup, openLookup, openLookup, openWindow, openWindow, showMessageDialog, showNotification, showNotification, showNotification, showOptionDialog, showOptionDialog, showWebPage

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_FIELD_WIDTH

public static final java.lang.String DEFAULT_FIELD_WIDTH

See Also:

Constant Field Values

rds

protected RuntimePropsDatasource rds

categoriesDs

protected CollectionDatasource categoriesDs

requiredControlEnabled

protected boolean requiredControlEnabled

categoryFieldBox

@Inject
protected BoxLayout categoryFieldBox

categoryField

@Inject
protected LookupField categoryField

uiComponents

@Inject
protected UiComponents uiComponents

dynamicAttributes

@Inject
protected DynamicAttributes dynamicAttributes

dynamicAttributesTools

@Inject
protected DynamicAttributesTools dynamicAttributesTools

dynamicAttributesGuiTools

@Inject
protected DynamicAttributesGuiTools dynamicAttributesGuiTools

security

@Inject
protected Security security

rows

protected java.lang.String rows

cols

protected java.lang.String cols

fieldWidth

protected java.lang.String fieldWidth

borderVisible

protected java.lang.Boolean borderVisible

fieldCaptionWidth

protected java.lang.String fieldCaptionWidth

fieldCaptionWidths

protected java.lang.String[] fieldCaptionWidths

Constructor Detail

RuntimePropertiesFrame

public RuntimePropertiesFrame()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from class: AbstractFrame

Called by the framework after creation of all components and before showing the screen.
Override this method and put initialization logic here.

Overrides:

init in class AbstractFrame

Parameters:

params - parameters passed from caller's code, usually from HasWindowManager.openWindow(String, WindowManager.OpenType) and similar methods, or set in screens.xml for this registered screen

initDatasources

protected void initDatasources(java.util.Map<java.lang.String,java.lang.Object> params)

initCategoryField

protected void initCategoryField()

loadComponent

protected void loadComponent(Datasource ds)

createRuntimeFieldGroup

protected FieldGroup createRuntimeFieldGroup(Datasource ds)

initFieldCaptionWidth

protected void initFieldCaptionWidth(FieldGroup newRuntimeFieldGroup)

createFieldsForAttributes

protected java.util.List<FieldGroup.FieldConfig> createFieldsForAttributes(FieldGroup newRuntimeFieldGroup)

addFieldsToFieldGroup

protected void addFieldsToFieldGroup(FieldGroup newRuntimeFieldGroup,
                                     java.util.List<FieldGroup.FieldConfig> fields)

getValidator

protected java.util.Collection<java.util.function.Consumer<?>> getValidator(MetaProperty property)

loadValidators

protected void loadValidators(FieldGroup fieldGroup,
                              FieldGroup.FieldConfig field)

loadRequired

protected void loadRequired(FieldGroup fieldGroup,
                            FieldGroup.FieldConfig field)

loadEditable

protected void loadEditable(FieldGroup fieldGroup,
                            FieldGroup.FieldConfig field)

setCategoryFieldVisible

public void setCategoryFieldVisible(boolean visible)

isRequiredControlEnabled

public boolean isRequiredControlEnabled()

setRequiredControlEnabled

public void setRequiredControlEnabled(boolean requiredControlEnabled)

setCategoryFieldEditable

public void setCategoryFieldEditable(boolean editable)