Attributes (The ZKoss Web Library 9.6.5 API)

java.lang.Object
- org.zkoss.web.Attributes

```
public class Attributes
extends Object
```
Definition of constants used as attributes and parameters across requests.

Author:

tomyeh

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALERT` The attribute name that contains the alert passed from another request `Https.sendRedirect(jakarta.servlet.ServletContext, jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse, java.lang.String, java.util.Map, int)`.
`static String`	`ALERT_TYPE` Denote the type of `ALERT`.
`static String`	`ARG` The attribute used to pass parameters from the caller that invokes Servlets.include() or Servlets.forward() with `Servlets.PASS_THRU_ATTR`.
`static String`	`ASYNC_CONTEXT_PATH` The async context path; set by the servlet container.
`static String`	`ERROR_EXCEPTION` The attribute to hold the exception, if any.
`static String`	`FORWARD_CONTEXT_PATH` The original context path that forwards this page; set by the servlet container.
`static String`	`FORWARD_PATH_INFO` The original servlet path that forwards this page; set by the servlet container.
`static String`	`FORWARD_QUERY_STRING` The original servlet path that forwards this page; set by the servlet container.
`static String`	`FORWARD_REQUEST_URI` The original request URI that forwards this page; set by the servlet container.
`static String`	`FORWARD_SERVLET_PATH` The original servlet path that forwards this page; set by the servlet container.
`static String`	`INCLUDE_CONTEXT_PATH` The included context path; set by the servlet container.
`static String`	`INCLUDE_PATH_INFO` The included servlet path; set by the servlet container.
`static String`	`INCLUDE_QUERY_STRING` The included servlet path; set by the servlet container.
`static String`	`INCLUDE_REQUEST_URI` The included request URI; set by the servlet container.
`static String`	`INCLUDE_SERVLET_PATH` The included servlet path; set by the servlet container.
`static String`	`PREFERRED_2DIGITYEARSTART` The library property used to store the preferred 2DigitYearStart.
`static String`	`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.
`static String`	`PREFERRED_FIRST_DAY_OF_WEEK` The session attribute used to store the preferred first-day-of-week.
`static String`	`PREFERRED_LOCALE` The session attribute used to store the preferred locale (Locale) in a session.
`static String`	`PREFERRED_TIME_ZONE` The session attribute used to store the preferred time zone (TimeZone) in a session.
`static String`	`TITLE` The title (String) of a servlet or a portal.

Constructor Summary

Constructors
Modifier Constructor and Description

protected Attributes()
Don't construct it.

Constructors
Modifier	Constructor and Description
`protected`	`Attributes()` Don't construct it.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TITLE
```
public static final String TITLE
```
    The title (String) of a servlet or a portal. Stored as an attribute of the request.
    
    See Also:
    
    Constant Field Values
  - PREFERRED_LOCALE
```
public static final String PREFERRED_LOCALE
```
    The session attribute used to store the preferred locale (Locale) in a session.
    
    See Also:
    
    Constant Field Values
  - PREFERRED_TIME_ZONE
```
public static final String PREFERRED_TIME_ZONE
```
    The session attribute used to store the preferred time zone (TimeZone) in a session.
    
    See Also:
    
    Constant Field Values
  - PREFERRED_FIRST_DAY_OF_WEEK
```
public static final String PREFERRED_FIRST_DAY_OF_WEEK
```
    The session attribute used to store the preferred first-day-of-week. The value must be one of Calendar.SUNDAY, Calendar.MONDAY, Calendar.SATURDAY and 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:
    
    Constant Field Values
  - PREFERRED_2DIGITYEARSTART
```
public static final String PREFERRED_2DIGITYEARSTART
```
    The library property used to store the preferred 2DigitYearStart.
    Default: 1929
    
    Since:
    
    8.6.2
    
    See Also:
    
    Constant Field Values
  - PREFERRED_DATE_FORMAT_INFO
```
public static final String 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 implement org.zkoss.text.DateFormatInfo.
    
    Since:
    
    5.0.7
    
    See Also:
    
    Constant Field Values
  - ALERT
```
public static final String ALERT
```
    The attribute name that contains the alert passed from another request Https.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:
    
    Constant Field Values
  - ALERT_TYPE
```
public static final String ALERT_TYPE
```
    Denote the type of ALERT. It could be "error", "warning" and undefined. It is used by JSP page to do more accurate page layout.
    
    See Also:
    
    Constant Field Values
  - ARG
```
public static final String ARG
```
    The attribute used to pass parameters from the caller that invokes Servlets.include() or Servlets.forward() with Servlets.PASS_THRU_ATTR.
    
    See Also:
    
    Constant Field Values
  - INCLUDE_CONTEXT_PATH
```
public static final String INCLUDE_CONTEXT_PATH
```
    The included context path; set by the servlet container.
    
    See Also:
    
    Https.getThisContextPath(jakarta.servlet.ServletRequest), Https.getOriginContextPath(jakarta.servlet.ServletRequest), Constant Field Values
  - INCLUDE_SERVLET_PATH
```
public static final String INCLUDE_SERVLET_PATH
```
    The included servlet path; set by the servlet container.
    
    See Also:
    
    Https.getThisServletPath(jakarta.servlet.ServletRequest), Https.getOriginServletPath(jakarta.servlet.ServletRequest), Constant Field Values
  - INCLUDE_REQUEST_URI
```
public static final String INCLUDE_REQUEST_URI
```
    The included request URI; set by the servlet container.
    
    See Also:
    
    Https.getThisRequestURI(jakarta.servlet.ServletRequest), Constant Field Values
  - INCLUDE_PATH_INFO
```
public static final String INCLUDE_PATH_INFO
```
    The included servlet path; set by the servlet container.
    
    See Also:
    
    Https.getThisPathInfo(jakarta.servlet.ServletRequest), Https.getOriginPathInfo(jakarta.servlet.ServletRequest), Constant Field Values
  - INCLUDE_QUERY_STRING
```
public static final String INCLUDE_QUERY_STRING
```
    The included servlet path; set by the servlet container.
    
    See Also:
    
    Https.getThisQueryString(jakarta.servlet.ServletRequest), Https.getOriginQueryString(jakarta.servlet.ServletRequest), Constant Field Values
  - FORWARD_CONTEXT_PATH
```
public static final String FORWARD_CONTEXT_PATH
```
    The original context path that forwards this page; set by the servlet container.
    
    See Also:
    
    Https.getThisServletPath(jakarta.servlet.ServletRequest), Https.getOriginServletPath(jakarta.servlet.ServletRequest), Constant Field Values
  - FORWARD_SERVLET_PATH
```
public static final String FORWARD_SERVLET_PATH
```
    The original servlet path that forwards this page; set by the servlet container.
    
    See Also:
    
    Https.getThisServletPath(jakarta.servlet.ServletRequest), Https.getOriginServletPath(jakarta.servlet.ServletRequest), Constant Field Values
  - FORWARD_REQUEST_URI
```
public static final String FORWARD_REQUEST_URI
```
    The original request URI that forwards this page; set by the servlet container.
    
    See Also:
    
    Https.getThisRequestURI(jakarta.servlet.ServletRequest), Constant Field Values
  - FORWARD_PATH_INFO
```
public static final String FORWARD_PATH_INFO
```
    The original servlet path that forwards this page; set by the servlet container.
    
    See Also:
    
    Https.getThisPathInfo(jakarta.servlet.ServletRequest), Https.getOriginPathInfo(jakarta.servlet.ServletRequest), Constant Field Values
  - FORWARD_QUERY_STRING
```
public static final String FORWARD_QUERY_STRING
```
    The original servlet path that forwards this page; set by the servlet container.
    
    See Also:
    
    Https.getThisQueryString(jakarta.servlet.ServletRequest), Https.getOriginQueryString(jakarta.servlet.ServletRequest), Constant Field Values
  - ASYNC_CONTEXT_PATH
```
public static final String ASYNC_CONTEXT_PATH
```
    The async context path; set by the servlet container.
    
    See Also:
    
    Https.getThisContextPath(jakarta.servlet.ServletRequest), Constant Field Values
  - ERROR_EXCEPTION
```
public static final String ERROR_EXCEPTION
```
    The attribute to hold the exception, if any.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Attributes
```
protected Attributes()
```
    Don't construct it. All members are static.

Class Attributes

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TITLE

PREFERRED_LOCALE

PREFERRED_TIME_ZONE

PREFERRED_FIRST_DAY_OF_WEEK

PREFERRED_2DIGITYEARSTART

PREFERRED_DATE_FORMAT_INFO

ALERT

ALERT_TYPE

ARG

INCLUDE_CONTEXT_PATH

INCLUDE_SERVLET_PATH

INCLUDE_REQUEST_URI

INCLUDE_PATH_INFO

INCLUDE_QUERY_STRING

FORWARD_CONTEXT_PATH

FORWARD_SERVLET_PATH

FORWARD_REQUEST_URI

FORWARD_PATH_INFO

FORWARD_QUERY_STRING

ASYNC_CONTEXT_PATH

ERROR_EXCEPTION

Constructor Detail

Attributes