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

Interface ToggleTileComponent<C extends ToggleTileComponent<C>>

All Superinterfaces:

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

All Known Implementing Classes:

DefaultToggleTileComponent

public interface ToggleTileComponent<C extends ToggleTileComponent<C>>
extends TileComponent<C>

Represents the metadata for a TileComponentTypes.TOGGLE.

Since:

Metadata Service 2.0.8, Release Train 2.3.0

Author:

Julia Lopez-Pozas (jlopezpozas)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ToggleTileComponent.Attributes
static final class	ToggleTileComponent.EndpointTypes

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

TileComponent.TileComponentAttributes

Field Summary

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

CSS_ATTRIBUTE

Method Summary

Modifier and Type	Method	Description
default Optional<Endpoint<?>>	findSubmitEndpoint()
default Endpoint<?>	getSubmitEndpoint()
default C	icon(String icon)	Sets the icon to be used for the toggle.
default C	submitEndpoint(Endpoint<?> endpoint)	Configures the submit endpoint for the toggle.
default C	submitEndpoint(UnaryOperator<Endpoint<?>> fn)	Configures the submit endpoint for the toggle.
default C	submitScope(String scope)	Configures submitEndpoint(UnaryOperator) scope.
default C	submitUrl(String url)	Configures submitEndpoint(UnaryOperator) url.
default C	submitUrl(String url, String scope)	Configures submitEndpoint(UnaryOperator) url and scope.

Methods inherited from interface java.lang.Comparable

compareTo

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

addAction, addAction, addComponent, addEndpoint, addEndpoint, addSimpleComponent, apply, attribute, augmentable, 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, getAugmentableFlag, 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, setAugmentable, 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.CustomCssComponent

addCssClass, addCssClass, addCssClass, clearCssClasses, getCssClasses, removeCssClass, removeCssClass, removeCssClass

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

getName, name, setName

Method Details

icon

default C icon(String icon)

Sets the icon to be used for the toggle.

See the Zondicons Icon list for a list of icon names available.

Parameters:

icon - the icon to be used for the toggle

Returns:

this

submitEndpoint

default C submitEndpoint(Endpoint<?> endpoint)

Configures the submit endpoint for the toggle. This endpoint is called when the tile component is clicked in order to submit using the toggle value.

Parameters:

endpoint - the submit endpoint

Returns:

this

submitEndpoint

default C submitEndpoint(UnaryOperator<Endpoint<?>> fn)

Configures the submit endpoint for the toggle. This endpoint is called when the tile component is clicked in order to submit using the toggle value.

Parameters:

fn - a function to configure the submit endpoint

Returns:

this

submitUrl

default C submitUrl(String url)

Configures submitEndpoint(UnaryOperator) url.

Returns:

this

submitScope

default C submitScope(String scope)

Configures submitEndpoint(UnaryOperator) scope.

Returns:

this

submitUrl

default C submitUrl(String url,
 String scope)

Configures submitEndpoint(UnaryOperator) url and scope.

Returns:

this

getSubmitEndpoint

default Endpoint<?> getSubmitEndpoint()

Returns:

the submit endpoint

findSubmitEndpoint

default Optional<Endpoint<?>> findSubmitEndpoint()

Returns:

an optional with submit endpoint, or empty