Package org.zkoss.zk.ui.metainfo.impl

Class ComponentDefinitionImpl

java.lang.Object

org.zkoss.zk.ui.metainfo.impl.ComponentDefinitionImpl

All Implemented Interfaces:

Serializable, Cloneable, ComponentDefinition

Direct Known Subclasses:

MacroDefinition, ShadowDefinitionImpl

public class ComponentDefinitionImpl
extends Object
implements ComponentDefinition, Serializable

An implementation of ComponentDefinition.

Note: it is not thread safe. Thus, it is better to clone() and then modifying the cloned instance if you want to change it concurrently.

Author:

tomyeh

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ComponentDefinitionImpl(LanguageDefinition langdef, PageDefinition pgdef, String name, Class<? extends Component> cls)	Constructs a native component, i.e., a component implemented by a Java class.
ComponentDefinitionImpl(LanguageDefinition langdef, PageDefinition pgdef, String name, String clsnm)	Constructs a native component, i.e., a component implemented by a Java class.

Method Summary

Modifier and Type	Method	Description
void	addAnnotation(String propName, String annotName, Map<String,String[]> annotAttrs, org.zkoss.util.resource.Location loc)	Adds an annotation to the specified property of this component definition.
void	addCustomAttribute(String name, String value)	Adds a custom attribute.
void	addMold(String name, String widgetClass)	Adds a mold.
void	addProperty(String name, String value)	Adds a property initializer.
void	applyAttributes(Component comp)	Applies the custom attributes defined in this definition to the specified component.
void	applyProperties(Component comp)	Applies the properties defined in this definition to the specified component.
Object	clone()	Clones this component definition.
ComponentDefinition	clone(LanguageDefinition langdef, String name)	Clones this definition and assigns with the specified language definition and name.
Map<String,Object>	evalProperties(Map<String,Object> propmap, Page owner, Component parent)	Evaluates and retrieves properties to the specified map.
AnnotationMap	getAnnotationMap()	Returns the annotation map defined in this definition, or null if no annotation is ever defined.
String	getApply()	Returns the apply attribute that is a list of Composer class names or EL expressions returning classes, class names or composer instances, or null if no apply attribute.
String	getCurrentDirectory()	Returns the current directory which is used to convert a relative URI to absolute, or null if not available.
URL	getDeclarationURL()	Returns the URL where this component definition is declared, or null if not available.
String	getDefaultWidgetClass(Component comp)	Returns the default widget class, or null if not available.
Object	getImplementationClass()	Returns the class (Class) or the class name (String) that implements the component.
LanguageDefinition	getLanguageDefinition()	Returns the language definition, or null if it is a temporary definition belonging to a page.
String	getMacroURI()	Returns the macro URI, or null if not a macro.
Collection<String>	getMoldNames()	Returns a readonly collection of the names of the mold.
String	getName()	Returns name of this component definition (never null).
ExValue[]	getParsedApply()	Return the parsed expressions of the apply attribute.
String	getTextAs()	Returns the property name to which the text enclosed within the element (associated with this component definition) is assigned to.
String	getWidgetClass(Component comp, String moldName)	Returns the widget class associated with specified mold, or the default widget class (ComponentDefinition.getWidgetClass(org.zkoss.zk.ui.Component, java.lang.String)) if not available.
boolean	hasMold(String name)	Returns whether the specified mold exists.
boolean	isBlankPreserved()	Returns whether to preserve the blank text.
boolean	isChildAllowedInTextAs()	Returns if a child is allowed in the text-as area.
boolean	isInlineMacro()	Returns whether this is an inline macro.
boolean	isInstance(Component comp)	Returns whether a component belongs to this definition.
boolean	isMacro()	Returns whether this is a macro component.
boolean	isNative()	Returns whether this is used for the native namespace.
boolean	isShadowElement()	Returns whether this is a shadow element.
Component	newInstance(Class<? extends Component> cls)	Creates an component of this definition.
Component	newInstance(Page page, String clsnm)	Creates an component of this definition.
static final ComponentDefinition	newMacroDefinition(LanguageDefinition langdef, PageDefinition pgdef, String name, Class<? extends Component> cls, String macroURI, boolean inline)	Constructs a macro component definition.
static final ComponentDefinition	newNativeDefinition(LanguageDefinition langdef, String name, Class<? extends Component> cls)	Constructs a native component definition.
static final ComponentDefinition	newShadowDefinition(LanguageDefinition langdef, PageDefinition pgdef, String name, Class<? extends Component> cls, String templateURI)	Constructs a shadow component definition.
Class<?>	resolveImplementationClass(Page page, String clsnm)	Resolves and returns the class that implements the component.
void	setApply(String apply)	Sets the apply attribute that is is a list of Composer class or EL expressions returning classes, class names or composer instances.
void	setBlankPreserved(boolean preserve)	Sets whether to preserve the blank text.
void	setChildAllowedInTextAs(boolean allowed)	Sets whether the child component is allowed within the element.
void	setCurrentDirectory(String curdir)	Sets the current directory which is used to convert a relative URI to absolute.
void	setDeclarationURL(URL url)	Sets the URI where this definition is declared.
void	setDefaultWidgetClass(String widgetClass)	Sets the default widget class.
void	setImplementationClass(Class<? extends Component> cls)	Sets the class to implements the component.
void	setImplementationClass(String clsnm)	Sets the class name to implements the component.
void	setTextAs(String propnm)	Sets the property name to which the text enclosed within the element (associated with this component definition) is assigned to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentDefinitionImpl

public ComponentDefinitionImpl(LanguageDefinition langdef,
 PageDefinition pgdef,
 String name,
 Class<? extends Component> cls)

Constructs a native component, i.e., a component implemented by a Java class.

Note; if both langdef and pgdef are null, it must be a reserved component.

Parameters:

langdef - the language definition. It is null if it is defined as part of a page definition

pgdef - the page definition. It is null if it is defined as part of a language definition. doesn't belong to any language.

cls - the implementation class.

Since:

3.0.0

ComponentDefinitionImpl

public ComponentDefinitionImpl(LanguageDefinition langdef,
 PageDefinition pgdef,
 String name,
 String clsnm)

Constructs a native component, i.e., a component implemented by a Java class.

Note; if both langdef and pgdef are null, it must be a reserved component.

Parameters:

langdef - the language definition. It is null if it is defined as part of a page definition

pgdef - the page definition. It is null if it is defined as part of a language definition. doesn't belong to any language.

clsnm - the implementation class.

Since:

3.0.8

Method Details

newShadowDefinition

public static final ComponentDefinition newShadowDefinition(LanguageDefinition langdef,
 PageDefinition pgdef,
 String name,
 Class<? extends Component> cls,
 String templateURI)

Constructs a shadow component definition. It is the component definition used to implement the shadow element.

Parameters:

langdef - the language definition. It is null if it is defined as part of a page definition

pgdef - the page definition. It is null if it is defined as part of a language definition.

templateURI - the URI of the ZUML page to representing this shadow, like macroURI.

Since:

8.0.0

newMacroDefinition

public static final ComponentDefinition newMacroDefinition(LanguageDefinition langdef,
 PageDefinition pgdef,
 String name,
 Class<? extends Component> cls,
 String macroURI,
 boolean inline)

Constructs a macro component definition. It is the component definition used to implement the macros.

Parameters:

langdef - the language definition. It is null if it is defined as part of a page definition

pgdef - the page definition. It is null if it is defined as part of a language definition.

macroURI - the URI of the ZUML page to representing this macro.

Since:

3.0.0

newNativeDefinition

public static final ComponentDefinition newNativeDefinition(LanguageDefinition langdef,
 String name,
 Class<? extends Component> cls)

Constructs a native component definition. It is the component definition used to implement the native namespace.

Parameters:

langdef - the language definition. It cannot be null.

Since:

3.0.0

addCustomAttribute

public void addCustomAttribute(String name,
 String value)

Adds a custom attribute.

addAnnotation

public void addAnnotation(String propName,
 String annotName,
 Map<String,String[]> annotAttrs,
 org.zkoss.util.resource.Location loc)

Adds an annotation to the specified property of this component definition.

Parameters:

propName - the property name. If null, the annotation is associated with the whole component rather than a particular property.

annotName - the annotation name (never null, nor empty).

annotAttrs - a map of attributes, or null if no attribute at all. The attribute must be in a pair of strings (String name, String value).

loc - the location information of the annotation in the document, or null if not available.

Since:

6.0.0

getCurrentDirectory

public String getCurrentDirectory()

Returns the current directory which is used to convert a relative URI to absolute, or null if not available.

setCurrentDirectory

public void setCurrentDirectory(String curdir)

Sets the current directory which is used to convert a relative URI to absolute.

Parameters:

curdir - the current directory; null to ignore.

setTextAs

public void setTextAs(String propnm)

Sets the property name to which the text enclosed within the element (associated with this component definition) is assigned to.

Default: null (means to create a Label component)

Parameters:

propnm - the property name. If empty (""), null is assumed.

Since:

3.0.0

See Also:

• getTextAs()

setBlankPreserved

public void setBlankPreserved(boolean preserve)

Sets whether to preserve the blank text. If false, the blank text (a non-empty string consisting of whitespaces) are ignored. If true, they are converted to a label child.

Default: false.

Since:

3.5.0

See Also:

• isBlankPreserved()

setChildAllowedInTextAs

public void setChildAllowedInTextAs(boolean allowed)

Sets whether the child component is allowed within the element. For more information, please refer to ComponentDefinition.getTextAs().

Since:

6.0.0

setDeclarationURL

public void setDeclarationURL(URL url)

Sets the URI where this definition is declared.

Parameters:

url - the URL. If null, it means not available.

Since:

3.0.3

getLanguageDefinition

public LanguageDefinition getLanguageDefinition()

Description copied from interface: ComponentDefinition

Returns the language definition, or null if it is a temporary definition belonging to a page.

Specified by:

getLanguageDefinition in interface ComponentDefinition

getName

public String getName()

Description copied from interface: ComponentDefinition

Returns name of this component definition (never null). It is unique in the same language, LanguageDefinition, if it belongs to a language, i.e., ComponentDefinition.getLanguageDefinition() is not null.

Specified by:

getName in interface ComponentDefinition

getTextAs

public String getTextAs()

Description copied from interface: ComponentDefinition

Returns the property name to which the text enclosed within the element (associated with this component definition) is assigned to.

Default: null (means to create a Label component as the child)

For example, if ComponentDefinition.getTextAs() returns null, then a Label component is created as a child of comp with the "Hi Text" value in the following example:

<comp>
  Hi Text
</comp>

In other words, it is equivalent to

<comp>
  <label value="Hi Text"/>
</comp>

On the other hand, if ComponentDefinition.getTextAs() returns a non-empty string, say, "content", then "Hi Text" is assigned to the content property of comp. In other words, it is equivalent to

<comp content="Hi Text"/>
</comp>

It is also the same as

<comp>
  <attribute name="content"/>
  Hi Text
  </attribute>
</comp>

To enable it, you can declare text-as in the component definition in lang.xml or lang-addon.xml:

<component>
  <component-name>html</component-name>
  <text-as>content</text-as>
...

Notice that it is valid to have XML fragment, including XML elements, within the element. For example,

<html>
        <ul>
        <li forEach="apple, orange">${each}</li>
        </ul>
        </html>

If the component allows child components, it is better not to try XML fragment as the plain text. And then, it shall return true in ComponentDefinition.isChildAllowedInTextAs(). Example, A.

Specified by:

getTextAs in interface ComponentDefinition

See Also:

• ComponentDefinition.isChildAllowedInTextAs()

isChildAllowedInTextAs

public boolean isChildAllowedInTextAs()

Description copied from interface: ComponentDefinition

Returns if a child is allowed in the text-as area. It is meaningful only if ComponentDefinition.getTextAs() is not null. If true, the text enclosed within the element is considered as text only if there is no other XML element.

For example, <div> in the following example won't be considered as text. Rather, a div component will be created.

<a>
  <div>...</div>
</a>

Default: false.

Specified by:

isChildAllowedInTextAs in interface ComponentDefinition

See Also:

• ComponentDefinition.getTextAs()

isBlankPreserved

public boolean isBlankPreserved()

Description copied from interface: ComponentDefinition

Returns whether to preserve the blank text. If false, the blank text (a non-empty string consisting of whitespaces) are ignored. If true, they are converted to a label child.

Default: false.

Specified by:

isBlankPreserved in interface ComponentDefinition

isMacro

public boolean isMacro()

Description copied from interface: ComponentDefinition

Returns whether this is a macro component.

Specified by:

isMacro in interface ComponentDefinition

See Also:

• ComponentDefinition.getMacroURI()

getMacroURI

public String getMacroURI()

Description copied from interface: ComponentDefinition

Returns the macro URI, or null if not a macro.

Specified by:

getMacroURI in interface ComponentDefinition

isInlineMacro

public boolean isInlineMacro()

Description copied from interface: ComponentDefinition

Returns whether this is an inline macro. If false, you have to examine ComponentDefinition.isMacro() to see whether it is a regular macro.

Specified by:

isInlineMacro in interface ComponentDefinition

isNative

public boolean isNative()

Description copied from interface: ComponentDefinition

Returns whether this is used for the native namespace.

Specified by:

isNative in interface ComponentDefinition

See Also:

• LanguageDefinition.getNativeDefinition()

getImplementationClass

public Object getImplementationClass()

Description copied from interface: ComponentDefinition

Returns the class (Class) or the class name (String) that implements the component.

If a string is returned, the real class may depend on which page a component will be created to. Reason: the zscript interpreter is associated with a page and it may define classes upon evaluating a page.

Specified by:

getImplementationClass in interface ComponentDefinition

setImplementationClass

public void setImplementationClass(Class<? extends Component> cls)

Description copied from interface: ComponentDefinition

Sets the class to implements the component.

Note: currently, classes specified in lang.xml or lang-addon.xml must be resolved when loading the files. However, classes specified in a page (by use of class or use attributes) might be resolved later because it might be defined by zscript.

Specified by:

setImplementationClass in interface ComponentDefinition

setImplementationClass

public void setImplementationClass(String clsnm)

Description copied from interface: ComponentDefinition

Sets the class name to implements the component. Unlike ComponentDefinition.setImplementationClass(Class), the class won't be resolved until ComponentInfo.newInstance(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Component) or ComponentDefinition.getImplementationClass() is used. In other words, the class can be provided later (thru, usually, zscript).

Specified by:

setImplementationClass in interface ComponentDefinition

newInstance

public Component newInstance(Page page,
 String clsnm)

Description copied from interface: ComponentDefinition

Creates an component of this definition.

Note: this method doesn't invoke ComponentDefinition.applyProperties(org.zkoss.zk.ui.Component). It is caller's job to apply these properties if necessary. Since the value of a property might depend on the component tree, it is better to assign the component with a proper parent before calling ComponentDefinition.applyProperties(org.zkoss.zk.ui.Component).

Similarly, this method doesn't attach the component to the specified page. Developers may or may not add it to a page or a parent.

An application developer can invoke UiFactory.newComponent(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.metainfo.ComponentInfo, org.zkoss.zk.ui.Component) instead of ComponentDefinition.newInstance(org.zkoss.zk.ui.Page, java.lang.String), since a deployer might customize the way to create components by providing an implementation of UiFactory. In additions, it also invokes ComponentDefinition.applyProperties(org.zkoss.zk.ui.Component) assigning page/parent.

On the other hand, this method is 'low-level'. It simply resolves the implementation class by use of ComponentDefinition.resolveImplementationClass(org.zkoss.zk.ui.Page, java.lang.String), and then uses it to create an instance.

Specified by:

newInstance in interface ComponentDefinition

Parameters:

page - the page that is used to resolve the implementation class. It is used only this definition is associated with a class name by ComponentDefinition.setImplementationClass(String), or clsnm is not null. Note: this method won't attach the component to the specified page. It can be null if ComponentDefinition.getImplementationClass() returns a Class instance, and clsnm is null.

clsnm - [optional] If specified, clsnm is used instead of ComponentDefinition.getImplementationClass(). In other words, it overrides the default class.

Returns:

the new component (never null)

newInstance

public Component newInstance(Class<? extends Component> cls)

Description copied from interface: ComponentDefinition

Creates an component of this definition. Refer to ComponentDefinition.newInstance(Page, String). They are the same except this method accepts the class directly, while ComponentDefinition.newInstance(Page, String) invokes ComponentDefinition.resolveImplementationClass(org.zkoss.zk.ui.Page, java.lang.String) to resolve the class first.

Specified by:

newInstance in interface ComponentDefinition

Returns:

the new component (never null)

isInstance

public boolean isInstance(Component comp)

Description copied from interface: ComponentDefinition

Returns whether a component belongs to this definition.

If ComponentDefinition.resolveImplementationClass(org.zkoss.zk.ui.Page, java.lang.String) failed to resolve, true is returned!

Specified by:

isInstance in interface ComponentDefinition

resolveImplementationClass

public Class<?> resolveImplementationClass(Page page,
 String clsnm)
                                    throws ClassNotFoundException

Description copied from interface: ComponentDefinition

Resolves and returns the class that implements the component.

Unlike ComponentDefinition.getImplementationClass(), this method will resolve a class name (String) to a class (Class), if necessary. In addition, if the clsnm argument is specified, it is used instead of ComponentDefinition.getImplementationClass(). In other words, it overrides the default class.

Specified by:

resolveImplementationClass in interface ComponentDefinition

Parameters:

page - the page to check whether the class is defined in its interpreters. Ignored if null. This method will search the class loader of the current thread. If not found, it will search the interpreters of the specified page (Page.getLoadedInterpreters()). Note: this method won't attach the component to the specified page.

clsnm - [optional] If specified, clsnm is used instead of ComponentDefinition.getImplementationClass(). In other words, it overrides the default class.

Throws:

ClassNotFoundException - if the class not found

getAnnotationMap

public AnnotationMap getAnnotationMap()

Description copied from interface: ComponentDefinition

Returns the annotation map defined in this definition, or null if no annotation is ever defined.

Specified by:

getAnnotationMap in interface ComponentDefinition

getApply

public String getApply()

Description copied from interface: ComponentDefinition

Returns the apply attribute that is a list of Composer class names or EL expressions returning classes, class names or composer instances, or null if no apply attribute.

Specified by:

getApply in interface ComponentDefinition

See Also:

• ComponentDefinition.getParsedApply()

setApply

public void setApply(String apply)

Description copied from interface: ComponentDefinition

Sets the apply attribute that is is a list of Composer class or EL expressions returning classes, class names or composer instances.

Specified by:

setApply in interface ComponentDefinition

Parameters:

apply - the attribute this is a list of Composer class or EL expressions El expressions are allowed, but self means the parent, if available; or page, if no parent at all. (Note: the component is not created yet when the apply attribute is evaluated).

getParsedApply

public ExValue[] getParsedApply()

Description copied from interface: ComponentDefinition

Return the parsed expressions of the apply attribute.

Specified by:

getParsedApply in interface ComponentDefinition

See Also:

• ComponentDefinition.getApply()

getDeclarationURL

public URL getDeclarationURL()

Description copied from interface: ComponentDefinition

Returns the URL where this component definition is declared, or null if not available.

Specified by:

getDeclarationURL in interface ComponentDefinition

addProperty

public void addProperty(String name,
 String value)

Description copied from interface: ComponentDefinition

Adds a property initializer. It will initialize a component when created with is definition.

Specified by:

addProperty in interface ComponentDefinition

Parameters:

name - the member name. The component must have a valid setter for it.

value - the value. It might contain expressions (${}).

applyProperties

public void applyProperties(Component comp)

Description copied from interface: ComponentDefinition

Applies the properties defined in this definition to the specified component.

Note: annotations are applied to the component when a component is created. So, this method doesn't and need not to copy them.

Also notice that, since 5.0.7, custom-attributes are applied automatically in the constructor of AbstractComponent(boolean) (by invoking ComponentDefinition.applyAttributes(org.zkoss.zk.ui.Component), so they are always available no matter this method is called or not.

Specified by:

applyProperties in interface ComponentDefinition

applyAttributes

public void applyAttributes(Component comp)

Description copied from interface: ComponentDefinition

Applies the custom attributes defined in this definition to the specified component.

It is called automatically in AbstractComponent(boolean), so you rarely need to invoke this method.

Specified by:

applyAttributes in interface ComponentDefinition

evalProperties

public Map<String,Object> evalProperties(Map<String,Object> propmap,
 Page owner,
 Component parent)

Description copied from interface: ComponentDefinition

Evaluates and retrieves properties to the specified map.

Specified by:

evalProperties in interface ComponentDefinition

Parameters:

propmap - the map to store the retrieved properties. If null, a HashMap instance is created. (String name, Object value).

owner - the owner page; used if parent is null

parent - the parent

addMold

public void addMold(String name,
 String widgetClass)

Description copied from interface: ComponentDefinition

Adds a mold.

Specified by:

addMold in interface ComponentDefinition

Parameters:

name - the mold name.

widgetClass - the widget class (a.k.a., name). Ignored if null.

hasMold

public boolean hasMold(String name)

Description copied from interface: ComponentDefinition

Returns whether the specified mold exists.

Specified by:

hasMold in interface ComponentDefinition

getMoldNames

public Collection<String> getMoldNames()

Description copied from interface: ComponentDefinition

Returns a readonly collection of the names of the mold.

Specified by:

getMoldNames in interface ComponentDefinition

getWidgetClass

public String getWidgetClass(Component comp,
 String moldName)

Description copied from interface: ComponentDefinition

Returns the widget class associated with specified mold, or the default widget class (ComponentDefinition.getWidgetClass(org.zkoss.zk.ui.Component, java.lang.String)) if not available. The returned widget class includes the package name (JavaScript class).

Specified by:

getWidgetClass in interface ComponentDefinition

Parameters:

comp - the component used to evaluate EL expression, if any, when retrieving the widget class. Ignored if null.

moldName - the mold name

getDefaultWidgetClass

public String getDefaultWidgetClass(Component comp)

Description copied from interface: ComponentDefinition

Returns the default widget class, or null if not available.

Specified by:

getDefaultWidgetClass in interface ComponentDefinition

Parameters:

comp - the component used to evaluate EL expression, if any, when retrieving the widget class. Ignored if null.

setDefaultWidgetClass

public void setDefaultWidgetClass(String widgetClass)

Description copied from interface: ComponentDefinition

Sets the default widget class.

Specified by:

setDefaultWidgetClass in interface ComponentDefinition

Parameters:

widgetClass - the name of the widget class (JavaScript class), including the package name.

isShadowElement

public boolean isShadowElement()

Description copied from interface: ComponentDefinition

Returns whether this is a shadow element.

Specified by:

isShadowElement in interface ComponentDefinition

See Also:

• LanguageDefinition.getShadowDefinition(java.lang.String)

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Description copied from interface: ComponentDefinition

Clones this component definition. You rarely invoke this method directly. Rather, use ComponentDefinition.clone(LanguageDefinition, String).

Note: the caller usually has to change the component name, and then assign to a language definition (LanguageDefinition) or a page definition (PageDefinition).

Specified by:

clone in interface ComponentDefinition

Overrides:

clone in class Object

Returns:

the new component definition by cloning from this definition.

clone

public ComponentDefinition clone(LanguageDefinition langdef,
 String name)

Description copied from interface: ComponentDefinition

Clones this definition and assigns with the specified language definition and name.

Specified by:

clone in interface ComponentDefinition