You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by lu...@apache.org on 2011/08/11 21:50:32 UTC
svn commit: r1156777 - in /myfaces/core/trunk:
api/src/main/java/javax/faces/application/
api/src/main/java/javax/faces/component/
api/src/main/java/javax/faces/webapp/
impl/src/main/java/org/apache/myfaces/config/annotation/
impl/src/main/java/org/apa...
Author: lu4242
Date: Thu Aug 11 19:50:32 2011
New Revision: 1156777
URL: http://svn.apache.org/viewvc?rev=1156777&view=rev
Log:
MYFACES-3273 Create a better site layout for myfaces project
Added:
myfaces/core/trunk/impl/src/main/resources/META-INF/xdoc-web-config.vm
Modified:
myfaces/core/trunk/api/src/main/java/javax/faces/application/ResourceHandler.java
myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java
myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java
myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java
myfaces/core/trunk/api/src/main/java/javax/faces/webapp/PreJsf2ExceptionHandlerFactory.java
myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultAnnotationProvider.java
myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java
myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/ServerSideStateCacheImpl.java
myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/html/HtmlResponseStateManager.java
myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java
myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/application/ResourceHandler.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/application/ResourceHandler.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/application/ResourceHandler.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/application/ResourceHandler.java Thu Aug 11 19:50:32 2011
@@ -35,6 +35,9 @@ public abstract class ResourceHandler
public static final String LOCALE_PREFIX = "javax.faces.resource.localePrefix";
public static final String RESOURCE_EXCLUDES_DEFAULT_VALUE = ".class .jsp .jspx .properties .xhtml .groovy";
+ /**
+ * Space separated file extensions that will not be served by the default ResourceHandler implementation.
+ */
@JSFWebConfigParam(defaultValue=".class .jsp .jspx .properties .xhtml .groovy",since="2.0")
public static final String RESOURCE_EXCLUDES_PARAM_NAME = "javax.faces.RESOURCE_EXCLUDES";
public static final String RESOURCE_IDENTIFIER = "/javax.faces.resource";
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/application/StateManager.java Thu Aug 11 19:50:32 2011
@@ -76,15 +76,27 @@ public abstract class StateManager
* token is embedded in the data rendered to the user.
* </p>
*/
- @JSFWebConfigParam(defaultValue="server", expectedValues="server,client", since="1.1")
+ @JSFWebConfigParam(defaultValue="server", expectedValues="server,client", since="1.1",
+ desc="Define the state method to be used. There are two different options defined by the specification: 'client' and 'server' state.")
public static final String STATE_SAVING_METHOD_PARAM_NAME = "javax.faces.STATE_SAVING_METHOD";
public static final String STATE_SAVING_METHOD_CLIENT = "client";
public static final String STATE_SAVING_METHOD_SERVER = "server";
+ /**
+ * Indicate the viewId(s) separated by commas that should be saved and restored fully, without use Partial State Saving (PSS).
+ */
@JSFWebConfigParam(since="2.0")
public static final String FULL_STATE_SAVING_VIEW_IDS_PARAM_NAME = "javax.faces.FULL_STATE_SAVING_VIEW_IDS";
- @JSFWebConfigParam(expectedValues="true,false", since="2.0")
+ /**
+ * Enable or disable partial state saving algorithm.
+ *
+ * <p>Partial State Saving algorithm allows to reduce the size of the state required to save a view,
+ * keeping track of the "delta" or differences between the view build by first time and the current
+ * state of the view.</p>
+ * <p>If the webapp faces-config file version is 2.0 or upper the default value is true, otherwise is false.</p>
+ */
+ @JSFWebConfigParam(expectedValues="true,false", since="2.0", defaultValue="true (false with 1.2 webapps)")
public static final String PARTIAL_STATE_SAVING_PARAM_NAME = "javax.faces.PARTIAL_STATE_SAVING";
private Boolean _savingStateInClient = null;
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/application/ViewHandler.java Thu Aug 11 19:50:32 2011
@@ -74,14 +74,21 @@ public abstract class ViewHandler
public static final String DEFAULT_SUFFIX = ".xhtml .view.xml .jsp";
/**
- * Indicate the default suffix to derive the file URI if extension mapping is used.
+ * Indicate the default suffixes, separated by spaces to derive the default file URI
+ * used by JSF to create views and render pages.
*/
- @JSFWebConfigParam(defaultValue=".xhtml .jsp", since="1.1")
+ @JSFWebConfigParam(defaultValue=".xhtml .view.xml .jsp", since="1.1")
public static final String DEFAULT_SUFFIX_PARAM_NAME = "javax.faces.DEFAULT_SUFFIX";
+ /**
+ * The default extension used to handle facelets pages.
+ */
@JSFWebConfigParam(defaultValue=".xhtml", since="2.0")
public static final String FACELETS_SUFFIX_PARAM_NAME = "javax.faces.FACELETS_SUFFIX";
+ /**
+ * Set of extensions handled by facelets, separated by ';'.
+ */
@JSFWebConfigParam(since="2.0")
public static final String FACELETS_VIEW_MAPPINGS_PARAM_NAME = "javax.faces.FACELETS_VIEW_MAPPINGS";
// TODO: Notify EG on that last constant. Using the Facelets' param as well for backward compatiblity is
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/component/UIInput.java Thu Aug 11 19:50:32 2011
@@ -70,13 +70,18 @@ public class UIInput extends UIOutput im
public static final String REQUIRED_MESSAGE_ID = "javax.faces.component.UIInput.REQUIRED";
public static final String UPDATE_MESSAGE_ID = "javax.faces.component.UIInput.UPDATE";
+ /**
+ * Force validation on empty fields (By default is auto, which means it is only
+ * enabled when Bean Validation binaries are available on the current classpath).
+ */
@JSFWebConfigParam(defaultValue="auto", expectedValues="auto, true, false", since="2.0")
public static final String VALIDATE_EMPTY_FIELDS_PARAM_NAME = "javax.faces.VALIDATE_EMPTY_FIELDS";
- /** -=Leonardo Uribe =- According to http://wiki.java.net/bin/view/Projects/Jsf2MR1ChangeLog
- * this constant will be made public on 2.1. For now, since this param is handled in
- * 2.0, we should do it as well.
- **/
+ /**
+ * Submitted values are decoded as null values instead empty strings.
+ *
+ * <p>Note this param is ignored for components extending from UISelectOne/UISelectMany.</p>
+ **/
@JSFWebConfigParam(defaultValue="false", expectedValues="true, false", since="2.0")
private static final String EMPTY_VALUES_AS_NULL_PARAM_NAME = "javax.faces.INTERPRET_EMPTY_STRING_SUBMITTED_VALUES_AS_NULL";
Modified: myfaces/core/trunk/api/src/main/java/javax/faces/webapp/PreJsf2ExceptionHandlerFactory.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/api/src/main/java/javax/faces/webapp/PreJsf2ExceptionHandlerFactory.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/api/src/main/java/javax/faces/webapp/PreJsf2ExceptionHandlerFactory.java (original)
+++ myfaces/core/trunk/api/src/main/java/javax/faces/webapp/PreJsf2ExceptionHandlerFactory.java Thu Aug 11 19:50:32 2011
@@ -95,7 +95,7 @@ public class PreJsf2ExceptionHandlerFact
* </ul>
* Furthermore, the init parameter only works when using the PreJsf2ExceptionHandlerFactory.
*/
- @JSFWebConfigParam(since="1.2.4")
+ @JSFWebConfigParam(since="1.2.4",desc="Deprecated: use JSF 2.0 ExceptionHandler")
private static final String ERROR_HANDLER_PARAMETER = "org.apache.myfaces.ERROR_HANDLER";
private Queue<ExceptionQueuedEvent> handled;
Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultAnnotationProvider.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultAnnotationProvider.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultAnnotationProvider.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/config/annotation/DefaultAnnotationProvider.java Thu Aug 11 19:50:32 2011
@@ -65,8 +65,8 @@ public class DefaultAnnotationProvider e
private static final Logger log = Logger.getLogger(DefaultAnnotationProvider.class.getName());
/**
- * <p> Servlet context init parameter which defines which packages to scan
- * for beans, separated by commas.</p>
+ * Servlet context init parameter which defines which packages to scan
+ * for beans, separated by commas.
*/
@JSFWebConfigParam(since="2.0")
public static final String SCAN_PACKAGES = "org.apache.myfaces.annotation.SCAN_PACKAGES";
Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/el/unified/ResolverBuilderBase.java Thu Aug 11 19:50:32 2011
@@ -47,7 +47,7 @@ public class ResolverBuilderBase
private static final Logger log = Logger.getLogger(ResolverBuilderBase.class.getName());
@JSFWebConfigParam(since = "1.2.10, 2.0.2",
- desc = "The Class of an Comparator<ELResolver> implementation.")
+ desc = "The Class of an Comparator<ELResolver> implementation.")
public static final String EL_RESOLVER_COMPARATOR = "org.apache.myfaces.EL_RESOLVER_COMPARATOR";
@JSFWebConfigParam(since = "2.1.0",
Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/ServerSideStateCacheImpl.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/ServerSideStateCacheImpl.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/ServerSideStateCacheImpl.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/ServerSideStateCacheImpl.java Thu Aug 11 19:50:32 2011
@@ -63,17 +63,21 @@ class ServerSideStateCacheImpl extends S
ServerSideStateCacheImpl.class.getName() + ".RESTORED_VIEW_KEY";
/**
- * Only applicable if state saving method is "server" (= default).
* Defines the amount (default = 20) of the latest views are stored in session.
+ *
+ * <p>Only applicable if state saving method is "server" (= default).
+ * </p>
+ *
*/
@JSFWebConfigParam(defaultValue="20",since="1.1")
private static final String NUMBER_OF_VIEWS_IN_SESSION_PARAM = "org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION";
/**
- * Only applicable if state saving method is "server" (= default).
* Indicates the amount of views (default is not active) that should be stored in session between sequential
- * POST or POST-REDIRECT-GET if org.apache.myfaces.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION is true.
- * <p>For example, if this param has value = 2 and in your custom webapp there is a form that is clicked 3 times, only 2 views
+ * POST or POST-REDIRECT-GET if org.apache.myfaces.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION is true.
+ *
+ * <p>Only applicable if state saving method is "server" (= default). For example, if this param has value = 2 and
+ * in your custom webapp there is a form that is clicked 3 times, only 2 views
* will be stored and the third one (the one stored the first time) will be removed from session, even if the view can
* store more sessions org.apache.myfaces.NUMBER_OF_VIEWS_IN_SESSION. This feature becomes useful for multi-window applications.
* where without this feature a window can swallow all view slots so the other ones will throw ViewExpiredException.</p>
@@ -87,14 +91,19 @@ class ServerSideStateCacheImpl extends S
private static final int DEFAULT_NUMBER_OF_VIEWS_IN_SESSION = 20;
/**
+ * Indicate if the state should be serialized before save it on the session.
+ * <p>
* Only applicable if state saving method is "server" (= default).
* If <code>true</code> (default) the state will be serialized to a byte stream before it is written to the session.
* If <code>false</code> the state will not be serialized to a byte stream.
+ * </p>
*/
@JSFWebConfigParam(defaultValue="true",since="1.1")
private static final String SERIALIZE_STATE_IN_SESSION_PARAM = "org.apache.myfaces.SERIALIZE_STATE_IN_SESSION";
/**
+ * Indicates that the serialized state will be compressed before it is written to the session. By default true.
+ *
* Only applicable if state saving method is "server" (= default) and if <code>org.apache.myfaces.SERIALIZE_STATE_IN_SESSION</code> is <code>true</code> (= default).
* If <code>true</code> (default) the serialized state will be compressed before it is written to the session.
* If <code>false</code> the state will not be compressed.
@@ -154,10 +163,12 @@ class ServerSideStateCacheImpl extends S
private static final String CACHE_OLD_VIEWS_IN_SESSION_MODE_OFF = "off";
/**
- * Only applicable if state saving method is "server" (= default).
* Allow use flash scope to keep track of the views used in session and the previous ones,
- * so server side state saving can delete old views even if POST-REDIRECT-GET pattern is used.
- * The default value is false.
+ * so server side state saving can delete old views even if POST-REDIRECT-GET pattern is used.
+ *
+ * <p>
+ * Only applicable if state saving method is "server" (= default).
+ * The default value is false.</p>
*/
@JSFWebConfigParam(since="2.0.6", defaultValue="false", expectedValues="true, false")
private static final String USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION = "org.apache.myfaces.USE_FLASH_SCOPE_PURGE_VIEWS_IN_SESSION";
Modified: myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/html/HtmlResponseStateManager.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/html/HtmlResponseStateManager.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/html/HtmlResponseStateManager.java (original)
+++ myfaces/core/trunk/impl/src/main/java/org/apache/myfaces/renderkit/html/HtmlResponseStateManager.java Thu Aug 11 19:50:32 2011
@@ -55,6 +55,14 @@ public class HtmlResponseStateManager ex
public static final String STANDARD_STATE_SAVING_PARAM = "javax.faces.ViewState";
+ /**
+ * Define if the state caching code should be handled by the ResponseStateManager or by the StateManager used.
+ * <p>
+ * This param is used to keep compatibility with previous state managers implementations depending from old myfaces
+ * way to deal with this. For example, JspStateManagerImpl requires this param set to false, but by default
+ * it is set to true, to keep aligned with the Reference Implementation (RI).
+ * </p>
+ */
@JSFWebConfigParam(since="2.0.6", expectedValues="true, false", defaultValue="true")
public static final String INIT_PARAM_HANDLE_STATE_CACHING_MECHANICS = "org.apache.myfaces.HANDLE_STATE_CACHING_MECHANICS";
Added: myfaces/core/trunk/impl/src/main/resources/META-INF/xdoc-web-config.vm
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/impl/src/main/resources/META-INF/xdoc-web-config.vm?rev=1156777&view=auto
==============================================================================
--- myfaces/core/trunk/impl/src/main/resources/META-INF/xdoc-web-config.vm (added)
+++ myfaces/core/trunk/impl/src/main/resources/META-INF/xdoc-web-config.vm Thu Aug 11 19:50:32 2011
@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<document>
+ <properties>
+ <title>Web Context Parameters</title>
+ </properties>
+ <body>
+ <section name="Web Context Parameters">
+ <p>
+ MyFaces core behavior can be customized, adding some web config params into your
+ WEB-INF/web.xml file for your custom project in this way:
+ </p>
+ <div class="source"><pre>
+ <context-param>
+ <param-name>org.apache.myfaces.SOME_USEFUL_PARAM</param-name>
+ <param-value>someValue</param-value>
+ </context-param>
+ </pre></div>
+ <p>
+ Below is the list of available web context parameters supported:
+ </p>
+ </section>
+#if ($baseContent)
+$baseContent
+#end
+ <section name="Summary">
+ <p>Click on the name of each param to find detailed information about each one of them.</p>
+ <p>The "since" column means the version since the param was added. Note this param is not "lineal",
+ so please check the release dates on myfaces issue tracker to know if an specified version
+ has or not the selected param. For example, if a param was added on 2.0.7, it means that 2.1.1
+ has the parameter because it was released on the same time, but 2.1.0 will not have it, because
+ it was released before that date.
+ </p>
+#set ($webConfigList = ${model.getWebConfigs()})
+ <p><b>State Saving Configuration Params</b></p>
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Since</th>
+ <th>Default Value</th>
+ <th>Short Description</th>
+ </tr>
+#foreach( $webConfig in $webConfigList )
+#if ($modelIds.contains($webConfig.modelId))
+#set ($webConfigParamList = ${webConfig.getWebConfigParametersList()})
+#foreach( $webConfigParam in $webConfigParamList )
+#if ($webConfigParam.sourceClassName == "javax.faces.application.StateManager"
+ || $webConfigParam.sourceClassName == "org.apache.myfaces.shared.util.StateUtils"
+ || $webConfigParam.sourceClassName == "org.apache.myfaces.renderkit.ServerSideStateCacheImpl"
+ || $webConfigParam.sourceClassName == "org.apache.myfaces.renderkit.html.HtmlResponseStateManager"
+ || $webConfigParam.name == "org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS"
+ || $webConfigParam.name == "org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE")
+ <tr>
+ <td><a href="#$webConfigParam.name.replace('.','_')">$webConfigParam.name</a></td>
+#if ($webConfigParam.since)
+ <td>$webConfigParam.since</td>
+#else
+ <td></td>
+#end
+#if ($webConfigParam.defaultValue)
+ <td>$webConfigParam.defaultValue</td>
+#else
+ <td></td>
+#end
+#if ($webConfigParam.description)
+ <td>$webConfigParam.description</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+#end
+#end
+#end
+</table>
+
+ <p><b>Other Configuration Params</b></p>
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Since</th>
+ <th>Default Value</th>
+ <th>Short Description</th>
+ </tr>
+#foreach( $webConfig in $webConfigList )
+#if ($modelIds.contains($webConfig.modelId))
+#set ($webConfigParamList = ${webConfig.getWebConfigParametersList()})
+#foreach( $webConfigParam in $webConfigParamList )
+#if ($webConfigParam.sourceClassName != "javax.faces.application.StateManager"
+ && $webConfigParam.sourceClassName != "org.apache.myfaces.shared.util.StateUtils"
+ && $webConfigParam.sourceClassName != "org.apache.myfaces.renderkit.ServerSideStateCacheImpl"
+ && $webConfigParam.sourceClassName != "org.apache.myfaces.renderkit.html.HtmlResponseStateManager"
+ && $webConfigParam.name != "org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS"
+ && $webConfigParam.name != "org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE")
+ <tr>
+ <td><a href="#$webConfigParam.name.replace('.','_')">$webConfigParam.name</a></td>
+#if ($webConfigParam.since)
+ <td>$webConfigParam.since</td>
+#else
+ <td></td>
+#end
+#if ($webConfigParam.defaultValue)
+ <td>$webConfigParam.defaultValue</td>
+#else
+ <td></td>
+#end
+#if ($webConfigParam.description)
+ <td>$webConfigParam.description</td>
+#else
+ <td></td>
+#end
+ </tr>
+#end
+#end
+#end
+#end
+</table>
+
+ </section>
+ <section name="Detailed Information">
+
+#foreach( $webConfig in $webConfigList )
+#if ($modelIds.contains($webConfig.modelId))
+<p>Artifact Id: $webConfig.modelId</p>
+<table>
+#set ($webConfigParamList = ${webConfig.getWebConfigParametersList()})
+#foreach( $webConfigParam in $webConfigParamList )
+ <tr><td>
+ <p>
+ <b>Param Name:</b> <a name="$webConfigParam.name.replace('.','_')">$webConfigParam.name</a>
+ <br/>
+#if ($webConfigParam.defaultValue)
+ <b>Default Value:</b> $webConfigParam.defaultValue
+ <br/>
+#end
+#if ($webConfigParam.expectedValues)
+ <b>Expected Values:</b> $webConfigParam.expectedValues
+ <br/>
+#end
+#if ($webConfigParam.since)
+ <b>Since:</b> $webConfigParam.since
+ <br/>
+#end
+#if ($webConfigParam.sourceClassName.startsWith("javax.faces."))
+#set ($javadocPath = "../../myfaces-api/apidocs/" + $webConfigParam.sourceClassName.replace('.', '/') )
+#elseif ($webConfigParam.sourceClassName.startsWith("org.apache.myfaces.shared."))
+#set ($javadocPath = "../../myfaces-impl-shared/apidocs/" + $webConfigParam.sourceClassName.replace('.', '/') )
+#else
+#set ($javadocPath = "../apidocs/" + $webConfigParam.sourceClassName.replace('.', '/') )
+#end
+ <b>Source Class:</b> <a href="${javadocPath}.html">$webConfigParam.sourceClassName</a>
+ <br/>
+#if ($webConfigParam.longDescription)
+ <b>Description:</b>
+ <br/>
+ $webConfigParam.longDescription
+#else
+ <b>Description:</b> no description available yet.
+ <br/>
+#end
+ </p>
+ </td></tr>
+#end
+</table>
+#end
+#end
+
+ </section>
+ </body>
+</document>
Modified: myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java (original)
+++ myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/application/DefaultViewHandlerSupport.java Thu Aug 11 19:50:32 2011
@@ -52,10 +52,17 @@ public class DefaultViewHandlerSupport i
//private static final Log log = LogFactory.getLog(DefaultViewHandlerSupport.class);
private static final Logger log = Logger.getLogger(DefaultViewHandlerSupport.class.getName());
+ /**
+ * Controls the size of the cache used to "remember" if a view exists or not.
+ */
@JSFWebConfigParam(defaultValue = "500", since = "2.0.2")
private static final String CHECKED_VIEWID_CACHE_SIZE_ATTRIBUTE = "org.apache.myfaces.CHECKED_VIEWID_CACHE_SIZE";
private static final int CHECKED_VIEWID_CACHE_DEFAULT_SIZE = 500;
+ /**
+ * Enable or disable a cache used to "remember" if a view exists or not and reduce the impact of
+ * sucesive calls to ExternalContext.getResource().
+ */
@JSFWebConfigParam(defaultValue = "true", since = "2.0.2")
private static final String CHECKED_VIEWID_CACHE_ENABLED_ATTRIBUTE = "org.apache.myfaces.CHECKED_VIEWID_CACHE_ENABLED";
private static final boolean CHECKED_VIEWID_CACHE_ENABLED_DEFAULT = true;
Modified: myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java
URL: http://svn.apache.org/viewvc/myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java?rev=1156777&r1=1156776&r2=1156777&view=diff
==============================================================================
--- myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java (original)
+++ myfaces/core/trunk/shared/src/main/java/org/apache/myfaces/shared/config/MyfacesConfig.java Thu Aug 11 19:50:32 2011
@@ -102,7 +102,7 @@ public class MyfacesConfig
* StreamingAddResource instead of DefaultAddResource if you want to
* gain performance.
*/
- @JSFWebConfigParam(defaultValue="org.apache.myfaces.renderkit.html.util.DefaultAddResource",since="1.1")
+ @JSFWebConfigParam(defaultValue="org.apache.myfaces. renderkit.html.util. DefaultAddResource",since="1.1")
private static final String INIT_PARAM_ADD_RESOURCE_CLASS = "org.apache.myfaces.ADD_RESOURCE_CLASS";
private static final String INIT_PARAM_ADD_RESOURCE_CLASS_DEFAULT = "org.apache.myfaces.renderkit.html.util.DefaultAddResource";
@@ -192,26 +192,34 @@ public class MyfacesConfig
private static final String INIT_PARAM_DELEGATE_FACES_SERVLET = "org.apache.myfaces.DELEGATE_FACES_SERVLET";
/**
- * This param is only valid when partial state saving is on.
- * If this is set as true, the tag-handlers are reapplied like in facelets 1.1.x, allowing
+ * Indicate if the facelet associated to the view should be reapplied when the view is refreshed. Default mode is "auto".
+ *
+ * <p>This param is only valid when partial state saving is on.
+ * If this is set as true, the tag-handlers are always reapplied before render view, like in facelets 1.1.x, allowing
* c:if work correctly to "toggle" components based on a value changed on invoke application phase.
+ * If the param is set as "auto", the implementation check if c:if, c:forEach,
+ * c:choose and ui:include with src=ELExpression is used on the page and if that so, mark the view
+ * to be refreshed.</p>
*/
@JSFWebConfigParam(since="2.0", defaultValue="auto", expectedValues="true,false,auto")
public final static String INIT_PARAM_REFRESH_TRANSIENT_BUILD_ON_PSS = "org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS";
public final static String INIT_PARAM_REFRESH_TRANSIENT_BUILD_ON_PSS_DEFAULT = "auto";
/**
- * This param is only valid when partial state saving is on.
+ * Enable or disable a special mode that enable full state for parent components containing c:if, c:forEach,
+ * c:choose and ui:include with src=ELExpression. By default is disabled(false).
+ *
+ * <p>This param is only valid when partial state saving is on.
* If this is set as true, parent components containing c:if, c:forEach,
- * c:choose and ui:insert with src=ELExpression are marked to be restored fully, so state
- * is preserved between request.
+ * c:choose and ui:include with src=ELExpression are marked to be restored fully, so state
+ * is preserved between request.</p>
*/
@JSFWebConfigParam(since="2.0", defaultValue="false")
public final static String INIT_PARAM_REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE = "org.apache.myfaces.REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE";
public final static boolean INIT_PARAM_REFRESH_TRANSIENT_BUILD_ON_PSS_PRESERVE_STATE_DEFAULT = false;
/**
- * if set to <code>true</code>, tag library XML files and faces config XML files using schema
+ * If set to <code>true</code>, tag library XML files and faces config XML files using schema
* will be validated during application start up
*/
@JSFWebConfigParam(since="2.0", expectedValues="true,false")