Html (ZK 3.6.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.zkoss.zul.api
Interface Html

All Superinterfaces:: java.lang.Cloneable, Component, HtmlBasedComponent, Scope, java.io.Serializable, XulElement

All Known Implementing Classes:: Html

public interface Html
extends XulElement
extends XulElement

A comonent used to embed the browser native content (i.e., HTML tags) into the output sent to the browser. The browser native content is specified by setContent(java.lang.String).

Notice that Html generates HTML SPAN to enclose the embedded HTML tags. Thus, you can specify the style (HtmlBasedComponent.getStyle()), tooltip XulElement.getTooltip() and so on.

 <code><html style="border: 1px solid blue"><![CDATA[
 <ul>
  <li>It is in a SPAN tag.</li>
 </ul>
 ]></html></code>

The generated HTML tags will look like:

 <code><SPAN id="xxx" style="border: 1px solid blue">
 <ul>
  <li>It is in a SPAN tag.</li>
 </ul>
 </SPAN></code>

Since SPAN is used to enclosed the embedded HTML tags, so the following is incorrect.

 <code><html><![CDATA[
 <table>
  <tr>
   <td> <-- Incomplete since it is inside SPAN -->
 ]></html>
 <textbox/>
 <html><![CDATA[
   </td>
  </tr>
 </table>
 ]></html></code>

If you need to generate the HTML tags directly without enclosing with SPAN, you can use the Native namespace, http://www.zkoss.org/2005/zk/native. Refer to the Developer's Guide for more information.

A non-XUL extension.

Since:: 3.5.2
Author:: tomyeh

Field Summary

Fields inherited from interface org.zkoss.zk.ui.Component
`APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE`

Method Summary
`java.lang.String`	`getContent()` Returns the embedded content (i.e., HTML tags).
`void`	`setContent(java.lang.String content)` Sets the embedded content (i.e., HTML tags).

Methods inherited from interface org.zkoss.zul.impl.api.XulElement
`getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip`

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent
`focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZclass, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex`

Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributes, getAttributes, getChildren, getDefinition, getDesktop, getFellow, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, insertBefore, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, redraw, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, unsetVariable

Method Detail

getContent

java.lang.String getContent()

Returns the embedded content (i.e., HTML tags).

Default: empty ("").

setContent

void setContent(java.lang.String content)

Sets the embedded content (i.e., HTML tags).