org.sakaiproject.cheftool

Class PagedResourceActionII

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.sakaiproject.vm.ComponentServlet

org.sakaiproject.vm.VmServlet

org.sakaiproject.cheftool.VmServlet

org.sakaiproject.cheftool.ToolServlet

org.sakaiproject.cheftool.VelocityPortletPaneledAction

org.sakaiproject.cheftool.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

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_PAGE_SIZE The default number of messages per page.
protected static String	FORM_PAGE_NUMBER
protected static String	FORM_SEARCH Form fields.
protected static int[]	PAGESIZES
protected static String	PARAM_PAGESIZE portlet configuration parameter names.
protected static ResourceLoader	rb_praII
protected static String	STATE_CURRENT_PAGE
protected static String	STATE_FIRST_PAGE_EXISTS
protected static String	STATE_GO_FIRST_PAGE
protected static String	STATE_GO_LAST_PAGE
protected static String	STATE_GO_NEXT
protected static String	STATE_GO_NEXT_PAGE
protected static String	STATE_GO_PREV
protected static String	STATE_GO_PREV_PAGE
protected static String	STATE_GOTO_PAGE
protected static String	STATE_LAST_PAGE_EXISTS
protected static String	STATE_MANUAL_REFRESH
protected static String	STATE_NEXT_EXISTS
protected static String	STATE_NEXT_PAGE_EXISTS
protected static String	STATE_NUM_MESSAGES
protected static String	STATE_PAGESIZE
protected static String	STATE_PREV_EXISTS
protected static String	STATE_PREV_PAGE_EXISTS
protected static String	STATE_SEARCH
protected static String	STATE_TOP_PAGE_MESSAGE
protected static String	STATE_TOTAL_PAGENUMBER
protected static String	STATE_VIEW_ID state attribute names.

Fields inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

ATTR_CONFIG, ATTR_CONTEXT, ATTR_FRAME_FOCUS, ATTR_FRAME_REFRESH, ATTR_PORTLET, ATTR_RUNDATA, ATTR_TOP_REFRESH, BUTTON, CONTEXT_SITE_COLLECTION_ID, CONTEXT_SITE_COLLECTION_URL, HELPER_LINK_MODE, HELPER_MODE_DONE, LAYOUT_MAIN, MODE_OPTIONS, SAKAI_CSRF_TOKEN, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MESSAGE, STATE_MODE, STATE_NEW_PANEL, STATE_NOTIF, STATE_OBSERVER, STATE_OBSERVER2, STATE_PRESENCE_OBSERVER, STATE_TOOL

Fields inherited from class org.sakaiproject.cheftool.ToolServlet

ALERT_ATTR, ALERT_STATE_INITED, HELPER_ID, MAIN_PANEL, MENU_ATTR, PARAM_ACTION, PARAM_ACTION_COMBO, TITLE_PANEL, TOOL_MODE_ATTR, TOOL_MODE_DEFAULT

Fields inherited from class org.sakaiproject.cheftool.VmServlet

m_validator

Fields inherited from class org.sakaiproject.vm.ComponentServlet

ATTR_PARAMS

Constructor Summary

Constructors

Constructor and Description
PagedResourceActionII()

Method Summary

Modifier and Type	Method and Description
protected void	addListPagingMenus(Menu bar, SessionState state) Add the menus for a list mode for paging.
protected void	addRefreshMenus(Menu bar, SessionState state) Add the menus for manual / auto - refresh.
protected void	addSearchMenus(Menu bar, SessionState state) Add the menus for search.
protected void	addSearchMenus(Menu bar, SessionState state, String accessibilityLabel) Add the menus for search, including accessibility title
protected void	addViewPagingMenus(Menu bar, SessionState state) Add the menus for a view mode for paging.
void	cleanStatePaging(SessionState state) Clean up all state value for paging.
void	doAuto(RunData data, Context context) Toggle auto-update
void	doChange_pagesize(RunData data, Context context) Handle a request to change the page size of search list.
void	doList_first(RunData runData, Context context) Handle a first-message page (list) request.
void	doList_last(RunData runData, Context context) Handle a last-message page (list) request.
void	doList_next(RunData runData, Context context) Handle a next-page (list) request.
void	doList_prev(RunData runData, Context context) Handle a prev-page (list) request.
void	doRefresh(RunData data, Context context) The action for when the user want's an update
void	doSearch_clear(RunData runData, Context context) Handle a Search Clear request.
void	doSearch(RunData runData, Context context) Handle a Search request.
void	doView_next(RunData runData, Context context) Handle a next-message (view) request.
void	doView_page(RunData runData, Context context) Handle a view indecated page request
void	doView_prev(RunData runData, Context context) Handle a prev-message (view) request.
void	enableObserver(SessionState state) Enable the observer, unless we are in search mode, where we want it disabled.
protected void	initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata) Populate the state object, if needed, concerning paging
void	pagingInfoToContext(SessionState state, Context context)
protected List	prepPage(SessionState state) Prepare the current page of messages to display.
protected abstract List	readResourcesPage(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.
protected void	resetPaging(SessionState state) Reset to the first page
protected abstract int	sizeResources(SessionState state) Implement this to return the number of records that are currently selected.
protected int	totalPageNumber(SessionState state) Return the total page number

Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

actionDispatch, addAlert, addFlashNotif, addOptionsMenu, allowedToOptions, cancelOptions, checkCSRFToken, checkRunData, clientWindowId, disableObservers, doGet, doOptions, doReset, enableObservers, getContext, getDateFormatString, getTimeFormatString, helperActionDispatch, initState, justDelivered, mainPanelUpdateId, panelMethodName, processAction, resetTool, saveOptions, scheduleFocusRefresh, schedulePeerFrameRefresh, scheduleTopRefresh, setVmCourier, setVmStdRef, switchPanel, titlePanelUpdateId, toolModeDispatch, updateState

Methods inherited from class org.sakaiproject.cheftool.ToolServlet

doPost, getAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, sendToHelper, setToolMode, startHelper, startHelper

Methods inherited from class org.sakaiproject.vm.VmServlet

getActionURL, getVmReference, includeVm, setVmReference

Methods inherited from class org.sakaiproject.vm.ComponentServlet

sendParentRedirect, service, setNoCacheHeaders

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

rb_praII

protected static ResourceLoader rb_praII

DEFAULT_PAGE_SIZE

protected static final int DEFAULT_PAGE_SIZE

The default number of messages per page.

See Also:

Constant Field Values

PARAM_PAGESIZE

protected static final String PARAM_PAGESIZE

portlet configuration parameter names.

See Also:

Constant Field Values

STATE_VIEW_ID

protected static final String STATE_VIEW_ID

state attribute names.

See Also:

Constant Field Values

STATE_TOP_PAGE_MESSAGE

protected static final String STATE_TOP_PAGE_MESSAGE

See Also:

Constant Field Values

STATE_PAGESIZE

protected static final String STATE_PAGESIZE

See Also:

Constant Field Values

STATE_NUM_MESSAGES

protected static final String STATE_NUM_MESSAGES

See Also:

Constant Field Values

STATE_NEXT_PAGE_EXISTS

protected static final String STATE_NEXT_PAGE_EXISTS

See Also:

Constant Field Values

STATE_PREV_PAGE_EXISTS

protected static final String STATE_PREV_PAGE_EXISTS

See Also:

Constant Field Values

STATE_FIRST_PAGE_EXISTS

protected static final String STATE_FIRST_PAGE_EXISTS

See Also:

Constant Field Values

STATE_LAST_PAGE_EXISTS

protected static final String STATE_LAST_PAGE_EXISTS

See Also:

Constant Field Values

STATE_GO_NEXT_PAGE

protected static final String STATE_GO_NEXT_PAGE

See Also:

Constant Field Values

STATE_GO_PREV_PAGE

protected static final String STATE_GO_PREV_PAGE

See Also:

Constant Field Values

STATE_GO_NEXT

protected static final String STATE_GO_NEXT

See Also:

Constant Field Values

STATE_GO_PREV

protected static final String STATE_GO_PREV

See Also:

Constant Field Values

STATE_NEXT_EXISTS

protected static final String STATE_NEXT_EXISTS

See Also:

Constant Field Values

STATE_PREV_EXISTS

protected static final String STATE_PREV_EXISTS

See Also:

Constant Field Values

STATE_GO_FIRST_PAGE

protected static final String STATE_GO_FIRST_PAGE

See Also:

Constant Field Values

STATE_GO_LAST_PAGE

protected static final String STATE_GO_LAST_PAGE

See Also:

Constant Field Values

STATE_SEARCH

protected static final String STATE_SEARCH

See Also:

Constant Field Values

STATE_MANUAL_REFRESH

protected static final String STATE_MANUAL_REFRESH

See Also:

Constant Field Values

FORM_SEARCH

protected static final String FORM_SEARCH

Form fields.

See Also:

Constant Field Values

STATE_TOTAL_PAGENUMBER

protected static final String STATE_TOTAL_PAGENUMBER

See Also:

Constant Field Values

STATE_CURRENT_PAGE

protected static final String STATE_CURRENT_PAGE

See Also:

Constant Field Values

FORM_PAGE_NUMBER

protected static final String FORM_PAGE_NUMBER

See Also:

Constant Field Values

STATE_GOTO_PAGE

protected static final String STATE_GOTO_PAGE

See Also:

Constant Field Values

PAGESIZES

protected static final int[] PAGESIZES

Constructor Detail

PagedResourceActionII

public PagedResourceActionII()

Method Detail

readResourcesPage

protected abstract List readResourcesPage(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(SessionState state)

Implement this to return the number of records that are currently selected.

totalPageNumber

protected int totalPageNumber(SessionState state)

Return the total page number

initState

protected void initState(SessionState state,
                         VelocityPortlet portlet,
                         JetspeedRunData rundata)

Populate the state object, if needed, concerning paging

Overrides:

initState in class VelocityPortletPaneledAction

addViewPagingMenus

protected void addViewPagingMenus(Menu bar,
                                  SessionState state)

Add the menus for a view mode for paging.

addListPagingMenus

protected void addListPagingMenus(Menu bar,
                                  SessionState state)

Add the menus for a list mode for paging.

addSearchMenus

protected void addSearchMenus(Menu bar,
                              SessionState state)

Add the menus for search.

addSearchMenus

protected void addSearchMenus(Menu bar,
                              SessionState state,
                              String accessibilityLabel)

Add the menus for search, including accessibility title

addRefreshMenus

protected void addRefreshMenus(Menu bar,
                               SessionState state)

Add the menus for manual / auto - refresh.

prepPage

protected List prepPage(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(SessionState state,
                                Context context)

cleanStatePaging

public void cleanStatePaging(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(SessionState state)

Reset to the first page

doAuto

public void doAuto(RunData data,
                   Context context)

Toggle auto-update

doRefresh

public void doRefresh(RunData data,
                      Context context)

The action for when the user want's an update

enableObserver

public void enableObserver(SessionState state)

Enable the observer, unless we are in search mode, where we want it disabled.