alfresco-content-app/e2e/components/pagination/pagination.ts

/*!
 * @license
 * Alfresco Example Content Application
 *
 * Copyright (C) 2005 - 2020 Alfresco Software Limited
 *
 * This file is part of the Alfresco Example Content Application.
 * 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:
 *
 * The Alfresco Example Content Application 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.
 *
 * The Alfresco Example Content Application 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/>.
 */

import { ElementFinder, by, browser, ExpectedConditions as EC } from 'protractor';
import { Logger } from '@alfresco/adf-testing';
import { BROWSER_WAIT_TIMEOUT } from '../../configs';
import { Menu } from '../menu/menu';
import { Component } from '../component';

export class Pagination extends Component {
  private static selectors = {
    root: 'adf-pagination',
    range: '.adf-pagination__range',
    maxItems: '.adf-pagination__max-items',
    currentPage: '.adf-pagination__current-page',
    totalPages: '.adf-pagination__total-pages',

    previousButton: '.adf-pagination__previous-button',
    nextButton: '.adf-pagination__next-button',
    maxItemsButton: '.adf-pagination__max-items + button[mat-icon-button]',
    pagesButton: '.adf-pagination__current-page + button[mat-icon-button]'
  };

  range: ElementFinder = this.component.element(by.css(Pagination.selectors.range));
  maxItems: ElementFinder = this.component.element(by.css(Pagination.selectors.maxItems));
  currentPage: ElementFinder = this.component.element(by.css(Pagination.selectors.currentPage));
  totalPages: ElementFinder = this.component.element(by.css(Pagination.selectors.totalPages));
  previousButton: ElementFinder = this.component.element(by.css(Pagination.selectors.previousButton));
  nextButton: ElementFinder = this.component.element(by.css(Pagination.selectors.nextButton));
  maxItemsButton: ElementFinder = this.component.element(by.css(Pagination.selectors.maxItemsButton));
  pagesButton: ElementFinder = this.component.element(by.css(Pagination.selectors.pagesButton));

  menu: Menu = new Menu();

  constructor(ancestor?: string) {
    super(Pagination.selectors.root, ancestor);
  }

  async openMaxItemsMenu() {
    const { menu, maxItemsButton } = this;

    try {
      await browser.wait(EC.elementToBeClickable(maxItemsButton), BROWSER_WAIT_TIMEOUT, 'timeout waiting for maxItemsButton to be clickable');
      await maxItemsButton.click();
      await menu.waitForMenuToOpen();
    } catch (error) {
      Logger.error('____ open max items catch ___', error);
    }
  }

  async openCurrentPageMenu() {
    const { menu, pagesButton } = this;

    try {
      await browser.wait(EC.elementToBeClickable(pagesButton), BROWSER_WAIT_TIMEOUT, 'timeout waiting for pagesButton to be clickable');
      await pagesButton.click();
      await menu.waitForMenuToOpen();
    } catch (error) {
      Logger.error('____ open current page menu ___', error);
    }
  }

  async resetToDefaultPageSize() {
    try {
      await this.openMaxItemsMenu();
      await this.menu.clickNthItem(1);
      await this.menu.waitForMenuToClose();
    } catch (error) {
      Logger.error('___ reset to default page size catch ___', error);
    }
  }

  async resetToDefaultPageNumber() {
    try {
      await this.openCurrentPageMenu();
      await this.menu.clickNthItem(1);
      await this.menu.waitForMenuToClose();
    } catch (error) {
      Logger.error('____ reset to default page number catch ___', error);
    }
  }

  async clickNext() {
    await this.nextButton.click();
  }

  async clickPrevious() {
    await this.previousButton.click();
  }

  async isNextEnabled() {
    return this.nextButton.isEnabled();
  }

  async isPreviousEnabled() {
    return this.previousButton.isEnabled();
  }

  async isPagesButtonPresent() {
    return browser.isElementPresent(this.pagesButton);
  }

  async isRangePresent() {
    return this.range.isPresent();
  }

  async isMaxItemsPresent() {
    return this.maxItems.isPresent();
  }

  async isCurrentPagePresent() {
    return this.currentPage.isPresent();
  }

  async isTotalPagesPresent() {
    return this.totalPages.isPresent();
  }

  async isPreviousButtonPresent() {
    return this.previousButton.isPresent();
  }

  async isNextButtonPresent() {
    return this.nextButton.isPresent();
  }

  async getCurrentPage() {
    return this.currentPage.getText();
  }

  async getRange() {
    return this.range.getText();
  }

  async getMaxItems() {
    return this.maxItems.getText();
  }

  async getTotalPages() {
    return this.totalPages.getText();
  }
}