org.zkoss.zk.ui.impl

Class HybrisUiVisualizer

java.lang.Object

org.zkoss.zk.ui.impl.HybrisUiVisualizer

public class HybrisUiVisualizer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
HybrisUiVisualizer(Execution exec, boolean asyncUpdate, boolean recovering) Creates a root execution (without parent).
HybrisUiVisualizer(HybrisUiVisualizer parent, Execution exec) Creates the following execution.

Method Summary

Modifier and Type	Method and Description
void	addInvalidate(Component comp) Adds an invalidated component.
void	addInvalidate(Page page) Invalidates the whole page.
void	addMoved(Component comp, Component oldparent, Page oldpg, Page newpg) Called to update (redraw) a component, when a component is moved.
void	addResponse(java.lang.String key, AuResponse response) Adds a response directly (which will be returned when getResponses() is called).
void	addSmartUpdate(Component comp, java.lang.String attr, DeferredValue value) Smart updates an attribute of a component with a deferred value.
void	addSmartUpdate(Component comp, java.lang.String attr, java.lang.Object[] values) Smart updates a component's attribute with an array of values.
void	addSmartUpdate(Component comp, java.lang.String attr, java.lang.String value) Smart updates a component's attribute.
boolean	addToFirstAsyncUpdate(java.util.List responses)
void	addUuidChanged(Component comp, boolean addOnlyMoved) Called before changing the component's UUID.
void	disable()
boolean	disableClientUpdate(Component comp, boolean disable) Sets whether to disable the update of the client widget.
AbortingReason	getAbortingReason() Returns the reason to aborting, or null if no aborting at all.
Execution	getExecution()
Component	getOwner() Returns the owner component for this execution, or null if this execution is not owned by any component.
java.util.List	getResponses() Returns a list of AuResponse according to what components are invalidated and attached.
boolean	isAborting() Returns whether it is aborting.
boolean	isEverAsyncUpdate()
boolean	isInvalidated(Component comp) Returns if this component needs to be redrawn.
boolean	isRecovering()
void	popOwner() Called after a component redraws itself if it ever calls pushOwner(Component).
void	pushOwner(Component comp) Called before a component redraws itself if the component might include another page.
void	setAbortingReason(AbortingReason reason) Sets the reason to abort the current execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

HybrisUiVisualizer

public HybrisUiVisualizer(Execution exec,
                          boolean asyncUpdate,
                          boolean recovering)

Creates a root execution (without parent). In other words, it must be the first execution in the current request.

Parameters:

asyncUpdate - whether this execution is for async-update

recovering - whether this execution is in recovering, i.e., caused by org.zkoss.zk.ui.sys.FailoverManager#recover.

HybrisUiVisualizer

public HybrisUiVisualizer(HybrisUiVisualizer parent,
                          Execution exec)

Creates the following execution.

Method Detail

getExecution

public final Execution getExecution()

isEverAsyncUpdate

public final boolean isEverAsyncUpdate()

addToFirstAsyncUpdate

public final boolean addToFirstAsyncUpdate(java.util.List responses)

isRecovering

public boolean isRecovering()

disable

public void disable()

isInvalidated

public boolean isInvalidated(Component comp)

Returns if this component needs to be redrawn.

Note:

1. It always returns true if the current execution is not an asynchroous update.
2. If its parent is invalidated, this component will be redrawn too, but this method returns false since addInvalidate(Component) was not called against this component.

Since:

3.0.5

addInvalidate

public void addInvalidate(Page page)

Invalidates the whole page.

addInvalidate

public void addInvalidate(Component comp)

Adds an invalidated component. Once invalidated, all invocations to addSmartUpdate(Component, java.lang.String, java.lang.String) are ignored in this execution.

addSmartUpdate

public void addSmartUpdate(Component comp,
                           java.lang.String attr,
                           java.lang.String value)

Smart updates a component's attribute. Meaningful only if addInvalidate(Component) is not called in this execution

addSmartUpdate

public void addSmartUpdate(Component comp,
                           java.lang.String attr,
                           DeferredValue value)

Smart updates an attribute of a component with a deferred value. A deferred value is used to encapsulate a value that shall be retrieved only in the rendering phase.

Since:

3.0.1

addSmartUpdate

public void addSmartUpdate(Component comp,
                           java.lang.String attr,
                           java.lang.Object[] values)

Smart updates a component's attribute with an array of values. Meaningful only if addInvalidate(Component) is not called in this execution

Since:

3.0.5

disableClientUpdate

public boolean disableClientUpdate(Component comp,
                                   boolean disable)

Sets whether to disable the update of the client widget. By default, if a component is attached to a page, modications that change the visual representation will be sent to the client to ensure the consistency.

Returns:

whether it has been disabled before this invocation, i.e., the previous disable status

Since:

3.6.2

addMoved

public void addMoved(Component comp,
                     Component oldparent,
                     Page oldpg,
                     Page newpg)

Called to update (redraw) a component, when a component is moved. If a component's page or parent is changed, this method need to be called only once for the top one.

Parameters:

oldparent - the parent before moved

oldpg - the page before moved

newpg - the page after moved

addUuidChanged

public void addUuidChanged(Component comp,
                           boolean addOnlyMoved)

Called before changing the component's UUID.

Parameters:

addOnlyMoved - if true, it is added only if it was moved before (see addMoved(Component, Component, Page, Page)).

addResponse

public void addResponse(java.lang.String key,
                        AuResponse response)

Adds a response directly (which will be returned when getResponses() is called).

If the response is component-dependent, AuResponse#getDepends must return a component. And, if the component is removed, the response is removed, too.

Parameters:

key - could be anything. The second invocation of this method in the same execution with the same key will override the previous one.

getResponses

public java.util.List getResponses()
                            throws java.io.IOException

Returns a list of AuResponse according to what components are invalidated and attached.

Throws:

java.io.IOException

pushOwner

public void pushOwner(Component comp)

Called before a component redraws itself if the component might include another page.

popOwner

public void popOwner()

Called after a component redraws itself if it ever calls pushOwner(Component).

getOwner

public Component getOwner()

Returns the owner component for this execution, or null if this execution is not owned by any component. The owner is the top of the stack pushed by pushOwner(Component).

setAbortingReason

public void setAbortingReason(AbortingReason reason)

Sets the reason to abort the current execution. if not null, it means the current execution is aborting and the specified argument is the reason to aborting. Its interpretation depends on org.zkoss.zk.ui.sys.UiEngine.

Note: if setAbortingReason is ever set with non-null, you CANNOT set it back to null.

The aborting flag means no more processing, i.e., dropping pending requests, events, and rendering.

After call this method, you shall not keep processing the page because the rendering is dropped and the client is out-of-sync with the server.

This method doesn't really abort pending events and requests. It just set a flag, getAbortingReason(), and it is org.zkoss.zk.ui.sys.UiEngine's job to detect this flag and handling it properly.

getAbortingReason

public AbortingReason getAbortingReason()

Returns the reason to aborting, or null if no aborting at all.

See Also:

setAbortingReason(AbortingReason)

isAborting

public boolean isAborting()

Returns whether it is aborting.

The execution is aborting if getAbortingReason() returns not null and the returned reason's AbortingReason#isAborting is true.

Note: Execution#isVoided() means the execution is voided and no output shall be generated. The request is taken charged by other servlet. On the other hand, isAborting() means the execution is aborting and the output shall still be generated (and sent). The request is still taken charged by this execution.