Package org.sakaiproject.cheftool

Class PagedResourceActionII

  • All Implemented Interfaces:
    Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    public abstract class PagedResourceActionII
extends VelocityPortletPaneledAction

    PagedResourceAction is a base class that handles paged display of lists of Resourecs with service support for paging.

    See Also:
    Serialized Form

    • Constructor Detail

      • PagedResourceActionII

        public PagedResourceActionII()

    • Method Detail

      • readResourcesPage

        protected abstract List readResourcesPage​(org.sakaiproject.event.api.SessionState state,
                                          int first,
                                          int last)
        Implement this to return a list of all the resources in this record range, with search and sorting applied.
        Parameters:
        first - The first record to include (1 based).
        last - The last record to include (inclusive, 1 based).

      • sizeResources

        protected abstract int sizeResources​(org.sakaiproject.event.api.SessionState state)
        Implement this to return the number of records that are currently selected.

      • totalPageNumber

        protected int totalPageNumber​(org.sakaiproject.event.api.SessionState state)
        Return the total page number

      • addViewPagingMenus

        protected void addViewPagingMenus​(org.sakaiproject.cheftool.api.Menu bar,
                                  org.sakaiproject.event.api.SessionState state)
        Add the menus for a view mode for paging.

      • addListPagingMenus

        protected void addListPagingMenus​(org.sakaiproject.cheftool.api.Menu bar,
                                  org.sakaiproject.event.api.SessionState state)
        Add the menus for a list mode for paging.

      • addSearchMenus

        protected void addSearchMenus​(org.sakaiproject.cheftool.api.Menu bar,
                              org.sakaiproject.event.api.SessionState state)
        Add the menus for search.

      • addSearchMenus

        protected void addSearchMenus​(org.sakaiproject.cheftool.api.Menu bar,
                              org.sakaiproject.event.api.SessionState state,
                              String accessibilityLabel)
        Add the menus for search, including accessibility title

      • prepPage

        protected List prepPage​(org.sakaiproject.event.api.SessionState state)
        Prepare the current page of messages to display.
        Returns:
        List of MailArchiveMessage to display on this page.

      • doChange_pagesize

        public void doChange_pagesize​(RunData data,
                              Context context)
        Handle a request to change the page size of search list.

      • pagingInfoToContext

        public void pagingInfoToContext​(org.sakaiproject.event.api.SessionState state,
                                Context context)

      • cleanStatePaging

        public void cleanStatePaging​(org.sakaiproject.event.api.SessionState state)
        Clean up all state value for paging.

      • doView_page

        public void doView_page​(RunData runData,
                        Context context)
        Handle a view indecated page request

      • doView_next

        public void doView_next​(RunData runData,
                        Context context)
        Handle a next-message (view) request.

      • doList_first

        public void doList_first​(RunData runData,
                         Context context)
        Handle a first-message page (list) request.

      • doList_last

        public void doList_last​(RunData runData,
                        Context context)
        Handle a last-message page (list) request.

      • doList_next

        public void doList_next​(RunData runData,
                        Context context)
        Handle a next-page (list) request.

      • doView_prev

        public void doView_prev​(RunData runData,
                        Context context)
        Handle a prev-message (view) request.

      • doList_prev

        public void doList_prev​(RunData runData,
                        Context context)
        Handle a prev-page (list) request.

      • doSearch

        public void doSearch​(RunData runData,
                     Context context)
        Handle a Search request.

      • doSearch_clear

        public void doSearch_clear​(RunData runData,
                           Context context)
        Handle a Search Clear request.

      • resetPaging

        protected void resetPaging​(org.sakaiproject.event.api.SessionState state)
        Reset to the first page