org.zkoss.zk.ui.sys
Interface PageConfig

public interface PageConfig

Represents the info used to initialize a page.

Since:

3.0.0

Author:

tomyeh

See Also:

PageCtrl.init(org.zkoss.zk.ui.sys.PageConfig)

Method Summary

java.lang.Boolean	getCacheable() Returns if the client can cache the rendered result, or null to use the device default.
java.lang.String	getContentType() Returns the content type, or null to use the device default.
java.lang.String	getDocType() Returns the doc type (<!
java.lang.String	getFirstLine() Returns the first line to be generated to the output, or null if nothing to generate.
java.lang.String	getHeaders() Returns the content that will be generated inside the header element, or null if no special header is required.
java.lang.String	getId() Returns the page identifier, or null if auto-generation is required.
java.lang.String	getRootAttributes() Returns the content that will be generated as the attributes of the root element, or null if no special attribute is required.
java.lang.String	getStyle() Returns the page's CSS style, or null if no special CSS style to assign.
java.lang.String	getTitle() Returns the page title, or null if not available (no title at all).
java.lang.String	getUuid() Returns the page's UUID.

Method Detail

getId

java.lang.String getId()

Returns the page identifier, or null if auto-generation is required. It is the identifier set by the appplication developer. If null, the implementation of PageCtrl.init(org.zkoss.zk.ui.sys.PageConfig) shall generate one automatically.

Note: if Page.setId(java.lang.String) was called with a non-empty value before, this method is ignored.

getUuid

java.lang.String getUuid()

Returns the page's UUID. This method is used only in the recovering mode (ExecutionCtrl.isRecovering()). In other words, it is null if not in the recovering mode.

getTitle

java.lang.String getTitle()

Returns the page title, or null if not available (no title at all).

Note: if Page.setTitle(java.lang.String) was called with a non-empty value before, this method is ignored.

getStyle

java.lang.String getStyle()

Returns the page's CSS style, or null if no special CSS style to assign.

Note: if Page.setStyle(java.lang.String) was called with a non-empty value before, this method is ignored.

getHeaders

java.lang.String getHeaders()

Returns the content that will be generated inside the header element, or null if no special header is required.

For HTML, the header element is the HEAD element.

See Also:

PageCtrl.getHeaders()

getRootAttributes

java.lang.String getRootAttributes()

Returns the content that will be generated as the attributes of the root element, or null if no special attribute is required.

For HTML, the root element is the HTML element.

See Also:

PageCtrl.getRootAttributes()

getContentType

java.lang.String getContentType()

Returns the content type, or null to use the device default.

getDocType

java.lang.String getDocType()

Returns the doc type (<!DOCTYPE>), or null to use the device default.

getFirstLine

java.lang.String getFirstLine()

Returns the first line to be generated to the output, or null if nothing to generate.

For XML devices, it is usually the xml processing instruction:
<?xml version="1.0" encoding="UTF-8"?>

getCacheable

java.lang.Boolean getCacheable()

Returns if the client can cache the rendered result, or null to use the device default.