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

java.lang.Object
  extended by 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 $
Author:
The Oracle ADF Faces Team
See Also:
ConfigurationImpl

Field Summary
static java.lang.Object BASE_DIRECTORY
          Key for the base UIX directory.
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 STYLE_SHEET_NAME
          Key for the XSS style sheet name 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 TECATE_SERVLET_URL
          Deprecated. Use IMAGE_SERVLET_URL
static java.lang.Object USER_STYLE_SHEET
          Key for the UserStyleSheetProperty.
static java.lang.Object XML_PROVIDER
          Key for the XMLProvider property.
 
Constructor Summary
Configuration(java.lang.String name)
          Create a Configuration with a name.
 
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, clients should not need to disable these optimizations. However, clients that want to disable this functionality for testing or debugging purposes can do so by setting this property to Boolean.TRUE.

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

STYLE_SHEET_NAME

public static final java.lang.Object STYLE_SHEET_NAME
Key for the XSS style sheet name property. Any value registered here will be used as the default stylesheet for all UIX projects. The stylesheet will be looked for in the directory specified by the STYLES_DIRECTORY key.


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.


TECATE_SERVLET_URL

@Deprecated
public static final java.lang.Object TECATE_SERVLET_URL
Deprecated. Use IMAGE_SERVLET_URL
Key used to specify the URL location of the ImageServlet to use for image generation.


USER_STYLE_SHEET

public static final java.lang.Object USER_STYLE_SHEET
Key for the UserStyleSheetProperty. The styles defined by the UserStyleSheet instance stored are merged with styles defined by the UIX Styles StyleProvider when generating a new style sheet.

See Also:
UserStyleSheet, StyleProvider

DISABLE_STANDARDS_MODE

public static final java.lang.Object DISABLE_STANDARDS_MODE
Constructor Detail

Configuration

public Configuration(java.lang.String name)
Create a Configuration with a name. The name must be non-null. The Configuration must be registered (with the register() method) before it is used.

See Also:
#register
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.



Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.