• Home
• com.github.markusbernhardt
• robotframework-selenium2library-java
• 1.1.0.6
• source code
• SelectElement.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.markusbernhardt.selenium2library.keywords.SelectElement Maven / Gradle / Ivy

package com.github.markusbernhardt.selenium2library.keywords;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.ui.Select;

import com.github.markusbernhardt.selenium2library.Selenium2LibraryNonFatalException;
import com.github.markusbernhardt.selenium2library.utils.Python;

public abstract class SelectElement extends Screenshot {

	// ##############################
	// Keywords
	// ##############################

	public List getListItems(String locator) {
		List options = this.getSelectListOptions(locator);

		return getLabelsForOptions(options);
	}

	public String getSelectedListLabel(String locator) {
		Select select = getSelectList(locator);

		return select.getFirstSelectedOption().getAttribute("label");
	}

	public List getSelectedListLabels(String locator) {
		List options = getSelectListOptionsSelected(locator);

		if (options.size() == 0) {
			throw new Selenium2LibraryNonFatalException(
					String.format(
							"Select list with locator '%s' does not have any selected values.",
							locator));
		}

		return getLabelsForOptions(options);
	}

	public String getSelectedListValue(String locator) {
		Select select = getSelectList(locator);

		return select.getFirstSelectedOption().getAttribute("value");
	}

	public List getSelectedListValues(String locator) {
		List options = getSelectListOptionsSelected(locator);

		if (options.size() == 0) {
			throw new Selenium2LibraryNonFatalException(
					String.format(
							"Select list with locator '%s' does not have any selected values.",
							locator));
		}

		return getValuesForOptions(options);
	}

	public void listSelectionShouldBe(String locator, List items) {
		String itemList = items.size() != 0 ? String.format("option(s) [ %s ]",
				Python.join(" | ", items)) : "no options";
		info(String.format("Verifying list '%s' has %s selected.", locator,
				itemList));

		this.pageShouldContainList(locator);

		List options = getSelectListOptionsSelected(locator);
		if (items.size() > 0 || options.size() > 0) {
			List selectedValues = getValuesForOptions(options);
			List selectedLabels = getLabelsForOptions(options);

			String message = String
					.format("List '%s' should have had selection [ %s ] but it was [ %s ].",
							locator, Python.join(" | ", items),
							Python.join(" | ", selectedLabels));

			for (String item : items) {
				if (!selectedValues.contains(item)
						|| !selectedLabels.contains(item)) {
					throw new Selenium2LibraryNonFatalException(message);
				}
			}

			Map map = Python
					.zip(selectedValues, selectedLabels);
			for (Map.Entry entry : map.entrySet()) {
				if (!items.contains(entry.getKey())
						|| !items.contains(entry.getValue())) {
					throw new Selenium2LibraryNonFatalException(message);
				}
			}
		}
	}

	public void listShouldHaveNoSelections(String locator) {
		info(String.format("Verifying list '%s' has no selection.", locator));

		List options = getSelectListOptionsSelected(locator);
		if (!options.equals(null)) {
			List selectedLabels = getLabelsForOptions(options);
			String items = Python.join(" | ", selectedLabels);
			throw new Selenium2LibraryNonFatalException(
					String.format(
							"List '%s' should have had no selection (selection was [ %s ]).",
							locator, items.toString()));
		}
	}

	public void pageShouldContainList(String locator) {
		pageShouldContainList(locator, "");
	}

	public void pageShouldContainList(String locator, String message) {
		pageShouldContainList(locator, message, "INFO");
	}

	public void pageShouldContainList(String locator, String message,
			String logLevel) {
		this.pageShouldContainElement(locator, "list", message, logLevel);
	}

	public void pageShouldNotContainList(String locator) {
		pageShouldNotContainList(locator, "");
	}

	public void pageShouldNotContainList(String locator, String message) {
		pageShouldNotContainList(locator, message, "INFO");
	}

	public void pageShouldNotContainList(String locator, String message,
			String logLevel) {
		this.pageShouldNotContainElement(locator, "list", message, logLevel);
	}

	public void selectAllFromList(String locator) {
		info(String.format("Selecting all options from list '%s'.", locator));

		Select select = getSelectList(locator);
		if (!isMultiselectList(select)) {
			throw new Selenium2LibraryNonFatalException(
					"Keyword 'Select all from list' works only for multiselect lists.");
		}

		for (int i = 0; i < select.getOptions().size(); i++) {
			select.selectByIndex(i);
		}
	}

	public void selectFromList(String locator, String... items) {
		String itemList = items.length != 0 ? String.format("option(s) [ %s ]",
				Python.join(" | ", items)) : "all options";
		info(String.format("Selecting %s from list '%s'.", itemList, locator));

		Select select = getSelectList(locator);

		if (items.length != 0) {
			for (int i = 0; i < select.getOptions().size(); i++) {
				select.selectByIndex(i);
			}
		}

		for (String item : items) {
			try {
				select.selectByValue(item);
			} catch (NoSuchElementException e1) {
				try {
					select.selectByVisibleText(item);
				} catch (NoSuchElementException e2) {
					continue;
				}
			}
		}
	}

	public void selectFromListByIndex(String locator, String... indexes) {
		if (indexes.length == 0) {
			throw new Selenium2LibraryNonFatalException("No index given.");
		}

		List tmp = new ArrayList();
		for (String index : indexes) {
			tmp.add(index);
		}
		String items = String.format("index(es) '%s'", Python.join(", ", tmp));
		info(String.format("Selecting %s from list '%s'.", items, locator));

		Select select = getSelectList(locator);
		for (String index : indexes) {
			select.selectByIndex(Integer.parseInt(index));
		}
	}

	public void selectFromListByValue(String locator, String... values) {
		if (values.length == 0) {
			throw new Selenium2LibraryNonFatalException("No value given.");
		}

		String items = String
				.format("value(s) '%s'", Python.join(", ", values));
		info(String.format("Selecting %s from list '%s'.", items, locator));

		Select select = getSelectList(locator);
		for (String value : values) {
			select.selectByValue(value);
		}
	}

	public void selectFromListByLabel(String locator, String... labels) {
		if (labels.length == 0) {
			throw new Selenium2LibraryNonFatalException("No value given.");
		}

		String items = String
				.format("label(s) '%s'", Python.join(", ", labels));
		info(String.format("Selecting %s from list '%s'.", items, locator));

		Select select = getSelectList(locator);
		for (String label : labels) {
			select.selectByVisibleText(label);
		}
	}

	public void unselectFromList(String locator, String... items) {
		String itemList = items.length != 0 ? String.format("option(s) [ %s ]",
				Python.join(" | ", items)) : "all options";
		info(String.format("Unselecting %s from list '%s'.", itemList, locator));

		Select select = getSelectList(locator);

		if (!isMultiselectList(select)) {
			throw new Selenium2LibraryNonFatalException(
					"Keyword 'Unselect from list' works only for multiselect lists.");
		}

		if (items.length == 0) {
			select.deselectAll();

			return;
		}

		for (String item : items) {
			select.deselectByValue(item);
			select.deselectByVisibleText(item);
		}
	}

	public void unselectFromListByIndex(String locator, Integer... indexes) {
		if (indexes.equals(null)) {
			throw new Selenium2LibraryNonFatalException("No index given.");
		}

		List tmp = new ArrayList();
		for (Integer index : indexes) {
			tmp.add(index.toString());
		}
		String items = String.format("index(es) '%s'", Python.join(", ", tmp));
		info(String.format("Unselecting %s from list '%s'.", items, locator));

		Select select = getSelectList(locator);

		if (!isMultiselectList(select)) {
			throw new Selenium2LibraryNonFatalException(
					"Keyword 'Unselect from list' works only for multiselect lists.");
		}

		for (int index : indexes) {
			select.deselectByIndex(index);
		}
	}

	public void unselectFromListByValue(String locator, String... values) {
		if (values.equals(null)) {
			throw new Selenium2LibraryNonFatalException("No value given.");
		}

		String items = String
				.format("value(s) '%s'", Python.join(", ", values));
		info(String.format("Unselecting %s from list '%s'.", items, locator));

		Select select = getSelectList(locator);

		if (!isMultiselectList(select)) {
			throw new Selenium2LibraryNonFatalException(
					"Keyword 'Unselect from list' works only for multiselect lists.");
		}

		for (String value : values) {
			select.deselectByValue(value);
		}
	}

	public void unselectFromListByLabel(String locator, String... labels) {
		if (labels.equals(null)) {
			throw new Selenium2LibraryNonFatalException("No value given.");
		}

		String items = String
				.format("label(s) '%s'", Python.join(", ", labels));
		info(String.format("Unselecting %s from list '%s'.", items, locator));

		Select select = getSelectList(locator);

		if (!isMultiselectList(select)) {
			throw new Selenium2LibraryNonFatalException(
					"Keyword 'Unselect from list' works only for multiselect lists.");
		}

		for (String label : labels) {
			select.deselectByVisibleText(label);
		}
	}

	// ##############################
	// Internal Methods
	// ##############################

	private List getLabelsForOptions(List options) {
		List labels = new ArrayList();

		for (WebElement option : options) {
			labels.add(option.getText());
		}

		return labels;
	}

	private Select getSelectList(String locator) {
		List elements = elementFind(locator, true, true, "select");

		return new Select(elements.get(0));
	}

	private List getSelectListOptions(Select select) {
		return new ArrayList(select.getOptions());
	}

	private List getSelectListOptions(String locator) {
		Select select = getSelectList(locator);

		return getSelectListOptions(select);
	}

	private List getSelectListOptionsSelected(String locator) {
		Select select = getSelectList(locator);

		return new ArrayList(select.getAllSelectedOptions());
	}

	private List getValuesForOptions(List options) {
		ArrayList labels = new ArrayList();

		for (WebElement option : options) {
			labels.add(option.getAttribute("value"));
		}

		return labels;
	}

	private boolean isMultiselectList(Select select) {
		return select.isMultiple();
	}

}