org.alfresco.po.share.dashlet.EditingContentDashlet.java Source code

Introduction

Here is the source code for org.alfresco.po.share.dashlet.EditingContentDashlet.java

Source

/*
 * #%L
 * share-po
 * %%
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 * %%
 * This file is part of the Alfresco software. 
 * If the software was purchased under a paid Alfresco license, the terms of 
 * the paid license agreement will prevail.  Otherwise, the software is 
 * provided under the following open source license terms:
 * 
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

package org.alfresco.po.share.dashlet;

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.Collections;
import java.util.List;

import org.alfresco.po.HtmlPage;
import org.alfresco.po.RenderTime;
import org.alfresco.po.exception.PageOperationException;
import org.alfresco.po.exception.PageRenderTimeException;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.openqa.selenium.By;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.StaleElementReferenceException;
import org.openqa.selenium.TimeoutException;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.support.FindBy;

@FindBy(css = "div[id$='-my-docs-dashlet']")
/**
 * Page object to hold Content I'm Editing dashlet
 * Created by olga lokhach
 */
public class EditingContentDashlet extends AbstractDashlet implements Dashlet {
    private static final By DASHLET_CONTAINER_PLACEHOLDER = By.cssSelector("div[id$='-my-docs-dashlet']");
    private static final By ITEMS_DETAILS = By.cssSelector(".detail-list-item>div.details");
    private static final By ITEM_LINKS = By.cssSelector(".detail-list-item>div.details>h4>a");
    private static final By SITE_LINKS = By.cssSelector(".detail-list-item>div.details>div>a[class$='site-link']");
    private Log logger = LogFactory.getLog(this.getClass());

    @SuppressWarnings("unchecked")
    public EditingContentDashlet render(RenderTime timer) {
        try {
            //Set focus of dashlet if below visbile area of screen.
            setResizeHandle(DASHLET_CONTAINER_PLACEHOLDER);
            while (true) {
                timer.start();
                synchronized (this) {
                    try {
                        this.wait(50L);
                    } catch (InterruptedException e) {
                    }
                }
                try {
                    scrollDownToDashlet();
                    getFocus(DASHLET_CONTAINER_PLACEHOLDER);
                    this.dashlet = driver.findElement((DASHLET_CONTAINER_PLACEHOLDER));
                    break;
                } catch (NoSuchElementException e) {
                    logger.error("The placeholder for EditingContentDashlet dashlet was not found ", e);
                } catch (StaleElementReferenceException ste) {
                    logger.error("DOM has changed therefore page should render once change", ste);
                }

                finally {
                    timer.end();
                }
            }
        } catch (PageRenderTimeException te) {
            throw new NoSuchDashletExpection(
                    this.getClass().getName() + " failed to find Content I'm Editing dashlet", te);
        }
        return this;
    }

    @SuppressWarnings("unchecked")
    @Override
    public EditingContentDashlet render() {
        return render(new RenderTime(maxPageLoadingTime));
    }

    private List<WebElement> getItemsDetailsElem() {
        try {
            return dashlet.findElements(ITEMS_DETAILS);
        } catch (StaleElementReferenceException e) {
            return getItemsDetailsElem();
        } catch (TimeoutException e) {
            return Collections.emptyList();
        }
    }

    /**
     * Return true if item link with the details is displayed.
     *
     * @param itemName String
     * @param siteName String
     * @return boolean
     */
    public boolean isItemWithDetailDisplayed(String itemName, String siteName) {
        checkNotNull(itemName);
        List<WebElement> itemLinks = getItemsDetailsElem();
        for (WebElement itemLink : itemLinks) {
            String linkText = itemLink.getText();
            if (linkText.contains(itemName) && linkText.contains(siteName)) {
                return itemLink.isDisplayed();
            }
        }
        return false;
    }

    private List<WebElement> getItemLinksElem() {
        try {
            return dashlet.findElements(ITEM_LINKS);
        } catch (StaleElementReferenceException e) {
            return getItemLinksElem();
        } catch (TimeoutException e) {
            return Collections.emptyList();
        }
    }

    /**
     * Click on item
     *
     * @param itemName String
     * @return HTMLPage
     */
    public HtmlPage clickItem(String itemName) {
        checkNotNull(itemName);
        List<WebElement> itemLinks = getItemLinksElem();
        for (WebElement itemLink : itemLinks) {
            String linkText = itemLink.getText();
            if (linkText.equalsIgnoreCase(itemName)) {
                itemLink.click();
                return getCurrentPage();
            }
        }

        throw new PageOperationException(itemName + "' was not found!");
    }

    private List<WebElement> getSitesDetailsElem() {
        try {
            return dashlet.findElements(SITE_LINKS);
        } catch (StaleElementReferenceException e) {
            return getSitesDetailsElem();
        } catch (Exception e) {
            return Collections.emptyList();
        }
    }

    /**
     * Click on site
     *
     * @param siteName String
     * @return SitePage
     */
    public HtmlPage clickSite(String siteName) {
        checkNotNull(siteName);
        List<WebElement> eventLinks = getSitesDetailsElem();
        for (WebElement eventLink : eventLinks) {
            String linkText = eventLink.getText();
            if (linkText.equalsIgnoreCase(siteName)) {
                eventLink.click();
                return getCurrentPage();
            }
        }
        throw new PageOperationException("Site '" + siteName + "' was not found!");
    }

}