IWidgetIdentifierStrategy.java

/*******************************************************************************
 *  Copyright (c) 2012 Google, Inc.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *  
 *  Contributors:
 *  Google, Inc. - initial API and implementation
 *******************************************************************************/
package com.windowtester.runtime.swt.internal.finder;

import org.eclipse.swt.widgets.Event;
import org.eclipse.swt.widgets.Widget;

import com.windowtester.internal.runtime.IWidgetIdentifier;

public interface IWidgetIdentifierStrategy {

	/**
	 * Generates a <code>WidgetLocator</code> that uniquely identifies this widget
	 * relative to the current widget hierarchy.  If no uniquely identifying locator is found
	 * <code>null</code> is returned.
	 * @param w the widget to identify
	 * @return a uniquely identifying <code>WidgetLocator</code> or <code>null</code> if none can be infered
	 */
	IWidgetIdentifier identify(Widget w);

	/**
	 * Generates a <code>WidgetLocator</code> that uniquely identifies this widget
	 * relative to the current widget hierarchy.  If no uniquely identifying locator is found
	 * <code>null</code> is returned.
	 * @param w the widget to identify
	 * @param event the associated event
	 * @return a uniquely identifying <code>WidgetLocator</code> or <code>null</code> if none can be infered
	 */
	IWidgetIdentifier identify(Widget w, Event event);

}