Package com.broadleafcommerce.metadata.dsl.core.extension.views.tree

Interface TreeView<V extends TreeView<V>>

All Superinterfaces:

AugmentableView<V>, Comparable<V>, Component<V>, Copyable<V>, PreviewableView<V>, Serializable, Trackable<V>, Tree<V>, View<V>

All Known Implementing Classes:

DefaultTreeView

public interface TreeView<V extends TreeView<V>>
extends PreviewableView<V>, Trackable<V>, Tree<V>, View<V>, AugmentableView<V>

Represents the metadata for a top-level tree view. This is primarily used for managing highly hierarchical data sets such as categories.

Author:

Nick Crum (ncrum)

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.AugmentableView

AugmentableView.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.PreviewableView

PreviewableView.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable

Trackable.Attributes

Nested classes/interfaces inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.common.tree.Tree

Tree.ActionKeys, Tree.ActionPlacements, Tree.ActionTypes, Tree.Attributes, Tree.ChildrenViewTypes, Tree.EndpointTypes

Method Summary

Modifier and Type	Method	Description
default V	addCloneAction(CloneModalFormAction<?> action)	Configures this view with a secondary action that provides the ability to "clone" the entity.
default V	cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)	Same purpose as addCloneAction(CloneModalFormAction) except that this takes a function to configure the clone action rather than taking an already configured action.
default Optional<CloneModalFormAction<?>>	findCloneAction()
default CloneModalFormAction<?>	getCloneAction()

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.AugmentableView

complexAttributes, complexAttributes, notComplexAttributes

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, 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 com.broadleafcommerce.metadata.dsl.core.Copyable

copy

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.views.PreviewableView

previewPath, removePreviewPath

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.Trackable

catalogTrackable, notCatalogTrackable, notProfileTrackable, notSandboxTrackable, profileTrackable, sandboxTrackable

Methods inherited from interface com.broadleafcommerce.metadata.dsl.core.extension.common.tree.Tree

addCreateForm, addGlobalAction, addGlobalAction, addGrid, addSecondaryAction, addSecondaryAction, addUpdateForm, ancestorsListKey, createForm, createItemEndpoint, createItemEndpoint, createItemScope, createItemUrl, createItemUrl, deleteItemEndpoint, deleteItemEndpoint, deleteItemScope, deleteItemUrl, deleteItemUrl, findCreateForm, findForm, findGlobalAction, findGrid, findReadGridItemsEndpoint, findSecondaryAction, findUpdateForm, getCreateForm, getCreateItemEndpoint, getDeleteItemEndpoint, getForm, getGlobalAction, getGrid, getReadAncestorsEndpoint, getReadChildrenItemsEndpoint, getReadGridItemsEndpoint, getReadItemEndpoint, getReadRootItemsEndpoint, getSecondaryAction, getUpdateForm, getUpdateItemEndpoint, getUpdateTranslationsEndpoint, globalAction, globalAction, grid, itemDisplayNameKey, itemIdKey, itemParentIdKey, itemTypeLabel, itemTypeLabel, pageSize, readAncestorsEndpoint, readAncestorsEndpoint, readAncestorsScope, readAncestorsUrl, readAncestorsUrl, readChildrenItemsEndpoint, readChildrenItemsEndpoint, readChildrenItemsScope, readChildrenItemsUrl, readChildrenItemsUrl, readGridItemsEndpoint, readGridItemsEndpoint, readGridItemsScope, readGridItemsUrl, readGridItemsUrl, readItemEndpoint, readItemEndpoint, readItemScope, readItemUrl, readItemUrl, readRootItemsEndpoint, readRootItemsEndpoint, readRootItemsScope, readRootItemsUrl, readRootItemsUrl, secondaryAction, secondaryAction, updateForm, updateItemEndpoint, updateItemEndpoint, updateItemScope, updateItemUrl, updateItemUrl, updateTranslationsEndpoint, updateTranslationsEndpoint, updateTranslationsScope, updateTranslationsUrl, updateTranslationsUrl

Method Detail

addCloneAction

default V addCloneAction(CloneModalFormAction<?> action)

Configures this view with a secondary 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

default V cloneAction(UnaryOperator<CloneModalFormAction<?>> fn)

Same purpose as addCloneAction(CloneModalFormAction) except that this takes a function to configure the clone action rather than taking an already configured action.

Parameters:

fn - a function that configures the action

Returns:

this

getCloneAction

default CloneModalFormAction<?> getCloneAction()

findCloneAction

default Optional<CloneModalFormAction<?>> findCloneAction()