org.jrebirth.af.core.resource.image

Class WebImage

java.lang.Object

org.jrebirth.af.core.resource.AbstractBaseParams

org.jrebirth.af.core.resource.image.AbstractBaseImage

org.jrebirth.af.core.resource.image.WebImage

All Implemented Interfaces:

ImageParams, ResourceParams

public class WebImage
extends AbstractBaseImage
implements ImageParams

The interface LocalImage.

Author:

Sébastien Bordes

Property Summary

Type	Property and Description
BooleanProperty	secured Return the secured property.
StringProperty	website Return the website property.

Properties inherited from class org.jrebirth.af.core.resource.image.AbstractBaseImage

extensionProperty, nameProperty, pathProperty

Field Summary

Fields inherited from interface org.jrebirth.af.api.resource.ResourceParams

PARAMETER_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
WebImage(String website, boolean secured, String path, String name, ImageExtension extension) Default Constructor.
WebImage(String website, String path, String name, ImageExtension extension) Default Constructor.

Method Summary

Modifier and Type	Method and Description
protected List<? extends Object>	getFieldValues() Return all values of ParameterEntry object.
String	getUrl() Build the image url.
void	parse(String... parameters) Parse a string to initialize fields.
Boolean	secured() Return the secured flag.
BooleanProperty	securedProperty() Return the secured property.
String	website() Return the website base url.
StringProperty	websiteProperty() Return the website property.

Methods inherited from class org.jrebirth.af.core.resource.image.AbstractBaseImage

backgroundLoading, extension, extensionProperty, name, nameProperty, path, pathProperty, preserveRatio, requestedHeight, requestedWidth, smooth

Methods inherited from class org.jrebirth.af.core.resource.AbstractBaseParams

activateAutoRefresh, equals, getKey, hasChanged, hasChanged, hashCode, readBoolean, readDouble, readInteger, setKey, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jrebirth.af.api.resource.image.ImageParams

extension, name, path

Methods inherited from interface org.jrebirth.af.api.resource.ResourceParams

activateAutoRefresh, getKey, hasChanged, hasChanged, setKey

Property Detail

website

public StringProperty websiteProperty

Return the website property.

secured

public BooleanProperty securedProperty

Return the secured property.

Constructor Detail

WebImage

public WebImage(String website,
                String path,
                String name,
                ImageExtension extension)

Default Constructor.

Parameters:

website - the website base url

path - the path of the image to load

name - the image file name to use.

extension - the image extension to use

WebImage

public WebImage(String website,
                boolean secured,
                String path,
                String name,
                ImageExtension extension)

Default Constructor.

Parameters:

website - the website base url

secured - the http protocol to use (http or https)

path - the path of the image to load

name - the image file name to use.

extension - the image extension to use

Method Detail

website

public String website()

Return the website base url.

Returns:

the website

websiteProperty

public StringProperty websiteProperty()

Return the website property.

secured

public Boolean secured()

Return the secured flag.

Returns:

the secured

securedProperty

public BooleanProperty securedProperty()

Return the secured property.

getUrl

public String getUrl()

Build the image url.

Returns:

the full image url string

parse

public void parse(String... parameters)

Parse a string to initialize fields.

Specified by:

parse in interface ResourceParams

Parameters:

parameters - split from resource properties file

getFieldValues

protected List<? extends Object> getFieldValues()

Return all values of ParameterEntry object.

Specified by:

getFieldValues in class AbstractBaseParams

Returns:

the list of parameters describing the resource to build