    001// Licensed under the Apache License, Version 2.0 (the "License");
    002// you may not use this file except in compliance with the License.
    003// You may obtain a copy of the License at
    004//
    005// http://www.apache.org/licenses/LICENSE-2.0
    006//
    007// Unless required by applicable law or agreed to in writing, software
    008// distributed under the License is distributed on an "AS IS" BASIS,
    009// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    010// See the License for the specific language governing permissions and
    011// limitations under the License.
    012
    013package org.apache.tapestry5;
    014
    015import org.apache.tapestry5.corelib.base.AbstractField;
    016import org.apache.tapestry5.corelib.components.AjaxFormLoop;
    017import org.apache.tapestry5.corelib.components.BeanDisplay;
    018import org.apache.tapestry5.corelib.components.BeanEditForm;
    019import org.apache.tapestry5.corelib.components.BeanEditor;
    020import org.apache.tapestry5.corelib.components.Errors;
    021import org.apache.tapestry5.corelib.mixins.FormGroup;
    022import org.apache.tapestry5.http.TapestryHttpSymbolConstants;
    023import org.apache.tapestry5.internal.services.AssetDispatcher;
    024import org.apache.tapestry5.modules.NoBootstrapModule;
    025import org.apache.tapestry5.services.Html5Support;
    026import org.apache.tapestry5.services.assets.AssetPathConstructor;
    027import org.apache.tapestry5.services.assets.ResourceMinimizer;
    028import org.apache.tapestry5.services.compatibility.Trait;
    029import org.apache.tapestry5.services.javascript.JavaScriptStack;
    030
    031/**
    032 * Defines the names of symbols used to configure Tapestry.
    033 *
    034 * @see org.apache.tapestry5.ioc.services.SymbolSource
    035 */
    036public class SymbolConstants
    037{
    038    /**
    039     * A comma separated list of execution modes used to control how the application is initialized.
    040     * Each modes can contribute a list (comma separated) of Module classes to be loaded during startup,
    041     * the order in which they appear is preserved.
    042     * The default value is: <code>production</code>.
    043     * This is an alias for {@link TapestryHttpSymbolConstants#EXECUTION_MODE}.
    044     */
    045    public static final String EXECUTION_MODE = TapestryHttpSymbolConstants.EXECUTION_MODE;
    046    /**
    047     * Indicates whether Tapestry is running in production mode or developer mode. This affects a large
    048     * number of Tapestry behaviors related to performance and security, including how exceptions are
    049     * reported, whether far-future expire headers are emitted, whether JavaScript files may be combined,
    050     * whether JSON is compressed, whether component field and parameter values are shadowed to instance
    051     * variables (to assist with debugging), and more.
    052     *
    053     * This is an alias to {@link TapestryHttpSymbolConstants#PRODUCTION_MODE}.
    054     */
    055    public static final String PRODUCTION_MODE = TapestryHttpSymbolConstants.PRODUCTION_MODE;
    056
    057    /**
    058     * A version of {@link TapestryHttpSymbolConstants#PRODUCTION_MODE} as a symbol reference. This can be used as the default value
    059     * of other symbols, to indicate that their default matches whatever PRODUCTION_MODE is set to, which is quite
    060     * common.
    061     *
    062     * @since 5.2.0
    063     */
    064    public static final String PRODUCTION_MODE_VALUE = String.format("${%s}", TapestryHttpSymbolConstants.PRODUCTION_MODE);
    065
    066    /**
    067     * The list of locales supported by the application; locales identified in the incoming request are "narrowed" to
    068     * one of these values. The first locale name in the list is the default locale used when no proper match can be
    069     * found.
    070     */
    071    public static final String SUPPORTED_LOCALES = "tapestry.supported-locales";
    072
    073    /**
    074     * Controls whether whitespace is compressed by default in templates, or left as is. The factory default is to
    075     * compress whitespace. (This can also be overridden using the xml:space attribute inside template elements.)
    076     */
    077    public static final String COMPRESS_WHITESPACE = "tapestry.compress-whitespace";
    078
    079    /**
    080     * Time interval defining how often Tapestry will check for updates to local files (including classes).
    081     * Starting with 5.3, this is only used when not running in production mode. The default is "1 s"
    082     * (one second), which is appropriate for development. With Tapestry 5.2 and earlier this number
    083     * should be raised in a production environment.
    084     */
    085    public static final String FILE_CHECK_INTERVAL = "tapestry.file-check-interval";
    086
    087    /**
    088     * Time interval that sets how long Tapestry will wait to obtain the exclusive lock needed to check local files. The
    089     * default is "50 ms". Starting with 5.3, this is only used when not running in production mode.
    090     */
    091    public static final String FILE_CHECK_UPDATE_TIMEOUT = "tapestry.file-check-update-timeout";
    092
    093    /**
    094     * The version number of the core Tapestry framework, or UNKNOWN if the version number is not available (which
    095     * should only occur when developing Tapestry).
    096     */
    097    public static final String TAPESTRY_VERSION = "tapestry.version";
    098
    099    /**
    100     * The location of the application-wide component messages catalog, relative to the web application context. This
    101     * will normally be <code>WEB-INF/app.properties</code>.
    102     */
    103    public static final String APPLICATION_CATALOG = "tapestry.app-catalog";
    104
    105    /**
    106     * The charset used when rendering page markup; the charset is also used as the request encoding when handling
    107     * incoming requests. The default is "UTF-8".
    108     * This is an alias for {@link TapestryHttpSymbolConstants#CHARSET}
    109     */
    110    public static final String CHARSET = TapestryHttpSymbolConstants.CHARSET;
    111
    112    /**
    113     * Used as the default for the Form's autofocus and clientValidation parameters. If overridden to "false", then
    114     * Forms will not (unless explicitly specified) use client validation or autofocus, which in turn, means that most
    115     * pages with Forms will not make use of the Tapestry JavaScript stack.
    116     */
    117    public static final String FORM_CLIENT_LOGIC_ENABLED = "tapestry.form-client-logic-enabled";
    118
    119    /**
    120     * Name of page used to report exceptions; the page must implement
    121     * {@link org.apache.tapestry5.services.ExceptionReporter}.
    122     * This is used by the default exception report handler service.
    123     */
    124    public static final String EXCEPTION_REPORT_PAGE = "tapestry.exception-report-page";
    125
    126    /**
    127     * Identifies the default persistence strategy for all pages that do not provide an override (using this value as
    128     * {@link org.apache.tapestry5.annotations.Meta key}).
    129     *
    130     * @since 5.1.0.0
    131     */
    132    public static final String PERSISTENCE_STRATEGY = "tapestry.persistence-strategy";
    133
    134    /**
    135     * Minimum output stream size, in bytes, before output is compressed using GZIP. Shorter streams are not compressed.
    136     * Tapestry buffers this amount and switches to a GZIP output stream as needed. The default is "100".
    137     * This is an alias to {@link TapestryHttpSymbolConstants#MIN_GZIP_SIZE}.
    138     *
    139     * @see TapestryHttpSymbolConstants#GZIP_COMPRESSION_ENABLED
    140     * @since 5.1.0.0
    141     */
    142    public static final String MIN_GZIP_SIZE = TapestryHttpSymbolConstants.MIN_GZIP_SIZE;
    143
    144    /**
    145     * Version number of the application. Prior to 5.4, this version number was integrated into asset URLs. Starting
    146     * with 5.4, a checksum of the individual asset's content is used instead, and this version number is only used
    147     * for documentation purposes; it appears in the default exception report page, for example.
    148     *
    149     * The default value is "0.0.1".  In 5.3 and earlier, the default value was a random hexadecimal string.
    150     *
    151     * This is an alias to {@link TapestryHttpSymbolConstants#APPLICATION_VERSION}.
    152     *
    153     * @see AssetDispatcher
    154     * @see AssetPathConstructor
    155     * @since 5.1.0.0
    156     */
    157    public static final String APPLICATION_VERSION = TapestryHttpSymbolConstants.APPLICATION_VERSION;
    158
    159    /**
    160     * Used to omit the normal Tapestry framework generator meta tag. The meta tag is rendered by default, but clients
    161     * who do not wish to advertise their use of Tapestry may set this symbol to "true".
    162     *
    163     * @since 5.1.0.0
    164     */
    165    public static final String OMIT_GENERATOR_META = "tapestry.omit-generator-meta";
    166
    167    /**
    168     * If "true" (the default) then GZip compression is enabled for dynamic requests and for static assets. If you are
    169     * using a server that handles GZip compression for you, or you don't want to use the extra processing power
    170     * necessary to GZIP requests, then override this to "false".
    171     * This is an alias to {@link TapestryHttpSymbolConstants#GZIP_COMPRESSION_ENABLED}.
    172     *
    173     * @see TapestryHttpSymbolConstants#MIN_GZIP_SIZE
    174     * @see org.apache.tapestry5.http.services.ResponseCompressionAnalyzer
    175     * @see org.apache.tapestry5.http.services.CompressionAnalyzer
    176     * @since 5.1.0.0
    177     */
    178    public static final String GZIP_COMPRESSION_ENABLED = TapestryHttpSymbolConstants.GZIP_COMPRESSION_ENABLED;
    179
    180    /**
    181     * If "true" (which itself defaults to production mode), then the {@link org.apache.tapestry5.annotations.Secure}
    182     * annotation will be honored. If "false" (i.e., development mode), then the annotation and related HTTP/HTTPS
    183     * logic is ignored.
    184     *
    185     * @since 5.1.0.1
    186     */
    187    public static final String SECURE_ENABLED = "tapestry.secure-enabled";
    188
    189    /**
    190     * If "true" (the default), then the {@link org.apache.tapestry5.services.PersistentLocale} will be encoded into the
    191     * {@link org.apache.tapestry5.http.Link} path by the {@link org.apache.tapestry5.services.ComponentEventLinkEncoder}
    192     * service. If overridden to "false" this does not occur, but you should provide a
    193     * {@link org.apache.tapestry5.services.LinkCreationListener2} (registered with the
    194     * {@link org.apache.tapestry5.services.LinkCreationHub}) in order to add the locale as a query parameter (or
    195     * provide some alternate means of persisting the locale between requests).
    196     *
    197     * @since 5.1.0.1
    198     */
    199    public static final String ENCODE_LOCALE_INTO_PATH = "tapestry.encode-locale-into-path";
    200
    201    /**
    202     * If "true" then JavaScript files in a {@link JavaScriptStack} will be combined into a single virtual JavaScript
    203     * file. Defaults to "true" in production mode.
    204     *
    205     * @since 5.1.0.2
    206     */
    207    public static final String COMBINE_SCRIPTS = "tapestry.combine-scripts";
    208
    209
    210    /**
    211     * The default time interval that cookies created by Tapestry will be kept in the client web browser. The default is
    212     * "7 d" (that is, seven days).
    213     *
    214     * @since 5.2.0
    215     */
    216    public static final String COOKIE_MAX_AGE = "tapestry.default-cookie-max-age";
    217
    218    /**
    219     * The logical name of the start page, the page that is rendered for the root URL.
    220     *
    221     * @since 5.2.0
    222     */
    223    public static final String START_PAGE_NAME = "tapestry.start-page-name";
    224
    225    /**
    226     * The default stylesheet automatically inserted into every rendered HTML page when
    227     * no Bootstrap version is enabled (i.e both {@link Trait#BOOTSTRAP_3} and {@link Trait#BOOTSTRAP_4}
    228     * traits are disabled, something done by {@linkplain NoBootstrapModule}).
    229     *
    230     * It was deprecated in 5.4 with no replacement (the stylesheet is now associated with the core {@link JavaScriptStack}.),
    231     * but undeprecated in 5.5.0 with the caveat described above.
    232     *
    233     * @see NoBootstrapModule
    234     * @since 5.2.0
    235     */
    236    public static final String DEFAULT_STYLESHEET = "tapestry.default-stylesheet";
    237
    238    /**
    239     * The Asset path to the embedded copy of script.aculo.us packaged with Tapestry.
    240     *
    241     * @since 5.2.0
    242     */
    243    public static final String SCRIPTACULOUS = "tapestry.scriptaculous";
    244
    245    /**
    246     * The Asset path to the embedded datepicker.
    247     *
    248     * @since 5.2.0
    249     */
    250    public static final String DATEPICKER = "tapestry.datepicker";
    251
    252    /**
    253     * If "true", then JSON page initialization content is compressed; if "false"
    254     * then extra white space is added (pretty printing). Defaults to "true" in production mode.
    255     *
    256     * @since 5.2.0
    257     */
    258    public static final String COMPACT_JSON = "tapestry.compact-json";
    259
    260    /**
    261     * If "true" and {@link TapestryHttpSymbolConstants#PRODUCTION_MODE} is off, comments will be rendered before and after the rendering of any
    262     * component
    263     * allowing more visibility into which components rendered which markup. Defaults to "false". Component render
    264     * tracing may be
    265     * enabled per-request by the presence of a request parameter "t:component-trace" with a value of "true".
    266     *
    267     * @since 5.2.5
    268     */
    269    public static final String COMPONENT_RENDER_TRACING_ENABLED = "tapestry.component-render-tracing-enabled";
    270
    271    /**
    272     * The hostname that application should use when constructing an absolute URL. The default is "", i.e. an empty
    273     * string,
    274     * in which case system will use request.getServerName(). Not the same as environment variable HOSTNAME, but you can
    275     * also
    276     * contribute "$HOSTNAME" as the value to make it the same as the environment variable HOSTNAME.
    277     * This is an alias to {@link TapestryHttpSymbolConstants#HOSTNAME}.
    278     *
    279     * @since 5.3
    280     */
    281    public static final String HOSTNAME = TapestryHttpSymbolConstants.HOSTNAME;
    282
    283    /**
    284     * The hostport that application should use when constructing an absolute URL. The default is "0", i.e. use the port
    285     * value from
    286     * the request. This is an alias to {@link TapestryHttpSymbolConstants#HOSTPORT}.
    287     *
    288     * @since 5.3
    289     */
    290    public static final String HOSTPORT = TapestryHttpSymbolConstants.HOSTPORT;
    291
    292    /**
    293     * The secure (https) hostport that application should use when constructing an absolute URL. The default is "0",
    294     * i.e. use
    295     * the value from the request.
    296     * This is an alias to {@link TapestryHttpSymbolConstants#HOSTPORT_SECURE}.
    297     *
    298     * @since 5.3
    299     */
    300    public static final String HOSTPORT_SECURE = TapestryHttpSymbolConstants.HOSTPORT_SECURE;
    301
    302    /**
    303     * If "true", then resources (individually or when aggregated into stacks) will be minimized via the
    304     * {@link ResourceMinimizer} service. If "false", then minification is disabled. Tracks production mode
    305     * (minification is normally disabled in development mode).
    306     *
    307     * Note that Tapestry's default implementation of {@link ResourceMinimizer} does nothing; minification is provided
    308     * by add-on libraries.
    309     *
    310     * @since 5.3
    311     */
    312    public static final String MINIFICATION_ENABLED = "tapestry.enable-minification";
    313
    314    /**
    315     * If "true" then at the end of each request the
    316     * {@link org.apache.tapestry5.http.services.SessionPersistedObjectAnalyzer} will be called on each session persisted
    317     * object that was accessed during the request.
    318     *
    319     * This is provided as a performance enhancement for servers that do not use clustered sessions.
    320     *
    321     * The default is {@code true}, to preserve 5.2 behavior. For non-clustered applications (the majority), this value should be
    322     * overridden to {@code false}. A future release of Tapestry may change the default.
    323     *
    324     * This is an alias to {@link TapestryHttpSymbolConstants#CLUSTERED_SESSIONS}.
    325     *
    326     * @since 5.3
    327     */
    328    public static final String CLUSTERED_SESSIONS = TapestryHttpSymbolConstants.CLUSTERED_SESSIONS;
    329
    330    /**
    331     * The name of a folder in which the Tapestry application executes. Prior to 5.3, a Tapestry application always responded to all
    332     * URLs in the context under the context root; by setting this to the name of a folder, the T5 URLs will be inside that folder only, and should
    333     * match a corresponding entry in the {@code web.xml} configuration file.  This is useful when running multiple servlets within the same web application (such as when migrating
    334     * from Tapestry 4 or some other framework, to Tapestry 5).
    335     * Effectively, if this symbol is set to a value, that folder name will be placed after the context path
    336     * (typically "/") and before the locale, page name, or other prefix.  For example, if this symbol is set to "app", the {@code web.xml <url-pattern>} should be set to {@code /app/*}, and Tapestry will
    337     * only be in invoked by the servlet container for requests inside the virtual {@code app} folder.
    338     *
    339     * This also affects the search for page templates (which are allowed within the web context). When set to a non-blank value, page templates are searched for in the folder, rather than in the root context.
    340     *
    341     * The default value is the empty string, which preserves Tapestry 5.2 behavior (and continues to be appropriate for most applications).
    342     *
    343     * Note that while Tapestry is case-insensitive, the servlet container is not, so the configured value must exactly match
    344     * the folder name inside the {@code <url-parameter>} value, including case.
    345     *
    346     * @since 5.3
    347     */
    348    public static final String APPLICATION_FOLDER = "tapestry.application-folder";
    349
    350    /**
    351     * Boolean value to indicate if every {@link  org.apache.tapestry5.Asset} should be fully qualified or not.
    352     * Default to <code>false</code> meaning no Asset URL will be fully qualified.
    353     *
    354     * @since 5.3
    355     */
    356    public static final String ASSET_URL_FULL_QUALIFIED = "tapestry.asset-url-fully-qualified";
    357
    358    /**
    359     * Prefix to be used for all resource paths, used to recognize which requests are for assets. This value
    360     * is appended to the context path and the (optional {@linkplain #APPLICATION_FOLDER application folder}.
    361     * It may contain slashes, but should not begin or end with one.
    362     *
    363     * The default is "assets".
    364     */
    365    public static final String ASSET_PATH_PREFIX = "tapestry.asset-path-prefix";
    366
    367
    368    /**
    369     * Prefix used for all module resources. This may contain slashes, but should not being or end with one.
    370     * Tapestry will create two {@link org.apache.tapestry5.http.services.Dispatcher}s from this: one for normal
    371     * modules, the other for GZip compressed modules (by appending ".gz" to this value).
    372     *
    373     * The default is "modules".
    374     *
    375     * @since 5.4
    376     */
    377    public static final String MODULE_PATH_PREFIX = "tapestry.module-path-prefix";
    378
    379    /**
    380     * Identifies the context path of the application, as determined from {@link javax.servlet.ServletContext#getContextPath()}.
    381     * This is either a blank string or a string that starts with a slash but does not end with one.
    382     * This is an alias to {@link TapestryHttpSymbolConstants#CONTEXT_PATH}.
    383     *
    384     * @since 5.4
    385     */
    386    public static final String CONTEXT_PATH = TapestryHttpSymbolConstants.CONTEXT_PATH;
    387
    388    /**
    389     * A passphrase used as the basis of hash-based message authentication (HMAC) for any object stream data stored on
    390     * the client.  The default phrase is the empty string, which will result in a logged runtime <em>error</em>.
    391     * You should configure this to a reasonable value (longer is better) and ensure that all servers in your cluster
    392     * share the same value (configuring this in code, rather than the command line, is preferred).
    393     *
    394     * @see org.apache.tapestry5.services.ClientDataEncoder
    395     * @since 5.3.6
    396     */
    397    public static final String HMAC_PASSPHRASE = "tapestry.hmac-passphrase";
    398
    399    /**
    400     * The root asset path for Twitter Bootstrap; if your application uses a modified version of Bootstrap,
    401     * you can override this symbol to have Tapestry automatically use your version. The value should be a path
    402     * to a folder (under "classpath:" or "context:") and should not include a trailing slash.
    403     *
    404     * @since 5.4
    405     */
    406    public static final String BOOTSTRAP_ROOT = "tapestry.bootstrap-root";
    407
    408    /**
    409     * The root asset path for Font Awesome; if your application uses a modified version of it,
    410     * you can override this symbol to have Tapestry automatically use your version. The value should be a path
    411     * to a folder (under "classpath:" or "context:") and should not include a trailing slash.
    412     *
    413     * @since 5.5
    414     */
    415    public static final String FONT_AWESOME_ROOT = "tapestry.font-awesome-root";
    416
    417    /**
    418     * Tapestry relies on an underlying client-side JavaScript infrastructure framework to handle DOM manipulation,
    419     * event handling, and Ajax requests. Through Tapestry 5.3, the foundation was
    420     * <a href="http://http://prototypejs.org/">Prototype</a>. In 5.4, support for
    421     * <a href="http://jquery.org/">jQuery</a> has been added, and it is possible to add others. This symbol defines a value that is used to select
    422     * a resource that is provided to the {@link org.apache.tapestry5.services.javascript.ModuleManager} service
    423     * as a {@link org.apache.tapestry5.services.javascript.JavaScriptModuleConfiguration} to provide a specific implementation
    424     * of the {@code t5/core/dom} module. Tapestry 5.4 directly supports "prototype" or "jquery".  To support
    425     * other foundation frameworks, override this symbol value and supply your own module configuration.
    426     *
    427     * In Tapestry 5.4, this defaults to "prototype" for compatibility with 5.3. This will likely change in
    428     * 5.5 to default to "jquery". At some point in the future, Prototype support will no longer be present.
    429     *
    430     * @since 5.4
    431     */
    432    public static final String JAVASCRIPT_INFRASTRUCTURE_PROVIDER = "tapestry.javascript-infrastructure-provider";
    433
    434    /**
    435     * If true (the default), then Tapestry will apply locking semantics around access to the {@link javax.servlet.http.HttpSession}.
    436     * Reading attribute names occurs with a shared read lock; getting or setting an attribute upgrades to an exclusive write lock.
    437     * This can tend to serialize threads when a number of simultaneous (Ajax) requests from the client arrive ... however,
    438     * many implementations of HttpSession are not thread safe, and often mutable objects are stored in the session and shared
    439     * between threads. Leaving this on the default will yield a more robust application; setting it to false may speed
    440     * up processing for more Ajax intensive applications (but care should then be given to ensuring that objects shared inside
    441     * the session are themselves immutable or thread-safe).
    442     *
    443     * This is an alias to {@link TapestryHttpSymbolConstants#SESSION_LOCKING_ENABLED}.
    444     *
    445     * @since 5.4
    446     */
    447    public static final String SESSION_LOCKING_ENABLED = TapestryHttpSymbolConstants.SESSION_LOCKING_ENABLED;
    448
    449    /**
    450     * If true (the default), then Tapestry will automatically include the "core" stack in all
    451     * pages.
    452     *
    453     * @see <a href="https://issues.apache.org/jira/browse/TAP5-2169">TAP5-2169</a>
    454     * @since 5.4
    455     */
    456    public static final String INCLUDE_CORE_STACK = "tapestry.include-core-stack";
    457
    458    /**
    459     * Defines the CSS class that will be given to HTML element (usually a div) &lt;div&gt; generated by
    460     * the {@linkplain FormGroup} mixin and the
    461     * {@linkplain BeanEditForm} and {@linkplain BeanEditor}
    462     * components surrounding the label and the field. If the value isn't
    463     * {@code form-group}, the div will have {@code class="form-group [value]}.
    464     * The default value is <code>form-group</code>.
    465     *
    466     * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a>
    467     * @since 5.4
    468     */
    469    public static final String FORM_GROUP_WRAPPER_CSS_CLASS = "tapestry.form-group-wrapper-css-class";
    470
    471    /**
    472     * Defines the name of the HTML element that will surround the HTML form field generated by
    473     * the {@linkplain FormGroup} mixin and the {@linkplain BeanEditForm} and {@linkplain BeanEditor}.
    474     * If this symbol is null or an empty string, no element will be generated surrouding the
    475     * form field. The default value is the empty string (no wrapping).
    476     *
    477     * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a>
    478     * @see #FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS
    479     * @since 5.4
    480     */
    481    public static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME = "tapestry.form-group-form-field-wrapper-element-name";
    482
    483    /**
    484     * Defines the CSS class of the HTML element generated by
    485     * the {@linkplain FormGroup} mixin and the {@linkplain BeanEditForm} and {@linkplain BeanEditor}.
    486     * when {@linkplain #FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME} is not set to null or the empty string.
    487     * The default value is the empty string (no CSS class added).
    488     *
    489     * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a>
    490     * @since 5.4
    491     */
    492    public static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS = "tapestry.form-group-form-field-wrapper-element-css-class";
    493
    494    /**
    495     * Defines the CSS class that will be given to &lt;label&gt; element generated by
    496     * the {@linkplain FormGroup} mixin and the
    497     * {@linkplain BeanEditForm} and {@linkplain BeanEditor}
    498     * components. The default value is <code>control-label</code>.
    499     *
    500     * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a>
    501     * @since 5.4
    502     */
    503    public static final String FORM_GROUP_LABEL_CSS_CLASS = "tapestry.form-group-label-css-class";
    504
    505    /**
    506     * Defines the CSS class that will be given to form field components which are
    507     * {@linkplain AbstractField} subclasses. The default value is <code>form-control</code>.
    508     *
    509     * @see <a href="https://issues.apache.org/jira/browse/TAP5-2182">TAP5-2182</a>
    510     * @since 5.4
    511     */
    512    public static final String FORM_FIELD_CSS_CLASS = "tapestry.form-field-css-class";
    513
    514    /**
    515     * Defines the CSS class that will be given to the &lt;dl&gt; HTML element generated by
    516     * {@linkplain BeanDisplay}. The default value is <code>well dl-horizontal</code>.
    517     *
    518     * @since 5.5
    519     */
    520    public static final String BEAN_DISPLAY_CSS_CLASS = "tapestry.bean-display-css-class";
    521
    522    /**
    523     * Defines the CSS class that will be given to the &lt;div&gt; HTML element generated by
    524     * {@linkplain BeanEditor}/{@linkplain BeanEditForm} for boolean properties.
    525     * The default value is <code>input-group</code>.
    526     *
    527     * @since 5.5
    528     */
    529    public static final String BEAN_EDITOR_BOOLEAN_PROPERTY_DIV_CSS_CLASS = "tapestry.bean-editor-boolean-property-div-css-class";
    530
    531    /**
    532     * Defines the CSS class that will be given to the HTML element generated by
    533     * {@linkplain Error}. If the value isn't <code>help-block</code>, the class attribute
    534     * will be <code>help-block [symbol value]</code>
    535     * The default value is <code>help-block</code>.
    536     *
    537     * @since 5.5
    538     */
    539    public static final String ERROR_CSS_CLASS = "tapestry.error-css-class";
    540
    541    /**
    542     * Defines the CSS class that will be given to the add row link generated by
    543     * {@linkplain AjaxFormLoop}. The default value is <code>btn btn-default btn-sm</code>.
    544     *
    545     * @since 5.5
    546     */
    547    public static final String AJAX_FORM_LOOP_ADD_ROW_LINK_CSS_CLASS = "tapestry.ajax-form-loop-add-row-link-css-class";
    548
    549    /**
    550     * Defines the prefix of the CSS class that will be given to the outer &lt;div&gt; element generated by
    551     * {@linkplain Errors}. The value of {@linkplain Errors}'s <code>class</code> parameter appended
    552     * after the prefix and a space character. The default value is <code>alert-dismissable</code>.
    553     *
    554     * @since 5.5
    555     */
    556    public static final String ERRORS_BASE_CSS_CLASS = "tapestry.errors-base-css-class";
    557
    558    /**
    559     * Defines the default value of the {@linkplain Errors}'s <code>class</code> parameter.
    560     * The default value for this symbol is <code>alert alert-danger</code>.
    561     *
    562     * @since 5.5
    563     */
    564    public static final String ERRORS_DEFAULT_CLASS_PARAMETER_VALUE = "tapestry.errors-default-class-parameter-value";
    565
    566    /**
    567     * Defines the CSS class that will be given to the close &lt;button&gt; generated by
    568     * {@linkplain Errors}. The default value is <code>close</code>.
    569     *
    570     * @since 5.5
    571     */
    572    public static final String ERRORS_CLOSE_BUTTON_CSS_CLASS = "tapestry.errors-close-button-css-class";
    573
    574    /**
    575     * Defines whether {@link java.text.DateFormat} instances created by Tapestry should be
    576     * lenient or not by default. The default value is <code>false</code>.
    577     *
    578     * @since 5.4
    579     */
    580    public static final String LENIENT_DATE_FORMAT = "tapestry.lenient-date-format";
    581
    582    /**
    583     * The directory to which exception report files should be written. The default is appropriate
    584     * for development: {@code build/exceptions}, and should be changed for production.
    585     *
    586     * @see org.apache.tapestry5.services.ExceptionReporter
    587     * @since 5.4
    588     */
    589
    590    public static final String EXCEPTION_REPORTS_DIR = "tapestry.exception-reports-dir";
    591
    592    /**
    593     * Defines whether {@link org.apache.tapestry5.internal.services.assets.CSSURLRewriter} will throw an exception when a CSS file
    594     * references an URL which doesn't exist. The default value is <code>false</code>.
    595     *
    596     * @since 5.4
    597     */
    598    public static final String STRICT_CSS_URL_REWRITING = "tapestry.strict-css-url-rewriting";
    599
    600    /**
    601     * When an asset (typically, a JavaScript module) is streamed without an explicit expiration header, then
    602     * this value is sent as the {@code Cache-Control} header; the default is "max-age=60, must-revalidate". Setting
    603     * max-age to a value above zero significantly reduces the number of client requests for module content, as client
    604     * browsers will then cache previously downloaded versions. For normal assets, which are immutable, and fingerprinted with
    605     * a content hash, there is no need to set max age, and instead, a far-future expiration date is provided.
    606     *
    607     * @since 5.4
    608     */
    609    public static final String OMIT_EXPIRATION_CACHE_CONTROL_HEADER = "tapestry.omit-expiration-cache-control-header";
    610
    611    /**
    612     * Defines whether HTML5 features should be used. Value used in the default implementation of
    613     * {@link Html5Support#isHtml5SupportEnabled()}. Default value: <code>false</code>.
    614     *
    615     * @see Html5Support#isHtml5SupportEnabled()
    616     * @since 5.4
    617     */
    618    public static final String ENABLE_HTML5_SUPPORT = "tapestry.enable-html5-support";
    619
    620    /**
    621     * A general switch for restrictive environments, such as Google App Engine, which forbid some useful operations,
    622     * such as creating files or directories. Defaults to false.
    623     *
    624     * @since 5.4
    625     */
    626    public static final String RESTRICTIVE_ENVIRONMENT = "tapestry.restrictive-environment";
    627
    628    /**
    629     * If true, then when a page includes any JavaScript, a {@code script} block is added to insert
    630     * a pageloader mask into the page; the pageloader mask ensure that the user can't interact with the page
    631     * until after the page is fully initialized.
    632     *
    633     * @since 5.4
    634     */
    635    public static final String ENABLE_PAGELOADING_MASK = "tapestry.enable-pageloading-mask";
    636
    637    /**
    638     * Controls in what environment page preloading should occur. By default, preloading only occurs
    639     * in production.
    640     *
    641     * @see org.apache.tapestry5.services.pageload.PagePreloader
    642     * @see org.apache.tapestry5.services.pageload.PreloaderMode
    643     * @since 5.4
    644     */
    645    public static final String PRELOADER_MODE = "tapestry.page-preload-mode";
    646}