|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IdGenerator
Used to generate UUID of components and pages and ID of desktops.
To create an ID generator that generates the same set of IDs from
one test run to anther, you need only to implement nextDesktopId(org.zkoss.zk.ui.Desktop)
to return a deterministic value. All other methods just return null
to use the default.
Component.getUuid()
,
Page.getUuid()
,
Desktop.getId()
Method Summary | |
---|---|
java.lang.String |
nextComponentUuid(Desktop desktop,
Component comp,
ComponentInfo compInfo)
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 ID. |
java.lang.String |
nextPageUuid(Page page)
Returns the next page UUID for the specified page, or null to generate the default UUID. |
Method Detail |
---|
java.lang.String nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo)
Default (if null is returned): UUID is generated by prefixing a portion of the desktop's ID with a number starting from 0.
Notice that UUID cannot be empty and can only have alphanumeric characters or underscore (i.e., a-z, A-Z, 0-9, and _).
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.
desktop
- the current desktop (never null)comp
- the component (never null)compInfo
- the information about the properties specified in the ZUML
document, null if the component is instantiated manually.
java.lang.String nextPageUuid(Page page)
Default (if null is returned): UUID is generated by prefixing a portion of the desktop's ID with a number starting from 0.
Notice that UUID cannot be empty and can only have alphanumeric characters or underscore (i.e., a-z, A-Z, 0-9, and _). In additions, UUID for pages cannot be the same as UUID for components.
Also notice that the execution can be retrieved by use of
Executions.getCurrent()
.
java.lang.String nextDesktopId(Desktop desktop)
Default (if null is returned): ID is generated randomly. In other words, the desktop's ID, by default, is not deterministic. To have a deterministric value, you have to implement this method.
Notice that UUID cannot be empty and can only have alphanumeric characters or underscore (i.e., a-z, A-Z, 0-9, and _).
Also notice that we can retrieve the execution by use of
Desktop.getExecution()
, or Executions.getCurrent()
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |