Package org.zkoss.zk.ui.impl

Class AbstractExecution

java.lang.Object

org.zkoss.zk.ui.impl.AbstractExecution

All Implemented Interfaces:

Execution, Scope, ExecutionCtrl

Direct Known Subclasses:

ExecutionImpl

public abstract class AbstractExecution
extends Object
implements Execution, ExecutionCtrl

A skeletal implementation of Execution.

Author:

tomyeh

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	Add_ON_ACTIVATE
protected static final String	Add_ON_DEACTIVATE

Fields inherited from interface org.zkoss.zk.ui.Execution

APPEND_PARAM, IGNORE_PARAM, OVERWRITE_URI, PASS_THRU_ATTR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractExecution(Desktop desktop, Page creating)	Constructs an execution.

Method Summary

Modifier and Type	Method	Description
void	addAuResponse(String key, AuResponse response)	Adds an asynchronous response (AuResponse) with the given key instead of AuResponse.getOverrideKey().
void	addAuResponse(AuResponse response)	Adds an asynchronous response (AuResponse) which will be sent to client at the end of the execution.
void	addOnActivate(Callback callback)	Adds a callback method to be executed only once after the execution activated.
void	addOnDeactivate(Callback callback)	Adds a callback method to be executed only once after the execution deactivated.
boolean	addVariableResolver(org.zkoss.xel.VariableResolver resolver)	Adds a name resolver that will be used to resolve a variable (by Execution.getVariableResolver()).
Component[]	createComponents(String uri, Map<?,?> arg)	Creates components that don't belong to any page from a page file specified by an URI.
Component	createComponents(String uri, Component parent, Map<?,?> arg)	Creates components from a page file specified by an URI.
Component	createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)	Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.
Component[]	createComponents(String uri, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver, Map<?,?> arg)	Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component.
Component[]	createComponents(String uri, Page page, org.zkoss.xel.VariableResolver resolver, Map<?,?> arg)	Creates components that belong to the given page from a page file specified by an URI.
Component[]	createComponents(PageDefinition pagedef, Map<?,?> arg)	Creates components that don't belong to any page from the specified page definition.
Component	createComponents(PageDefinition pagedef, Component parent, Map<?,?> arg)	Creates components from the specified page definition.
Component	createComponents(PageDefinition pagedef, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)	Creates components from the specified page definition with a custom variable resolver and inserts before a particular component.
Component[]	createComponentsDirectly(Reader reader, String ext, Map<?,?> arg)	Creates components that don't belong to any page from the raw content read from the specified reader.
Component	createComponentsDirectly(Reader reader, String ext, Component parent, Map<?,?> arg)	Creates components from the raw content read from the specified reader.
Component	createComponentsDirectly(Reader reader, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)	Creates components from the raw content read from the specified reader with a custom variable resolver and inserts before a particular component.
Component[]	createComponentsDirectly(String content, String ext, Map<?,?> arg)	Creates components that don't belong to any page from the raw content specified by a string.
Component	createComponentsDirectly(String content, String ext, Component parent, Map<?,?> arg)	Creates components from the raw content specified by a string.
Component	createComponentsDirectly(String content, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)	Creates components from the raw content specified by a string with a custom variable resolver and inserts before a particular component.
Component[]	createComponentsDirectly(org.zkoss.idom.Document content, String ext, Map<?,?> arg)	Creates components that don't belong to any page from the raw content specified by a DOM tree.
Component	createComponentsDirectly(org.zkoss.idom.Document content, String ext, Component parent, Map<?,?> arg)	Creates components from the raw content specified by a DOM tree.
Component	createComponentsDirectly(org.zkoss.idom.Document content, String ext, Component parent, Component insertBefore, org.zkoss.xel.VariableResolver resolver)	Creates components from the raw content specified by a DOM tree with a custom variable resolver and inserts before a particular component.
Map<?,?>	getArg()	Returns the parameters (aka., arg) if Execution.pushArg(java.util.Map<?, ?>) is called recently, or an empty map if not available.
Object	getAttribute(String name, boolean recurse)	Returns the custom attribute associated with this object.
final Page	getCurrentPage()	Returns the current page.
PageDefinition	getCurrentPageDefinition()	Returns the current page definition, which is pushed when evaluating a page (from a page definition).
Desktop	getDesktop()	Returns the desktop associated with this execution.
ExecutionInfo	getExecutionInfo()	Returns the information of the event being served, or null if the execution is not under serving an event.
Object	getExtraXelVariable(String name)	Returns the object, if any, defined in any variable resolver added by Execution.addVariableResolver(org.zkoss.xel.VariableResolver).
Object	getExtraXelVariable(org.zkoss.xel.XelContext ctx, Object base, Object name)	Returns the object, if any, defined in any variable resolver added by Execution.addVariableResolver(org.zkoss.xel.VariableResolver).
Event	getNextEvent()	Returns the next event queued by Execution.postEvent(org.zkoss.zk.ui.event.Event), or null if no event queued.
String	getRequestId()	Returns the sequence ID of the current request, or null if not available.
Collection<AuResponse>	getResponses()	Returns the collection of the AU responses (AuResponse) that shall be generated to the output, or null if not available.
Session	getSession()	Returns the session this execution belongs to.
Visualizer	getVisualizer()	Returns the Visualizer for this execution.
boolean	hasAttribute(String name, boolean recurse)	Returns if a custom attribute is associated with this object.
boolean	hasVariableResolver(Class<? extends org.zkoss.xel.VariableResolver> cls)	Returns if any instance of the give class has been registered.
boolean	hasVariableResolver(org.zkoss.xel.VariableResolver resolver)	Returns if the specified variable resolved has been registered
boolean	isActivated()	Returns whether this execution is activated.
boolean	isAsyncUpdate(Page page)	Returns whether this execution is an asynchronous update for the specified page (thru ZK Update Engine).
boolean	isRecovering()	Returns whether this execution is in recovering.
void	log(String msg)	Writes the specified message to a servlet log file, usually an event log.
void	log(String msg, Throwable ex)	Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.
void	onActivate()	Called when this execution is about to become the current execution Executions.getCurrent().
void	onBeforeDeactivate()	Called when this execution is about to become a non-current execution.
void	onDeactivate()	Called when this execution is about to become a non-current execution.
void	popArg()	Pops the parameters (aka., arg) that is pushed by Execution.pushArg(java.util.Map<?, ?>).
void	postEvent(int priority, Component realTarget, Event evt)	Queues the give event for the specified target to this execution.
void	postEvent(int priority, Event evt)	Queues an event with the specified priority to this execution.
void	postEvent(Event evt)	Queues an event to this execution.
void	pushArg(Map<?,?> arg)	Pushes the parameters (aka., arg) that EL could refer it by the arg variable.
Object	removeAttribute(String name, boolean recurse)	Removes the custom attribute associated with this scope.
boolean	removeVariableResolver(org.zkoss.xel.VariableResolver resolver)	Removes a name resolve that was added by Execution.addVariableResolver(org.zkoss.xel.VariableResolver).
void	sendRedirect(String uri)	Sends a temporary redirect response to the client using the specified redirect location URL.
void	sendRedirect(String uri, boolean respRedirect)	Send a redirect to the given url in the application the redirect is done via status 302 by AuRedirect if respRedirect is set to true.
void	sendRedirect(String uri, String target)	Sends a temporary redirect response to the client using the specified redirect location URL and redirect to the specified browser window.
Object	setAttribute(String name, Object value, boolean recurse)	Sets the custom attribute associated with this scope, or the parent scope.
final void	setCurrentPage(Page curpage)	Sets the current page.
void	setCurrentPageDefinition(PageDefinition pgdef)	Sets the current page definition.
void	setDesktop(Desktop desktop)	Sets the desktop associated with this execution.
void	setExecutionInfo(ExecutionInfo execinf)	Sets the information of the event being served, or null if not under serving an event.
void	setRequestId(String reqId)	Sets the sequence ID of the current request.
void	setResponses(Collection<AuResponse> responses)	Sets the collection of the AU responses (AuResponse) that shall be generated to the output.
String	toAbsoluteURI(String uri, boolean skipInclude)	Converts the specified URI to an absolute URI, if uri is related and the current execution is not included (Execution.isIncluded()).
String	toString()

Methods inherited from class java.lang.Object

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

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

addResponseHeader, addResponseHeader, containsResponseHeader, encodeURL, evaluate, evaluate, forward, forward, getAttribute, getAttributes, getBrowser, getBrowser, getContextPath, getContextURI, getEvaluator, getEvaluator, getHeader, getHeaderNames, getHeaders, getLocalAddr, getLocalName, getLocalPort, getNativeRequest, getNativeResponse, getPageDefinition, getPageDefinitionDirectly, getPageDefinitionDirectly, getPageDefinitionDirectly, getParameter, getParameterMap, getParameterValues, getRemoteAddr, getRemoteHost, getRemoteUser, getScheme, getServerName, getServerPort, getUserAgent, getUserPrincipal, getVariableResolver, include, include, isForwarded, isIncluded, isUserInRole, isVoided, locate, removeAttribute, setAttribute, setResponseHeader, setResponseHeader, setVoided

Methods inherited from interface org.zkoss.zk.ui.sys.ExecutionCtrl

setContentType

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, hasAttribute, removeScopeListener

Field Details

Add_ON_ACTIVATE

protected static final String Add_ON_ACTIVATE

See Also:

• Constant Field Values

Add_ON_DEACTIVATE

protected static final String Add_ON_DEACTIVATE

See Also:

• Constant Field Values

Constructor Details

AbstractExecution

protected AbstractExecution(Desktop desktop,
 Page creating)

Constructs an execution.

Parameters:

creating - which page is being creating for this execution, or null if none is being created. isAsyncUpdate(org.zkoss.zk.ui.Page) returns based on this.

Method Details

isAsyncUpdate

public boolean isAsyncUpdate(Page page)

Description copied from interface: Execution

Returns whether this execution is an asynchronous update for the specified page (thru ZK Update Engine).

Specified by:

isAsyncUpdate in interface Execution

Returns:

whether the specified page is being asynchronous updated by this execution. If the specified page is null, this method returns whether this execution is caused by an asynchronous update (i.e., caused by an AU request).

getDesktop

public Desktop getDesktop()

Description copied from interface: Execution

Returns the desktop associated with this execution. Each execution is against exactly one desktop.

Specified by:

getDesktop in interface Execution

getSession

public Session getSession()

Description copied from interface: Execution

Returns the session this execution belongs to.

Specified by:

getSession in interface Execution

postEvent

public void postEvent(Event evt)

Description copied from interface: Execution

Queues an event to this execution. In other words, the event is placed to the event queue.

The priority of the event is assumed to be 0. Refer to Execution.postEvent(int, Event) for more information.

Specified by:

postEvent in interface Execution

See Also:

• Execution.postEvent(int, Event)
• Execution.postEvent(int, Component, Event)

postEvent

public void postEvent(int priority,
 Event evt)

Description copied from interface: Execution

Queues an event with the specified priority to this execution. In other words, the event is placed to the event queue with the specified priority.

The event will be sent to the component specified in Event.getTarget(). If Event.getTarget() is null, it means broadcast, i.e., all root components will receive this event. If you prefer a different target, you could use Execution.postEvent(int, Component, Event) instead.

The posted events are processed from the higher priority to the lower one. If two events are posted with the same priority, the earlier the event being posted is processed earlier (first-in-first-out).

The priority posted by posted by Execution.postEvent(Event) is 0. Applications shall not use the priority higher than 10,000 and lower than -10,000 since they are reserved for component development.

Specified by:

postEvent in interface Execution

Parameters:

priority - the priority of the event. The default priority is 0 and the higher value means higher priority.

See Also:

• Execution.postEvent(int, Component, Event)

postEvent

public void postEvent(int priority,
 Component realTarget,
 Event evt)

Description copied from interface: Execution

Queues the give event for the specified target to this execution. The target could be different from Event.getTarget().

Specified by:

postEvent in interface Execution

Parameters:

priority - the priority of the event. The default priority is 0 and the higher value means higher priority.

realTarget - the target component that will receive the event. If null, it means broadcast, i.e., all root components will receive this event.
Notice that postEvent(n, event) is the same as postEvent(n, event.getTarget(), event), but different from postEvent(n, 0, event).

getAttribute

public Object getAttribute(String name,
 boolean recurse)

Description copied from interface: Scope

Returns the custom attribute associated with this object.

Specified by:

getAttribute in interface Scope

recurse - whether to search its ancestor scope. If true and the current scope doen't define the attribute, it searches up its ancestor to see any of them has defined the specified attribute.

hasAttribute

public boolean hasAttribute(String name,
 boolean recurse)

Description copied from interface: Scope

Returns if a custom attribute is associated with this object.

Notice that null is a valid value, so you can tell if an attribute is associated by examining the return value of Scope.getAttribute(java.lang.String).

Specified by:

hasAttribute in interface Scope

recurse - whether to search its ancestor scope. If true and the current scope doen't define the attribute, it searches up its ancestor to see any of them has defined the specified attribute.

setAttribute

public Object setAttribute(String name,
 Object value,
 boolean recurse)

Description copied from interface: Scope

Sets the custom attribute associated with this scope, or the parent scope.

Specified by:

setAttribute in interface Scope

recurse - whether to look up the parent scope for the existence of the attribute.
If recurse is true and the attribute is defined in one of its ancestor (including page), the attribute is replaced. Otherwise, it is the same as Scope.setAttribute(String,Object).

removeAttribute

public Object removeAttribute(String name,
 boolean recurse)

Description copied from interface: Scope

Removes the custom attribute associated with this scope.

Specified by:

removeAttribute in interface Scope

recurse - whether to look up the parent scope for the existence of the attribute.
If recurse is true and the attribute is defined in one of its ancestor (including page), the attribute is removed. Otherwise, it is the same as Scope.removeAttribute(String).

getCurrentPage

public final Page getCurrentPage()

Description copied from interface: ExecutionCtrl

Returns the current page. Though an execution might process many pages, it processes update requests one-by-one and each update request is associated with a page.

Design decision: we put it here because user need not to know about the concept of the current page.

Since 3.6.0, this method returns the first page if ExecutionCtrl.setCurrentPage(org.zkoss.zk.ui.Page) was not called (such as Server Push).

Specified by:

getCurrentPage in interface ExecutionCtrl

See Also:

• Desktop.getPage(java.lang.String)

setCurrentPage

public final void setCurrentPage(Page curpage)

Description copied from interface: ExecutionCtrl

Sets the current page. Though an execution might process many pages, it processes update requests one-by-one and each update request is associated with a page.

Specified by:

setCurrentPage in interface ExecutionCtrl

getCurrentPageDefinition

public PageDefinition getCurrentPageDefinition()

Description copied from interface: ExecutionCtrl

Returns the current page definition, which is pushed when evaluating a page (from a page definition).

Specified by:

getCurrentPageDefinition in interface ExecutionCtrl

setCurrentPageDefinition

public void setCurrentPageDefinition(PageDefinition pgdef)

Description copied from interface: ExecutionCtrl

Sets the current page definition.

Specified by:

setCurrentPageDefinition in interface ExecutionCtrl

Parameters:

pgdef - the page definition. If null, it means it is the same as getCurrentPage().getPageDefinition().

getNextEvent

public Event getNextEvent()

Description copied from interface: ExecutionCtrl

Returns the next event queued by Execution.postEvent(org.zkoss.zk.ui.event.Event), or null if no event queued.

Implementation Notes: Execution.postEvent(int,Component,Event) proxies the event with ProxyEvent if the real target is different from Event.getTarget(). Of course, it is transparent to the event listeners since the real event will be passed to the listener (rather than the proxy event).

Specified by:

getNextEvent in interface ExecutionCtrl

isActivated

public boolean isActivated()

Description copied from interface: ExecutionCtrl

Returns whether this execution is activated.

Specified by:

isActivated in interface ExecutionCtrl

onActivate

public void onActivate()

Description copied from interface: ExecutionCtrl

Called when this execution is about to become the current execution Executions.getCurrent().

Note: an execution might spread over several threads, so this method might be called several times to activate the states in each thread. Also, an execution might be activated before another is deactivate. For example, when a component includes another page, the second exec is activated to render the included page.

It is used as callback notification.

Note: don't throw any exception in this method.

Specified by:

onActivate in interface ExecutionCtrl

onBeforeDeactivate

public void onBeforeDeactivate()

Description copied from interface: ExecutionCtrl

Called when this execution is about to become a non-current execution.

It is used as callback notification.

Note: don't throw any exception in this method.

Specified by:

onBeforeDeactivate in interface ExecutionCtrl

See Also:

• ExecutionCtrl.onDeactivate()

onDeactivate

public void onDeactivate()

Description copied from interface: ExecutionCtrl

Called when this execution is about to become a non-current execution.

It is used as callback notification.

Note: don't throw any exception in this method.

Specified by:

onDeactivate in interface ExecutionCtrl

See Also:

• ExecutionCtrl.onActivate()

isRecovering

public boolean isRecovering()

Description copied from interface: ExecutionCtrl

Returns whether this execution is in recovering. In other words, it is in the invocation of FailoverManager.recover(org.zkoss.zk.ui.Session, org.zkoss.zk.ui.Execution, org.zkoss.zk.ui.Desktop). If in recovering, no response is sent to the client. It assumes the server is recovering the desktop and all it contains to match the client's status.

Specified by:

isRecovering in interface ExecutionCtrl

getVisualizer

public Visualizer getVisualizer()

Description copied from interface: ExecutionCtrl

Returns the Visualizer for this execution. It is the same as DesktopCtrl.getVisualizer().

Specified by:

getVisualizer in interface ExecutionCtrl

toAbsoluteURI

public String toAbsoluteURI(String uri,
 boolean skipInclude)

Description copied from interface: Execution

Converts the specified URI to an absolute URI, if uri is related and the current execution is not included (Execution.isIncluded()).

Note: an asynchronous update is processed by the update servlet. It is different from the servlet for rendering the ZUML page. In other words, a relative URI won't be interpreted correctly, so you have to invoke this method to convert them if necessary.

In additions, RequestDispatcher.include doesn't handle related URI well.

Specified by:

toAbsoluteURI in interface Execution

skipInclude - whether not to convert to an absolute URI if the current page is included by another page. If you are not sure, you might specify false.

createComponents

public Component createComponents(String uri,
 Component parent,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components from a page file specified by an URI. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

It loads the page definition from the specified URI (by use Execution.getPageDefinition(java.lang.String) ), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponents in interface Execution

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Component, Map)
• Execution.createComponentsDirectly(String, String, Component, Map)
• Execution.createComponentsDirectly(Document, String, Component, Map)
• Execution.createComponentsDirectly(Reader, String, Component, Map)

createComponents

public Component createComponents(String uri,
 Component parent,
 Component insertBefore,
 org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

It loads the page definition from the specified URI (by use Execution.getPageDefinition(java.lang.String) ), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponents in interface Execution

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

insertBefore - the sibling component that new components will be inserted before. Ignored if null (i.e., append as last children).

resolver - the variable resolver used to resolve variables. Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(String, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Document, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Reader, String, Component, Component, VariableResolver)

createComponents

public Component[] createComponents(String uri,
 Component parent,
 Component insertBefore,
 org.zkoss.xel.VariableResolver resolver,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components from a page file specified by an URI with a custom variable resolver and inserts before a particular component. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

It loads the page definition from the specified URI (by use Execution.getPageDefinition(java.lang.String) ), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponents in interface Execution

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

insertBefore - the sibling component that new components will be inserted before. Ignored if null (i.e., append as last children).

resolver - the variable resolver used to resolve variables. Ignored if null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(String, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Document, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Reader, String, Component, Component, VariableResolver)

createComponents

public Component createComponents(PageDefinition pagedef,
 Component parent,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components from the specified page definition. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

Specified by:

createComponents in interface Execution

Parameters:

pagedef - the page definition to use. It cannot be null.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

Returns:

the first component being created.

See Also:

• Execution.createComponents(String, Component, Map)

createComponents

public Component createComponents(PageDefinition pagedef,
 Component parent,
 Component insertBefore,
 org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Creates components from the specified page definition with a custom variable resolver and inserts before a particular component. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

Specified by:

createComponents in interface Execution

Parameters:

pagedef - the page definition to use. It cannot be null.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

insertBefore - the sibling component that new components will be inserted before. Ignored if null (i.e., append as last children).

resolver - the variable resolver used to resolve variables. Ignored if null.

Returns:

the first component being created.

See Also:

• Execution.createComponents(String, Component, Component, VariableResolver)

createComponents

public Component[] createComponents(String uri,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components that don't belong to any page from a page file specified by an URI.

It loads the page definition from the specified URI (by use Execution.getPageDefinition(java.lang.String) ), and then invokes Execution.createComponents(PageDefinition,Map) to create components.

Specified by:

createComponents in interface Execution

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Map)
• Execution.createComponentsDirectly(String, String, Map)
• Execution.createComponentsDirectly(Document, String, Map)
• Execution.createComponentsDirectly(Reader, String, Map)

createComponents

public Component[] createComponents(String uri,
 Page page,
 org.zkoss.xel.VariableResolver resolver,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components that belong to the given page from a page file specified by an URI.

It loads the page definition from the specified URI (by use Execution.getPageDefinition(java.lang.String) ), and then invokes Execution.createComponents(PageDefinition,Map) to create components.

Specified by:

createComponents in interface Execution

page - the page, or null if you want it to attach the created components.

resolver - the variable resolver used to resolve variables. Ignored if null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Map)
• Execution.createComponentsDirectly(String, String, Map)
• Execution.createComponentsDirectly(Document, String, Map)
• Execution.createComponentsDirectly(Reader, String, Map)

createComponents

public Component[] createComponents(PageDefinition pagedef,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components that don't belong to any page from the specified page definition.

Specified by:

createComponents in interface Execution

Parameters:

pagedef - the page definition to use. It cannot be null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

Returns:

the first component being created.

See Also:

• Execution.createComponents(String, Map)

createComponentsDirectly

public Component createComponentsDirectly(String content,
 String ext,
 Component parent,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components from the raw content specified by a string. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

The raw content is parsed to a page definition by use of Execution.getPageDefinitionDirectly(String, String), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

content - the raw content of the page. It must be in ZUML.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Component, Map)
• Execution.createComponents(String, Component, Map)
• Execution.createComponentsDirectly(Document, String, Component, Map)
• Execution.createComponentsDirectly(Reader, String, Component, Map)

createComponentsDirectly

public Component createComponentsDirectly(String content,
 String ext,
 Component parent,
 Component insertBefore,
 org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Creates components from the raw content specified by a string with a custom variable resolver and inserts before a particular component. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

The raw content is parsed to a page definition by use of Execution.getPageDefinitionDirectly(String, String), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

content - the raw content of the page. It must be in ZUML.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

insertBefore - the sibling component that new components will be inserted before. Ignored if null (i.e., append as last children).

resolver - the variable resolver used to resolve variables.

See Also:

• Execution.createComponents(PageDefinition, Component, Component, VariableResolver)
• Execution.createComponents(String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Document, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Reader, String, Component, Component, VariableResolver)

createComponentsDirectly

public Component createComponentsDirectly(org.zkoss.idom.Document content,
 String ext,
 Component parent,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components from the raw content specified by a DOM tree. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

The raw content is parsed to a page definition by use of Execution.getPageDefinitionDirectly(Document, String), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

content - the raw content in DOM.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Component, Map)
• Execution.createComponents(String, Component, Map)
• Execution.createComponentsDirectly(Document, String, Component, Map)
• Execution.createComponentsDirectly(Reader, String, Component, Map)

createComponentsDirectly

public Component createComponentsDirectly(org.zkoss.idom.Document content,
 String ext,
 Component parent,
 Component insertBefore,
 org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Creates components from the raw content specified by a DOM tree with a custom variable resolver and inserts before a particular component. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

The raw content is parsed to a page definition by use of Execution.getPageDefinitionDirectly(Document, String), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

content - the raw content in DOM.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

insertBefore - the sibling component that new components will be inserted before. Ignored if null (i.e., append as last children).

resolver - the variable resolver used to resolve variables. Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Component, Component, VariableResolver)
• Execution.createComponents(String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Document, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Reader, String, Component, Component, VariableResolver)

createComponentsDirectly

public Component createComponentsDirectly(Reader reader,
 String ext,
 Component parent,
 Map<?,?> arg)
                                   throws IOException

Description copied from interface: Execution

Creates components from the raw content read from the specified reader. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

The raw content is loaded and parsed to a page definition by use of Execution.getPageDefinitionDirectly(Reader,String), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

reader - the reader to retrieve the raw content in ZUML.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

Throws:

IOException

See Also:

• Execution.createComponents(PageDefinition, Component, Map)
• Execution.createComponents(String, Component, Map)
• Execution.createComponentsDirectly(Document, String, Component, Map)
• Execution.createComponentsDirectly(String, String, Component, Map)

createComponentsDirectly

public Component createComponentsDirectly(Reader reader,
 String ext,
 Component parent,
 Component insertBefore,
 org.zkoss.xel.VariableResolver resolver)
                                   throws IOException

Description copied from interface: Execution

Creates components from the raw content read from the specified reader with a custom variable resolver and inserts before a particular component. The created components become the child of the specified parent, or become the root components of the current page if parent is specified as null.

The raw content is loaded and parsed to a page definition by use of Execution.getPageDefinitionDirectly(Reader,String), and then invokes Execution.createComponents(PageDefinition,Component,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

reader - the reader to retrieve the raw content in ZUML.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

parent - the parent component, or null if you want it to be a root component. If parent is null, the page is assumed to be the current page, which is determined by the execution context. In other words, the new component will be the root component of the current page if parent is null.

insertBefore - the sibling component that new components will be inserted before. Ignored if null (i.e., append as last children).

resolver - the variable resolver used to resolve variables. Ignored if null.

Throws:

IOException

See Also:

• Execution.createComponents(PageDefinition, Component, Component, VariableResolver)
• Execution.createComponents(String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(Document, String, Component, Component, VariableResolver)
• Execution.createComponentsDirectly(String, String, Component, Component, VariableResolver)

createComponentsDirectly

public Component[] createComponentsDirectly(String content,
 String ext,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components that don't belong to any page from the raw content specified by a string.

The raw content is parsed to a page definition by use of Execution.getPageDefinitionDirectly(String, String), and then invokes Execution.createComponents(PageDefinition,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

content - the raw content of the page. It must be in ZUML.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Map)
• Execution.createComponents(String, Map)
• Execution.createComponentsDirectly(Document, String, Map)
• Execution.createComponentsDirectly(Reader, String, Map)

createComponentsDirectly

public Component[] createComponentsDirectly(org.zkoss.idom.Document content,
 String ext,
 Map<?,?> arg)

Description copied from interface: Execution

Creates components that don't belong to any page from the raw content specified by a DOM tree.

The raw content is parsed to a page definition by use of Execution.getPageDefinitionDirectly(Document, String), and then invokes Execution.createComponents(PageDefinition,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

content - the raw content in DOM.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

See Also:

• Execution.createComponents(PageDefinition, Map)
• Execution.createComponents(String, Map)
• Execution.createComponentsDirectly(Document, String, Map)
• Execution.createComponentsDirectly(Reader, String, Map)

createComponentsDirectly

public Component[] createComponentsDirectly(Reader reader,
 String ext,
 Map<?,?> arg)
                                     throws IOException

Description copied from interface: Execution

Creates components that don't belong to any page from the raw content read from the specified reader.

The raw content is loaded and parsed to a page defintion by use of Execution.getPageDefinitionDirectly(Reader,String), and then invokes Execution.createComponents(PageDefinition,Map) to create components.

Specified by:

createComponentsDirectly in interface Execution

Parameters:

reader - the reader to retrieve the raw content in ZUML.

ext - the default extension if the content doesn't specify an language. In other words, if the content doesn't specify an language, LanguageDefinition.getByExtension(java.lang.String) is called. If extension is null and the content doesn't specify a language, the language called "xul/html" is assumed.

arg - a map of parameters that is accessible by the arg variable in EL, or by Execution.getArg(). Ignored if null.

Throws:

IOException

See Also:

• Execution.createComponents(PageDefinition, Map)
• Execution.createComponents(String, Map)
• Execution.createComponentsDirectly(Document, String, Map)
• Execution.createComponentsDirectly(String, String, Map)

sendRedirect

public void sendRedirect(String uri)

Description copied from interface: Execution

Sends a temporary redirect response to the client using the specified redirect location URL.

It is the same as sendRedirect(url, null).

After calling this method, the caller shall end the processing immediately (by returning). All pending requests and events will be dropped.

Specified by:

sendRedirect in interface Execution

Parameters:

uri - the URI to redirect to, or null to reload the same page

sendRedirect

public void sendRedirect(String uri,
 String target)

Description copied from interface: Execution

Sends a temporary redirect response to the client using the specified redirect location URL and redirect to the specified browser window.

After calling this method, the caller shall end the processing immediately (by returning). All pending requests and events will be dropped.

Note: if you specify target other than null and "_self", it'll fail if the browser prevent the server to popup a window.

Specified by:

sendRedirect in interface Execution

Parameters:

uri - the URI to redirect to, or null to reload the same page

target - the name of the browser window that send-redirect will load the specified URI, or null if the current browser window is used.

sendRedirect

public void sendRedirect(String uri,
 boolean respRedirect)

Description copied from interface: Execution

Send a redirect to the given url in the application the redirect is done via status 302 by AuRedirect if respRedirect is set to true. If respRedirect is set to false, it is the same with Execution.sendRedirect(String).

Specified by:

sendRedirect in interface Execution

Parameters:

uri - the URI to redirect to, or null to reload the same page

respRedirect - whether to send redirect by HttpResponse or not

getArg

public Map<?,?> getArg()

Description copied from interface: Execution

Returns the parameters (aka., arg) if Execution.pushArg(java.util.Map<?, ?>) is called recently, or an empty map if not available.

The use of parameters is application dependent. ZK only provides the way to store (Execution.pushArg(java.util.Map<?, ?>) and to restore Execution.popArg(). And, let the parameters being accessible in EL by referring it as the arg variable.

Currently, Execution.createComponents(String,Component,Map) and similar methods use this mechanism to let caller customize a page definition.

Notice that Execution.createComponents(String,Component,Map) pops arg after creating components, and before processing any event. In other words, it is not aviable for event listener, including onCreate. However, CreateEvent.getArg() preserves the map for its event listeners.

Specified by:

getArg in interface Execution

pushArg

public void pushArg(Map<?,?> arg)

Description copied from interface: Execution

Pushes the parameters (aka., arg) that EL could refer it by the arg variable. Remember to call Execution.popArg() in the finally clause.

Specified by:

pushArg in interface Execution

See Also:

• Execution.getArg()

popArg

public void popArg()

Description copied from interface: Execution

Pops the parameters (aka., arg) that is pushed by Execution.pushArg(java.util.Map<?, ?>).

It never throws an exception.

Specified by:

popArg in interface Execution

See Also:

• Execution.getArg()

addAuResponse

public void addAuResponse(AuResponse response)

Description copied from interface: Execution

Adds an asynchronous response (AuResponse) which will be sent to client at the end of the execution. It is the same as addAuResponse(response.getOverrideKey(), resposne)

If AuResponse.getDepends() is not null, the response depends on the returned componet. In other words, the response is removed if the component is removed. If it is null, the response is component-independent.

Specified by:

addAuResponse in interface Execution

addAuResponse

public void addAuResponse(String key,
 AuResponse response)

Description copied from interface: Execution

Adds an asynchronous response (AuResponse) with the given key instead of AuResponse.getOverrideKey().

If AuResponse.getDepends() is not null, the response depends on the returned componet. In other words, the response is removed if the component is removed. If it is null, the response is component-independent.

Specified by:

addAuResponse in interface Execution

Parameters:

key - could be anything. If not null, the second invocation of this method in the same execution with the same key and the same depends (AuResponse.getDepends()) will override the previous one. In other words, the previous one will be dropped. If null is specified, the response is simply appended to the end without overriding any previous one.

setDesktop

public void setDesktop(Desktop desktop)

Description copied from interface: ExecutionCtrl

Sets the desktop associated with this execution. You rarely need to use this method, since the desktop is associated when this execution is created.

Currently, it is used to communicate between WebManager.newDesktop and DesktopImpl's constructor.

Specified by:

setDesktop in interface ExecutionCtrl

setRequestId

public void setRequestId(String reqId)

Description copied from interface: ExecutionCtrl

Sets the sequence ID of the current request.

Specified by:

setRequestId in interface ExecutionCtrl

getRequestId

public String getRequestId()

Description copied from interface: ExecutionCtrl

Returns the sequence ID of the current request, or null if not available. Not all clients support the request ID.

Specified by:

getRequestId in interface ExecutionCtrl

getResponses

public Collection<AuResponse> getResponses()

Description copied from interface: ExecutionCtrl

Returns the collection of the AU responses (AuResponse) that shall be generated to the output, or null if not available.

Specified by:

getResponses in interface ExecutionCtrl

setResponses

public void setResponses(Collection<AuResponse> responses)

Description copied from interface: ExecutionCtrl

Sets the collection of the AU responses (AuResponse) that shall be generated to the output.

Specified by:

setResponses in interface ExecutionCtrl

getExecutionInfo

public ExecutionInfo getExecutionInfo()

Description copied from interface: ExecutionCtrl

Returns the information of the event being served, or null if the execution is not under serving an event.

Unlike most of other methods, this method could be accessed by another thread.

Specified by:

getExecutionInfo in interface ExecutionCtrl

setExecutionInfo

public void setExecutionInfo(ExecutionInfo execinf)

Description copied from interface: ExecutionCtrl

Sets the information of the event being served, or null if not under serving an event.

Specified by:

setExecutionInfo in interface ExecutionCtrl

addVariableResolver

public boolean addVariableResolver(org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Adds a name resolver that will be used to resolve a variable (by Execution.getVariableResolver()).

The new added variable resolver is called first, so it has the higher priority than the previous added variable resolver. In additions, the priority of the variable resolver added with this method is higher than the variable resolvers added to a page (Page.addVariableResolver(org.zkoss.xel.VariableResolver)). However, its priority is lower than attributes defined in the execution and components.

Notice that Execution.getVariableResolver() returns a variable resolver used to evaluate EL expressions. It resolves all builtin names and all custom variable resolvers. It is not any variable resolver added by this method.

Specified by:

addVariableResolver in interface Execution

Returns:

whether the resolver is added successfully. Note: if the resolver was added before, it won't be added again and this method returns false.

removeVariableResolver

public boolean removeVariableResolver(org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Removes a name resolve that was added by Execution.addVariableResolver(org.zkoss.xel.VariableResolver).

Specified by:

removeVariableResolver in interface Execution

Returns:

false if resolved is not added before.

hasVariableResolver

public boolean hasVariableResolver(org.zkoss.xel.VariableResolver resolver)

Description copied from interface: Execution

Returns if the specified variable resolved has been registered

Specified by:

hasVariableResolver in interface Execution

See Also:

• Execution.addVariableResolver(org.zkoss.xel.VariableResolver)

hasVariableResolver

public boolean hasVariableResolver(Class<? extends org.zkoss.xel.VariableResolver> cls)

Description copied from interface: Execution

Returns if any instance of the give class has been registered.

Specified by:

hasVariableResolver in interface Execution

getExtraXelVariable

public Object getExtraXelVariable(String name)

Description copied from interface: ExecutionCtrl

Returns the object, if any, defined in any variable resolver added by Execution.addVariableResolver(org.zkoss.xel.VariableResolver).

Notice that it looks only for the variables defined in Execution.addVariableResolver(org.zkoss.xel.VariableResolver). To get a variable an EL expression can reference, please use Execution.getVariableResolver() instead.

Specified by:

getExtraXelVariable in interface ExecutionCtrl

getExtraXelVariable

public Object getExtraXelVariable(org.zkoss.xel.XelContext ctx,
 Object base,
 Object name)

Description copied from interface: ExecutionCtrl

Returns the object, if any, defined in any variable resolver added by Execution.addVariableResolver(org.zkoss.xel.VariableResolver).

Notice that it looks only for the variables defined in Execution.addVariableResolver(org.zkoss.xel.VariableResolver). To get a variable an EL expression can reference, please use Execution.getVariableResolver() instead.

Unlike ExecutionCtrl.getExtraXelVariable(String), this method can utilize VariableResolverX if you'd like to retrieve a property of another object.

Specified by:

getExtraXelVariable in interface ExecutionCtrl

Parameters:

ctx - the XEL context

base - the base object. If null, it looks for a top-level variable. If not null, it looks for a member of the base object (such as getter).

name - the property to retrieve.

See Also:

• ExecutionCtrl.getExtraXelVariable(String)

log

public void log(String msg)

Description copied from interface: Execution

Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.

Specified by:

log in interface Execution

log

public void log(String msg,
 Throwable ex)

Description copied from interface: Execution

Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log.

Specified by:

log in interface Execution

addOnActivate

public void addOnActivate(Callback callback)

Adds a callback method to be executed only once after the execution activated.

Specified by:

addOnActivate in interface ExecutionCtrl

Parameters:

callback -

Since:

7.0.5

addOnDeactivate

public void addOnDeactivate(Callback callback)

Adds a callback method to be executed only once after the execution deactivated.

Specified by:

addOnDeactivate in interface ExecutionCtrl

Parameters:

callback -

Since:

7.0.5

toString

public String toString()

Overrides:

toString in class Object