content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library 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 2.1 of the License, or (at your option) any later version.
   *
   * This library 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.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.workplace.list;
  
  /**
   * Class for storing the state of a list.<p>
   *
   * A list state includes:<br>
   * <ul>
   * <li>The current sorted Column</li>
   * <li>The sorted column Order</li>
   * <li>The current displayed Page</li>
   * <li>The current search Filter</li>
   * </ul>
   * <p>
   *
   * @since 6.0.0
   */
  public class CmsListState {
  
      /** Current sorted column. */
      private String m_column;
      /** Current search filter. */
      private String m_filter;
      /** Current sort order. */
      private CmsListOrderEnum m_order;
      /** Current visible page. */
      private int m_page;
  
      /**
       * Empty constructor, with default values.<p>
       */
      public CmsListState() {
  
          m_page = 1;
          m_order = CmsListOrderEnum.ORDER_ASCENDING;
          m_filter = "";
          m_column = "";
      }
  
      /**
       * Default Constructor.<p>
       *
       * @param list the list to read the state from
       */
      public CmsListState(CmsHtmlList list) {
  
          m_column = list.getSortedColumn();
          m_filter = list.getSearchFilter();
          m_page = list.getCurrentPage();
          m_order = list.getCurrentSortOrder();
      }
  
      /**
       * Returns the column.<p>
       *
       * @return the column
       */
      public String getColumn() {
  
          return m_column;
      }
  
      /**
       * Returns the filter.<p>
       *
       * @return the filter
       */
      public String getFilter() {
  
          return m_filter;
      }
  
      /**
       * Returns the order.<p>
       *
       * @return the order
       */
      public CmsListOrderEnum getOrder() {
  
          return m_order;
      }
  
      /**
       * Returns the page.<p>
       *
       * @return the page
       */
      public int getPage() {
  
          return m_page;
      }
  
      /**
       * Sets the column.<p>
       *
       * @param column the column to set
       */
      public void setColumn(String column) {
  
          m_column = column;
      }
  
      /**
       * Sets the filter.<p>
       *
       * @param filter the filter to set
       */
      public void setFilter(String filter) {
  
          m_filter = filter;
      }
  
      /**
       * Sets the order.<p>
       *
       * @param order the order to set
       */
      public void setOrder(CmsListOrderEnum order) {
  
          m_order = order;
      }
  
      /**
       * Sets the page.<p>
       *
       * @param page the page to set
       */
      public void setPage(int page) {
  
          m_page = page;
      }
  }
  