The org.zkoss.zk.ui.sys.SEORenderer interface

From Documentation
Revision as of 10:24, 19 January 2022 by Hawk (talk | contribs) (correct highlight (via JWB))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

DocumentationZK Configuration Referencezk.xmlThe listener ElementThe org.zkoss.zk.ui.sys.SEORenderer interface
The org.zkoss.zk.ui.sys.SEORenderer interface



A listener could implement SEORenderer to generate application-specific SEO content. The SEO content could be anything. It is visible to the search engine (for indexing), but it is not visible to the end users[1]

Once registered, SEORenderer.render(Page, Writer) will be invoked each time the main page of a desktop has been rendered and sent to the client[2].

For example, assume you have an implementation called foo.MySEORenderer, then you could specify it in WEB-INF/zk.xml

<!-- in WEB-INF/zk.xml -->

You could generate anything that you'd like the search engine to index in SEORenderer.render(Page, Writer):

package foo;
import org.zkoss.zk.ui.sys.SEORenderer;
import org.zkoss.zk.ui.Page;
public class MySEORenderer implements SEORenderer {
    public void render(Page page, out)
    throws {
        out.write("<a href=\"whatever\">whatever</a>");

In addition to SEO content, you could also generate the JavaScript code. For example, you could implement a SEORenderer listener to generate a snippet of JavaScript code that will be embedded into every page.

Notice that, if specified, this class will be instantiated and invoked even if the crawlable option is not enabled.

Instantiation: An independent instance of the given class is instantiated each time before the method is invoked. It means it is thread safe, and all information stored in non-static members will be lost after called.

Real Example

You can also take a look at the ZK's blog about another approach to SEO in ZK Applications.

  1. The SEO content will be replaced with the content of ZK components after the page has been rendered.
  2. It also means it won't be called in AU requests.

Version History

Last Update : 2022/01/19

Version Date Content
5.0.7 April 2011 SEORenderer could be specified as a listener.

Last Update : 2022/01/19

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.