| org.sakaiproject.vm.VmServlet
 org.sakaiproject.cheftool.VmServlet
org.sakaiproject.cheftool.ToolServlet
org.sakaiproject.cheftool.VelocityPortletPaneledAction
org.sakaiproject.cheftool.PagedResourceAction
| PagedResourceAction | | abstract public class PagedResourceAction extends VelocityPortletPaneledAction (Code) | |
PagedResourceAction is a base class that handles paged display of lists of Resourecs.
|
| Method Summary | |
| 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 | addViewPagingMenus(Menu bar, SessionState state)
Add the menus for a view mode for paging. | | public void | doAuto(RunData data, Context context)
| | public void | doList_first(RunData runData, Context context)
Handle a first-message page (list) request. | | public void | doList_last(RunData runData, Context context)
Handle a last-message page (list) request. | | public void | doList_next(RunData runData, Context context)
Handle a next-page (list) request. | | public void | doList_prev(RunData runData, Context context)
Handle a prev-page (list) request. | | public void | doRefresh(RunData data, Context context)
| | public void | doSearch(RunData runData, Context context)
Handle a Search request. | | public void | doSearch_clear(RunData runData, Context context)
Handle a Search Clear request. | | public void | doView_next(RunData runData, Context context)
Handle a next-message (view) request. | | public void | doView_prev(RunData runData, Context context)
Handle a prev-message (view) request. | | public void | enableObserver(SessionState state)
Enable the observer, unless we are in search mode, where we want it disabled. | | protected int | findResourceInList(List resources, String id)
Find the resource with this id in the list.
Parameters:
messages - The list of messages.
Parameters:
id - The message id. | | protected void | initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
| | protected List | prepPage(SessionState state)
Prepare the current page of messages to display. | | abstract protected List | readAllResources(SessionState state)
Implement this to return alist of all the resources that there are to page. | | protected void | resetPaging(SessionState state)
|
| DEFAULT_PAGE_SIZE | | final protected static int DEFAULT_PAGE_SIZE(Code) | | The default number of messages per page.
|
| FORM_SEARCH | | final protected static String FORM_SEARCH(Code) | | Form fields.
|
| PARAM_PAGESIZE | | final protected static String PARAM_PAGESIZE(Code) | | portlet configuration parameter names.
|
| STATE_GO_FIRST_PAGE | | final protected static String STATE_GO_FIRST_PAGE(Code) | | |
| STATE_GO_LAST_PAGE | | final protected static String STATE_GO_LAST_PAGE(Code) | | |
| STATE_GO_NEXT | | final protected static String STATE_GO_NEXT(Code) | | |
| STATE_GO_NEXT_PAGE | | final protected static String STATE_GO_NEXT_PAGE(Code) | | |
| STATE_GO_PREV | | final protected static String STATE_GO_PREV(Code) | | |
| STATE_GO_PREV_PAGE | | final protected static String STATE_GO_PREV_PAGE(Code) | | |
| STATE_MANUAL_REFRESH | | final protected static String STATE_MANUAL_REFRESH(Code) | | |
| STATE_NEXT_EXISTS | | final protected static String STATE_NEXT_EXISTS(Code) | | |
| STATE_NEXT_PAGE_EXISTS | | final protected static String STATE_NEXT_PAGE_EXISTS(Code) | | |
| STATE_NUM_MESSAGES | | final protected static String STATE_NUM_MESSAGES(Code) | | |
| STATE_PAGESIZE | | final protected static String STATE_PAGESIZE(Code) | | |
| STATE_PREV_EXISTS | | final protected static String STATE_PREV_EXISTS(Code) | | |
| STATE_PREV_PAGE_EXISTS | | final protected static String STATE_PREV_PAGE_EXISTS(Code) | | |
| STATE_SEARCH | | final protected static String STATE_SEARCH(Code) | | |
| STATE_TOP_PAGE_MESSAGE | | final protected static String STATE_TOP_PAGE_MESSAGE(Code) | | |
| STATE_VIEW_ID | | final protected static String STATE_VIEW_ID(Code) | | state attribute names.
|
| addListPagingMenus | | protected void addListPagingMenus(Menu bar, SessionState state)(Code) | | Add the menus for a list mode for paging.
|
| addRefreshMenus | | protected void addRefreshMenus(Menu bar, SessionState state)(Code) | | Add the menus for manual / auto - refresh.
|
| addViewPagingMenus | | protected void addViewPagingMenus(Menu bar, SessionState state)(Code) | | Add the menus for a view mode for paging.
|
| doList_first | | public void doList_first(RunData runData, Context context)(Code) | | Handle a first-message page (list) request.
|
| doList_last | | public void doList_last(RunData runData, Context context)(Code) | | Handle a last-message page (list) request.
|
| doList_next | | public void doList_next(RunData runData, Context context)(Code) | | Handle a next-page (list) request.
|
| doList_prev | | public void doList_prev(RunData runData, Context context)(Code) | | Handle a prev-page (list) request.
|
| doRefresh | | public void doRefresh(RunData data, Context context)(Code) | | The action for when the user want's an update
|
| doSearch_clear | | public void doSearch_clear(RunData runData, Context context)(Code) | | Handle a Search Clear request.
|
| doView_next | | public void doView_next(RunData runData, Context context)(Code) | | Handle a next-message (view) request.
|
| doView_prev | | public void doView_prev(RunData runData, Context context)(Code) | | Handle a prev-message (view) request.
|
| enableObserver | | public void enableObserver(SessionState state)(Code) | | Enable the observer, unless we are in search mode, where we want it disabled.
|
| findResourceInList | | protected int findResourceInList(List resources, String id)(Code) | | Find the resource with this id in the list.
Parameters:
messages - The list of messages.
Parameters:
id - The message id. The index position in the list of the message with this id, or -1 if not found. |
| prepPage | | protected List prepPage(SessionState state)(Code) | | Prepare the current page of messages to display.
List of MailArchiveMessage to display on this page. |
| readAllResources | | abstract protected List readAllResources(SessionState state)(Code) | | Implement this to return alist of all the resources that there are to page. Sort them as appropriate, and apply search criteria.
|
| Methods inherited from org.sakaiproject.cheftool.VelocityPortletPaneledAction | protected void actionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
public static void addAlert(SessionState state, String message)(Code)(Java Doc)
protected void addOptionsMenu(Menu bar, JetspeedRunData data)(Code)(Java Doc)
protected boolean allowedToOptions()(Code)(Java Doc)
protected void cancelOptions()(Code)(Java Doc)
protected String clientWindowId(SessionState state, String toolId)(Code)(Java Doc)
public static void disableObservers(SessionState state)(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException(Code)(Java Doc)
public void doOptions(RunData runData, Context context)(Code)(Java Doc)
public void doReset(RunData runData, Context context)(Code)(Java Doc)
public static void enableObservers(SessionState state)(Code)(Java Doc)
protected Map getContext(RunData data)(Code)(Java Doc)
protected void helperActionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res, String className)(Code)(Java Doc)
protected void initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)(Code)(Java Doc)
protected void initState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
public static void justDelivered(SessionState state)(Code)(Java Doc)
public static String mainPanelUpdateId(String toolId)(Code)(Java Doc)
protected String panelMethodName(String panel)(Code)(Java Doc)
public void processAction(HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void resetTool(SessionState state)(Code)(Java Doc)
protected void saveOptions()(Code)(Java Doc)
protected void scheduleFocusRefresh(String[] path)(Code)(Java Doc)
protected void schedulePeerFrameRefresh(String id)(Code)(Java Doc)
protected void scheduleTopRefresh()(Code)(Java Doc)
protected void setVmCourier(HttpServletRequest request, int refresh)(Code)(Java Doc)
protected void setVmStdRef(HttpServletRequest request, HttpServletResponse response)(Code)(Java Doc)
public static String titlePanelUpdateId(String toolId)(Code)(Java Doc)
protected void toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res) throws ToolException(Code)(Java Doc)
protected void updateState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
|
| Methods inherited from org.sakaiproject.cheftool.ToolServlet | protected void actionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException(Code)(Java Doc)
protected void doPost(HttpServletRequest req, HttpServletResponse res) throws ServletException(Code)(Java Doc)
protected Alert getAlert(HttpServletRequest req)(Code)(Java Doc)
protected Alert getAlert(SessionState state)(Code)(Java Doc)
protected Menu getMenu(HttpServletRequest req)(Code)(Java Doc)
protected String getPid(HttpServletRequest req)(Code)(Java Doc)
protected SessionState getState(HttpServletRequest req)(Code)(Java Doc)
protected String getToolMode(HttpServletRequest req)(Code)(Java Doc)
protected void initState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void prepState(HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected void processAction(HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
protected boolean sendToHelper(HttpServletRequest req, HttpServletResponse res, String target) throws ToolException(Code)(Java Doc)
protected void setToolMode(String toolMode, HttpServletRequest req)(Code)(Java Doc)
protected void setVmStdRef(HttpServletRequest request, HttpServletResponse response)(Code)(Java Doc)
protected void startHelper(HttpServletRequest req, String helperId, String panel)(Code)(Java Doc)
protected void startHelper(HttpServletRequest req, String helperId)(Code)(Java Doc)
protected void toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res) throws ToolException(Code)(Java Doc)
protected void updateState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code)(Java Doc)
|
|
|