org.sakaiproject.news.tool

Class NewsAction

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.news.tool.NewsAction

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class NewsAction
extends org.sakaiproject.cheftool.VelocityPortletPaneledAction

NewsAction is the Sakai RSS news tool.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

org.sakaiproject.cheftool.VelocityPortletPaneledAction.MyLogger

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	FEED_ACCESS Basic feed access event.
protected static String	FEED_UPDATE Basic feed update event.
protected static String	PARAM_CHANNEL_URL portlet configuration parameter names.
protected static String	STATE_CHANNEL_URL
protected static String	STATE_DETECT_REGISTERED_EVENT

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, Log, MODE_OPTIONS, SAKAI_CSRF_TOKEN, STATE_ACTION, STATE_FLOAT, STATE_HELPER, STATE_MESSAGE, STATE_MODE, STATE_NEW_PANEL, 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
NewsAction()

Method Summary

Methods

Modifier and Type	Method and Description
String	buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state) build the context for the Main (Layout) panel
String	buildOptionsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.Context context, org.sakaiproject.cheftool.RunData rundata, org.sakaiproject.event.api.SessionState state) Setup for the options panel.
void	doCancel(org.sakaiproject.cheftool.RunData data, org.sakaiproject.cheftool.Context context) Handle a user clicking the "Done" button in the Options panel
void	doUpdate(org.sakaiproject.cheftool.RunData data, org.sakaiproject.cheftool.Context context) Handle a user clicking the "Done" button in the Options panel
protected String	getCurrentSitePageId() Get the current site page our current tool is placed on.
protected void	initState(org.sakaiproject.event.api.SessionState state, org.sakaiproject.cheftool.VelocityPortlet portlet, org.sakaiproject.cheftool.JetspeedRunData rundata) Populate the state object, if needed.

Methods inherited from class org.sakaiproject.cheftool.VelocityPortletPaneledAction

actionDispatch, addAlert, addOptionsMenu, allowedToOptions, cancelOptions, checkCSRFToken, 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

PARAM_CHANNEL_URL

protected static final String PARAM_CHANNEL_URL

portlet configuration parameter names.

See Also:

Constant Field Values

STATE_CHANNEL_URL

protected static final String STATE_CHANNEL_URL

See Also:

Constant Field Values

FEED_ACCESS

protected static final String FEED_ACCESS

Basic feed access event.

See Also:

Constant Field Values

FEED_UPDATE

protected static final String FEED_UPDATE

Basic feed update event.

See Also:

Constant Field Values

STATE_DETECT_REGISTERED_EVENT

protected static final String STATE_DETECT_REGISTERED_EVENT

See Also:

Constant Field Values

Constructor Detail

NewsAction

public NewsAction()

Method Detail

initState

protected void initState(org.sakaiproject.event.api.SessionState state,
             org.sakaiproject.cheftool.VelocityPortlet portlet,
             org.sakaiproject.cheftool.JetspeedRunData rundata)

Populate the state object, if needed.

Overrides:

initState in class org.sakaiproject.cheftool.VelocityPortletPaneledAction

buildMainPanelContext

public String buildMainPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                           org.sakaiproject.cheftool.Context context,
                           org.sakaiproject.cheftool.RunData rundata,
                           org.sakaiproject.event.api.SessionState state)

build the context for the Main (Layout) panel

Returns:

(optional) template name for this panel

buildOptionsPanelContext

public String buildOptionsPanelContext(org.sakaiproject.cheftool.VelocityPortlet portlet,
                              org.sakaiproject.cheftool.Context context,
                              org.sakaiproject.cheftool.RunData rundata,
                              org.sakaiproject.event.api.SessionState state)

Setup for the options panel.

doUpdate

public void doUpdate(org.sakaiproject.cheftool.RunData data,
            org.sakaiproject.cheftool.Context context)

Handle a user clicking the "Done" button in the Options panel

doCancel

public void doCancel(org.sakaiproject.cheftool.RunData data,
            org.sakaiproject.cheftool.Context context)

Handle a user clicking the "Done" button in the Options panel

getCurrentSitePageId

protected String getCurrentSitePageId()

Get the current site page our current tool is placed on.

Returns:

The site page id on which our tool is placed.