/*******************************************************************************
 *  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.locator;

import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Control;

import com.windowtester.runtime.WidgetSearchException;
import com.windowtester.runtime.condition.HasFocus;
import com.windowtester.runtime.condition.HasText;
import com.windowtester.runtime.condition.HasTextCondition;
import com.windowtester.runtime.condition.IUICondition;
import com.windowtester.runtime.condition.IsEnabled;
import com.windowtester.runtime.condition.IsEnabledCondition;
import com.windowtester.runtime.util.StringComparator;

/**
 * Locates {@link Combo} widgets.
 */
public class ComboLocator  extends SWTWidgetLocator
	implements IsEnabled, HasText, HasFocus
{
	private static final long serialVersionUID = 8194661177031756245L;

	/**
	 * Create a locator instance.
	 */
	public ComboLocator() {
		super(Combo.class);
	}

	//child
	/**
	 * Create a locator instance.
	 * @param parent the parent locator	 
	 */
	public ComboLocator(SWTWidgetLocator parent) {
		super(Combo.class, parent);
	}

	//indexed child
	/**
	 * Create a locator instance.
	 * @param index this locators index with respect to its parent
	 * @param parent the parent locator	 
	 */
	public ComboLocator(int index, SWTWidgetLocator parent) {
		super(Combo.class, index, parent);
	}

	/* (non-Javadoc)
	 * @see com.windowtester.runtime.swt.locator.SWTWidgetLocator#getWidgetText(org.eclipse.swt.widgets.Control)
	 */
	protected String getWidgetText(Control widget) throws WidgetSearchException {
		return ((Combo) widget).getText();
	}
	
	///////////////////////////////////////////////////////////////////////////
	//
	// Condition Factories
	//
	///////////////////////////////////////////////////////////////////////////

	/**
	 * Create a condition that tests if the given widget is enabled.
	 * Note that this is a convenience method, equivalent to:
	 * <code>isEnabled(true)</code>
	 */
	public IUICondition isEnabled() {
		return isEnabled(true);
	}
	
	/**
	 * Create a condition that tests if the given widget is enabled.
	 * @param expected <code>true</code> if the text is expected to be enabled, else
	 *            <code>false</code>
	 * @see IsEnabledCondition
	 */            
	public IUICondition isEnabled(boolean expected) {
		return new IsEnabledCondition(this, expected);
	}
		
	/**
	 * Create a condition that tests if the given widget has the expected text.
	 * <p>
	 * For example, the following asserts that a combo has the text value "win32"
	 * <pre>
	 *    ui.assertThat(new ComboLocator().hasText("win32"));
	 * </pre>
	 * @param expected the expected text
	 *  (can be a regular expression as described in the {@link StringComparator} utility)
	 */
	public IUICondition hasText(String expected) {
		return new HasTextCondition(this, expected);
	}
}