|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.AbstractComponent
org.zkoss.zml.XmlMacroComponent
public class XmlMacroComponent
The implementation of a macro component for XML output.
By default, compose()
will wire members by use
of Selectors
. In other words, it will wire annotated members
the same way as SelectorComposer
does.
If you prefer to wire the members based on the name convention
as GenericForwardComposer
does (i.e.,
backward compatible with ZK 5), you could specify a library property
called org.zkoss.zk.ui.macro.autowire.convention
to true
in WEB-INF/zk.xml as follows.
org.zkoss.zk.ui.macro.autowire.convention
true
If you prefer not to wire at all (neither by-selector nor by-convention),
you could specify a library property called
org.zkoss.zk.ui.macro.autowire.disabled
to true
in WEB-INF/zk.xml as follows..
org.zkoss.zk.ui.macro.autowire.disabled
true
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
org.zkoss.zk.ui.AbstractComponent.Children |
Field Summary | |
---|---|
protected List<org.zkoss.xel.VariableResolver> |
_resolvers
A list of resolvers (never null). |
Fields inherited from interface org.zkoss.zk.ui.Component |
---|
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE |
Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl |
---|
CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE |
Constructor Summary | |
---|---|
XmlMacroComponent()
|
Method Summary | |
---|---|
void |
afterCompose()
Creates the child components after apply dynamic properties setDynamicProperty(java.lang.String, java.lang.Object) . |
Object |
clone()
|
protected void |
compose()
Composes the macro component. |
Object |
getDynamicProperty(String name)
|
String |
getMacroURI()
|
boolean |
hasDynamicProperty(String name)
|
protected boolean |
isChildable()
|
boolean |
isInline()
|
void |
recreate()
|
void |
redraw(Writer out)
|
void |
setDynamicProperty(String name,
Object value)
|
boolean |
setInlineParent(org.zkoss.zk.ui.Component parent,
org.zkoss.zk.ui.Component beforeSibling)
|
void |
setMacroURI(String uri)
|
void |
setPage(org.zkoss.zk.ui.Page page)
Changes the page. |
void |
setParent(org.zkoss.zk.ui.Component parent)
Changes the parent. |
Methods inherited from class org.zkoss.zk.ui.AbstractComponent |
---|
addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onWrongValue, query, queryAll, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderProperties, replace, response, response, response, service, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setDefinition, setDefinition, setId, setMold, setPageBefore, setStubonly, setStubonly, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.zkoss.zk.ui.IdSpace |
---|
getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow |
Methods inherited from interface org.zkoss.zk.ui.ext.Scope |
---|
addScopeListener, getAttribute, getAttribute, getAttributes, hasAttribute, hasAttribute, removeAttribute, removeAttribute, removeScopeListener, setAttribute, setAttribute |
Field Detail |
---|
protected final List<org.zkoss.xel.VariableResolver> _resolvers
org.zkoss.zk.ui.select.annotation.VariableResolver
was annotated.
Constructor Detail |
---|
public XmlMacroComponent()
Method Detail |
---|
public void afterCompose()
setDynamicProperty(java.lang.String, java.lang.Object)
.
The second invocation is ignored. If you want to recreate
child components, use recreate()
instead.
If a macro component is created by ZK loader, this method is invoked automatically. Developers need to invoke this method only if they create a macro component manually.
If this is an line macro, this method is invoked automatically
if setParent(org.zkoss.zk.ui.Component)
or setPage(org.zkoss.zk.ui.Page)
called
afterCompose
in interface org.zkoss.zk.ui.ext.AfterCompose
protected void compose()
afterCompose()
, and others
to do the rendering based on getMacroURI()
.
public void setMacroURI(String uri)
setMacroURI
in interface org.zkoss.zk.ui.ext.Macro
public String getMacroURI()
getMacroURI
in interface org.zkoss.zk.ui.ext.Macro
public void recreate()
recreate
in interface org.zkoss.zk.ui.ext.Macro
public boolean isInline()
isInline
in interface org.zkoss.zk.ui.ext.Macro
public void setParent(org.zkoss.zk.ui.Component parent)
Note: if this is an inline macro (isInline()
),
this method actually changes the parent of all components created
from the macro URI.
In other word, an inline macro behaves like a controller of
the components it created. It doesn't belong to any page or parent.
Moreover, afterCompose()
is called automatically if
it is not called (and this is an inline macro).
setParent
in interface org.zkoss.zk.ui.Component
setParent
in class org.zkoss.zk.ui.AbstractComponent
public boolean setInlineParent(org.zkoss.zk.ui.Component parent, org.zkoss.zk.ui.Component beforeSibling)
setInlineParent
in interface org.zkoss.zk.ui.ext.Macro
public void setPage(org.zkoss.zk.ui.Page page)
Note: if this is an inline macro (isInline()
),
this method actually changes the page of all components created
from the macro URI.
In other word, an inline macro behaves like a controller of
the components it created. It doesn't belong to any page or parent.
Moreover, afterCompose()
is called automatically if
it is not called (and this is an inline macro).
setPage
in interface org.zkoss.zk.ui.Component
setPage
in class org.zkoss.zk.ui.AbstractComponent
protected boolean isChildable()
isChildable
in class org.zkoss.zk.ui.AbstractComponent
public void redraw(Writer out) throws IOException
redraw
in interface org.zkoss.zk.ui.sys.ComponentCtrl
redraw
in class org.zkoss.zk.ui.AbstractComponent
IOException
public Object clone()
clone
in interface org.zkoss.zk.ui.Component
clone
in class org.zkoss.zk.ui.AbstractComponent
public boolean hasDynamicProperty(String name)
hasDynamicProperty
in interface org.zkoss.zk.ui.ext.DynamicPropertied
public Object getDynamicProperty(String name)
getDynamicProperty
in interface org.zkoss.zk.ui.ext.DynamicPropertied
public void setDynamicProperty(String name, Object value) throws org.zkoss.zk.ui.WrongValueException
setDynamicProperty
in interface org.zkoss.zk.ui.ext.DynamicPropertied
org.zkoss.zk.ui.WrongValueException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |