com.foreach.across.modules.bootstrapui.elements

Class ScriptViewElement

java.lang.Object

com.foreach.across.modules.web.ui.elements.ContainerViewElement

com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

com.foreach.across.modules.bootstrapui.elements.ScriptViewElement

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.HtmlViewElement, com.foreach.across.modules.web.ui.MutableViewElement, com.foreach.across.modules.web.ui.ViewElement

public class ScriptViewElement
extends com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

Represents a <script> element. A script tag may not be safely nested, using a ScriptViewElement will ensure that any nested ScriptViewElement will get written after the original instead of inside it. In the original location a reference node with all the same non-script-specific attributes will be written instead. A special attribute data-bum-ref-id will be added holding the HTML id of the actual <script> that has been written in a valid location. Client-side you can use BootstrapUiModule.refTarget(node) on a selector to ensure you transparently fetch the actual script node.

The replacement tag written inside the original script is by default an i element with explicit hidden styling. You can use a different tag if necessary by setting it using setTagName(String).

If you really want to nest script elements, use a regular NodeViewElement instead.

Since:

2.1.1

Author:

Arne Vandamme

Nested Class Summary

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

com.foreach.across.modules.web.ui.elements.HtmlViewElement.Functions

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElement

com.foreach.across.modules.web.ui.ViewElement.Wither<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherGetter<T extends com.foreach.across.modules.web.ui.ViewElement,U>, com.foreach.across.modules.web.ui.ViewElement.WitherRemover<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherSetter<T extends com.foreach.across.modules.web.ui.ViewElement>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_REF_TAG Value to set on #setRefTagName(String) to avoid a reference tag from being written.

Fields inherited from class com.foreach.across.modules.web.ui.elements.ContainerViewElement

ELEMENT_TYPE

Constructor Summary

Constructors

Constructor and Description
ScriptViewElement()

Method Summary

Modifier and Type	Method and Description
ScriptViewElement	addAttributes(Map<String,Object> attributes)
ScriptViewElement	addChild(com.foreach.across.modules.web.ui.ViewElement element)
ScriptViewElement	addChildren(Collection<? extends com.foreach.across.modules.web.ui.ViewElement> elements)
ScriptViewElement	addCssClass(String... cssClass)
ScriptViewElement	addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)
ScriptViewElement	apply(Consumer<com.foreach.across.modules.web.ui.elements.ContainerViewElement> consumer)
<U extends com.foreach.across.modules.web.ui.ViewElement> ScriptViewElement	applyUnsafe(Consumer<U> consumer)
ScriptViewElement	clearChildren()
String	getCharset()
String	getSource()
org.springframework.http.MediaType	getType()
boolean	isAsync()
boolean	isDefer()
ScriptViewElement	remove(com.foreach.across.modules.web.ui.ViewElement.WitherRemover... functions)
ScriptViewElement	removeAttribute(String attributeName)
ScriptViewElement	removeCssClass(String... cssClass)
ScriptViewElement	set(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)
ScriptViewElement	setAsync(boolean async) Specifies that the script is executed asynchronously (only for external scripts).
ScriptViewElement	setAttribute(String attributeName, Object attributeValue)
ScriptViewElement	setAttributes(Map<String,Object> attributes)
ScriptViewElement	setCharset(String charset) Specifies the character encoding used in an external script file.
ScriptViewElement	setCustomTemplate(String customTemplate)
ScriptViewElement	setDefer(boolean defer) Specifies that the script is executed when the page has finished parsing (only for external scripts).
protected ScriptViewElement	setElementType(String elementType)
ScriptViewElement	setHtmlId(String htmlId)
ScriptViewElement	setName(String name)
ScriptViewElement	setSource(String src) Specifies the URL of an external script file.
protected ScriptViewElement	setTagName(String tagName)
ScriptViewElement	setType(@NonNull org.springframework.http.MediaType mediaType) Set the script media type.
ScriptViewElement	setType(String mediaType) Set the script media type.

Methods inherited from class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

get, getAttribute, getAttribute, getAttributes, getHtmlId, getTagName, hasAttribute, hasCssClass, returnIfType

Methods inherited from class com.foreach.across.modules.web.ui.elements.ContainerViewElement

elementStream, find, find, findAll, findAll, findAll, findOrSelf, findOrSelf, flatStream, getChildren, getCustomTemplate, getElementType, getName, hasChildren, removeAllFromTree, removeChild, removeFromTree, removeFromTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElement

getCustomTemplate, getElementType, getName, matches, predicateFor, with

Field Detail

NO_REF_TAG

public static final String NO_REF_TAG

Value to set on #setRefTagName(String) to avoid a reference tag from being written.

See Also:

Constant Field Values

Constructor Detail

ScriptViewElement

public ScriptViewElement()

Method Detail

setSource

public ScriptViewElement setSource(String src)

Specifies the URL of an external script file.

Parameters:

src - url

getSource

public String getSource()

Returns:

the URL of an external script file

setCharset

public ScriptViewElement setCharset(String charset)

Specifies the character encoding used in an external script file.

Parameters:

charset - encoding

getCharset

public String getCharset()

Returns:

the character encoding used in an external script file

setType

public ScriptViewElement setType(String mediaType)

Set the script media type.

Parameters:

mediaType - to set

setType

public ScriptViewElement setType(@NonNull
                                 @NonNull org.springframework.http.MediaType mediaType)

Set the script media type.

Parameters:

mediaType - to set

getType

public org.springframework.http.MediaType getType()

Returns:

the script media type

setAsync

public ScriptViewElement setAsync(boolean async)

Specifies that the script is executed asynchronously (only for external scripts).

Parameters:

async - true if async

isAsync

public boolean isAsync()

Returns:

true if the script is executed asynchronously (only for external scripts)

setDefer

public ScriptViewElement setDefer(boolean defer)

Specifies that the script is executed when the page has finished parsing (only for external scripts).

Parameters:

defer - true if script is deferred

isDefer

public boolean isDefer()

Returns:

true if the script is executed when the page has finished parsing (only for external scripts)

addCssClass

public ScriptViewElement addCssClass(String... cssClass)

Specified by:

addCssClass in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

addCssClass in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

removeCssClass

public ScriptViewElement removeCssClass(String... cssClass)

Specified by:

removeCssClass in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

removeCssClass in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setAttributes

public ScriptViewElement setAttributes(Map<String,Object> attributes)

Specified by:

setAttributes in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

setAttributes in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setAttribute

public ScriptViewElement setAttribute(String attributeName,
                                      Object attributeValue)

Specified by:

setAttribute in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

setAttribute in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

addAttributes

public ScriptViewElement addAttributes(Map<String,Object> attributes)

Specified by:

addAttributes in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

addAttributes in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

removeAttribute

public ScriptViewElement removeAttribute(String attributeName)

Specified by:

removeAttribute in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

removeAttribute in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setName

public ScriptViewElement setName(String name)

Specified by:

setName in interface com.foreach.across.modules.web.ui.MutableViewElement

Overrides:

setName in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setCustomTemplate

public ScriptViewElement setCustomTemplate(String customTemplate)

Specified by:

setCustomTemplate in interface com.foreach.across.modules.web.ui.MutableViewElement

Overrides:

setCustomTemplate in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setElementType

protected ScriptViewElement setElementType(String elementType)

Overrides:

setElementType in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

addChild

public ScriptViewElement addChild(com.foreach.across.modules.web.ui.ViewElement element)

Overrides:

addChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

addChildren

public ScriptViewElement addChildren(Collection<? extends com.foreach.across.modules.web.ui.ViewElement> elements)

Overrides:

addChildren in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

addFirstChild

public ScriptViewElement addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)

Overrides:

addFirstChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

clearChildren

public ScriptViewElement clearChildren()

Overrides:

clearChildren in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

apply

public ScriptViewElement apply(Consumer<com.foreach.across.modules.web.ui.elements.ContainerViewElement> consumer)

Overrides:

apply in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

applyUnsafe

public <U extends com.foreach.across.modules.web.ui.ViewElement> ScriptViewElement applyUnsafe(Consumer<U> consumer)

Overrides:

applyUnsafe in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setTagName

protected ScriptViewElement setTagName(String tagName)

Overrides:

setTagName in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setHtmlId

public ScriptViewElement setHtmlId(String htmlId)

Specified by:

setHtmlId in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Overrides:

setHtmlId in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

set

public ScriptViewElement set(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)

Specified by:

set in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Specified by:

set in interface com.foreach.across.modules.web.ui.MutableViewElement

Specified by:

set in interface com.foreach.across.modules.web.ui.ViewElement

Overrides:

set in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

remove

public ScriptViewElement remove(com.foreach.across.modules.web.ui.ViewElement.WitherRemover... functions)

Specified by:

remove in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement

Specified by:

remove in interface com.foreach.across.modules.web.ui.MutableViewElement

Specified by:

remove in interface com.foreach.across.modules.web.ui.ViewElement

Overrides:

remove in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement