org.zkoss.zk.ui.sys
Interface IdGenerator

public interface IdGenerator

Used to generate UUID of components and pages and ID of desktops.

Since:

2.4.1

Author:

tomyeh

See Also:

Component.getUuid(), Page.getUuid(), Desktop.getId()

Method Summary

java.lang.String	nextComponentUuid(Desktop desktop, Component comp) Returns the next component UUID for the specified component, or null to generate the default UUID.
java.lang.String	nextDesktopId(Desktop desktop) Returns the next desktop ID for the specified desktop, or null to generate the default UUID.
java.lang.String	nextPageUuid(Page page) Returns the next page UUID for the specified page, or null to generate the default UUID.

Method Detail

nextComponentUuid

java.lang.String nextComponentUuid(Desktop desktop,
                                   Component comp)

Returns the next component UUID for the specified component, or null to generate the default UUID.

This method is called when Component.getUuid() is called at the first time. It is usually when the component is attached to a page, unless the application invokes Component.getUuid() earlier.

Parameters:

desktop - the current desktop (never null)

comp - the component (never null)

Returns:

the next component UUID, or null to generate the default UUID.

nextPageUuid

java.lang.String nextPageUuid(Page page)

Returns the next page UUID for the specified page, or null to generate the default UUID.

Note: we can retrieve the execution by use of Executions.getCurrent().

Returns:

the next page UUID, or null to generate the default UUID.

nextDesktopId

java.lang.String nextDesktopId(Desktop desktop)

Returns the next desktop ID for the specified desktop, or null to generate the default UUID.

Note: we can retrieve the execution by use of Desktop.getExecution(), or Executions.getCurrent().

Returns:

the next desktop UUID, or null to generate the default UUID.