org.sakaiproject.tool.admin
Class PresenceToolAction

java.lang.Object
  extended byjavax.servlet.GenericServlet
      extended byjavax.servlet.http.HttpServlet
          extended byorg.sakaiproject.vm.ComponentServlet
              extended byorg.sakaiproject.vm.VmServlet
                  extended byorg.sakaiproject.cheftool.VmServlet
                      extended byorg.sakaiproject.cheftool.ToolServlet
                          extended byorg.sakaiproject.cheftool.VelocityPortletPaneledAction
                              extended byorg.sakaiproject.tool.admin.PresenceToolAction
All Implemented Interfaces:
Serializable, Servlet, ServletConfig

public class PresenceToolAction
extends VelocityPortletPaneledAction

PresenceToolAction is the CHEF presence display tool showing everyone everywhere.

Version:
$Revision: 4742 $
Author:
University of Michigan, CHEF Software Development Team
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
VelocityPortletPaneledAction.MyLogger
 
Field Summary
protected static String MODE_LOCATIONS
           
protected static String MODE_SERVERS
           
protected static String MODE_SESSIONS
           
protected static String STATE_DISPLAY_MODE
          The display modes.
 
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, LAYOUT_MAIN, Log, MODE_OPTIONS, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MESSAGE, STATE_MODE, STATE_OBSERVER, STATE_OBSERVER2, STATE_PRESENCE_OBSERVER, STATE_TOOL
 
Fields inherited from class org.sakaiproject.cheftool.ToolServlet
ALERT_ATTR, ALERT_STATE_INITED, 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
PresenceToolAction()
           
 
Method Summary
 String buildMainPanelContext(VelocityPortlet portlet, Context context, RunData rundata, SessionState state)
          build the context for the Main (List) panel
 void doAuto(RunData data, Context context)
          Toggle auto-update
 void doLocations(RunData data, Context context)
          Switch to locations mode
 void doRefresh(RunData data, Context context)
          The action for when the user want's an update
 void doServers(RunData data, Context context)
          Switch to servers mode
 void doSessions(RunData data, Context context)
          Switch to sessions mode
protected  void initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
          Populate the state object, if needed.
 
Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction
actionDispatch, addAlert, addOptionsMenu, cancelOptions, clientWindowId, disableObservers, doGet, doOptions, doReset, enableObservers, getContext, helperActionDispatch, initState, justDelivered, mainPanelUpdateId, processAction, resetTool, saveOptions, scheduleFocusRefresh, schedulePeerFrameRefresh, scheduleTopRefresh, setVmCourier, setVmStdRef, titlePanelUpdateId, toolModeDispatch, updateState
 
Methods inherited from class org.sakaiproject.cheftool.ToolServlet
doPost, getAlert, getAlert, getMenu, getPid, getState, getToolMode, prepState, setToolMode
 
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

STATE_DISPLAY_MODE

protected static final String STATE_DISPLAY_MODE
The display modes.

See Also:
Constant Field Values

MODE_LOCATIONS

protected static final String MODE_LOCATIONS
See Also:
Constant Field Values

MODE_SESSIONS

protected static final String MODE_SESSIONS
See Also:
Constant Field Values

MODE_SERVERS

protected static final String MODE_SERVERS
See Also:
Constant Field Values
Constructor Detail

PresenceToolAction

public PresenceToolAction()
Method Detail

initState

protected void initState(SessionState state,
                         VelocityPortlet portlet,
                         JetspeedRunData rundata)
Populate the state object, if needed.

Overrides:
initState in class VelocityPortletPaneledAction

buildMainPanelContext

public String buildMainPanelContext(VelocityPortlet portlet,
                                    Context context,
                                    RunData rundata,
                                    SessionState state)
build the context for the Main (List) panel

Returns:
(optional) template name for this panel

doLocations

public void doLocations(RunData data,
                        Context context)
Switch to locations mode


doSessions

public void doSessions(RunData data,
                       Context context)
Switch to sessions mode


doServers

public void doServers(RunData data,
                      Context context)
Switch to servers mode


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