public class SelectorComposer<T extends Component> extends Object implements Composer<T>, ComposerExt<T>, ComponentCloneListener, ComponentActivationListener, Serializable
A composer analogous to GenericForwardComposer. Instead of wiring variables and adding event listeners by naming convention, this composer do the work by annotation and selectors.
For example:
MyComposer.java
public class MyComposer extends SelectorComposer {
@Wire("#win")
private Window myWin;
// implicit variables
@WireVariable
private Desktop desktop;
@Listen("onClick = button#btn")
public void onSubmit(Event event){
// do something ...
}
}
@Wire("textbox") // matches all textboxes
@Wire("#win") // matches components of id "#win" within the same IdSpace
@Wire(".myclass") // matches components of sclass "myclass"
@Wire("label[value = 'My Label']") // matches all labels with value "My Label"
@Wire(":first-child") // matches all components which are first child
@Wire("window textbox") // matches textbox who is a descendant of a window
@Wire("window > textbox") // matches textbox who is a child of a window
@Wire("window + textbox") // matches textbox who is the next sibling of a window
@Wire("window ~ textbox") // matches textbox who is a younger sibling of a window
@Wire("window > textbox.myclass:first-child") // conditions can be mixed
| Modifier and Type | Class and Description |
|---|---|
static interface |
SelectorComposer.UtilityHandler
An interface for SelectorComposer's functionality plug-in.
|
static class |
SelectorComposer.UtilityHandlerImpl
Default skeletal implementation of
SelectorComposer.UtilityHandler. |
| Modifier and Type | Field and Description |
|---|---|
protected List<org.zkoss.xel.VariableResolver> |
_resolvers
A list of resolvers (never null).
|
| Constructor and Description |
|---|
SelectorComposer() |
| Modifier and Type | Method and Description |
|---|---|
protected void |
alert(String m)
Shortcut to call Messagebox.show(String).
|
void |
didActivate(Component comp)
Called when a session has just been activated
(and its value has been deserialized).
|
void |
doAfterCompose(T comp)
Invokes after ZK loader creates this component,
initializes it and composes all its children, if any.
|
ComponentInfo |
doBeforeCompose(Page page,
Component parent,
ComponentInfo compInfo)
Invokes before composing a component.
|
void |
doBeforeComposeChildren(T comp)
Invokes after the component is instantiated and initialized, but
before composing any child.
|
boolean |
doCatch(Throwable ex)
Called when an exception occurs when composing the component.
|
void |
doFinally()
Called after the component has been composed completely.
|
protected Page |
getPage()
Returns the current page.
|
protected T |
getSelf()
Returns the component which applies to this composer.
|
protected static SelectorComposer.UtilityHandler |
getUtilityHandler() |
Object |
willClone(Component comp)
Internal use only.
|
void |
willPassivate(Component comp)
Called when a session is about to be passivated
(and then serialize its value).
|
protected final List<org.zkoss.xel.VariableResolver> _resolvers
VariableResolver was annotated.public ComponentInfo doBeforeCompose(Page page, Component parent, ComponentInfo compInfo)
ComposerExtComponentInfo.duplicate() to make a copy and then
modify it such that it won't affect the default behavior.doBeforeCompose in interface ComposerExt<T extends Component>page - the page for composing this component.parent - the parent component, or null if it is the root component.compInfo - the component info used to instantiate the component.
Notice that it is null if the page is rendered as ZK JSP, since
ComponentInfo is not available under ZK JSP.public void doBeforeComposeChildren(T comp) throws Exception
ComposerExtdoBeforeComposeChildren in interface ComposerExt<T extends Component>comp - the component being composedExceptionpublic void doAfterCompose(T comp) throws Exception
ComposerdoAfterCompose in interface Composer<T extends Component>comp - the component has been composedExceptionprotected T getSelf()
protected Page getPage()
protected void alert(String m)
public Object willClone(Component comp)
willClone in interface ComponentCloneListenercomp - the clone of the applied componentpublic void didActivate(Component comp)
ComponentActivationListenerdidActivate in interface ComponentActivationListenerpublic void willPassivate(Component comp)
ComponentActivationListenerwillPassivate in interface ComponentActivationListenerpublic boolean doCatch(Throwable ex) throws Exception
ComposerExtIf you don't want to handle the exception, simply returns false.
boolean doCatch(Throwable ex) {return false;}
An exception thrown in this method is simply logged. It has no effect on the execution. If you want to ignore the exception, just return true.
doCatch in interface ComposerExt<T extends Component>ex - the exception being thrownExceptionpublic void doFinally()
throws Exception
ComposerExtNote: it is always called even if ComposerExt.doCatch(java.lang.Throwable),
ComposerExt.doBeforeComposeChildren(T) or
Composer.doAfterCompose(T) is not called (due to exceptions).
Note: it is called after the onCreate event is posted, but before the onCreate and any other events are handled.
An exception thrown in this method is simply logged. It has no effect on the execution.
doFinally in interface ComposerExt<T extends Component>Exceptionprotected static SelectorComposer.UtilityHandler getUtilityHandler()
Copyright © 2017. All rights reserved.