org.jrebirth.af.core.resource

Class Resources

java.lang.Object

org.jrebirth.af.core.resource.Resources

public final class Resources
extends Object

The class Resources is the first access point when you want to declare a resource for your application.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_SEP The class path separator.

Method Summary

Modifier and Type	Method and Description
static ColorItem	create(ColorParams colorParams) Build a color item.
static FontItem	create(FontParams fontParams) Build a font item.
static FXMLItem	create(FXMLParams fxmlParams) Build a Singleton FXML item.
static FXMLItem	create(FXMLParams fxmlParams, boolean isSingleton) Build a FXML item with according singleton parameter.
static ImageItem	create(ImageParams imageParams) Build an image item.
static MessageItem	create(Message messageParams) Build a Message item.
static <O> ParameterItem<O>	create(ObjectParameter<O> parameterParams) Build a parameter item.
static <O> ParameterItem<O>	create(String name, O defaultValue) Build a parameter item.
static StyleSheetItem	create(StyleSheetParams styleSheetParams) Build a style sheet item.
static boolean	isNotAutoRefreshParam(ResourceParams params) This utility method allow to avoid doing something if the parameter given is tahe AutoRefresh one.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEP

public static final String PATH_SEP

The class path separator.

See Also:

Constant Field Values

Method Detail

create

public static <O> ParameterItem<O> create(ObjectParameter<O> parameterParams)

Build a parameter item.

Type Parameters:

O - the type of parameterized object

Parameters:

parameterParams - the primitive values for the color

Returns:

a new fresh color item object

create

public static <O> ParameterItem<O> create(String name,
                                          O defaultValue)

Build a parameter item.

Type Parameters:

O - the type of parameterized object

Parameters:

name - the parameter unique name

defaultValue - the default object value

Returns:

a new fresh color item object

create

public static ColorItem create(ColorParams colorParams)

Build a color item.

Parameters:

colorParams - the primitive values for the color

Returns:

a new fresh color item object

create

public static FontItem create(FontParams fontParams)

Build a font item. Take care of the value used for (CoreParameters#FONT_FOLDER) which will be prepend to the font path.

Parameters:

fontParams - the primitive values for the font

Returns:

a new fresh font item object

create

public static ImageItem create(ImageParams imageParams)

Build an image item. Take care of the value used for (CoreParameters#IMAGE_FOLDER) which will be prepend to the image path.

Parameters:

imageParams - the primitive values for the image

Returns:

a new fresh image item object

create

public static StyleSheetItem create(StyleSheetParams styleSheetParams)

Build a style sheet item. Take care of the value used for (CoreParameters#STYLE_FOLDER) which will be prepend to the style sheet path.

Parameters:

styleSheetParams - the primitive values for the style sheet

Returns:

a new fresh file

create

public static FXMLItem create(FXMLParams fxmlParams)

Build a Singleton FXML item. Each call to FXMLItem.get() will return the same FXML Component instance

Parameters:

fxmlParams - the primitive values for the fxml resource

Returns:

a new fresh FXML item

create

public static FXMLItem create(FXMLParams fxmlParams,
                              boolean isSingleton)

Build a FXML item with according singleton parameter.

Parameters:

fxmlParams - the primitive values for the FXML resource

isSingleton - the flag that indicates if the FXMLCOmponent will be the same (true) or another instance (false) after each call to FXMLItem.get()

Returns:

a new fresh FXML item

create

public static MessageItem create(Message messageParams)

Build a Message item.

Parameters:

messageParams - the key of the i18n message

Returns:

a new fresh Message item

isNotAutoRefreshParam

public static boolean isNotAutoRefreshParam(ResourceParams params)

This utility method allow to avoid doing something if the parameter given is tahe AutoRefresh one.
Because this parameter is used to control how other parameters can be updated.

Parameters:

params - the ResourceParams to check

Returns:

true if the resource params is not the auto refresh parameter