Package org.zkoss.stateless.sul

Interface IHtml

All Superinterfaces:

IAnyGroup<IHtml>, IComponent<IHtml>, IHtmlBasedComponent<IHtml>, IXulElement<IHtml>

public interface IHtml
extends IXulElement<IHtml>, IAnyGroup<IHtml>

Immutable Html component

A component 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 withContent(java.lang.String).

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

Author:

katherine

See Also:

• Html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IHtml.Builder	Builds instances of type IHtml.
static class	IHtml.Updater	Builds an updater of type IHtml for UiAgent.smartUpdate(Locator, SmartUpdater).

Field Summary

Fields

Modifier and Type	Field	Description
static final IHtml	DEFAULT	Constant for default attributes of this immutable component.

Method Summary

Modifier and Type	Method	Description
default String	getContent()	Returns the embedded content (i.e., HTML tags).
default String	getWidgetClass()	Returns the client widget class.
static IHtml	of(String content)	Returns the instance with the given content.
static IHtml	ofId(String id)	Returns the instance with the given id.
IHtml	withContent(String content)	Returns a copy of this immutable component with the specified content.

Methods inherited from interface org.zkoss.stateless.sul.IComponent

getAction, getActions, getClientAttributes, getId, getMold, getWidgetListeners, getWidgetOverrides, isVisible, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withAction, withActions, withActions, withClientAttribute, withClientAttributes, withId, withMold, withVisible, withWidgetClass, withWidgetListener, withWidgetListeners, withWidgetOverride, withWidgetOverrides

Methods inherited from interface org.zkoss.stateless.sul.IHtmlBasedComponent

getClientAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getSkeleton, getStyle, getTabindex, getTooltiptext, getTop, getVflex, getWidth, getZclass, getZIndex, isFocus, withClientAction, withDraggable, withDroppable, withFocus, withHeight, withHflex, withLeft, withRenderdefer, withSclass, withSkeleton, withStyle, withTabindex, withTabindex, withTooltiptext, withTop, withVflex, withWidth, withZclass, withZIndex

Methods inherited from interface org.zkoss.stateless.sul.IXulElement

getContext, getCtrlKeys, getPopup, getTooltip, withContext, withCtrlKeys, withPopup, withTooltip

Field Details

DEFAULT

static final IHtml DEFAULT

Constant for default attributes of this immutable component.

Method Details

getWidgetClass

default String getWidgetClass()

Returns the client widget class.

Default: "zul.wgt.Html"

Specified by:

getWidgetClass in interface IComponent<IHtml>

getContent

default String getContent()

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

withContent

IHtml withContent(String content)

Returns a copy of this immutable component with the specified content.

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

Security Note

Unlike other methods, the content assigned to this method is generated directly to the browser without escaping. Thus, it is better not to have something input by the user to avoid any XSS attach.

Parameters:

content - The HTML content.

Default: "".

Returns:

A modified copy of the this object

of

static IHtml of(String content)

Returns the instance with the given content.

Parameters:

content - The HTML content

ofId

static IHtml ofId(String id)

Returns the instance with the given id.

Parameters:

id - The id to identify this component