public class SymbolConstants extends Object
SymbolSource
Modifier and Type | Field and Description |
---|---|
static String |
APPLICATION_CATALOG
The location of the application-wide component messages catalog, relative to the web application context.
|
static String |
APPLICATION_FOLDER
The name of a folder in which the Tapestry application executes.
|
static String |
APPLICATION_VERSION
Version number of the application.
|
static String |
ASSET_PATH_PREFIX
Prefix to be used for all resource paths, used to recognize which requests are for assets.
|
static String |
ASSET_URL_FULL_QUALIFIED
Boolean value to indicate if every
Asset2 should be fully qualified or not. |
static String |
BOOTSTRAP_ROOT
The root asset path for Twitter Bootstrap; if your application uses a modified version of Bootstrap,
you can override this symbol to have Tapestry automatically use your version.
|
static String |
CHARSET
The charset used when rendering page markup; the charset is also used as the request encoding when handling
incoming requests.
|
static String |
CLUSTERED_SESSIONS
If "true" then at the end of each request the
SessionPersistedObjectAnalyzer will be called on each session persisted
object that was accessed during the request. |
static String |
COMBINE_SCRIPTS
If "true" then JavaScript files in a
JavaScriptStack will be combined into a single virtual JavaScript
file. |
static String |
COMPACT_JSON
If "true", then JSON page initialization content is compressed; if "false"
then extra white space is added (pretty printing).
|
static String |
COMPONENT_RENDER_TRACING_ENABLED
If "true" and
PRODUCTION_MODE is off, comments will be rendered before and after the rendering of any
component
allowing more visibility into which components rendered which markup. |
static String |
COMPRESS_WHITESPACE
Controls whether whitespace is compressed by default in templates, or left as is.
|
static String |
CONTEXT_PATH
Identifies the context path of the application, as determined from
ServletContext.getContextPath() . |
static String |
COOKIE_MAX_AGE
The default time interval that cookies created by Tapestry will be kept in the client web browser.
|
static String |
DATEPICKER
The Asset path to the embedded datepicker.
|
static String |
DEFAULT_STYLESHEET
Deprecated.
Deprecated in 5.4 with no replacement; the stylesheet is now associated with the core
JavaScriptStack . |
static String |
ENABLE_HTML5_SUPPORT
Defines whether HTML5 features should be used.
|
static String |
ENABLE_PAGELOADING_MASK
If true, then when a page includes any JavaScript, a
script block is added to insert
a pageloader mask into the page; the pageloader mask ensure that the user can't interact with the page
until after the page is fully initialized. |
static String |
ENCODE_LOCALE_INTO_PATH
If "true" (the default), then the
PersistentLocale will be encoded into the
Link path by the ComponentEventLinkEncoder
service. |
static String |
EXCEPTION_REPORT_PAGE
Name of page used to report exceptions; the page must implement
ExceptionReporter . |
static String |
EXCEPTION_REPORTS_DIR
The directory to which exception report files should be written.
|
static String |
EXECUTION_MODE
A comma separated list of execution modes used to control how the application is initialized.
|
static String |
FILE_CHECK_INTERVAL
Time interval defining how often Tapestry will check for updates to local files (including classes).
|
static String |
FILE_CHECK_UPDATE_TIMEOUT
Time interval that sets how long Tapestry will wait to obtain the exclusive lock needed to check local files.
|
static String |
FORM_CLIENT_LOGIC_ENABLED
Used as the default for the Form's autofocus and clientValidation parameters.
|
static String |
FORM_FIELD_CSS_CLASS
Defines the CSS class that will be given to form field components which are
AbstractField subclasses.
|
static String |
FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS
Defines the CSS class of the HTML element generated by
the FormGroup mixin and the BeanEditForm and BeanEditor.
|
static String |
FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME
Defines the name of the HTML element that will surround the HTML form field generated by
the FormGroup mixin and the BeanEditForm and BeanEditor.
|
static String |
FORM_GROUP_LABEL_CSS_CLASS
Defines the CSS class that will be given to <label> element generated by
the FormGroup mixin and the
BeanEditForm and BeanEditor
components.
|
static String |
FORM_GROUP_WRAPPER_CSS_CLASS
Defines the CSS class that will be given to HTML element (usually a div) <div> generated by
the FormGroup mixin and the
BeanEditForm and BeanEditor
components surrounding the label and the field.
|
static String |
GZIP_COMPRESSION_ENABLED
If "true" (the default) then GZip compression is enabled for dynamic requests and for static assets.
|
static String |
HMAC_PASSPHRASE
A passphrase used as the basis of hash-based message authentication (HMAC) for any object stream data stored on
the client.
|
static String |
HOSTNAME
The hostname that application should use when constructing an absolute URL.
|
static String |
HOSTPORT
The hostport that application should use when constructing an absolute URL.
|
static String |
HOSTPORT_SECURE
The secure (https) hostport that application should use when constructing an absolute URL.
|
static String |
INCLUDE_CORE_STACK
If true (the default), then Tapestry will automatically include the "core" stack in all
pages.
|
static String |
JAVASCRIPT_INFRASTRUCTURE_PROVIDER
Tapestry relies on an underlying client-side JavaScript infrastructure framework to handle DOM manipulation,
event handling, and Ajax requests.
|
static String |
LENIENT_DATE_FORMAT
Defines whether
DateFormat instances created by Tapestry should be
lenient or not by default. |
static String |
MIN_GZIP_SIZE
Minimum output stream size, in bytes, before output is compressed using GZIP.
|
static String |
MINIFICATION_ENABLED
If "true", then resources (individually or when aggregated into stacks) will be minimized via the
ResourceMinimizer service. |
static String |
MODULE_PATH_PREFIX
Prefix used for all module resources.
|
static String |
OMIT_EXPIRATION_CACHE_CONTROL_HEADER
When an asset (typically, a JavaScript module) is streamed without an explicit expiration header, then
this value is sent as the
Cache-Control header; the default is "max-age=60, must-revalidate". |
static String |
OMIT_GENERATOR_META
Used to omit the normal Tapestry framework generator meta tag.
|
static String |
PERSISTENCE_STRATEGY
Identifies the default persistence strategy for all pages that do not provide an override (using this value as
key ). |
static String |
PRELOADER_MODE
Controls in what environment page preloading should occur.
|
static String |
PRODUCTION_MODE
Indicates whether Tapestry is running in production mode or developer mode.
|
static String |
PRODUCTION_MODE_VALUE
A version of
PRODUCTION_MODE as a symbol reference. |
static String |
RESTRICTIVE_ENVIRONMENT
A general switch for restrictive environments, such as Google App Engine, which forbid some useful operations,
such as creating files or directories.
|
static String |
SCRIPTACULOUS
The Asset path to the embedded copy of script.aculo.us packaged with Tapestry.
|
static String |
SECURE_ENABLED
If "true" (which itself defaults to production mode), then the
Secure
annotation will be honored. |
static String |
SESSION_LOCKING_ENABLED
If true (the default), then Tapestry will apply locking semantics around access to the
HttpSession . |
static String |
START_PAGE_NAME
The logical name of the start page, the page that is rendered for the root URL.
|
static String |
STRICT_CSS_URL_REWRITING
Defines whether
CSSURLRewriter will throw an exception when a CSS file
references an URL which doesn't exist. |
static String |
SUPPORTED_LOCALES
The list of locales supported by the application; locales identified in the incoming request are "narrowed" to
one of these values.
|
static String |
TAPESTRY_VERSION
The version number of the core Tapestry framework, or UNKNOWN if the version number is not available (which
should only occur when developing Tapestry).
|
Constructor and Description |
---|
SymbolConstants() |
public static final String EXECUTION_MODE
production
.public static final String PRODUCTION_MODE
public static final String PRODUCTION_MODE_VALUE
PRODUCTION_MODE
as a symbol reference. This can be used as the default value
of other symbols, to indicate that their default matches whatever PRODUCTION_MODE is set to, which is quite
common.public static final String SUPPORTED_LOCALES
public static final String COMPRESS_WHITESPACE
public static final String FILE_CHECK_INTERVAL
public static final String FILE_CHECK_UPDATE_TIMEOUT
public static final String TAPESTRY_VERSION
public static final String APPLICATION_CATALOG
WEB-INF/app.properties
.public static final String CHARSET
public static final String FORM_CLIENT_LOGIC_ENABLED
public static final String EXCEPTION_REPORT_PAGE
ExceptionReporter
.
This is used by the default exception report handler service.public static final String PERSISTENCE_STRATEGY
key
).public static final String MIN_GZIP_SIZE
GZIP_COMPRESSION_ENABLED
,
Constant Field Valuespublic static final String APPLICATION_VERSION
AssetDispatcher
,
AssetPathConstructor
,
Constant Field Valuespublic static final String OMIT_GENERATOR_META
public static final String GZIP_COMPRESSION_ENABLED
MIN_GZIP_SIZE
,
ResponseCompressionAnalyzer
,
CompressionAnalyzer
,
Constant Field Valuespublic static final String SECURE_ENABLED
Secure
annotation will be honored. If "false" (i.e., development mode), then the annotation and related HTTP/HTTPS
logic is ignored.public static final String ENCODE_LOCALE_INTO_PATH
PersistentLocale
will be encoded into the
Link
path by the ComponentEventLinkEncoder
service. If overridden to "false" this does not occur, but you should provide a
LinkCreationListener2
(registered with the
LinkCreationHub
) in order to add the locale as a query parameter (or
provide some alternate means of persisting the locale between requests).public static final String COMBINE_SCRIPTS
JavaScriptStack
will be combined into a single virtual JavaScript
file. Defaults to "true" in production mode.public static final String COOKIE_MAX_AGE
public static final String START_PAGE_NAME
public static final String DEFAULT_STYLESHEET
JavaScriptStack
.public static final String SCRIPTACULOUS
public static final String DATEPICKER
public static final String COMPACT_JSON
public static final String COMPONENT_RENDER_TRACING_ENABLED
PRODUCTION_MODE
is off, comments will be rendered before and after the rendering of any
component
allowing more visibility into which components rendered which markup. Defaults to "false". Component render
tracing may be
enabled per-request by the presence of a request parameter "t:component-trace" with a value of "true".public static final String HOSTNAME
public static final String HOSTPORT
public static final String HOSTPORT_SECURE
public static final String MINIFICATION_ENABLED
ResourceMinimizer
service. If "false", then minification is disabled. Tracks production mode
(minification is normally disabled in development mode).
Note that Tapestry's default implementation of ResourceMinimizer
does nothing; minification is provided
by add-on libraries.public static final String CLUSTERED_SESSIONS
SessionPersistedObjectAnalyzer
will be called on each session persisted
object that was accessed during the request.
This is provided as a performance enhancement for servers that do not use clustered sessions.
The default is true
, to preserve 5.2 behavior. For non-clustered applications (the majority), this value should be
overridden to false
. A future release of Tapestry may change the default.public static final String APPLICATION_FOLDER
web.xml
configuration file. This is useful when running multiple servlets within the same web application (such as when migrating
from Tapestry 4 or some other framework, to Tapestry 5).
Effectively, if this symbol is set to a value, that folder name will be placed after the context path
(typically "/") and before the locale, page name, or other prefix. For example, if this symbol is set to "app", the web.xml <url-pattern>
should be set to /app/*
, and Tapestry will
only be in invoked by the servlet container for requests inside the virtual app
folder.
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.
The default value is the empty string, which preserves Tapestry 5.2 behavior (and continues to be appropriate for most applications).
Note that while Tapestry is case-insensitive, the servlet container is not, so the configured value must exactly match
the folder name inside the <url-parameter>
value, including case.public static final String ASSET_URL_FULL_QUALIFIED
Asset2
should be fully qualified or not.
Default to false
meaning no Asset URL will be fully qualified.public static final String ASSET_PATH_PREFIX
public static final String MODULE_PATH_PREFIX
Dispatcher
s from this: one for normal
modules, the other for GZip compressed modules (by appending ".gz" to this value).
The default is "modules".public static final String CONTEXT_PATH
ServletContext.getContextPath()
.
This is either a blank string or a string that starts with a slash but does not end with one.public static final String HMAC_PASSPHRASE
ClientDataEncoder
,
Constant Field Valuespublic static final String BOOTSTRAP_ROOT
public static final String JAVASCRIPT_INFRASTRUCTURE_PROVIDER
ModuleManager
service
as a JavaScriptModuleConfiguration
to provide a specific implementation
of the t5/core/dom
module. Tapestry 5.4 directly supports "prototype" or "jquery". To support
other foundation frameworks, override this symbol value and supply your own module configuration.
In Tapestry 5.4, this defaults to "prototype" for compatibility with 5.3. This will likely change in
5.5 to default to "jquery". At some point in the future, Prototype support will no longer be present.public static final String SESSION_LOCKING_ENABLED
HttpSession
.
Reading attribute names occurs with a shared read lock; getting or setting an attribute upgrades to an exclusive write lock.
This can tend to serialize threads when a number of simultaneous (Ajax) requests from the client arrive ... however,
many implementations of HttpSession are not thread safe, and often mutable objects are stored in the session and shared
between threads. Leaving this on the default will yield a more robust application; setting it to false may speed
up processing for more Ajax intensive applications (but care should then be given to ensuring that objects shared inside
the session are themselves immutable or thread-safe).public static final String INCLUDE_CORE_STACK
public static final String FORM_GROUP_WRAPPER_CSS_CLASS
form-group
.public static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_NAME
FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS
,
Constant Field Valuespublic static final String FORM_GROUP_FORM_FIELD_WRAPPER_ELEMENT_CSS_CLASS
public static final String FORM_GROUP_LABEL_CSS_CLASS
control-label
.public static final String FORM_FIELD_CSS_CLASS
form-control
.public static final String LENIENT_DATE_FORMAT
DateFormat
instances created by Tapestry should be
lenient or not by default. The default value is false
.public static final String EXCEPTION_REPORTS_DIR
build/exceptions
, and should be changed for production.ExceptionReporter
,
Constant Field Valuespublic static final String STRICT_CSS_URL_REWRITING
CSSURLRewriter
will throw an exception when a CSS file
references an URL which doesn't exist. The default value is false
.public static final String OMIT_EXPIRATION_CACHE_CONTROL_HEADER
Cache-Control
header; the default is "max-age=60, must-revalidate". Setting
max-age to a value above zero significantly reduces the number of client requests for module content, as client
browsers will then cache previously downloaded versions. For normal assets, which are immutable, and fingerprinted with
a content hash, there is no need to set max age, and instead, a far-future expiration date is provided.public static final String ENABLE_HTML5_SUPPORT
Html5Support.isHtml5SupportEnabled()
. Default value: false
.Html5Support.isHtml5SupportEnabled()
,
Constant Field Valuespublic static final String RESTRICTIVE_ENVIRONMENT
public static final String ENABLE_PAGELOADING_MASK
script
block is added to insert
a pageloader mask into the page; the pageloader mask ensure that the user can't interact with the page
until after the page is fully initialized.public static final String PRELOADER_MODE
PagePreloader
,
PreloaderMode
,
Constant Field Valuespublic SymbolConstants()
${project.version} - Copyright © 2003-2015 The Apache Software Foundation.