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

Class DefaultSelectTargetEntityGridView

java.lang.Object

com.broadleafcommerce.metadata.dsl.core.AbstractComponent<V>

com.broadleafcommerce.metadata.dsl.core.extension.views.AbstractView<DefaultSelectTargetEntityGridView>

com.broadleafcommerce.metadata.dsl.core.extension.views.DefaultSelectTargetEntityGridView

All Implemented Interfaces:

Component<DefaultSelectTargetEntityGridView>, Copyable<DefaultSelectTargetEntityGridView>, CustomCssComponent<DefaultSelectTargetEntityGridView>, FetchGrid<DefaultSelectTargetEntityGridView>, Filterable<DefaultSelectTargetEntityGridView>, FilterableGrid<DefaultSelectTargetEntityGridView>, Grid<DefaultSelectTargetEntityGridView>, Selectable<DefaultSelectTargetEntityGridView>, SortableGrid<DefaultSelectTargetEntityGridView>, Trackable<DefaultSelectTargetEntityGridView>, SelectTargetEntityGridView<DefaultSelectTargetEntityGridView>, View<DefaultSelectTargetEntityGridView>, Serializable, Comparable<DefaultSelectTargetEntityGridView>

public class DefaultSelectTargetEntityGridView
extends AbstractView<DefaultSelectTargetEntityGridView>
implements SelectTargetEntityGridView<DefaultSelectTargetEntityGridView>

Author:

Dima Myroniuk (dmyroniuk)

See Also:

• Serialized Form

Nested Class Summary

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.EndpointTypes, FilterableGrid.FilterKeys, FilterableGrid.FilterParams, FilterableGrid.FilterPlacements, FilterableGrid.FilterTypes

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

Grid.Keys

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

Selectable.ConfigureSelectable, Selectable.SelectableTypes

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

SelectTargetEntityGridView.ActionIds, SelectTargetEntityGridView.Attributes, SelectTargetEntityGridView.ComponentIds

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

SortableGrid.Sort

Field Summary

Fields inherited from interface com.broadleafcommerce.metadata.dsl.core.CustomCssComponent

CSS_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
DefaultSelectTargetEntityGridView()
DefaultSelectTargetEntityGridView(DefaultSelectTargetEntityGridView targetEntityGridView)
DefaultSelectTargetEntityGridView(String type)

Method Summary

Modifier and Type	Method	Description
DefaultSelectTargetEntityGridView	copy()
ExplanatoryMessage	getHelpText()	Additional information that can be displayed from a clickable popup from a (?) or (!) icon displaying next to the component
InternationalizedMessage	getHint()	Displays as text next to the field with information about how a user should fill it out.
void	setHelpText(ExplanatoryMessage helpText)
void	setHint(InternationalizedMessage hint)

Methods inherited from class com.broadleafcommerce.metadata.dsl.core.AbstractComponent

canEqual, compareTo, equals, getActions, getAttributes, getAugmentationKey, getClassifier, getComponents, getConditionals, getDescription, getEndpoints, getId, getLabel, getOrder, getScope, getType, hashCode, isTranslatable, setActions, setAttributes, setAugmentationKey, setClassifier, setComponents, setConditionals, setDescription, setEndpoints, setId, setLabel, setOrder, setScope, setTranslatable, setType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.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.Selectable

multiPageSelectable, multiPageSelectableWithExclusions, multipleSelectable, notSelectable, selectable, selectable, selectable, selectableType, singleSelectable

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

filterTargetEntities, filterTargetEntitiesField, helpText, helpText, helpText, hint, hint, passFilterStringAsParam, readTargetEntitiesEndpoint, selectCatalogFieldLabel, selectCatalogFieldPlaceholder, selectSandboxFieldLabel, selectSandboxFieldPlaceholder

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

Constructor Details

DefaultSelectTargetEntityGridView

public DefaultSelectTargetEntityGridView()

DefaultSelectTargetEntityGridView

public DefaultSelectTargetEntityGridView(String type)

DefaultSelectTargetEntityGridView

public DefaultSelectTargetEntityGridView(DefaultSelectTargetEntityGridView targetEntityGridView)

Method Details

copy

public DefaultSelectTargetEntityGridView copy()

Specified by:

copy in interface Copyable<DefaultSelectTargetEntityGridView>

Returns:

a deep copy of this instance

getHelpText

public ExplanatoryMessage getHelpText()

Description copied from interface: SelectTargetEntityGridView

Additional information that can be displayed from a clickable popup from a (?) or (!) icon displaying next to the component

This value is translatable and can be a key that maps into a message bundle

Specified by:

getHelpText in interface SelectTargetEntityGridView<DefaultSelectTargetEntityGridView>

Returns:

the help text

getHint

public InternationalizedMessage getHint()

Description copied from interface: SelectTargetEntityGridView

Displays as text next to the field with information about how a user should fill it out. This is always visible when rendering the field

This value is translatable and can be a key that maps into a message bundle

Specified by:

getHint in interface SelectTargetEntityGridView<DefaultSelectTargetEntityGridView>

Returns:

the hint

setHelpText

public void setHelpText(ExplanatoryMessage helpText)

Specified by:

setHelpText in interface SelectTargetEntityGridView<DefaultSelectTargetEntityGridView>

setHint

public void setHint(InternationalizedMessage hint)

Specified by:

setHint in interface SelectTargetEntityGridView<DefaultSelectTargetEntityGridView>