org.josef.web.jsf.bean

Class ApplicationSettingsBean

java.lang.Object

org.josef.web.jsf.bean.ApplicationSettingsBean

All Implemented Interfaces:

Serializable

public class ApplicationSettingsBean
extends Object
implements Serializable

Java Server Faces Application Settings bean.
Note: This class is deliberately not annotated with @ManagedBean so others can use a subclass of this class, annotate it and use applicationSettingsBean as the name of the managed bean. If it had been annotated here, a subclass would have have to use a different managed bean name.

Version:

1.0 $Revision: 5773 $

Author:

Kees Schotanus

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_SHEET_BUNDLE_VAR_NAME Resource bundle name (var name in faces-config.xml) of style sheet bundle.

Constructor Summary

Constructors

Constructor and Description
ApplicationSettingsBean()

Method Summary

Modifier and Type	Method and Description
List<javax.faces.model.SelectItem>	getSupportedLocales() Gets the supported locales as configured in faces-config.xml.
List<javax.faces.model.SelectItem>	getSupportedStyleSheets() Gets the supported style sheets.
TimeZone	getTimeZone() Gets the time zone of the server where this application is running.
String	getTimeZoneAsGmtOffset() Gets the time zone of the server where this application is running, as an offset to standard GMT (Greenwich Mean Time).
boolean	isSupportedStyleSheet(String styleSheet) Determines whether the supplied styleSheet is one of the supported style sheets.

Methods inherited from class java.lang.Object

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

Field Detail

STYLE_SHEET_BUNDLE_VAR_NAME

public static final String STYLE_SHEET_BUNDLE_VAR_NAME

Resource bundle name (var name in faces-config.xml) of style sheet bundle.

See Also:

Constant Field Values

Constructor Detail

ApplicationSettingsBean

public ApplicationSettingsBean()

Method Detail

getSupportedLocales

public List<javax.faces.model.SelectItem> getSupportedLocales()

Gets the supported locales as configured in faces-config.xml.

Returns:

The supported locales as configured in faces-config.xml..

See Also:

JsfLocaleUtil.getSupportedLocalesAsListItems()

getSupportedStyleSheets

public List<javax.faces.model.SelectItem> getSupportedStyleSheets()

Gets the supported style sheets.
Style sheets should be placed in a resource bundle with a var name of stylesheetBundle. Every style sheet should have an ordinal from 1 to 99 in this bundle like this:

 styleSheet1=blue.css
 styleSheet2=green.css

A localized label should be added for every style sheet by appending "Label" to the key like this:

 styleSheet1=blue.css
 styleSheet1Label=Ocean
 styleSheet2=green.css
 styleSheet2Label=Emerald

The first style sheet in the list is used as the default style sheet.

Returns:

The supported style sheets.
The returned list is possibly empty but it is never null!

isSupportedStyleSheet

public boolean isSupportedStyleSheet(String styleSheet)

Determines whether the supplied styleSheet is one of the supported style sheets.

Parameters:

styleSheet - The style sheet to check.

Returns:

True, when the supplied styleSheet is supported, otherwise false is returned.

Throws:

NullPointerException - When the supplied styleSheet is null.

IllegalArgumentException - When the supplied styleSheet is empty.

getTimeZoneAsGmtOffset

public String getTimeZoneAsGmtOffset()

Gets the time zone of the server where this application is running, as an offset to standard GMT (Greenwich Mean Time).
The format of the returned String is: "GMT(+|-)HH[:MM].

Returns:

The time zone as a GMT offset.

See Also:

TimeZoneUtil.getGreenwichMeanTimeOffset()

getTimeZone

public TimeZone getTimeZone()

Gets the time zone of the server where this application is running.

Returns:

The time zone of the application server where this application is running.