Uses of Interface
com.broadleafcommerce.metadata.dsl.core.Component
Packages that use Component
Package
Description
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core
Classes in com.broadleafcommerce.metadata.dsl.core with type parameters of type ComponentModifier and TypeInterfaceDescriptioninterface
Represents the metadata of a component.interface
CustomCssComponent<C extends Component<C>>
Component that supports adding custom CSS classes.Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.coreModifier and TypeInterfaceDescriptioninterface
Represents the metadata for a column component.interface
CustomCssComponent<C extends Component<C>>
Component that supports adding custom CSS classes.interface
Represents the metadata for an external form component.interface
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
Represents the metadata for grouping form components.interface
Represents the metadata for a message component.interface
Represents the metadata for a view component.Classes in com.broadleafcommerce.metadata.dsl.core that implement ComponentModifier and TypeClassDescriptionclass
AbstractComponent<C extends AbstractComponent<C>>
The abstract implementation ofComponent
.class
AbstractFormComponent<C extends AbstractFormComponent<C>>
The abstract form component implementation.Methods in com.broadleafcommerce.metadata.dsl.core with type parameters of type ComponentModifier and TypeMethodDescriptiondefault <T extends Component<T>>
Tdefault <T extends Component<T>>
TAlias forgetComponent(String, Class)
.default <T extends Component<T>>
TAction.getComponent
(String key, Class<T> clazz) default <T extends Component<T>>
TComponent.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 ComponentModifier and TypeMethodDescriptiondefault Component<?>
default Component<?>
Alias forgetComponent(String)
.default Component<?>
Action.getComponent
(String key) default Component<?>
Component.getComponent
(String key) Retrieves the component stored at the given key, if it exists.Component<?>
Endpoint.getParent()
Methods in com.broadleafcommerce.metadata.dsl.core that return types with arguments of type ComponentModifier and TypeMethodDescriptionAction.findComponent
(String key) Action.findComponent
(Predicate<Component<?>> predicate) Component.findComponent
(String key) Finds the component stored at the given key.Component.findComponent
(Predicate<Component<?>> predicate) Retrieves a single child component that matches the given predicate.default Collection<Component<?>>
Action.findComponents
(Predicate<Component<?>> predicate) Component.findComponents
(Predicate<Component<?>> predicate) Retrieves a list of child components that match the given predicate.AbstractComponent.getComponents()
Action.getComponents()
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 ComponentModifier and TypeMethodDescriptiondefault A
Action.addComponent
(String key, Component<?> component) default C
Component.addComponent
(String key, Component<?> component) Primary method of adding a child component.void
Method parameters in com.broadleafcommerce.metadata.dsl.core with type arguments of type ComponentModifier and TypeMethodDescriptiondefault A
Action.addComponents
(Map<String, ? extends Component<?>> components) Action.findComponent
(Predicate<Component<?>> predicate) Component.findComponent
(Predicate<Component<?>> predicate) Retrieves a single child component that matches the given predicate.default Collection<Component<?>>
Action.findComponents
(Predicate<Component<?>> predicate) 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 -
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extensionModifier and TypeInterfaceDescriptioninterface
ActionGrid<G extends ActionGrid<G>>
An extension ofGrid
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
Represents metadata for aFormComponent
that has dependencies on its parent form's state.interface
ExportGrid<G extends ExportGrid<G>>
An extension ofActionGrid
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
Represents the metadata for aGrid
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 aFetchGrid
that supports filtering it's records using various filter actions.interface
Represents the metadata for a component whose children are variousFormComponent
.interface
An interface representing a grid with a collection ofColumn
.interface
ImportGrid<G extends ImportGrid<G>>
An extension ofActionGrid
to represent a grid with a grid-level import action.interface
Represents the metadata for a collection component that supports re-ordering it's members.interface
PageableFetch<C extends PageableFetch<C>>
interface
An interface implemented by components that intend to support pollable behavior.interface
ResourceGrid<G extends ResourceGrid<G>>
Represents the metadata of aActionGrid
andFetchGrid
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
-
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 ComponentMethod parameters in com.broadleafcommerce.metadata.dsl.core.extension.actions with type arguments of type ComponentModifier and TypeMethodDescriptionvoid
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.columnsModifier and TypeInterfaceDescriptioninterface
ConditionalColumn<C extends ConditionalColumn<C>>
Deprecated.interface
DateColumn<C extends DateColumn<C>>
interface
DerivedColumn<C extends DerivedColumn<C>>
Represents the metadata for aColumnTypes.DERIVED
column component.interface
DynamicColumn<C extends DynamicColumn<C>>
Builder that is used for buildingColumnTypes.DYNAMIC
type column components.interface
EmbeddedListColumn<C extends EmbeddedListColumn<C>>
Builder that is used for buildingColumnTypes.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
RsqlRuleColumn<C extends RsqlRuleColumn<C>>
Represents the metadata for aColumnTypes.RSQL_RULE
.interface
SpelRuleColumn<C extends SpelRuleColumn<C>>
Represents the metadata for aColumnTypes.SPEL_RULE
.interface
ThumbnailColumn<C extends ThumbnailColumn<C>>
Represents the metadata for aColumnTypes.THUMBNAIL
.Classes in com.broadleafcommerce.metadata.dsl.core.extension.columns that implement ComponentModifier and TypeClassDescriptionclass
AbstractColumn<C extends AbstractColumn<C>>
The abstract column component specification.class
class
The default implementation forConditionalColumn
.class
class
class
The default implementation forDynamicColumn
.class
The default implementation forEmbeddedListColumn
.class
class
class
class
class
The default implementation forProgressColumn
.class
class
class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.common.tree
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.common.treeModifier and TypeInterfaceDescriptioninterface
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 -
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.endpoints
Methods in com.broadleafcommerce.metadata.dsl.core.extension.endpoints that return ComponentMethods in com.broadleafcommerce.metadata.dsl.core.extension.endpoints with parameters of type Component -
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.externalsModifier and TypeInterfaceDescriptioninterface
ExportHistoryGridExternal<E extends ExportHistoryGridExternal<E>>
The grid view that is used to add the export history to theUpdateEntityView
.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 ComponentModifier and TypeClassDescriptionclass
AbstractExternal<E extends AbstractExternal<E>>
The abstract external component specification.class
The default implementation forExportHistoryGridExternal
.class
class
class
The default implementation forLinkExternal
.class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals.tree
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.externals.tree -
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.fields
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.fieldsModifier and TypeInterfaceDescriptioninterface
CustomAttributesGridField<F extends CustomAttributesGridField<F>>
interface
Represents the metadata for a date picker field.interface
DerivedField<F extends DerivedField<F>>
Represents the metadata for aFieldTypes.DERIVED
field component.interface
DerivedSelectField<F extends DerivedSelectField<F>>
Represents the metadata for aFieldTypes.DERIVED_ENUM
field component that is built as a derived version of aSelectField
.interface
DerivedUrlField<F extends DerivedUrlField<F>>
Represents the metadata for aFieldTypes.DERIVED_URL
field component.interface
DynamicField<F extends DynamicField<F>>
Represents the metadata for aFieldTypes.DYNAMIC
field.interface
EnumSwitchField<F extends EnumSwitchField<F>>
Defines a type of field use to display enumerated values in a boolean-like toggle switch component.interface
FieldArrayBlockField<F extends FieldArrayBlockField<F>>
Represents the metadata for aFieldTypes.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 aFieldTypes.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 aFieldTypes.LOOKUP
field.interface
LookupFieldModal<V extends LookupFieldModal<V>>
Represents the metadata for the modal used byLookupField
.interface
MoneyField<F extends MoneyField<F>>
Represents the metadata for aFieldTypes.MONEY
field component.interface
PhoneField<F extends PhoneField<F>>
Represents the metadata for aFieldTypes.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 ComponentModifier and TypeClassDescriptionclass
AbstractField<F extends AbstractField<F>>
The abstract field component specification.class
class
The default implementation forDateField
.class
class
class
class
class
class
class
class
class
The default implementation forFileInputField
.class
class
class
class
class
class
class
class
class
class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.grids
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.gridsModifier and TypeInterfaceDescriptioninterface
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.groupsModifier and TypeInterfaceDescriptioninterface
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
Classes in com.broadleafcommerce.metadata.dsl.core.extension.groups that implement ComponentModifier and TypeClassDescriptionclass
AbstractGroup<G extends AbstractGroup<G>>
class
class
class
class
class
The default implementation for theInlineGroup
.class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.messages
Classes in com.broadleafcommerce.metadata.dsl.core.extension.messages that implement ComponentModifier and TypeClassDescriptionclass
AbstractMessage<M extends AbstractMessage<M>>
The abstract message component specification.class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.viewsModifier and TypeInterfaceDescriptioninterface
ActionView<V extends ActionView<V>>
An interface for a view that managesActionView.ActionPlacements.PRIMARY
andActionView.ActionPlacements.SECONDARY
placementAction
.interface
AugmentableView<V extends AugmentableView<V>>
interface
ExportHistoryEntityGridView<V extends ExportHistoryEntityGridView<V>>
The grid view that is used to add the export history to theEntityBrowseView
.interface
interface
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 ComponentModifier and TypeClassDescriptionclass
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
The default implementation forExportHistoryEntityGridView
.class
class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.browse
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.browseModifier and TypeInterfaceDescriptioninterface
EntityBrowseView<V extends EntityBrowseView<V>>
interface
EntityGridView<V extends EntityGridView<V>>
Classes in com.broadleafcommerce.metadata.dsl.core.extension.views.browse that implement Component -
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.details
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.detailsModifier and TypeInterfaceDescriptioninterface
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 ComponentModifier and TypeClassDescriptionclass
class
class
class
class
-
Uses of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.tree
Subinterfaces of Component in com.broadleafcommerce.metadata.dsl.core.extension.views.treeModifier and TypeInterfaceDescriptioninterface
Represents the metadata for a top-level tree view.Classes in com.broadleafcommerce.metadata.dsl.core.extension.views.tree that implement Component -
Uses of Component in com.broadleafcommerce.metadata.dsl.registry
Methods in com.broadleafcommerce.metadata.dsl.registry with type parameters of type ComponentModifier and TypeMethodDescriptiondefault <T extends Component<T>>
Tdefault <T extends Component<T>>
TComponentRegistry.getComponent
(String id, Class<T> clazz) Gets a component from the registry and casts it to the specified type.Methods in com.broadleafcommerce.metadata.dsl.registry that return ComponentModifier and TypeMethodDescriptiondefault Component<?>
Alias forComponentRegistry.getComponent(String)
.Component<?>
AbstractComponentRegistry.getComponent
(String id) Component<?>
ComponentRegistry.getComponent
(String id) Retrieves a component from the registry.Methods in com.broadleafcommerce.metadata.dsl.registry that return types with arguments of type ComponentModifier and TypeMethodDescriptionAbstractComponentRegistry.getComponents()
ComponentRegistry.getComponents()
Gets all components in the registry.Methods in com.broadleafcommerce.metadata.dsl.registry with parameters of type ComponentModifier and TypeMethodDescriptiondefault R
default R
AbstractComponentRegistry.addComponent
(String id, @NonNull Component<?> component) ComponentRegistry.addComponent
(String id, Component<?> component) Adds a component to the registry. -
Uses of Component in com.broadleafcommerce.metadata.dsl.validators
Methods in com.broadleafcommerce.metadata.dsl.validators with parameters of type ComponentModifier and TypeMethodDescriptionvoid
ComponentValidator.validate
(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager) org.springframework.validation.Errors
The primary method of validating a targetComponent
and its entire component tree.void
DefaultComponentValidator.validate
(Component<?> target, org.springframework.validation.Errors errors, ComponentValidatorManager manager) org.springframework.validation.Errors
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 validateComponent
objects. -
Uses of Component in com.broadleafcommerce.metadata.dsl.validators.columns
Methods in com.broadleafcommerce.metadata.dsl.validators.columns with parameters of type ComponentModifier and TypeMethodDescriptionvoid
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 ComponentModifier and TypeMethodDescriptionvoid
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)
DynamicColumn