Uses of Interface
com.broadleafcommerce.metadata.dsl.core.Component

Packages that use Component

Package	Description
com.broadleafcommerce.metadata.dsl.core
com.broadleafcommerce.metadata.dsl.core.extension
com.broadleafcommerce.metadata.dsl.core.extension.actions
com.broadleafcommerce.metadata.dsl.core.extension.columns
com.broadleafcommerce.metadata.dsl.core.extension.common.tree
com.broadleafcommerce.metadata.dsl.core.extension.externals
com.broadleafcommerce.metadata.dsl.core.extension.externals.tree
com.broadleafcommerce.metadata.dsl.core.extension.fields
com.broadleafcommerce.metadata.dsl.core.extension.grids
com.broadleafcommerce.metadata.dsl.core.extension.groups
com.broadleafcommerce.metadata.dsl.core.extension.views
com.broadleafcommerce.metadata.dsl.core.extension.views.browse
com.broadleafcommerce.metadata.dsl.core.extension.views.details
com.broadleafcommerce.metadata.dsl.core.extension.views.tree
com.broadleafcommerce.metadata.dsl.registry
com.broadleafcommerce.metadata.dsl.validators
com.broadleafcommerce.metadata.dsl.validators.columns
com.broadleafcommerce.metadata.dsl.validators.fields

Uses of Component in com.broadleafcommerce.metadata.dsl.core

Classes in com.broadleafcommerce.metadata.dsl.core with type parameters of type Component

Modifier and Type	Interface	Description
interface	Component<C extends Component<C>>	Represents the metadata of a component.

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core

Modifier and Type	Interface	Description
interface	Column<C extends Column<C>>	Represents the metadata for a column component.
interface	External<E extends External<E>>	Represents the metadata for an external form component.
interface	Field<F extends Field<F>>	Represents the metadata for a field component.
interface	FormComponent<C extends FormComponent<C>>	Represents the metadata for a component that resides with a form.
interface	Group<G extends Group<G>>	Represents the metadata for grouping form components.
interface	View<V extends View<V>>	Represents the metadata for a view component.

Classes in com.broadleafcommerce.metadata.dsl.core that implement Component

Modifier and Type	Class	Description
class	AbstractComponent<C extends AbstractComponent<C>>	The abstract implementation of Component.
class	AbstractFormComponent<C extends AbstractFormComponent<C>>	The abstract form component implementation.

Methods in com.broadleafcommerce.metadata.dsl.core with type parameters of type Component

Modifier and Type	Method	Description
default <T extends Component<T>> T	Action.get(String key, Class<T> clazz)
default <T extends Component<T>> T	Component.get(String key, Class<T> clazz)	Alias for getComponent(String, Class).
default <T extends Component<T>> T	Action.getComponent(String key, Class<T> clazz)
default <T extends Component<T>> T	Component.getComponent(String key, Class<T> clazz)	Retrieves the component of the provided type stored at the given key, if it exists.

Methods in com.broadleafcommerce.metadata.dsl.core that return Component

Modifier and Type	Method	Description
default Component<?>	Action.get(String key)
default Component<?>	Component.get(String key)	Alias for getComponent(String).
default Component<?>	Action.getComponent(String key)
default Component<?>	Component.getComponent(String key)	Retrieves the component stored at the given key, if it exists.

Methods in com.broadleafcommerce.metadata.dsl.core that return types with arguments of type Component

Modifier and Type	Method	Description
default Optional<Component<?>>	Action.findComponent(String key)
default Optional<Component<?>>	Action.findComponent(Predicate<Component<?>> predicate)
default Optional<Component<?>>	Component.findComponent(String key)	Finds the component stored at the given key.
default Optional<Component<?>>	Component.findComponent(Predicate<Component<?>> predicate)	Retrieves a single child component that matches the given predicate.
default Collection<Component<?>>	Action.findComponents(Predicate<Component<?>> predicate)
default List<Component<?>>	Component.findComponents(Predicate<Component<?>> predicate)	Retrieves a list of child components that match the given predicate.
Map<String,Component<?>>	AbstractComponent.getComponents()
Map<String,Component<?>>	Action.getComponents()
Map<String,Component<?>>	Component.getComponents()	A key-value map of components used for managing the children components of this component.
default Collection<Component<?>>	Action.getComponentsList()
default Collection<Component<?>>	Component.getComponentsList()	The serializable, sorted list of children components.

Methods in com.broadleafcommerce.metadata.dsl.core with parameters of type Component

Modifier and Type	Method	Description
default A	Action.addComponent(String key, Component<?> component)
default C	Component.addComponent(String key, Component<?> component)	Primary method of adding a child component.

Method parameters in com.broadleafcommerce.metadata.dsl.core with type arguments of type Component

Modifier and Type	Method	Description
default A	Action.addComponents(Map<String,? extends Component<?>> components)
default Optional<Component<?>>	Action.findComponent(Predicate<Component<?>> predicate)
default Optional<Component<?>>	Component.findComponent(Predicate<Component<?>> predicate)	Retrieves a single child component that matches the given predicate.
default Collection<Component<?>>	Action.findComponents(Predicate<Component<?>> predicate)
default List<Component<?>>	Component.findComponents(Predicate<Component<?>> predicate)	Retrieves a list of child components that match the given predicate.
void	AbstractComponent.setComponents(Map<String,Component<?>> components)
void	Action.setComponents(Map<String,Component<?>> components)
void	Component.setComponents(Map<String,Component<?>> components)

Constructors in com.broadleafcommerce.metadata.dsl.core with parameters of type Component

Constructor	Description
AbstractComponent(Component<?> component)

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension

Modifier and Type	Interface	Description
interface	ActionGrid<G extends ActionGrid<G>>	An extension of Grid to represent a grid with grid-level and row-level actions.
interface	BuilderFieldSource<D extends BuilderFieldSource<D>>	An interface implemented by components that intend to support the inclusion of augmented custom fields.
interface	Dependent<D extends Dependent<D>>	Represents metadata for a FormComponent that has dependencies on its parent form's state.
interface	ExportGrid<G extends ExportGrid<G>>	An extension of ActionGrid to represent a grid with a grid-level export action.
interface	FetchEntity<C extends FetchEntity<C>>	Represents the metadata for a component that supports fetching a single entity.
interface	FetchGrid<G extends FetchGrid<G>>	Represents the metadata for a Grid that supports fetching it's own data.
interface	Filterable<D extends Filterable<D>>	An interface implemented by components that intend to support filterable behavior.
interface	FilterableGrid<G extends FilterableGrid<G>>	Represents the metadata for a FetchGrid that supports filtering it's records using various filter actions.
interface	Form<F extends Form<F>>	Represents the metadata for a component whose children are various FormComponent.
interface	Grid<G extends Grid<G>>	An interface representing a grid with a collection of Column.
interface	ImportGrid<G extends ImportGrid<G>>	An extension of ActionGrid to represent a grid with a grid-level import action.
interface	Orderable<R extends Orderable<R>>	Represents the metadata for a collection component that supports re-ordering it's members.
interface	PageableFetch<C extends PageableFetch<C>>
interface	Pollable<G extends Pollable<G>>	An interface implemented by components that intend to support pollable behavior.
interface	ResourceGrid<G extends ResourceGrid<G>>	Represents the metadata of a ActionGrid and FetchGrid that is used for managing an external resource.
interface	Selectable<S extends Selectable<S>>	An interface implemented by components that intend to support selectable behavior.
interface	SortableGrid<G extends SortableGrid<G>>
interface	Trackable<T extends Trackable<T>>

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.actions

Methods in com.broadleafcommerce.metadata.dsl.core.extension.actions that return types with arguments of type Component

Modifier and Type	Method	Description
Map<String,Component<?>>	AbstractAction.getComponents()

Method parameters in com.broadleafcommerce.metadata.dsl.core.extension.actions with type arguments of type Component

Modifier and Type	Method	Description
void	AbstractAction.setComponents(Map<String,Component<?>> components)

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.columns

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.columns

Modifier and Type	Interface	Description
interface	ConditionalColumn<C extends ConditionalColumn<C>>	Deprecated. please use DynamicColumn
interface	DateColumn<C extends DateColumn<C>>
interface	DynamicColumn<C extends DynamicColumn<C>>	Builder that is used for building ColumnTypes.DYNAMIC type column components.
interface	EmbeddedListColumn<C extends EmbeddedListColumn<C>>	Builder that is used for building ColumnTypes.EMBEDDED_LIST type column components.
interface	EnumColumn<C extends EnumColumn<C>>
interface	LinkColumn<C extends LinkColumn<C>>
interface	MoneyColumn<C extends MoneyColumn<C>>	Represents the metadata for a column that displays a monetary amount.
interface	ProgressColumn<C extends ProgressColumn<C>>	The column type that is used to render the progress in percentage.
interface	SpelRuleColumn<C extends SpelRuleColumn<C>>	Represents the metadata for a ColumnTypes.SPEL_RULE.
interface	ThumbnailColumn<C extends ThumbnailColumn<C>>	Represents the metadata for a ColumnTypes.THUMBNAIL.

Classes in com.broadleafcommerce.metadata.dsl.core.extension.columns that implement Component

Modifier and Type	Class	Description
class	AbstractColumn<C extends AbstractColumn<C>>	The abstract column component specification.
class	DefaultColumn
class	DefaultConditionalColumn	The default implementation for ConditionalColumn.
class	DefaultDateColumn
class	DefaultDynamicColumn	The default implementation for DynamicColumn.
class	DefaultEmbeddedListColumn	The default implementation for EmbeddedListColumn.
class	DefaultEnumArrayColumn
class	DefaultEnumColumn
class	DefaultLinkColumn
class	DefaultMoneyColumn
class	DefaultProgressColumn	The default implementation for ProgressColumn.
class	DefaultSpelRuleColumn
class	DefaultThumbnailColumn

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.common.tree

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.common.tree

Modifier and Type	Interface	Description
interface	Tree<T extends Tree<T>>	Represents the metadata for a tree component.
interface	TreeGridView<V extends TreeGridView<V>>

Classes in com.broadleafcommerce.metadata.dsl.core.extension.common.tree that implement Component

Modifier and Type	Class	Description
class	DefaultTreeGridView

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals

Modifier and Type	Interface	Description
interface	ExportHistoryGridExternal<E extends ExportHistoryGridExternal<E>>	The grid view that is used to add the export history to the UpdateEntityView.
interface	GridExternal<E extends GridExternal<E>>	Represents the metadata for a grid that provides a view of external data related to the form it resides within.
interface	LinkExternal<E extends LinkExternal<E>>	The external component that is used to build the HTML links.

Classes in com.broadleafcommerce.metadata.dsl.core.extension.externals that implement Component

Modifier and Type	Class	Description
class	AbstractExternal<E extends AbstractExternal<E>>	The abstract external component specification.
class	DefaultExportHistoryGridExternal	The default implementation for ExportHistoryGridExternal.
class	DefaultExternal
class	DefaultGridExternal
class	DefaultLinkExternal	The default implementation for LinkExternal.
class	DefaultTreeExternal

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals.tree

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals.tree

Modifier and Type	Interface	Description
interface	TreeExternal<E extends TreeExternal<E>>

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.fields

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.fields

Modifier and Type	Interface	Description
interface	CustomAttributesGridField<F extends CustomAttributesGridField<F>>
interface	DateField<F extends DateField<F>>	Represents the metadata for a date picker field.
interface	DerivedField<F extends DerivedField<F>>	Represents the metadata for a FieldTypes.DERIVED field component.
interface	DerivedSelectField<F extends DerivedSelectField<F>>	Represents the metadata for a FieldTypes.DERIVED_ENUM field component that is built as a derived version of a SelectField.
interface	DerivedUrlField<F extends DerivedUrlField<F>>	Represents the metadata for a FieldTypes.DERIVED_URL field component.
interface	DynamicField<F extends DynamicField<F>>	Represents the metadata for a FieldTypes.DYNAMIC field.
interface	FieldArrayBlockField<F extends FieldArrayBlockField<F>>	Represents the metadata for a FieldTypes.FIELD_ARRAY_BLOCK field.
interface	FieldArrayField<F extends FieldArrayField<F>>	Represents the metadata for an array of fields.
interface	FieldArrayGridField<F extends FieldArrayGridField<F>>	Represents the metadata for a FieldTypes.FIELD_ARRAY_GRID field.
interface	FileInputField<F extends FileInputField<F>>	The field that is used to select the file.
interface	IntegerField<F extends IntegerField<F>>
interface	LookupField<F extends LookupField<F>>	Represents the metadata for a FieldTypes.LOOKUP field.
interface	LookupFieldModal<V extends LookupFieldModal<V>>	Represents the metadata for the modal used by LookupField.
interface	MoneyField<F extends MoneyField<F>>	Represents the metadata for a FieldTypes.MONEY field component.
interface	PhoneField<F extends PhoneField<F>>	Represents the metadata for a FieldTypes.PHONE field.
interface	QueryBuilderField<F extends QueryBuilderField<F>>
interface	ResidentGridField<F extends ResidentGridField<F>>	Represents the metadata for a resident grid field component.
interface	ResidentMapField<F extends ResidentMapField<F>>
interface	RuleBuilderField<F extends RuleBuilderField<F>>
interface	SelectField<F extends SelectField<F>>	Represents the metadata for a select field within a form.

Classes in com.broadleafcommerce.metadata.dsl.core.extension.fields that implement Component

Modifier and Type	Class	Description
class	AbstractField<F extends AbstractField<F>>	The abstract field component specification.
class	DefaultCustomAttributesGridField
class	DefaultDateField	The default implementation for DateField.
class	DefaultDerivedField
class	DefaultDerivedSelectField
class	DefaultDerivedUrlField
class	DefaultDynamicField
class	DefaultField
class	DefaultFieldArrayBlockField
class	DefaultFieldArrayGridField
class	DefaultFileInputField	The default implementation for FileInputField.
class	DefaultIntegerField
class	DefaultLookupField
class	DefaultLookupFieldModal
class	DefaultMoneyField
class	DefaultPhoneField
class	DefaultQueryBuilderField
class	DefaultResidentGridField
class	DefaultResidentMapField
class	DefaultRuleBuilderField
class	DefaultSelectField

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.grids

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.grids

Modifier and Type	Interface	Description
interface	ExportHistoryGrid<G extends ExportHistoryGrid<G>>	The grid to display the export history.

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.groups

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.groups

Modifier and Type	Interface	Description
interface	CollapsibleGroup<G extends CollapsibleGroup<G>>
interface	ControlGroup<G extends ControlGroup<G>>
interface	InlineGroup<G extends InlineGroup<G>>	TThis group is used to render the components in one line.
interface	LinkGroup<G extends LinkGroup<G>>

Classes in com.broadleafcommerce.metadata.dsl.core.extension.groups that implement Component

Modifier and Type	Class	Description
class	AbstractGroup<G extends AbstractGroup<G>>
class	DefaultBasicGroup
class	DefaultCollapsibleGroup
class	DefaultControlGroup
class	DefaultGroup
class	DefaultInlineGroup	The default implementation for the InlineGroup.
class	DefaultLinkGroup

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views

Modifier and Type	Interface	Description
interface	ActionView<V extends ActionView<V>>	An interface for a view that manages ActionView.ActionPlacements.PRIMARY and ActionView.ActionPlacements.SECONDARY placement Action.
interface	AugmentableView<V extends AugmentableView<V>>
interface	ExportHistoryEntityGridView<V extends ExportHistoryEntityGridView<V>>	The grid view that is used to add the export history to the EntityBrowseView.
interface	FormView<V extends FormView<V>>
interface	GridView<V extends GridView<V>>
interface	PreviewableView<V extends PreviewableView<V>>	Represents the metadata for a trackable view that supports previewing sandbox data.
interface	SelectTargetEntityFormView<V extends SelectTargetEntityFormView<V>>	Represents the metadata used for a more guided approach for setting up the form components.
interface	SelectTargetEntityGridView<V extends SelectTargetEntityGridView<V>>	This grid is used to fetch and display the entities to export.

Classes in com.broadleafcommerce.metadata.dsl.core.extension.views that implement Component

Modifier and Type	Class	Description
class	AbstractSelectTargetEntityFormView<V extends AbstractSelectTargetEntityFormView<V>>	The base class for the form view that is used for a more guided approach for setting up the form components.
class	AbstractView<V extends AbstractView<V>>
class	DefaultExportHistoryEntityGridView	The default implementation for ExportHistoryEntityGridView.
class	DefaultFormView
class	DefaultSelectTargetEntityGridView

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.browse

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.browse

Modifier and Type	Interface	Description
interface	EntityBrowseView<V extends EntityBrowseView<V>>
interface	EntityGridView<V extends EntityGridView<V>>

Classes in com.broadleafcommerce.metadata.dsl.core.extension.views.browse that implement Component

Modifier and Type	Class	Description
class	DefaultEntityBrowseView
class	DefaultEntityGridView

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.details

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.details

Modifier and Type	Interface	Description
interface	CreateEntityView<V extends CreateEntityView<V>>
interface	EntityFormView<V extends EntityFormView<V>>
interface	EntityView<V extends EntityView<V>>
interface	UpdateEntityView<V extends UpdateEntityView<V>>

Classes in com.broadleafcommerce.metadata.dsl.core.extension.views.details that implement Component

Modifier and Type	Class	Description
class	DefaultCreateEntityLongFormView
class	DefaultCreateEntityView
class	DefaultEntityFormView
class	DefaultUpdateEntityLongFormView
class	DefaultUpdateEntityView

Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.tree

Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.tree

Modifier and Type	Interface	Description
interface	TreeView<V extends TreeView<V>>	Represents the metadata for a top-level tree view.

Classes in com.broadleafcommerce.metadata.dsl.core.extension.views.tree that implement Component

Modifier and Type	Class	Description
class	DefaultTreeView

Uses of Component in com.broadleafcommerce.metadata.dsl.registry

Methods in com.broadleafcommerce.metadata.dsl.registry with type parameters of type Component

Modifier and Type	Method	Description
<T extends Component<T>> T	AbstractComponentRegistry.get(String key, Class<T> clazz)
<T extends Component<T>> T	ComponentRegistry.get(String key, Class<T> clazz)
<T extends Component<T>> T	AbstractComponentRegistry.getComponent(String id, Class<T> clazz)
<T extends Component<T>> T	ComponentRegistry.getComponent(String id, Class<T> clazz)

Methods in com.broadleafcommerce.metadata.dsl.registry that return Component

Modifier and Type	Method	Description
Component<?>	AbstractComponentRegistry.get(String id)
Component<?>	ComponentRegistry.get(String id)
Component<?>	AbstractComponentRegistry.getComponent(String id)
Component<?>	ComponentRegistry.getComponent(String id)

Methods in com.broadleafcommerce.metadata.dsl.registry that return types with arguments of type Component

Modifier and Type	Method	Description
Map<String,Component<?>>	AbstractComponentRegistry.getComponents()
Map<String,Component<?>>	ComponentRegistry.getComponents()

Methods in com.broadleafcommerce.metadata.dsl.registry with parameters of type Component

Modifier and Type	Method	Description
R	AbstractComponentRegistry.add(Component<?> component)
R	AbstractComponentRegistry.add(String id, Component<?> component)
R	ComponentRegistry.add(Component<?> component)
R	ComponentRegistry.add(String id, Component<?> component)
R	AbstractComponentRegistry.addComponent(String id, Component<?> component)
R	ComponentRegistry.addComponent(String id, Component<?> component)

Uses of Component in com.broadleafcommerce.metadata.dsl.validators

Methods in com.broadleafcommerce.metadata.dsl.validators with parameters of type Component

Modifier and Type	Method	Description
void	ComponentValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
org.springframework.validation.Errors	ComponentValidatorManager.validate(Component<?> target)	The primary method of validating a target Component and its entire component tree.
void	DefaultComponentValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
org.springframework.validation.Errors	DefaultComponentValidatorManager.validate(Component<?> target)
void	DefaultFormValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
void	DefaultGridValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
void	DefaultOrderableValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
default void	ComponentValidatorManager.validateComponent(Component<?> target, org.springframework.validation.Errors errors)	Method used to validate Component objects.

Uses of Component in com.broadleafcommerce.metadata.dsl.validators.columns

Methods in com.broadleafcommerce.metadata.dsl.validators.columns with parameters of type Component

Modifier and Type	Method	Description
void	DefaultConditionalColumnValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
void	DefaultDynamicColumnValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)

Uses of Component in com.broadleafcommerce.metadata.dsl.validators.fields

Methods in com.broadleafcommerce.metadata.dsl.validators.fields with parameters of type Component

Modifier and Type	Method	Description
void	DefaultDynamicFieldValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
void	DefaultFieldValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
void	DefaultLookupFieldValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
void	DefaultSelectFieldValidator.validate(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager)
protected void	DefaultDynamicFieldValidator.validateChildIsFieldAndHasSameName(org.springframework.validation.Errors errors, Component<?> child, DynamicField<?> parent)