org.zkoss.zk.ui.sys
Class ComponentsCtrl

java.lang.Object
  org.zkoss.zk.ui.sys.ComponentsCtrl

public class ComponentsCtrl
extends java.lang.Object

Utilities for implementing components.

Author:

tomyeh

Field Summary

static java.lang.String	ANONYMOUS_ID The anonymous UUID.
static ComponentDefinition	DUMMY Represents a dummy definition.

Constructor Summary

ComponentsCtrl()

Method Summary

static void	applyForward(Component comp, java.lang.String forward) Applies the forward condition to the specified component.
static java.lang.String	getAnonymousId() Deprecated. As of release 2.4.1, replaced by ANONYMOUS_ID
static java.lang.Object	getCurrentInfo() Returns the current component info ComponentInfo, definition (ComponentDefinition or null, which is used only by UiEngine to communicate with AbstractComponent.
static java.lang.reflect.Method	getEventMethod(java.lang.Class cls, java.lang.String evtnm) Returns the method for handling the specified event, or null if not available.
static boolean	isAutoId(java.lang.String id) Returns whether an ID is generated automatically.
static boolean	isReservedAttribute(java.lang.String name) Returns if the attribute name is reserved.
static boolean	isUuid(java.lang.String id) Returns whether an ID is a valid UUID.
static java.lang.String	parseClientScript(Component comp, java.lang.String script) Parses a script by resolving #{xx} to make it executable at the client.
static java.lang.Object[]	parseEventExpression(Component comp, java.lang.String evtexpr, Component defaultComp, boolean deferred) Pares the event expression.
static void	setCurrentInfo(ComponentDefinition compdef) Sets the current component definition, which is used only by UiEngine to communicate with AbstractComponent.
static void	setCurrentInfo(ComponentInfo compInfo) Sets the current component definition, which is used only by UiEngine to communicate with AbstractComponent.
static void	setEventMethodCache(org.zkoss.util.Cache cache) Sets the cache that stores the information about event handler methods.
static java.lang.String	toAutoId(java.lang.String prefix, int id) Returns the automatically generate component's UUID/ID.

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS_ID

public static final java.lang.String ANONYMOUS_ID

The anonymous UUID. Used only internally.

See Also:

Constant Field Values

DUMMY

public static final ComponentDefinition DUMMY

Represents a dummy definition.

Constructor Detail

ComponentsCtrl

public ComponentsCtrl()

Method Detail

toAutoId

public static final java.lang.String toAutoId(java.lang.String prefix,
                                              int id)

Returns the automatically generate component's UUID/ID.

getAnonymousId

public static final java.lang.String getAnonymousId()

Deprecated. As of release 2.4.1, replaced by ANONYMOUS_ID

isAutoId

public static final boolean isAutoId(java.lang.String id)

Returns whether an ID is generated automatically.

isUuid

public static final boolean isUuid(java.lang.String id)

Returns whether an ID is a valid UUID.

isReservedAttribute

public static final boolean isReservedAttribute(java.lang.String name)

Returns if the attribute name is reserved. If name is null, false is returned.

Since:

3.0.0

getCurrentInfo

public static final java.lang.Object getCurrentInfo()

Returns the current component info ComponentInfo, definition (ComponentDefinition or null, which is used only by UiEngine to communicate with AbstractComponent.

Since:

3.0.0

setCurrentInfo

public static final void setCurrentInfo(ComponentDefinition compdef)

Sets the current component definition, which is used only by UiEngine to communicate with AbstractComponent.

Used only internally.

Since:

3.0.0

setCurrentInfo

public static void setCurrentInfo(ComponentInfo compInfo)

Sets the current component definition, which is used only by UiEngine to communicate with AbstractComponent.

Used only internally.

Since:

3.0.0

parseEventExpression

public static java.lang.Object[] parseEventExpression(Component comp,
                                                      java.lang.String evtexpr,
                                                      Component defaultComp,
                                                      boolean deferred)
                                               throws ComponentNotFoundException

Pares the event expression.

There are several formats for the event expression:

• onClick
• self.onClick
• id.onClick
• ../id1/id2.onClick
• ${elexpr}.onClick

Parameters:

comp - the component that the event expression is referenced to

evtexpr - the event expression.

defaultComp - the default component which is used when evtexpr doesn't specify the component.

deferred - whether to defer the conversion of the path to a component. If true and EL not specified or evaluated to a string, it returns the path directly rather than converting it to a component.

Returns:

a two element array. The first element is the component if deferred is false or EL is evaluated to a component, or a path, otherwise. The second component is the event name.

Throws:

ComponentNotFoundException

Since:

3.0.0

applyForward

public static final void applyForward(Component comp,
                                      java.lang.String forward)

Applies the forward condition to the specified component.

The basic format:
onEvent1=id1/id2.onEvent2,onEvent3=id3.onEvent4

See ComponentInfo.setForward(java.lang.String) for more information.

Since:

3.0.0

parseClientScript

public static java.lang.String parseClientScript(Component comp,
                                                 java.lang.String script)

Parses a script by resolving #{xx} to make it executable at the client.

Parameters:

comp - the component used to resolve the EL expression.

script - the Java script to convert

Since:

2.4.0

getEventMethod

public static final java.lang.reflect.Method getEventMethod(java.lang.Class cls,
                                                            java.lang.String evtnm)

Returns the method for handling the specified event, or null if not available.

setEventMethodCache

public static final void setEventMethodCache(org.zkoss.util.Cache cache)

Sets the cache that stores the information about event handler methods.

Since the performance of the cache is critical to the performance of the overall system. There is several options to choose from:

1. ThreadLocalCache: the default. It is the fastest but consumes more memory since it maintains a cache per thread (about 10MB - 16M for over 400 concurrent users).
2. MultiCache. It is the slowest but consumes less memory.

Parameters:

cache - the cache. It cannot be null. It must be thread safe. Once assigned, the caller shall not access it again.

Since:

3.0.0