Package com.broadleafcommerce.metadata.dsl.core

Interface CustomCssComponent<C extends Component<C>>

All Superinterfaces:

Comparable<C>, Component<C>, Copyable<C>, Serializable

All Known Subinterfaces:

ActionGrid<G>, Column<C>, ConditionalColumn<C>, CustomAttributesGridField<F>, DateColumn<C>, DerivedColumn<C>, DynamicColumn<C>, EmbeddedListColumn<C>, EntityGridView<V>, EnumColumn<C>, ExportGrid<G>, ExportHistoryEntityGridView<V>, ExportHistoryGrid<G>, ExportHistoryGridExternal<E>, FetchGrid<G>, FieldArrayGridField<F>, FilterableGrid<G>, Grid<G>, GridExternal<E>, GridView<V>, ImportGrid<G>, LinkColumn<C>, LookupFieldModal<V>, MoneyColumn<C>, Orderable<R>, ProgressColumn<C>, ResidentGridField<F>, ResidentMapField<F>, ResourceGrid<G>, RsqlRuleColumn<C>, SelectTargetEntityGridView<V>, SortableGrid<G>, SpelRuleColumn<C>, ThumbnailColumn<C>, TreeGridView<V>

All Known Implementing Classes:

AbstractColumn, DefaultColumn, DefaultConditionalColumn, DefaultCustomAttributesGridField, DefaultDateColumn, DefaultDerivedColumn, DefaultDynamicColumn, DefaultEmbeddedListColumn, DefaultEntityGridView, DefaultEnumArrayColumn, DefaultEnumColumn, DefaultExportHistoryEntityGridView, DefaultExportHistoryGridExternal, DefaultFieldArrayGridField, DefaultGridExternal, DefaultLinkColumn, DefaultLookupFieldModal, DefaultMoneyColumn, DefaultProgressColumn, DefaultResidentGridField, DefaultResidentMapField, DefaultRSQLRuleColumn, DefaultSelectTargetEntityGridView, DefaultSpelRuleColumn, DefaultThumbnailColumn, DefaultTreeGridView

public interface CustomCssComponent<C extends Component<C>>
extends Component<C>

Component that supports adding custom CSS classes. These classes will be added to the component's element in the rendered output.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CSS_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
default C	addCssClass(String cssClass)	Add a CSS class that will be applied to the component.
default C	addCssClass(String... cssClasses)	Add multiple CSS classes that will be applied to the component.
default C	addCssClass(Collection<String> cssClasses)	Add multiple CSS classes that will be applied to the component.
default C	clearCssClasses()
default List<String>	getCssClasses()
default C	removeCssClass(String cssClass)	Remove a CSS class that was previously applied to the component.
default C	removeCssClass(String... cssClasses)	Remove multiple CSS classes that were previously applied to the component.
default C	removeCssClass(Collection<String> cssClasses)

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

copy

Field Details

CSS_ATTRIBUTE

static final String CSS_ATTRIBUTE

See Also:

• Constant Field Values

Method Details

addCssClass

default C addCssClass(String cssClass)

Add a CSS class that will be applied to the component.

Parameters:

cssClass - the CSS class to add

addCssClass

default C addCssClass(String... cssClasses)

Add multiple CSS classes that will be applied to the component.

Parameters:

cssClasses - the CSS classes to add

addCssClass

default C addCssClass(Collection<String> cssClasses)

Add multiple CSS classes that will be applied to the component.

Parameters:

cssClasses - the CSS classes to add

removeCssClass

default C removeCssClass(String cssClass)

Remove a CSS class that was previously applied to the component.

Parameters:

cssClass - the CSS class to remove

removeCssClass

default C removeCssClass(String... cssClasses)

Remove multiple CSS classes that were previously applied to the component.

Parameters:

cssClasses - the CSS classes to remove

removeCssClass

default C removeCssClass(Collection<String> cssClasses)

clearCssClasses

default C clearCssClasses()

getCssClasses

default List<String> getCssClasses()