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

Interface LinkExternal<E extends LinkExternal<E>>

All Superinterfaces:

Comparable<E>, Component<E>, Copyable<E>, External<E>, FormComponent<E>, Serializable

All Known Implementing Classes:

DefaultLinkExternal

public interface LinkExternal<E extends LinkExternal<E>>
extends External<E>

The external component that is used to build the HTML links.

Author:

Dima Myroniuk (dmyroniuk)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	LinkExternal.Attributes

Method Summary

Modifier and Type	Method	Description
default E	download()	The download attribute specifies that the target will be downloaded when a user clicks on the hyperlink.
default E	download(boolean download)	Specifies whether or not to download file when a user clicks on the hyperlink.
default E	href(String href)	The href attribute specifies the link's destination.
default E	target(String target)	The target attribute specifies where to open the linked document.
default E	targetBlank()	Sets the value "_blank" for the "target" attribute to open the linked document in a new window or tab.

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

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

clearReadOnlyConditionals, getReadOnlyConditionals, isReadOnly, notReadOnly, readOnly, readOnly, readOnlyConditional, readOnlyConditionals, setReadOnly, setReadOnlyConditionals

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

getHelpText, getHint, getTooltip, helpText, helpText, helpText, hidden, hidden, hint, hint, isHidden, notHidden, setHelpText, setHidden, setHint, setTooltip, tooltip, tooltip

Method Details

href

default E href(String href)

The href attribute specifies the link's destination.

Parameters:

href - the link's destination

Returns:

this component for further customization

See Also:

• https://www.w3schools.com/tags/att_a_href.asp

download

default E download()

The download attribute specifies that the target will be downloaded when a user clicks on the hyperlink. This attribute is only used if the href attribute is set.

Returns:

this component for further customization

See Also:

• https://www.w3schools.com/tags/att_a_download.asp

download

default E download(boolean download)

Specifies whether or not to download file when a user clicks on the hyperlink. This attribute is only used if the href attribute is set.

Parameters:

download - whether or not to download file

Returns:

this component for further customization

See Also:

• https://www.w3schools.com/tags/att_a_download.asp

targetBlank

default E targetBlank()

Sets the value "_blank" for the "target" attribute to open the linked document in a new window or tab.

Returns:

this component for further customization

See Also:

• https://www.w3schools.com/tags/att_a_target.asp

target

default E target(String target)

The target attribute specifies where to open the linked document. Can be set to any valid target value.

Parameters:

target - the target value

Returns:

this component for further customization

See Also:

• https://www.w3schools.com/tags/att_a_target.asp