com.vaadin.terminal.gwt.client.


Class ComponentLocator

java.lang.Object
  com.vaadin.terminal.gwt.client.ComponentLocator


public class ComponentLocator
extends Object

ComponentLocator provides methods for generating a String locator for a given DOM element and for locating a DOM element using a String locator.

Constructor Summary
ComponentLocator(ApplicationConnection client)
          Construct a ComponentLocator for the given ApplicationConnection.
 
Method Summary
 com.google.gwt.user.client.Element getElementByPath(String path)
          Locates an element using a String locator (path) which identifies a DOM element.
 String getPathForElement(com.google.gwt.user.client.Element targetElement)
          Generates a String locator which uniquely identifies the target element.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ComponentLocator

public ComponentLocator(ApplicationConnection client)

Construct a ComponentLocator for the given ApplicationConnection.

Parameters:
client - ApplicationConnection instance for the application.

Method Detail

getPathForElement

public String getPathForElement(com.google.gwt.user.client.Element targetElement)

Generates a String locator which uniquely identifies the target element. The getElementByPath(String) method can be used for the inverse operation, i.e. locating an element based on the return value from this method.

Note that getElementByPath(getPathForElement(element)) == element is not always true as getPathForElement(Element) can return a path to another element if the widget determines an action on the other element will give the same result as the action on the target element.

Parameters:
targetElement - The element to generate a path for.
Returns:
A String locator that identifies the target element or null if a String locator could not be created.
Since:
5.4

getElementByPath

public com.google.gwt.user.client.Element getElementByPath(String path)

Locates an element using a String locator (path) which identifies a DOM element. The getPathForElement(Element) method can be used for the inverse operation, i.e. generating a string expression for a DOM element.

Parameters:
path - The String locater which identifies the target element.
Returns:
The DOM element identified by path or null if the element could not be located.
Since:
5.4