Package org.zkoss.zk.ui

Class Path

java.lang.Object

org.zkoss.zk.ui.Path

public class Path
extends java.lang.Object

A representation of a component path.

There are three formats: //page-id/comp-id/comp-id
/comp-id/comp-id
comp-id/comp-id

Alternatively, you could use Component.query(java.lang.String) or Component.queryAll(java.lang.String) instead.

Author:

tomyeh

Constructor Summary

Constructors

Constructor	Description
Path()
Path(java.lang.String path)
Path(java.lang.String parent, java.lang.String child)
Path(Component comp)	Returns the path of the specified component.
Path(Path parent, java.lang.String child)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
Component	getComponent()	Returns the component with this path, or null if no such component.
static Component	getComponent(java.lang.String path)	Returns the component of the specified path, or null if no such component.
static Component	getComponent(IdSpace is, java.lang.String path)	Returns the component of the specified path which is related to the specified ID space, or null if no such component.
java.lang.String	getPath()	Returns the path (after normalized).
static java.lang.String	getPath(Component comp)	Returns the path of the specified component.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Path

public Path()

Path

public Path(java.lang.String path)

Path

public Path(java.lang.String parent,
            java.lang.String child)

Path

public Path(Path parent,
            java.lang.String child)

Path

public Path(Component comp)

Returns the path of the specified component.

Method Detail

getPath

public java.lang.String getPath()

Returns the path (after normalized).

getPath

public static final java.lang.String getPath(Component comp)

Returns the path of the specified component.

getComponent

public Component getComponent()

Returns the component with this path, or null if no such component.

getComponent

public static final Component getComponent(java.lang.String path)

Returns the component of the specified path, or null if no such component.

getComponent

public static final Component getComponent(IdSpace is,
                                           java.lang.String path)

Returns the component of the specified path which is related to the specified ID space, or null if no such component.

Parameters:

is - the current ID space. It is required only if path is related (in other words, not starting with / or //).

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object