HasText.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.condition;

import com.windowtester.runtime.IUIContext;
import com.windowtester.runtime.WidgetSearchException;
import com.windowtester.runtime.locator.ILocator;

/**
 * A specialized {@link ILocator} providing a convenience method to extract text from the
 * underlying object. See {@link HasTextCondition} for typical usage.
 */
public interface HasText
{
	/**
	 * Resolve the locator to a single object and answer the text associated with it.
	 * 
	 * @param ui the UI context in which to find the widgets
	 * @return the text associated with that object (may be null)
	 */
	String getText(IUIContext ui) throws WidgetSearchException;
}