Interface EntityGridView<V extends EntityGridView<V>>
- All Superinterfaces:
ActionGrid<V>
,ActionView<V>
,Comparable<V>
,Component<V>
,Copyable<V>
,CustomCssComponent<V>
,ExportGrid<V>
,FetchGrid<V>
,Filterable<V>
,FilterableGrid<V>
,Grid<V>
,GridView<V>
,ImportGrid<V>
,Pollable<V>
,Selectable<V>
,Serializable
,SortableGrid<V>
,Trackable<V>
,View<V>
- All Known Subinterfaces:
ExportHistoryEntityGridView<V>
- All Known Implementing Classes:
DefaultEntityGridView
,DefaultExportHistoryEntityGridView
public interface EntityGridView<V extends EntityGridView<V>>
extends ActionView<V>, GridView<V>, Trackable<V>, ImportGrid<V>, ExportGrid<V>
- Author:
- Nick Crum (ncrum)
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ActionGrid
ActionGrid.ActionKeys, ActionGrid.ActionPlacements
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.ActionView
ActionView.ActionKeys, ActionView.ActionPlacements
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FetchGrid
FetchGrid.EndpointTypes
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FilterableGrid
FilterableGrid.ActionKeys, FilterableGrid.Attributes, FilterableGrid.EndpointTypes, FilterableGrid.FilterKeys, FilterableGrid.FilterParams, FilterableGrid.FilterPlacements, FilterableGrid.FilterTypes
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
Grid.Attributes, Grid.Keys
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Pollable
Pollable.Attributes
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Selectable
Selectable.Attributes, Selectable.ConfigureSelectable, Selectable.SelectableTypes
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.SortableGrid
SortableGrid.Attributes, SortableGrid.Sort
Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable
Trackable.Attributes
-
Field Summary
Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent
CSS_ATTRIBUTE
-
Method Summary
Modifier and TypeMethodDescriptiondefault V
addCloneAction
(CloneModalFormAction<?> action) Configures this grid with a row-level action that provides the ability to "clone" the entity.default V
addCreateAction
(LinkAction<?> action) default V
Configures this grid with a row-level action that provides the ability to "clone" the entity.default V
createAction
(UnaryOperator<LinkAction<?>> fn) default V
default V
createLabel
(String label) default V
createLink
(Link createLink) default V
createLinkById
(String componentId) default V
createScope
(String scope) default Optional<CloneModalFormAction<?>>
Finds the clone action on this grid.default Optional<LinkAction<?>>
default CloneModalFormAction<?>
Returns the clone action on this grid.default LinkAction<?>
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ActionGrid
addGridAction, addGridAction, addGridActionGroup, addRowAction, addRowAction, findGridAction, findRowAction, getGridAction, getRowAction, gridAction, removeGridAction, removeRowAction, rowAction
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.ActionView
addPrimaryAction, addPrimaryAction, addSecondaryAction, addSecondaryAction, findPrimaryAction, findSecondaryAction, getPrimaryAction, getSecondaryAction, primaryAction, primaryAction, secondaryAction, secondaryAction
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Component
addAction, addAction, addComponent, addEndpoint, addEndpoint, apply, attribute, augmentationKey, classifier, clearConditionals, clearEndpoints, conditional, conditionals, description, description, findAction, findAction, findActions, findAttribute, findAttribute, findComponent, findComponent, findComponents, findEndpoint, findEndpoint, findEndpoint, findEndpoints, get, get, getAction, getAction, getActions, getActionsList, getAttribute, getAttribute, getAttributes, getAugmentationKey, getClassifier, getComponent, getComponent, getComponents, getComponentsList, getConditionals, getDescription, getEndpoint, getEndpoint, getEndpoints, getEndpointsList, getId, getLabel, getOrder, getScope, getType, hasAction, hasAttribute, hasComponent, hasEndpoint, id, isAugmentable, isTranslatable, label, label, notTranslatable, order, removeAction, removeAttribute, removeComponent, removeEndpoint, scope, self, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, translatable, translatable, type
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent
addCssClass, addCssClass, addCssClass, clearCssClasses, getCssClasses, removeCssClass, removeCssClass, removeCssClass
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ExportGrid
addExportGridAction, exportGridAction, removeExportGridAction
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FetchGrid
displayRefresh, findReadEndpoint, getReadEndpoint, getReadEndpointType, narrowedPaging, narrowedPaging, numberedPaging, numberedPaging, readEndpoint, readEndpoint, readScope, readUrl, readUrl, unpaged
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Filterable
implicitFilter, implicitFilters, implicitFilters
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.FilterableGrid
addAdvancedFilter, addInlineFilter, addInlineFilter, addQueryFilter, collapseFiltersByDefault, facetedSearch, fallbackEndpoint, fallbackEndpoint, fallbackScope, fallbackUrl, fallbackUrl, filterByLookup, filterByLookup, filterByQueryBuilder, filterByQueryBuilder, filterByQueryBuilder, filterByQueryBuilder, filterByQueryBuilder, filterByTextQuery, filterByTextQuery, filterByTextQuery, filterByTextQuery, filterByTextQuery, findAdvancedFilter, findFacetFilterAction, findFallbackEndpoint, findFilterByLookupFilterAction, findFilterByQueryBuilderAction, findFilterByTextQueryAction, findInlineFilter, findQueryFilter, getAdvancedFilter, getEndpointByType, getFallbackEndpoint, getFallbackEndpointType, getFilterByLookupFilterAction, getFilterByQueryBuilderAction, getFilterByTextQueryAction, getInlineFilter, getQueryFilter, isFacetedSearchEnabled, isUsingFacetedSearch, notFacetedSearch, notFilterByQueryBuilder, notFilterByQueryBuilder, notFilterByTextQuery, notFilterByTextQuery, notUseFacetedSearch, removeAdvancedFilter, removeInlineFilter, removeQueryFilter, useFacetedSearch, useFacetedSearch, usingFacetedSearch
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Grid
addColumn, addColumn, addColumn, addColumns, addRowMessage, addRowMessage, findColumn, findRowMessage, getColumn, getRowMessage, idKey, removeColumn, removeRowMessage, rowMessage
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.ImportGrid
addImportGridAction, importGridAction, importGridAction, removeImportGridAction
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Pollable
notPollable, pollable, pollable, pollable, pollableCollectionCondition, pollableCollectionConditions, pollableItemCondition, pollableItemConditions, pollableOptions, pollableOptions
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Selectable
multiPageSelectable, multiPageSelectableWithExclusions, multipleSelectable, notSelectable, selectable, selectable, selectable, selectableType, singleSelectable
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.SortableGrid
notSortable, notSortable, sortable, sortable, sortableWithDefault, sortableWithDefault
Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable
applicationTrackable, applicationTrackable, auditable, auditable, catalogTrackable, notAuditable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, notSearchGroupTrackable, profileTrackable, sandboxTrackable, searchGroupTrackable
-
Method Details
-
addCreateAction
-
createAction
-
createLink
-
createLinkById
-
createLabel
-
createLabel
-
createScope
-
getCreateAction
-
findCreateAction
-
addCloneAction
Configures this grid with a row-level action that provides the ability to "clone" the entity. The use of this action will result in a modal form being provided with any fields configured on the action. This form is typically used so that a user has the opportunity to change up a limited set of properties on the cloned entity.- Parameters:
action
- the clone action- Returns:
- this
-
cloneAction
Configures this grid with a row-level action that provides the ability to "clone" the entity. The use of this action will result in a modal form being provided with any fields configured on the action. This form is typically used so that a user has the opportunity to change up a limited set of properties on the cloned entity.- Parameters:
fn
- a function that configures the action- Returns:
- this
-
getCloneAction
Returns the clone action on this grid.- Returns:
- the clone action, if it exists
-
findCloneAction
Finds the clone action on this grid.- Returns:
- an optional with the clone action, if it exists, or empty
-