Package io.jmix.flowui.kit.meta

Annotation Interface StudioAvailableChildrenInfo

public @interface StudioAvailableChildrenInfo

Description of various child components.

If availableTags() and availableClasses() are empty, then the Studio will use an internal standard mechanism to identify available children.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	StudioAvailableChildrenInfo.ClassInfo	Description of how many times a component class can occur inside the current component.
static enum	StudioAvailableChildrenInfo.ConditionPolicy	if StudioAvailableChildrenInfo.ConditionPolicy.AT_LEAST_ONE then the check must pass according to at least one criterion (availableTags() OR availableClasses()).
static @interface	StudioAvailableChildrenInfo.TagInfo	Description of how many times a component tag can occur inside the current component.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
StudioAvailableChildrenInfo.ClassInfo[]	availableClasses	Array with the components qualified names that can be contained inside the current component.
StudioAvailableChildrenInfo.TagInfo[]	availableTags	Array with the components tags qualified names (with namespace if exist) that can be contained inside the current component.
StudioAvailableChildrenInfo.ConditionPolicy	conditionPolicy	Policy describing the final result of whether a component can be a child or not.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANY_CLASS	Placeholder to describe any component class.
static final String	ANY_TAG	Placeholder to describe any xml tag.
static final String	FLOW_COMPONENT_FQN	Qualified name of Component.

Field Details

ANY_TAG

static final String ANY_TAG

Placeholder to describe any xml tag.

See Also:

• Constant Field Values

ANY_CLASS

static final String ANY_CLASS

Placeholder to describe any component class.

See Also:

• Constant Field Values

FLOW_COMPONENT_FQN

static final String FLOW_COMPONENT_FQN

Qualified name of Component.

See Also:

• Constant Field Values

Element Details

availableTags

StudioAvailableChildrenInfo.TagInfo[] availableTags

Array with the components tags qualified names (with namespace if exist) that can be contained inside the current component.

Empty array is equivalent to the fact that checking for a tag will return true.

Default:

{}

availableClasses

StudioAvailableChildrenInfo.ClassInfo[] availableClasses

Array with the components qualified names that can be contained inside the current component.

Empty array is equivalent to the fact that checking for a class will return true.

Default:

{}

conditionPolicy

StudioAvailableChildrenInfo.ConditionPolicy conditionPolicy

Policy describing the final result of whether a component can be a child or not. See more info in StudioAvailableChildrenInfo.ConditionPolicy.

See Also:

• StudioAvailableChildrenInfo.ConditionPolicy

Default:

ALL