net.sf.djdoc.action
Class ItemListAction

java.lang.Object
  net.sf.djdoc.action.ItemListAction

All Implemented Interfaces:

Action

public class ItemListAction
extends java.lang.Object
implements Action

The ItemListAction class combines three functionalities:

1. Its main purpose is to store the last accessed API and the last accessed package in the user session (which causes the list of classes and interfaces of that package to be cached in the session).
2. If an item hyperlink has been clicked, it registers that hit in both the cached and the persistent item lists.
3. If the user's view preference has changed (by expanding or collapsing one of the three item lists), the action registers that change in both the transient and the persistent user preference settings.

Constructor Summary

ItemListAction()

Method Summary

java.lang.Object	perform(DjdocRequest req) This method stores the names of the the currently accessed API and the currently accessed package in the user session (which causes the list of items of that package to be cached in the session).
void	sendResponse(DjdocRequest req, javax.servlet.http.HttpServletResponse res) This method simply redirects the response to the "listItems.jsp" page which displays (up to) three lists of items of the currently accessed package on the package-frame page.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemListAction

public ItemListAction()

Method Detail

perform

public java.lang.Object perform(DjdocRequest req)

This method stores the names of the the currently accessed API and the currently accessed package in the user session (which causes the list of items of that package to be cached in the session). It also registers "item hits" (clicks on one of the item hyperlinks) and "view preference changes" (clicks on one of the collapse/expand buttons) on the package-frame page.

Specified by:

perform in interface Action

Parameters:

req - The wrapper around the HTTP request

Returns:

null

sendResponse

public void sendResponse(DjdocRequest req,
                         javax.servlet.http.HttpServletResponse res)
                  throws java.io.IOException

This method simply redirects the response to the "listItems.jsp" page which displays (up to) three lists of items of the currently accessed package on the package-frame page.

Specified by:

sendResponse in interface Action

Parameters:

req - The wrapper around the HTTP request

res - The HTTP response connected to the server call

Throws:

java.io.IOException