org.zkoss.jsp.zul.impl
Class UiTag

java.lang.Object
  javax.servlet.jsp.tagext.SimpleTagSupport
      org.zkoss.jsp.zul.impl.AbstractTag
          org.zkoss.jsp.zul.impl.LeafTag
              org.zkoss.jsp.zul.impl.BranchTag
                  org.zkoss.jsp.zul.impl.UiTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.DynamicAttributes, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.SimpleTag, ComponentTag

public class UiTag
extends BranchTag

UiTag is used to represent the dynamic tagging feature that ZK support but Jsp spec does not.
The purpose of UiTag is to declare a component instance that user defined in language add-on or current Jsp page.
About how to declare a custom component definition in Jsp page, please take a look at: ComponentDefinitionTag

For example:
<z:ui tag="mywindow" title="A demo window"/>
It same as the declaration below in ZK's zul page:
<mywindow title="A demo window"/>

Author:

Ian Tsai

Field Summary

Fields inherited from class org.zkoss.jsp.zul.impl.LeafTag

_attrMap, _comp, _eventListenerMap, _forward, _parenttag, _roottag, _use, composeHandle

Constructor Summary

UiTag()

Method Summary

org.zkoss.zk.ui.Component[]	getComponents() a dummy method of LeafTag.getComponent()
protected java.lang.String	getJspTagName() The name of Jsp Tag.
java.lang.String	getTag()
boolean	isInline() default Tag's Component is not an inline macro.
void	setTag(java.lang.String tag) Set the information of component definition about what component this UiTag should create while component creation phase.

Methods inherited from class org.zkoss.jsp.zul.impl.BranchTag

addChildTag, doTag

Methods inherited from class org.zkoss.jsp.zul.impl.LeafTag

evaluateDynaAttributes, getComponent, getForward, getParentTag, getRootTag, getUse, setDynamicAttribute, setForward, setParent, setUse

Methods inherited from class org.zkoss.jsp.zul.impl.AbstractTag

getIf, getUnless, isEffective, setIf, setUnless

Methods inherited from class javax.servlet.jsp.tagext.SimpleTagSupport

findAncestorWithClass, getJspBody, getJspContext, getParent, setJspBody, setJspContext

Methods inherited from class java.lang.Object

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

Constructor Detail

UiTag

public UiTag()

Method Detail

getJspTagName

protected java.lang.String getJspTagName()

Description copied from class: LeafTag

The name of Jsp Tag.

Specified by:

getJspTagName in class LeafTag

getTag

public java.lang.String getTag()

Returns:

the tag that this UiTag use.

setTag

public void setTag(java.lang.String tag)

Set the information of component definition about what component this UiTag should create while component creation phase.

Parameters:

tag - .

isInline

public boolean isInline()

Description copied from class: LeafTag

default Tag's Component is not an inline macro.

Specified by:

isInline in interface ComponentTag

Overrides:

isInline in class LeafTag

getComponents

public org.zkoss.zk.ui.Component[] getComponents()

Description copied from class: LeafTag

a dummy method of LeafTag.getComponent()

Specified by:

getComponents in interface ComponentTag

Overrides:

getComponents in class LeafTag

Returns:

the inline macro will return mulitple Components.