org.zkoss.zk.fn
Class ZkFns

java.lang.Object
  org.zkoss.zk.fn.ZkFns

public class ZkFns
extends java.lang.Object

Utilities for using EL.

Author:

tomyeh

Constructor Summary

protected

ZkFns()

Method Summary

static java.io.Writer	getCurrentOut() Returns the current writer to generate the output.
static java.util.List	getStyleSheets(Execution exec) Returns a list of StyleSheet that shall be generated to the client for the specified execution.
static java.lang.String	outContentType(Page page) Returns the content type (never null).
static java.lang.String	outDocType(Page page) Returns the doc type, or null if not available.
static java.lang.String	outFirstLine(Page page) Returns the first line to be generated to the output, or null if no special first line.
static java.lang.String	outHeaders(Page page) Returns the content that will be placed inside the header element of the specified page.
static java.lang.String	outLangJavaScripts(java.lang.String action) Returns HTML tags to include all JavaScript files and codes that are required when loading a ZUML page.
static java.lang.String	outLangStyleSheets() Returns HTML tags to include all style sheets that are defined in all languages.
static java.lang.String	outLocaleJavaScript() Generates Locale-dependent strings in JavaScript syntax.
static java.lang.String	outResponseJavaScripts(java.util.Collection responses) Returns JavaScript for handling the specified response.
static java.lang.String	outRootAttributes(Page page) Returns the content that will be generated as the attributes of the root element of the specified page.
static void	redraw(Component comp, java.io.Writer out) Redraw the specified component into the specified out.
static java.lang.String	toAbsoluteURI(java.lang.String uri) Converts the specified URI to absolute if not included by another page.
static java.lang.String	toAbsoluteURI(java.lang.String uri, boolean skipInclude) Converts the specified URI to absolute if necessary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZkFns

protected ZkFns()

Method Detail

redraw

public static final void redraw(Component comp,
                                java.io.Writer out)
                         throws java.io.IOException

Redraw the specified component into the specified out.

Parameters:

comp - the component. If null, nothing happens

out - the output. If null, the current output will be used.

Throws:

java.io.IOException

getCurrentOut

public static final java.io.Writer getCurrentOut()
                                          throws java.io.IOException

Returns the current writer to generate the output.

Throws:

java.io.IOException

Since:

3.0.0

outResponseJavaScripts

public static final java.lang.String outResponseJavaScripts(java.util.Collection responses)

Returns JavaScript for handling the specified response.

outLangJavaScripts

public static final java.lang.String outLangJavaScripts(java.lang.String action)

Returns HTML tags to include all JavaScript files and codes that are required when loading a ZUML page.

Note: it assumes Executions.getCurrent() is available.

FUTURE CONSIDERATION: we might generate the inclusion on demand instead of all at once.

outLangStyleSheets

public static final java.lang.String outLangStyleSheets()

Returns HTML tags to include all style sheets that are defined in all languages.

Note: it assumes Executions.getCurrent() is available.

In addition to style sheets defined in lang.xml and lang-addon.xml, it also include:

1. The style sheet specified in the theme-uri parameter.

FUTURE CONSIDERATION: we might generate the inclusion on demand instead of all at once.

getStyleSheets

public static final java.util.List getStyleSheets(Execution exec)

Returns a list of StyleSheet that shall be generated to the client for the specified execution.

toAbsoluteURI

public static java.lang.String toAbsoluteURI(java.lang.String uri,
                                             boolean skipInclude)

Converts the specified URI to absolute if necessary. Refer to Execution.toAbsoluteURI(java.lang.String, boolean).

Parameters:

skipInclude - whether not to convert to an absolute URI if the current page is included by another page. When use the include directive, skipInclude shall be true.

toAbsoluteURI

public static java.lang.String toAbsoluteURI(java.lang.String uri)

Converts the specified URI to absolute if not included by another page. It is a shortcut of toAbsoluteURI(String, boolean) with skipInclude is true.

outHeaders

public static final java.lang.String outHeaders(Page page)

Returns the content that will be placed inside the header element of the specified page. For HTML, the header element is the HEAD element.

outRootAttributes

public static final java.lang.String outRootAttributes(Page page)

Returns the content that will be generated as the attributes of the root element of the specified page. For HTML, the root element is the HTML element.

outContentType

public static final java.lang.String outContentType(Page page)

Returns the content type (never null).

Since:

3.0.0

outDocType

public static final java.lang.String outDocType(Page page)

Returns the doc type, or null if not available. It is null or <!DOCTYPE ...>.

Since:

3.0.0

outFirstLine

public static final java.lang.String outFirstLine(Page page)

Returns the first line to be generated to the output, or null if no special first line.

outLocaleJavaScript

public static final java.lang.String outLocaleJavaScript()

Generates Locale-dependent strings in JavaScript syntax.