org.zkoss.zk.ui.ext
Interface Macro

All Superinterfaces:

AfterCompose, DynamicPropertied, IdSpace

All Known Implementing Classes:

Hello, HtmlMacroComponent, XmlMacroComponent

public interface Macro
extends AfterCompose, IdSpace, DynamicPropertied

Implemented with Component to represent a macro component.

Author:

tomyeh

Method Summary

java.lang.String	getMacroURI() Returns the macro URI.
boolean	isInline() Returns whether this is an inline macro.
void	recreate() Detaches all child components and then recreate them by use of AfterCompose.afterCompose().
void	setMacroURI(java.lang.String uri) Sets the macro URI.

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

afterCompose

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

getFellow, getFellowIfAny, getFellows, hasFellow

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

getDynamicProperty, hasDynamicProperty, setDynamicProperty

Method Detail

setMacroURI

void setMacroURI(java.lang.String uri)

Sets the macro URI. It affects only this component.

Note: this method calls recreate() automatically if uri is changed.

Parameters:

uri - the URI of this macro. If null, the default is used.

getMacroURI

java.lang.String getMacroURI()

Returns the macro URI.

If setMacroURI(java.lang.String) wasn't called, it returns the URI defined in the macro definition.

Since:

3.6.0

recreate

void recreate()

Detaches all child components and then recreate them by use of AfterCompose.afterCompose().

It is used if you have assigned new values to dynamical properties and want to re-create child components to reflect the new values. Note: it is convenient but the performance is better if you can manipulate only the child components that need to be changed. Refer to the Developer's Guide for details.

isInline

boolean isInline()

Returns whether this is an inline macro. The only way to create an inline macro is by use of ComponentDefinition.newInstance(org.zkoss.zk.ui.Page, java.lang.String).

Since:

2.4.0