| org.sakaiproject.vm.VmServlet
 org.sakaiproject.cheftool.VmServlet
org.sakaiproject.cheftool.ToolServlet
org.sakaiproject.cheftool.VelocityPortletPaneledAction
All known Subclasses: org.sakaiproject.presence.tool.PresenceToolAction, org.sakaiproject.cheftool.PagedResourceHelperAction, org.sakaiproject.memory.tool.MemoryAction, org.sakaiproject.news.tool.NewsAction, org.sakaiproject.cheftool.NewPagedResourceAction, org.sakaiproject.rights.tool.RightsHelperAction, org.sakaiproject.archive.tool.ArchiveAction, org.sakaiproject.chat.tool.ChatAction, org.sakaiproject.cheftool.PagedResourceAction, org.sakaiproject.cheftool.PagedResourceActionII, org.sakaiproject.cheftool.VelocityPortletStateAction, org.sakaiproject.discussion.tool.DiscussionAction, org.sakaiproject.web.tool.IFrameAction, org.sakaiproject.content.tool.ResourcesHelperAction, org.sakaiproject.authz.tool.PermissionsHelperAction, org.sakaiproject.message.tool.SynopticMessageAction, org.sakaiproject.citation.tool.CitationHelperAction,
| VelocityPortletPaneledAction | | abstract public class VelocityPortletPaneledAction extends ToolServlet (Code) | |
VelocityPortletPaneledAction ...
|
| Inner Class :protected class MyLogger | |
| Method Summary | |
| protected void | actionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res)
Dispatch to a "processAction" method based on reflection. | | public static void | addAlert(SessionState state, String message)
Add another string to the alert message. | | protected void | addOptionsMenu(Menu bar, JetspeedRunData data)
Add the options to the menu bar, if allowed. | | protected boolean | allowedToOptions()
| | protected void | cancelOptions()
Cancel the options process. | | protected String | clientWindowId(SessionState state, String toolId)
Compute the deliver address for the current request. | | public static void | disableObservers(SessionState state)
| | protected void | doGet(HttpServletRequest req, HttpServletResponse res)
| | public void | doOptions(RunData runData, Context context)
Handle a request to set options. | | public void | doReset(RunData runData, Context context)
Handle the "reset tool" option from the Title bar. | | public static void | enableObservers(SessionState state)
| | protected Map | getContext(RunData data)
This is used to get "template" from the map, the default template registered for the tool in chef_tools.xreg. | | protected void | helperActionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res, String className)
Dispatch to a "processAction" method based on reflection in a helper class. | | protected void | initState(SessionState state, VelocityPortlet portlet, JetspeedRunData rundata)
| | protected void | initState(SessionState state, HttpServletRequest req, HttpServletResponse res)
Initialize for the first time the session state for this session. | | public static void | justDelivered(SessionState state)
Tell the main observer we have just delivered. | | public static String | mainPanelUpdateId(String toolId)
Compute the courier update html element id for the main panel - add "." and other names for inner panels.
Parameters:
toolId - The tool (portlet) id. | | protected String | panelMethodName(String panel)
| | public void | processAction(HttpServletRequest req, HttpServletResponse res)
Process a Portlet action. | | protected void | resetTool(SessionState state)
Reset the tool (state) to "home" conditions. | | protected void | saveOptions()
Complete the options process with a save. | | protected void | scheduleFocusRefresh(String[] path)
Schedule a focus change. | | protected void | schedulePeerFrameRefresh(String id)
Schedule a refresh for a peer frame. | | protected void | scheduleTopRefresh()
| | protected void | setVmCourier(HttpServletRequest request, int refresh)
| | protected void | setVmStdRef(HttpServletRequest request, HttpServletResponse response)
Add some standard references to the vm context. | | public static String | titlePanelUpdateId(String toolId)
Compute the courier update html element id for the title panel.
Parameters:
toolId - The tool (portlet) id. | | protected void | toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res)
Dispatch to a "do" method based on reflection. | | protected void | updateState(SessionState state, HttpServletRequest req, HttpServletResponse res)
Update for this request processing the session state. |
| ATTR_CONFIG | | final protected static String ATTR_CONFIG(Code) | | A PortletConfig bound into the request attributes.
|
| ATTR_CONTEXT | | final protected static String ATTR_CONTEXT(Code) | | A Context bound into the request attributes.
|
| ATTR_FRAME_FOCUS | | final public static String ATTR_FRAME_FOCUS(Code) | | Tool session attribute name used to schedule a focus change.
|
| ATTR_FRAME_REFRESH | | final public static String ATTR_FRAME_REFRESH(Code) | | Tool session attribute name used to schedule a peer frame refresh.
|
| ATTR_PORTLET | | final protected static String ATTR_PORTLET(Code) | | A VelocityPortlet bound into the request attributes.
|
| ATTR_RUNDATA | | final protected static String ATTR_RUNDATA(Code) | | A JetspeedRunData bound into the request attributes.
|
| ATTR_TOP_REFRESH | | final public static String ATTR_TOP_REFRESH(Code) | | Tool session attribute name used to schedule a whole page refresh.
|
| CONTEXT_SITE_COLLECTION_ID | | final protected static String CONTEXT_SITE_COLLECTION_ID(Code) | | The name of the context variable containing the identifier for the site's root content collection
|
| CONTEXT_SITE_COLLECTION_URL | | final protected static String CONTEXT_SITE_COLLECTION_URL(Code) | | The name of the context variable containing the access URL for the site's root content collection
|
| LAYOUT_MAIN | | final protected static String LAYOUT_MAIN(Code) | | The panel name of the main panel - append the tool's id.
|
| Log | | protected MyLogger Log(Code) | | |
| MODE_OPTIONS | | final public static String MODE_OPTIONS(Code) | | Standard modes.
|
| STATE_ACTION | | final protected static String STATE_ACTION(Code) | | |
| STATE_HELPER | | final public static String STATE_HELPER(Code) | | The currently active helper mode static class.
|
| STATE_OBSERVER | | final protected static String STATE_OBSERVER(Code) | | |
| STATE_OBSERVER2 | | final public static String STATE_OBSERVER2(Code) | | |
| STATE_PRESENCE_OBSERVER | | final public static String STATE_PRESENCE_OBSERVER(Code) | | |
| actionDispatch | | protected void actionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res)(Code) | | Dispatch to a "processAction" method based on reflection.
Parameters:
methodBase - The base name of the method to call.
Parameters:
methodExt - The end name of the method to call.
Parameters:
req - The HttpServletRequest.
Parameters:
res - The HttpServletResponse
throws:
PortletExcption - ,IOException, just like the "do" methods. |
| addAlert | | public static void addAlert(SessionState state, String message)(Code) | | Add another string to the alert message.
Parameters:
state - The session state.
Parameters:
message - The string to add. |
| addOptionsMenu | | protected void addOptionsMenu(Menu bar, JetspeedRunData data)(Code) | | Add the options to the menu bar, if allowed.
Parameters:
bar - The menu bar to add to,
Parameters:
ref - The resource reference to base the security decision upon. |
| allowedToOptions | | protected boolean allowedToOptions()(Code) | | Check if the current user is allowed to do options for the current context (site based)
true if the user is allowed to modify the current context's options, false if not. |
| cancelOptions | | protected void cancelOptions()(Code) | | Cancel the options process.
|
| clientWindowId | | protected String clientWindowId(SessionState state, String toolId)(Code) | | Compute the deliver address for the current request. Compute the client window id, based on the float state
Parameters:
state - The tool state.
Parameters:
toolId - The tool instance id, which might be used as part of the client window id if floating. The client window id, based on the float state. |
| disableObservers | | public static void disableObservers(SessionState state)(Code) | | Disable any observers registered in state in STATE_OBSERVER or STATE_OBSERVER2
Parameters:
state - The session state. |
| doOptions | | public void doOptions(RunData runData, Context context)(Code) | | Handle a request to set options.
|
| doReset | | public void doReset(RunData runData, Context context)(Code) | | Handle the "reset tool" option from the Title bar.
|
| enableObservers | | public static void enableObservers(SessionState state)(Code) | | Enable any observers registered in state in STATE_OBSERVER or STATE_OBSERVER2
Parameters:
state - The session state. |
| getContext | | protected Map getContext(RunData data)(Code) | | This is used to get "template" from the map, the default template registered for the tool in chef_tools.xreg.
|
| helperActionDispatch | | protected void helperActionDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res, String className)(Code) | | Dispatch to a "processAction" method based on reflection in a helper class.
Parameters:
methodBase - The base name of the method to call.
Parameters:
methodExt - The end name of the method to call.
Parameters:
req - The HttpServletRequest.
Parameters:
res - The HttpServletResponse
throws:
PortletExcption - ,IOException, just like the "do" methods. |
| initState | | protected void initState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code) | | Initialize for the first time the session state for this session. If overridden in a sub-class, make sure to call super.
Parameters:
state - The session state.
Parameters:
req - The current portlet request.
Parameters:
res - The current portlet response. |
| justDelivered | | public static void justDelivered(SessionState state)(Code) | | Tell the main observer we have just delivered.
Parameters:
state - The session state. |
| mainPanelUpdateId | | public static String mainPanelUpdateId(String toolId)(Code) | | Compute the courier update html element id for the main panel - add "." and other names for inner panels.
Parameters:
toolId - The tool (portlet) id. The courier update html element id for the main panel. |
| panelMethodName | | protected String panelMethodName(String panel)(Code) | | Allow extension classes to control which build method gets called for this pannel
Parameters:
panel - |
| resetTool | | protected void resetTool(SessionState state)(Code) | | Reset the tool (state) to "home" conditions. Default here is to clear everything from state.
Parameters:
state - The tool's session state. |
| saveOptions | | protected void saveOptions()(Code) | | Complete the options process with a save.
|
| scheduleFocusRefresh | | protected void scheduleFocusRefresh(String[] path)(Code) | | Schedule a focus change.
Parameters:
path - The desired focus path elements |
| schedulePeerFrameRefresh | | protected void schedulePeerFrameRefresh(String id)(Code) | | Schedule a refresh for a peer frame.
Parameters:
id - The peer frame's id. |
| scheduleTopRefresh | | protected void scheduleTopRefresh()(Code) | | Schedule a refresh for whole page
|
| setVmCourier | | protected void setVmCourier(HttpServletRequest request, int refresh)(Code) | | Setup the vm context for a courier
Parameters:
request - |
| setVmStdRef | | protected void setVmStdRef(HttpServletRequest request, HttpServletResponse response)(Code) | | Add some standard references to the vm context.
Parameters:
request - The render request.
Parameters:
response - The render response. |
| titlePanelUpdateId | | public static String titlePanelUpdateId(String toolId)(Code) | | Compute the courier update html element id for the title panel.
Parameters:
toolId - The tool (portlet) id. The courier update html element id for the title panel. |
| toolModeDispatch | | protected void toolModeDispatch(String methodBase, String methodExt, HttpServletRequest req, HttpServletResponse res) throws ToolException(Code) | | Dispatch to a "do" method based on reflection. Override ToolServlet to support the old "build" ways.
Parameters:
methodBase - The base name of the method to call.
Parameters:
methodExt - The end name of the method to call.
Parameters:
req - The HttpServletRequest.
Parameters:
res - The HttpServletResponse |
| updateState | | protected void updateState(SessionState state, HttpServletRequest req, HttpServletResponse res)(Code) | | Update for this request processing the session state. If overridden in a sub-class, make sure to call super.
Parameters:
state - The session state.
Parameters:
req - The current portlet request.
Parameters:
res - The current portlet response. |
| 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)
|
|
|