Package com.foreach.across.modules.web.resource

Class WebResource

java.lang.Object

com.foreach.across.modules.web.resource.WebResource

public class WebResource
extends Object

Represents a single entry in the WebResourceRegistry.

All constants are deliberately Strings so they can easily be used in different view layers and custom values can be added in other modules.

As of version 3.2.0 the WebResource is mainly used as a static facade for commonly used web resource types (eg. css() and javascript()) and for the global constants of default buckets. Creating instances of WebResource is deprecated and only kept for backwards compatibility.

See Also:

• WebResourceRegistry

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CSS
static final String	DATA	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
static final String	EXTERNAL	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
static final String	HEAD	Default buckets of web resources.
static final String	INLINE	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
static final String	JAVASCRIPT
static final String	JAVASCRIPT_PAGE_END
static final String	RELATIVE	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
static final String	VIEWS	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead

Constructor Summary

Constructors

Constructor	Description
WebResource(String type, String key, Object data, String location)	Deprecated. since 3.2.0- replaced by WebResourceReference

Method Summary

Modifier and Type	Method	Description
static CssWebResourceBuilder	css()	A ViewElementBuilder which generates a link or style tag, depending if inline or url is used
static CssWebResourceBuilder	css(@NonNull String url)	A ViewElementBuilder which generates a link tag
Object	getData()	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
String	getKey()	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
String	getLocation()	Deprecated.
String	getType()	Deprecated.
static JavascriptWebResourceBuilder	globalJsonData(@NonNull String key, Object data)	A ViewElementBuilder which generates a <script> element that registers the data argument as global JSON data.
boolean	hasKey()	Deprecated.
static JavascriptWebResourceBuilder	javascript()	A ViewElementBuilder which generates a script tag and can be used for inline or json
static JavascriptWebResourceBuilder	javascript(@NonNull String url)	A ViewElementBuilder which generates a script tag for external resources
static LinkWebResourceBuilder	link()	A ViewElementBuilder which generates a link tag.
static LinkWebResourceBuilder	link(@NonNull String url)	A ViewElementBuilder which generates a link tag for the url specified.
static MetaWebResourceBuilder	meta()	A ViewElementBuilder which generates a meta tag.
static MetaWebResourceBuilder	meta(@NonNull String attributeName)	A ViewElementBuilder which generates a meta tag for the attribute name.
void	setData(Object data)	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
void	setKey(String key)	Deprecated. since 3.2.0 - use css(String) or javascript(String) instead
void	setLocation(String location)	Deprecated.
void	setType(String type)	Deprecated.

Methods inherited from class java.lang.Object

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

Field Details

HEAD

public static final String HEAD

Default buckets of web resources.

See Also:

• Constant Field Values

CSS

public static final String CSS

See Also:

• Constant Field Values

JAVASCRIPT

public static final String JAVASCRIPT

See Also:

• Constant Field Values

JAVASCRIPT_PAGE_END

public static final String JAVASCRIPT_PAGE_END

See Also:

• Constant Field Values

DATA

@Deprecated
public static final String DATA

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

Used for data that should be serialized and passed to the client (usually as json).

See Also:

• Constant Field Values

INLINE

@Deprecated
public static final String INLINE

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

Inline resource - entire content

See Also:

• Constant Field Values

EXTERNAL

@Deprecated
public static final String EXTERNAL

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

External resource - usually an absolute link

See Also:

• Constant Field Values

RELATIVE

@Deprecated
public static final String RELATIVE

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

Relative to the context/controller being rendered - this is usually the default.

See Also:

• Constant Field Values

VIEWS

public static final String VIEWS

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

Embedded resource in the views directory - these usually find translated into a path using a WebResourceTranslator.

See Also:

• Constant Field Values

Constructor Details

WebResource

@Deprecated
public WebResource(String type,
 String key,
 Object data,
 String location)

Deprecated.

since 3.2.0- replaced by WebResourceReference

See Also:

• WebResourceRegistry

Method Details

hasKey

@Deprecated
public boolean hasKey()

Deprecated.

globalJsonData

public static JavascriptWebResourceBuilder globalJsonData(@NonNull
 @NonNull String key,
 Object data)

A ViewElementBuilder which generates a <script> element that registers the data argument as global JSON data. See JavascriptWebResourceBuilder.globalJsonData(String, Object) for more details.

Parameters:

key - qualified key under which to register the data

data - object that should be converted to json

Returns:

javascript element builder

javascript

public static JavascriptWebResourceBuilder javascript(@NonNull
 @NonNull String url)

A ViewElementBuilder which generates a script tag for external resources

javascript

public static JavascriptWebResourceBuilder javascript()

A ViewElementBuilder which generates a script tag and can be used for inline or json

css

public static CssWebResourceBuilder css()

A ViewElementBuilder which generates a link or style tag, depending if inline or url is used

css

public static CssWebResourceBuilder css(@NonNull
 @NonNull String url)

A ViewElementBuilder which generates a link tag

link

public static LinkWebResourceBuilder link(@NonNull
 @NonNull String url)

A ViewElementBuilder which generates a link tag for the url specified.

link

public static LinkWebResourceBuilder link()

A ViewElementBuilder which generates a link tag.

meta

public static MetaWebResourceBuilder meta(@NonNull
 @NonNull String attributeName)

A ViewElementBuilder which generates a meta tag for the attribute name.

meta

public static MetaWebResourceBuilder meta()

A ViewElementBuilder which generates a meta tag.

getKey

@Deprecated
public String getKey()

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

getType

@Deprecated
public String getType()

Deprecated.

getLocation

@Deprecated
public String getLocation()

Deprecated.

setKey

@Deprecated
public void setKey(String key)

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

setType

@Deprecated
public void setType(String type)

Deprecated.

setLocation

@Deprecated
public void setLocation(String location)

Deprecated.

getData

@Deprecated
public Object getData()

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead

setData

@Deprecated
public void setData(Object data)

Deprecated.

since 3.2.0 - use css(String) or javascript(String) instead