Package org.zkoss.web
Class Attributes
java.lang.Object
org.zkoss.web.Attributes
Definition of constants used as attributes and parameters across
requests.
- Author:
- tomyeh
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe attribute name that contains the alert passed from another requestHttps.sendRedirect(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, java.lang.String, java.util.Map, int).static final StringDenote the type ofALERT.static final StringThe attribute used to pass parameters from the caller that invokes Servlets.include() or Servlets.forward() withServlets.PASS_THRU_ATTR.static final StringThe async context path; set by the servlet container.static final StringThe attribute to hold the exception, if any.static final StringThe attribute to hold the exception list, if any.static final StringThe original context path that forwards this page; set by the servlet container.static final StringThe original servlet path that forwards this page; set by the servlet container.static final StringThe original servlet path that forwards this page; set by the servlet container.static final StringThe original request URI that forwards this page; set by the servlet container.static final StringThe original servlet path that forwards this page; set by the servlet container.static final StringThe included context path; set by the servlet container.static final StringThe included servlet path; set by the servlet container.static final StringThe included servlet path; set by the servlet container.static final StringThe included request URI; set by the servlet container.static final StringThe included servlet path; set by the servlet container.static final StringThe library property used to store the preferred 2DigitYearStart.static final StringThe session attribute used to specify the class used to return the formats of date, time or both for datebox and timebox.static final StringThe session attribute used to store the preferred first-day-of-week.static final StringThe session attribute used to store the preferred locale (Locale) in a session.static final StringThe session attribute used to store the preferred time zone (TimeZone) in a session.static final StringThe title (String) of a servlet or a portal. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
TITLE
The title (String) of a servlet or a portal. Stored as an attribute of the request.- See Also:
-
PREFERRED_LOCALE
The session attribute used to store the preferred locale (Locale) in a session.- See Also:
-
PREFERRED_TIME_ZONE
The session attribute used to store the preferred time zone (TimeZone) in a session.- See Also:
-
PREFERRED_FIRST_DAY_OF_WEEK
The session attribute used to store the preferred first-day-of-week. The value must be one ofCalendar.SUNDAY,Calendar.MONDAY,Calendar.SATURDAYand so on.Default: -1 (it means
Calendar.getFirstDayOfWeek()is assumed)Notice that you could specify it as a library property such that it will be the default value for the whole application (with the higher priority than
Calendar.- Since:
- 5.0.3
- See Also:
-
PREFERRED_2DIGITYEARSTART
The library property used to store the preferred 2DigitYearStart.Default: 1929
- Since:
- 8.6.2
- See Also:
-
PREFERRED_DATE_FORMAT_INFO
The session attribute used to specify the class used to return the formats of date, time or both for datebox and timebox. The class must implementDateFormatInfo.- Since:
- 5.0.7
- See Also:
-
ALERT
The attribute name that contains the alert passed from another requestHttps.sendRedirect(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, java.lang.String, java.util.Map, int). It is automatically reset after the next request is responded. In JSP, web authors use <c:object name="i.alert" scope="request"> to access it.- See Also:
-
ALERT_TYPE
Denote the type ofALERT. It could be "error", "warning" and undefined. It is used by JSP page to do more accurate page layout.- See Also:
-
ARG
The attribute used to pass parameters from the caller that invokes Servlets.include() or Servlets.forward() withServlets.PASS_THRU_ATTR.- See Also:
-
INCLUDE_CONTEXT_PATH
The included context path; set by the servlet container. -
INCLUDE_SERVLET_PATH
The included servlet path; set by the servlet container. -
INCLUDE_REQUEST_URI
The included request URI; set by the servlet container. -
INCLUDE_PATH_INFO
The included servlet path; set by the servlet container. -
INCLUDE_QUERY_STRING
The included servlet path; set by the servlet container. -
FORWARD_CONTEXT_PATH
The original context path that forwards this page; set by the servlet container. -
FORWARD_SERVLET_PATH
The original servlet path that forwards this page; set by the servlet container. -
FORWARD_REQUEST_URI
The original request URI that forwards this page; set by the servlet container. -
FORWARD_PATH_INFO
The original servlet path that forwards this page; set by the servlet container. -
FORWARD_QUERY_STRING
The original servlet path that forwards this page; set by the servlet container. -
ASYNC_CONTEXT_PATH
The async context path; set by the servlet container. -
ERROR_EXCEPTION
The attribute to hold the exception, if any.- See Also:
-
ERROR_EXCEPTION_LIST
The attribute to hold the exception list, if any.- Since:
- 10.2.0
- See Also:
-
-
Constructor Details
-
Attributes
protected Attributes()Don't construct it. All members are static.
-