SWTBotLabel.java

/*******************************************************************************
 * Copyright (c) 2008 Stephen Paulin and others.
 * 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:
 *     Stephen Paulin - initial API and implementation
 *******************************************************************************/
package org.eclipse.swtbot.swt.finder.widgets;

import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swtbot.swt.finder.ReferenceBy;
import org.eclipse.swtbot.swt.finder.SWTBotWidget;
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
import org.eclipse.swtbot.swt.finder.results.IntResult;
import org.eclipse.swtbot.swt.finder.results.Result;
import org.hamcrest.SelfDescribing;

/**
 * This represents a {@link Label} widget.
 * 
 * @author Stephen Paulin <paulin [at] developerskingdom [dot] com>
 * @version $Id$
 * @since 1.2
 */
@SWTBotWidget(clasz = Label.class, preferredName = "label", referenceBy = { ReferenceBy.MNEMONIC })
public class SWTBotLabel extends AbstractSWTBotControl<Label> {

	/**
	 * Constructs an instance of this using the given finder and text to search for.
	 * 
	 * @param widget the widget
	 * @throws WidgetNotFoundException if the widget is null or disposed.
	 */
	public SWTBotLabel(Label widget) throws WidgetNotFoundException {
		this(widget, null);
	}

	/**
	 * Constructs an instance of this using the given finder and text to search for.
	 * 
	 * @param widget the widget
	 * @param description the description of the widget, this will be reported by {@link #toString()}
	 * @throws WidgetNotFoundException if the widget is null or disposed.
	 */
	public SWTBotLabel(Label widget, SelfDescribing description) throws WidgetNotFoundException {
		super(widget, description);
	}

	/**
	 * Clicks on the label.
	 */
	public AbstractSWTBot<Label> click() {
		return click(true);
	}

	/**
	 * Return the Label's image or <code>null</code>.
	 * 
	 * @return the image of the label or <code>null</code>.
	 */
	public Image image() {
		return syncExec(new Result<Image>() {
			public Image run() {
				return widget.getImage();
			}
		});
	}

	/**
	 * Returns the alignment. The alignment style (LEFT, CENTER or RIGHT) is returned.
	 * 
	 * @return SWT.LEFT, SWT.RIGHT or SWT.CENTER
	 */
	public int alignment() {
		return syncExec(new IntResult() {
			public Integer run() {
				return widget.getAlignment();
			}
		});
	}

}