com.broadleafcommerce.metadata.dsl.core.extension

Interface Selectable<S extends Selectable<S>>

All Superinterfaces:

Comparable<S>, Component<S>, Copyable<S>, Serializable

All Known Subinterfaces:

EntityGridView<V>, ExportHistoryEntityGridView<V>, ExportHistoryGridExternal<E>, GridExternal<E>, GridView<V>, Orderable<R>, SelectTargetEntityGridView<V>, TreeGridView<V>

All Known Implementing Classes:

DefaultEntityGridView, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultGridExternal, DefaultSelectTargetEntityGridView, DefaultTreeGridView

public interface Selectable<S extends Selectable<S>>
extends Component<S>

An interface implemented by components that intend to support selectable behavior.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Selectable.Attributes
static interface	Selectable.ConfigureSelectable A functional interface to provide a functional entry-point to Selectable.
static class	Selectable.SelectableTypes

Method Summary

Modifier and Type	Method and Description
default S	multiPageSelectable() Configure the component with multi-page selection behavior.
default S	multiPageSelectableWithExclusions() Configure the component with multi-page selection with exclusions behavior.
default S	multipleSelectable() Configure the component with multiple selection behavior.
default S	notSelectable() Disabled selectable behavior for the component.
default S	selectable() Configure the component with the default selectable behavior, i.e.
default S	selectable(boolean isSelectable) Sets whether or not the component supports selectable behavior.
default S	selectable(Selectable.ConfigureSelectable fn) Configure selection behavior for the component.
default S	selectableType(String selectableType) Sets the selectable type to indicate the type of selectable behavior supported.
default S	singleSelectable() Configure the component with single selection behavior.

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, findComponent, findComponent, findComponents, 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 java.lang.Comparable

compareTo

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Method Detail

selectable

default S selectable(Selectable.ConfigureSelectable fn)

Configure selection behavior for the component. This is generally used with a lambda function, for example:

 grid.selectable(selectable -> selectable.multipleSelection());
 

Parameters:

fn - the function to configure the selectable component

Returns:

the selectable

selectable

default S selectable(boolean isSelectable)

Sets whether or not the component supports selectable behavior.

Parameters:

isSelectable - is selectable or not

Returns:

the selectable

selectable

default S selectable()

Configure the component with the default selectable behavior, i.e. single-select.

Returns:

the selectable

notSelectable

default S notSelectable()

Disabled selectable behavior for the component.

Returns:

the selectable

selectableType

default S selectableType(String selectableType)

Sets the selectable type to indicate the type of selectable behavior supported.

Parameters:

selectableType - the type, usually one of Selectable.SelectableTypes

Returns:

the configurer

singleSelectable

default S singleSelectable()

Configure the component with single selection behavior.

Returns:

the selectable

multipleSelectable

default S multipleSelectable()

Configure the component with multiple selection behavior.

Returns:

the selectable

multiPageSelectable

default S multiPageSelectable()

Configure the component with multi-page selection behavior.

Returns:

the selectable

multiPageSelectableWithExclusions

default S multiPageSelectableWithExclusions()

Configure the component with multi-page selection with exclusions behavior.

Returns:

the selectable