org.apache.myfaces.trinidadinternal.share.config
Class Configuration

java.lang.Object
  org.apache.myfaces.trinidadinternal.share.config.Configuration

Direct Known Subclasses:

ConfigurationImpl

public abstract class Configuration
extends java.lang.Object

The Configuration class and its default implementation, ConfigurationImpl, are remnant configuration classes for the UIX portions of Trinidad, and should not be used for new code.

Version:

$Name: $ ($Revision: adfrt/faces/adf-faces-impl/src/main/java/oracle/adfinternal/view/faces/share/config/Configuration.java#0 $) $Date: 10-nov-2005.19:00:18 $

See Also:

ConfigurationImpl

Field Summary

static java.lang.Object	BASE_DIRECTORY Key for the base UIX directory.
static java.lang.String	CHECK_TIMESTAMP_PARAM
static java.lang.String	DISABLE_CONTENT_COMPRESSION Disables optimizations that are normally performed by the Trinidad Renderers to reduce content size.
static java.lang.Object	DISABLE_STANDARDS_MODE
static java.lang.Object	HEADLESS Key for enabled headless rendering.
static java.lang.Object	IMAGE_SERVLET_URL Key used to specify the URL location of the ImageServlet to use for image generation.
static java.lang.Object	IMAGES_CACHE_DIRECTORY Key for the UIX image cache directory.
static java.lang.Object	IMAGES_DIRECTORY Key for the UIX images directory.
static java.lang.Object	JSLIBS_DIRECTORY Key for the UIX jsLibs directory.
static java.lang.Object	JSPS_DIRECTORY Key for the UIX JSP directory.
static java.lang.Object	LOOK_AND_FEEL_MANAGER Key for the LookAndFeelManager property.
static java.lang.Object	RENDERER_MANAGER Key for the RendererManager property.
static java.lang.Object	SKIN_FAMILY Key for the Skin family property.
static java.lang.Object	STYLES_CACHE_DIRECTORY Key for the UIX styles cache directory.
static java.lang.Object	STYLES_DIRECTORY Key for the UIX styles directory.
static java.lang.Object	XML_PROVIDER Key for the XMLProvider property.

Method Summary

abstract java.lang.String	getPath(java.lang.Object key, java.lang.String contextPath) Return a path for a UIX directory.
abstract java.lang.Object	getProperty(java.lang.Object key) Return a registered property.
abstract java.lang.String	getURI(java.lang.Object key, java.lang.String contextURI) Return a URI for a UIX directory.
abstract boolean	isDebug() Returns whether the configuration is in debug mode.

Methods inherited from class java.lang.Object

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

Field Detail

DISABLE_CONTENT_COMPRESSION

public static final java.lang.String DISABLE_CONTENT_COMPRESSION

Disables optimizations that are normally performed by the Trinidad Renderers to reduce content size.

This Boolean property controls whether or not Trinidad Renderer implementations should attempt to reduce the size of generated content, for example, by compressing style class names. These optimizations are enabled by default. In general, users should not need to disable these optimizations. However, users who want to build custom skins for Trinidad will find this setting essential. Use Boolean.TRUE to disable compression.

See Also:

Constant Field Values

CHECK_TIMESTAMP_PARAM

public static final java.lang.String CHECK_TIMESTAMP_PARAM

See Also:

Constant Field Values

BASE_DIRECTORY

public static final java.lang.Object BASE_DIRECTORY

Key for the base UIX directory.

IMAGES_DIRECTORY

public static final java.lang.Object IMAGES_DIRECTORY

Key for the UIX images directory.

IMAGES_CACHE_DIRECTORY

public static final java.lang.Object IMAGES_CACHE_DIRECTORY

Key for the UIX image cache directory.

STYLES_DIRECTORY

public static final java.lang.Object STYLES_DIRECTORY

Key for the UIX styles directory.

STYLES_CACHE_DIRECTORY

public static final java.lang.Object STYLES_CACHE_DIRECTORY

Key for the UIX styles cache directory.

JSLIBS_DIRECTORY

public static final java.lang.Object JSLIBS_DIRECTORY

Key for the UIX jsLibs directory.

JSPS_DIRECTORY

public static final java.lang.Object JSPS_DIRECTORY

Key for the UIX JSP directory. Clients must be careful when setting this parameter. When the JSPs are executed, they will attempt to use the same Configuration as the page that launched them. However, if the JSPs were launched onto a different machine, that configuration may not be available. Even if launched onto the same machine, any context-relative directories will be resolved relative to the new JSP - not the original page. Consequently, if clients set this directory to a full path/URI, they should generally set all directories to full paths.

SKIN_FAMILY

public static final java.lang.Object SKIN_FAMILY

Key for the Skin family property. The Skin family stored in this key is used to help determine the default Skin instance to use.

See Also:

org.apache.myfaces.trinidadinternal.skin.Skin

LOOK_AND_FEEL_MANAGER

public static final java.lang.Object LOOK_AND_FEEL_MANAGER

Key for the LookAndFeelManager property. The LookAndFeelManager instance stored under this key is used to choose the LookAndFeel to use.

See Also:

LookAndFeelManager

RENDERER_MANAGER

public static final java.lang.Object RENDERER_MANAGER

Key for the RendererManager property. Any UIX Components RendererManager stored at this key will be used by UIX Components's ServletRenderingContext if none is explicitly attached.

XML_PROVIDER

public static final java.lang.Object XML_PROVIDER

Key for the XMLProvider property. UIX projects will use the String, Class, or XMLProvider instance registered with this property.

HEADLESS

public static final java.lang.Object HEADLESS

Key for enabled headless rendering. The value is a Boolean object. If set to Boolean.TRUE, UIX Components will avoid any rendering which requires graphical capabilities. This means, for example, that existing cached images will be used, but new images will not be dynamically generated. Enabling headless rendering might cause a slight degradation of the UI, as elements which are best implemented as images could instead be rendered as HTML links or using table-based constructs.

IMAGE_SERVLET_URL

public static final java.lang.Object IMAGE_SERVLET_URL

Key used to specify the URL location of the ImageServlet to use for image generation.

DISABLE_STANDARDS_MODE

public static final java.lang.Object DISABLE_STANDARDS_MODE

Method Detail

getURI

public abstract java.lang.String getURI(java.lang.Object key,
                                        java.lang.String contextURI)

Return a URI for a UIX directory.

Parameters:

key - the key used to identify the directory

contextURI - the current contextURI; this will be preprended to the returned URI if this directory is registered as (or defaulting to) context-relative. This path must not be terminated with a separator ("/").

Returns:

a URI, which will always be terminated with a separator

Throws:

DirectoryUnavailableException - if the directory is unavailable

getPath

public abstract java.lang.String getPath(java.lang.Object key,
                                         java.lang.String contextPath)

Return a path for a UIX directory.

Parameters:

key - the key used to identify the directory

contextPath - the current context path; this will be preprended to the returned path if this directory is registered as (or defaulting to) context-relative.

Returns:

a full file system path, which will always be terminated with the appropriate separator for the file system

Throws:

DirectoryUnavailableException - if the directory is unavailable

getProperty

public abstract java.lang.Object getProperty(java.lang.Object key)

Return a registered property.

Parameters:

key - the key used to identify the property

Returns:

the registered object, or null if no object was registered.

isDebug

public abstract boolean isDebug()

Returns whether the configuration is in debug mode.