oracle.jdeveloper.webapp.facelets

Class FaceletsConfigurationHandler

java.lang.Object

oracle.jdeveloper.webapp.facelets.FaceletsConfigurationHandler

public abstract class FaceletsConfigurationHandler
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FaceletsConfigurationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
abstract boolean	addFaceletsSuffix(Project project, java.lang.String suffix, boolean makeDefault) Add the suffix to the configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS" If makeDefault is true, the suffix is prepended to the FACELETS_VIEW_MAPPINGS, so that it is returned by getDefaultFaceletsSuffix()
abstract void	configureProject(Project project) Configure the Project for Facelets
abstract java.lang.String	getDefaultFaceletsSuffix(Project project) Determine the default Facelets Suffix, as defined for the Project
abstract FaceletsConfigurationManager.FaceletsConfiguration	getFaceletsConfiguration(Context projectContext) Determine if the Project has been configured for Facelets.
abstract java.util.Collection<java.lang.String>	getFaceletsIncludedSuffixes(Project project) Get the list of suffixes configured in the configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS" and any other extensions that can be included in a facelets page such as fragments
abstract java.util.Collection<java.lang.String>	getFaceletsSuffixes(Project project) Get the list of suffixes configured in the configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS"
abstract boolean	isFaceletsFile(Project project, java.net.URL url, boolean checkDefaults) Determine if the URL is a Facelets file.
boolean	isFaceletsSuffix(Project project, java.lang.String suffix, boolean checkDefaults) Determine if the suffix corresponds to a Facelets view mapping suffix.

Methods inherited from class java.lang.Object

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

Constructor Detail

FaceletsConfigurationHandler

public FaceletsConfigurationHandler()

Method Detail

getFaceletsConfiguration

public abstract FaceletsConfigurationManager.FaceletsConfiguration getFaceletsConfiguration(Context projectContext)

Determine if the Project has been configured for Facelets.

Parameters:

projectContext -

Returns:

configureProject

public abstract void configureProject(Project project)

Configure the Project for Facelets

Parameters:

project -

addFaceletsSuffix

public abstract boolean addFaceletsSuffix(Project project,
                        java.lang.String suffix,
                        boolean makeDefault)

Add the suffix to the configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS" If makeDefault is true, the suffix is prepended to the FACELETS_VIEW_MAPPINGS, so that it is returned by getDefaultFaceletsSuffix()

Parameters:

project -

suffix -

makeDefault - if true, the suffix is prepended to the FACELETS_VIEW_MAPPINGS

getFaceletsSuffixes

public abstract java.util.Collection<java.lang.String> getFaceletsSuffixes(Project project)

Get the list of suffixes configured in the configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS"

Parameters:

project -

Returns:

getFaceletsIncludedSuffixes

public abstract java.util.Collection<java.lang.String> getFaceletsIncludedSuffixes(Project project)

Get the list of suffixes configured in the configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS" and any other extensions that can be included in a facelets page such as fragments

Parameters:

project -

Returns:

Collection of suffixes. May be null.

isFaceletsFile

public abstract boolean isFaceletsFile(Project project,
                     java.net.URL url,
                     boolean checkDefaults)

Determine if the URL is a Facelets file. Checks the URL against the prefixes and suffixes in configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS". If not present there, checks against the default Facelets Suffix If none of these match, and checkDefaults is true, then the URL is checked against the suffixes that would be added if the project is configured for default facelets by the registered FaceletsConfigurationHandlers FaceletsConfigurationHandler implementations may inspect the contents of the file to determine if the file is rendered in facelets. This is useful for fragment file types that aren't toplevel facelets so aren't wouldn't necessarily have a view mapping.

Parameters:

project -

url -

checkDefaults -

Returns:

true if the url is a facelets file

isFaceletsSuffix

public boolean isFaceletsSuffix(Project project,
                       java.lang.String suffix,
                       boolean checkDefaults)

Determine if the suffix corresponds to a Facelets view mapping suffix. Checks the suffix against the suffixes in configuration parameter "javax.faces.FACELETS_VIEW_MAPPINGS". If not present there, checks against the default Facelets Suffix If none of these match, and checkDefaults is true, then the suffix is checked against the suffixes that would be added if the project is configured for default facelets by the registered FaceletsConfigurationHandlers

Parameters:

project -

suffix -

checkDefaults -

Returns:

true if the url is a facelets file

getDefaultFaceletsSuffix

public abstract java.lang.String getDefaultFaceletsSuffix(Project project)

Determine the default Facelets Suffix, as defined for the Project

Parameters:

project -

Returns: