Interface IExtendedTable

All Known Implementing Classes:
AsyncCategorizedTable, AsyncIterator, AsyncList, AsyncListbox, AsyncSearchResultTable, AsyncSearchResultTree, AsyncTable, AsyncTabsList, AsyncTree, Breadcrumbs, CalendarTable, CategorizedTable, Chart, DataList, DataTable, DataTree, FirstLevelList, GMarkerGroup, GMarkerList, Iterator, Listbox, NavList, Newsfeed.NewsfeedTable, PopupMenus, SearchResultTable, SearchResultTree, SecondLevelList, StaticMenus.SubList, StaticMenus.SubSubList, TabsList, ThirdLevelList

public interface IExtendedTable
Extended data table interface.
  • Method Details

    • getSortInfo

      ISortInfo getSortInfo(boolean keysNotColumnIds)
      Current sort info. Never null.
      Parameters:
      keysNotColumnIds - True to report keys using column "sort" property, false to report keys using column ids.
    • getRowId

      String getRowId()
      Get unique identifier for the current row. If no current row, returns null.
    • setRowById

      void setRowById(String id)
      Set current row by id. If id doesn't identify a row, makes no row current (equivalent to setRowIndex(-1)).
    • getContentProvider

      ITableContentProvider getContentProvider()
      Retrieves table content provider. Note that interacting directly with the content provider instead of the table control may cause the table control to get out of sync with the content provider.
    • getCanTemplateRow

      boolean getCanTemplateRow()
      True if provider can be put into template row state.
      See Also:
    • isTemplateRow

      boolean isTemplateRow()
      Is provider in state where it returns properties for template pseudo-row. In this state, row index is -1 and row id is null. Setting the row index or id to any value removes provider from this state.
    • setTemplateRow

      void setTemplateRow()
      Sets provider to state where it returns properties for template pseudo-row. In this state, row index is -1 and row id is null. Setting the row index or id to any value removes provider from this state.
    • getRowsToCreate

      String[] getRowsToCreate()
      List of pseudo-ids (used for client-id in place of row index) of new rows to create, or null.
    • setRowsToCreate

      void setRowsToCreate(String[] create)
      List of pseudo-ids (used for client-id in place of row index) of new rows to create, or null.
    • getRowsToMove

      IExtendedTable.RowMovement[] getRowsToMove()
      List of ids to move by list of to move in front of. Null or empty string ("") signals move to end.
    • setRowsToMove

      void setRowsToMove(IExtendedTable.RowMovement[] move)
      List of ids to move by list of to move in front of. Null or empty string ("") signals move to end.
    • getRowsToDelete

      String[] getRowsToDelete()
      List of ids of rows to delete, or null.
    • setRowsToDelete

      void setRowsToDelete(String[] delete)
      List of ids of rows to delete, or null.
    • getRowsToUpdate

      String[] getRowsToUpdate()
      List of ids of rows to update, or null.
    • setRowsToUpdate

      void setRowsToUpdate(String[] update)
      List of ids of rows to update, or null.
    • convertOriginalToCreatedRowIds

      Collection<String> convertOriginalToCreatedRowIds(Collection<String> ids)
      Converts client-generated ids to the actual row ids (ie from "__new1234" to "myRowOne").
    • convertCreatedToOriginalRowIds

      Collection<String> convertCreatedToOriginalRowIds(Collection<String> ids)
      Converts actual row ids to the original client-generated ids (ie from "myRowOne" to "__new1234").
    • getFilter

      String getFilter()
      Filter expression. Only rows matched by this filter should be exposed. Null or empty ("") signals expose the default set of rows.
    • setFilter

      void setFilter(String filter)
      Filter expression. Only rows matched by this filter should be exposed. Null or empty ("") signals expose the default set of rows.
    • resetRowCaches

      void resetRowCaches()
      Clear out any cached information about the rows. Call if the content provider has changed.