Class SheetState

java.lang.Object
org.apache.myfaces.tobago.model.SheetState
All Implemented Interfaces:
Serializable, ScrollPositionState
public class SheetState extends Object implements Serializable, ScrollPositionState
See Also:

  • Constructor Details

    • SheetState

      @Deprecated(since="5.3.0", forRemoval=true) public SheetState()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use SheetState(1) instead

    • SheetState

      public SheetState(int maxSortColumns)
      Creates a sheet state with a maximum number of simultaneously sortable columns.

      The parameter maxSortColumns specifies how many columns are taken into account when sorting. Use a value >1 if multiple rows contain the same value. In this case, the value in the next sort-selected column is used for further sorting.

      Parameters:
      maxSortColumns - number of columns considered for sorting

  • Method Details

    • reset

      @Deprecated(since="5.3.0", forRemoval=true) public void reset()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use reset(1) instead

    • reset

      public void reset(int maxSortColumns)
      Reset the sheet state.
      Parameters:
      maxSortColumns - number of columns considered for sorting

    • resetSelected

      public void resetSelected()
      Reset selected rows.

    • getSelectedRows

      public List<Integer> getSelectedRows()
      Returns:
      list of selected row indexes

    • setSelectedRows

      public void setSelectedRows(List<Integer> selectedRows)
      Parameters:
      selectedRows - indexes of selected rows

    • getSortedColumnId

      @Deprecated(since="5.3.0", forRemoval=true) public String getSortedColumnId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use getSortedColumnList().get(...).getId()

    • setSortedColumnId

      @Deprecated(since="5.3.0", forRemoval=true) public void setSortedColumnId(String sortedColumnId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use getSortedColumnList().get(...).setId()

    • isAscending

      @Deprecated(since="5.3.0", forRemoval=true) public boolean isAscending()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use getSortedColumnList().get(...).isAscending()

    • setAscending

      @Deprecated(since="5.3.0", forRemoval=true) public void setAscending(boolean ascending)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use getSortedColumnList().get(...).setAscending()

    • getSortedColumnList

      public SortedColumnList getSortedColumnList()

    • getColumnWidths

      public List<Integer> getColumnWidths()

    • setColumnWidths

      public void setColumnWidths(List<Integer> columnWidths)

    • isDefinedColumnWidths

      public boolean isDefinedColumnWidths()

    • getFirst

      public int getFirst()
      Returns:
      index of the first visible row

    • setFirst

      public void setFirst(int first)
      Parameters:
      first - index of the first visible row

    • updateSortState

      @Deprecated(since="4.2.0", forRemoval=true) public void updateSortState(SortActionEvent sortEvent)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use updateSortState(String id)

    • updateSortState

      public void updateSortState(String columnId)

    • resetSortState

      public void resetSortState()

    • getScrollPosition

      public ScrollPosition getScrollPosition()
      Specified by:
      getScrollPosition in interface ScrollPositionState

    • setScrollPosition

      public void setScrollPosition(ScrollPosition scrollPosition)

    • getLazyScrollPosition

      public LazyScrollPosition getLazyScrollPosition()

    • setLazyScrollPosition

      public void setLazyScrollPosition(LazyScrollPosition lazyScrollPosition)

    • getExpandedState

      public ExpandedState getExpandedState()

    • setExpandedState

      public void setExpandedState(ExpandedState expandedState)

    • getSelectedState

      public SelectedState getSelectedState()

    • setSelectedState

      public void setSelectedState(SelectedState selectedState)

    • isToBeSorted

      @Deprecated(since="5.3.0", forRemoval=true) public boolean isToBeSorted()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use getToBeSortedLevel()

    • setToBeSorted

      @Deprecated(since="5.3.0", forRemoval=true) public void setToBeSorted(boolean toBeSorted)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Please use sorted()

    • getToBeSortedLevel

      public int getToBeSortedLevel()
      Returns:
      the number of levels (columns) which must be sorted this request

    • sorted

      public void sorted()
      Indicates that the sheet is sorted and a SortActionEvent is not executed in this request.