Skip navigation links
A B C D E F G H I J K L M N O P R S T U V 

A

actionDispatch(String, String, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Dispatch to a "processAction" method based on reflection.
actionDispatch(String, String, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Dispatch to a "processAction" method based on reflection.
ActionURL - Class in org.sakaiproject.vm
PortletActionURL provides a URL with settable and re-settable parameters based on a portlet window's ActionURL base URL.
ActionURL(String, HttpServletRequest) - Constructor for class org.sakaiproject.vm.ActionURL
Construct with a base URL to the portlet, no parameters
add(String) - Method in class org.sakaiproject.cheftool.AlertImpl
Add a new alert line.
add(MenuItem) - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Add a menu item to the bar.
addAlert(SessionState, String) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Add another string to the alert message.
addAlert(SessionState, String, boolean) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Add another string to the alert message.
addFlashNotif(SessionState, String) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Add another string to the flash notification message.
addListPagingMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Add the menus for a list mode for paging.
addListPagingMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Add the menus for a list mode for paging.
addListPagingMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Add the menus for a list mode for paging.
addOptionsMenu(Menu, JetspeedRunData) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Add the options to the menu bar, if allowed.
addRefreshMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Add the menus for manual / auto - refresh.
addRefreshMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Add the menus for manual / auto - refresh.
addRefreshMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Add the menus for manual / auto - refresh.
addSearchMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Add the menus for search.
addSearchMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Add the menus for search.
addSearchMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Add the menus for search.
addSearchMenus(Menu, SessionState, String) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Add the menus for search, including accessibility title
addSearchMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Add the menus for search.
addViewPagingMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Add the menus for a view mode for paging.
addViewPagingMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Add the menus for a view mode for paging.
addViewPagingMenus(Menu, SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Add the menus for a view mode for paging.
adjustDividers() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Adjust by removing any dividers at the start or end.
ALERT_ATTR - Static variable in class org.sakaiproject.cheftool.ToolServlet
The state attribute name used to store the Alert.
ALERT_STATE_INITED - Static variable in class org.sakaiproject.cheftool.ToolServlet
The state attribute name used to store the marker of have been initialized.
AlertImpl - Class in org.sakaiproject.cheftool
Alert is a set of messages intended for user display in the user interface.
AlertImpl() - Constructor for class org.sakaiproject.cheftool.AlertImpl
 
allowedToOptions() - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Check if the current user is allowed to do options for the current context (site based)
ATTR_CONFIG - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
A PortletConfig bound into the request attributes.
ATTR_CONTEXT - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
A Context bound into the request attributes.
ATTR_FRAME_FOCUS - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Tool session attribute name used to schedule a focus change.
ATTR_FRAME_REFRESH - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Tool session attribute name used to schedule a peer frame refresh.
ATTR_PARAMS - Static variable in class org.sakaiproject.vm.ComponentServlet
This request's parsed parameters
ATTR_PORTLET - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
A VelocityPortlet bound into the request attributes.
ATTR_RUNDATA - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
A JetspeedRunData bound into the request attributes.
ATTR_TOP_REFRESH - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Tool session attribute name used to schedule a whole page refresh.

B

BUTTON - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 

C

cancelOptions() - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Cancel the options process.
checkCSRFToken(HttpServletRequest, RunData, String) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
checkRunData(HttpServletRequest) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
cleanStatePaging(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Clean up all state value for paging.
clear() - Method in class org.sakaiproject.cheftool.AlertImpl
Remove any messages in the Alert.
clear() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Clear the menu of all items.
clear() - Method in class org.sakaiproject.cheftool.PortletConfig
Unsupported operation
clientWindowId(SessionState, String) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Compute the deliver address for the current request.
ComponentServlet - Class in org.sakaiproject.vm
ComponentServlet does some setup and provides some support for (mostly legacy) Sakai servlets and tools.
ComponentServlet() - Constructor for class org.sakaiproject.vm.ComponentServlet
 
Configuration - Class in org.sakaiproject.cheftool
 
Configuration() - Constructor for class org.sakaiproject.cheftool.Configuration
 
containsKey(Object) - Method in class org.sakaiproject.cheftool.PortletConfig
 
containsValue(Object) - Method in class org.sakaiproject.cheftool.PortletConfig
 
Context - Class in org.sakaiproject.cheftool
 
Context(VelocityPortletPaneledAction, HttpServletRequest) - Constructor for class org.sakaiproject.cheftool.Context
 
CONTEXT_ACTION - Static variable in class org.sakaiproject.cheftool.menu.MenuImpl
 
CONTEXT_MENU - Static variable in class org.sakaiproject.cheftool.menu.MenuImpl
 
CONTEXT_SITE_COLLECTION_ID - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
The name of the context variable containing the identifier for the site's root content collection
CONTEXT_SITE_COLLECTION_URL - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
The name of the context variable containing the access URL for the site's root content collection
ControllerState - Class in org.sakaiproject.cheftool
ControllerState is the core base class for the CHEF Tool's state objects.
ControllerState() - Constructor for class org.sakaiproject.cheftool.ControllerState
 

D

DEFAULT_PAGE_SIZE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
The default number of items per page.
DEFAULT_PAGE_SIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
The default number of messages per page.
DEFAULT_PAGE_SIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
The default number of messages per page.
DEFAULT_PAGE_SIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
The default number of messages per page.
disableObservers(SessionState) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Disable any observers registered in state in STATE_OBSERVER or STATE_OBSERVER2
doAuto(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Toggle auto-update
doAuto(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Toggle auto-update
doAuto(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Toggle auto-update
doAuto(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Toggle auto-update
doChange_pagesize(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a request to change the page size of search list.
doChange_pagesize(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a request to change the page-size.
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
doGet(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
doList_first(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a first-item page (list) request.
doList_first(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a first-message page (list) request.
doList_first(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a first-message page (list) request.
doList_first(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a first-message page (list) request.
doList_last(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a last-item page (list) request.
doList_last(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a last-message page (list) request.
doList_last(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a last-message page (list) request.
doList_last(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a last-message page (list) request.
doList_next(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a next-page (list) request.
doList_next(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a next-page (list) request.
doList_next(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a next-page (list) request.
doList_next(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a next-page (list) request.
doList_prev(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a prev-page (list) request.
doList_prev(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a prev-page (list) request.
doList_prev(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a prev-page (list) request.
doList_prev(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a prev-page (list) request.
doOptions(RunData, Context) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Handle a request to set options.
doPost(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Respond to a request by dispatching to a portlet like "do" method based on the portlet mode and tool mode
doRefresh(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
The action for when the user want's an update
doRefresh(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
The action for when the user want's an update
doRefresh(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
The action for when the user want's an update
doRefresh(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
The action for when the user want's an update
doReset(RunData, Context) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Handle the "reset tool" option from the Title bar.
doSearch(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a Search request.
doSearch(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a Search request.
doSearch(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a Search request.
doSearch(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a Search request.
doSearch_clear(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a Search Clear request.
doSearch_clear(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a Search Clear request.
doSearch_clear(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a Search Clear request.
doSearch_clear(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a Search Clear request.
doToggle_paging(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
The action for toggling paging status: show all(no paging) or paging
doView_next(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a next-item (view) request.
doView_next(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a next-message (view) request.
doView_next(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a next-message (view) request.
doView_next(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a next-message (view) request.
doView_page(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a view indecated page request
doView_page(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a view indecated page request
doView_prev(RunData, Context) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Handle a prev-item (view) request.
doView_prev(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Handle a prev-message (view) request.
doView_prev(RunData, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Handle a prev-message (view) request.
doView_prev(RunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Handle a prev-message (view) request.

E

enableObserver(SessionState) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Enable the observer, unless we are in search mode, where we want it disabled.
enableObserver(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Enable the observer, unless we are in search mode, where we want it disabled.
enableObserver(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Enable the observer, unless we are in search mode, where we want it disabled.
enableObserver(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Enable the observer, unless we are in search mode, where we want it disabled.
enableObservers(SessionState) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Enable any observers registered in state in STATE_OBSERVER or STATE_OBSERVER2
entrySet() - Method in class org.sakaiproject.cheftool.PortletConfig
 
EnumerationIterator<E> - Class in org.sakaiproject.cheftool
Deprecated.
use EnumerationIterator instead, this will be removed after 12.0 - May 2017
EnumerationIterator(Enumeration<E>) - Constructor for class org.sakaiproject.cheftool.EnumerationIterator
Deprecated.
 
equals(Object) - Method in class org.sakaiproject.vm.ActionURL
escapeVmName(String) - Method in class org.sakaiproject.vm.VelocityServlet
Change any characters that Velocity doesn't like in the name to '_' to make a valid Velocity name

F

FileItem - Class in org.sakaiproject.util
FileItem is a file uploaded by the end user's browser.
FileItem(String, String) - Constructor for class org.sakaiproject.util.FileItem
Construct
FileItem(String, String, InputStream) - Constructor for class org.sakaiproject.util.FileItem
 
findResourceInList(List, String) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Find the resource with this id in the list.
findResourceInList(List, String) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Find the resource with this id in the list.
findResourceInList(List, String) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Find the resource with this id in the list.
FORM_PAGE_NUMBER - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
FORM_PAGE_NUMBER - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
FORM_SEARCH - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
Form fields.
FORM_SEARCH - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
Form fields.
FORM_SEARCH - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
Form fields.
FORM_SEARCH - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
Form fields.

G

get(Object) - Method in class org.sakaiproject.cheftool.PortletConfig
 
get(String) - Method in class org.sakaiproject.util.ParameterParser
Get a (String) parameter by name.
get3InitParameter(String) - Method in class org.sakaiproject.cheftool.PortletConfig
Special non-jetspeed imitation: get three possible init parameter values: [0] from servlet config [1] from tool registration [2] from tool config nulls if not present
getAccessibilityLabel() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
 
getAccessibilityLabel() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
 
getAccessibilityLabel() - Method in class org.sakaiproject.cheftool.menu.MenuField
 
getAccessibilityLabel() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
 
getAction() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the action string for this item; what to do when the user clicks.
getAction() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the action string for this item; what to do when the user clicks.
getAction() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the action string for this item; what to do when the user clicks.
getAction() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the action string for this item; what to do when the user clicks.
getActionURL(HttpServletRequest) - Method in class org.sakaiproject.vm.VmServlet
Get a new ActionURL.
getAlert() - Method in class org.sakaiproject.cheftool.AlertImpl
Access the alert message.
getAlert(HttpServletRequest) - Method in class org.sakaiproject.cheftool.ToolServlet
Access the Alert for the current request.
getAlert(SessionState) - Method in class org.sakaiproject.cheftool.ToolServlet
Access the Alert in this state - will create one if needed.
getBoolean(String) - Method in class org.sakaiproject.util.ParameterParser
Get a boolean parameter by name.
getChecked() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the checked status of this item.
getChecked() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the checked status of this item.
getChecked() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the checked status of this item.
getChecked() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the checked status of this item.
getCleanString(String) - Method in class org.sakaiproject.util.ParameterParser
Clean the user input string of strange newlines, etc.
getContentType() - Method in class org.sakaiproject.util.FileItem
 
getContext(RunData) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
This is used to get "template" from the map, the default template registered for the tool in chef_tools.xreg.
getDateFormatString() - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
getFileItem(String) - Method in class org.sakaiproject.util.ParameterParser
Get a FileItem parameter by name.
getFileName() - Method in class org.sakaiproject.util.FileItem
 
getForm() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the form name whose values will be used when this item is selected.
getForm() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the form name whose values will be used when this item is selected.
getForm() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the form name whose values will be used when this item is selected.
getForm() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the form name whose values will be used when this item is selected.
getIcon() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the icon name for the item (or null if no icon).
getIcon() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the icon name for the item (or null if no icon).
getIcon() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the icon name for the item (or null if no icon).
getIcon() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the icon name for the item (or null if no icon).
getId() - Method in class org.sakaiproject.cheftool.ControllerState
 
getID() - Method in class org.sakaiproject.cheftool.VelocityPortlet
 
getInitParameter(String, String) - Method in class org.sakaiproject.cheftool.PortletConfig
 
getInitParameter(String) - Method in class org.sakaiproject.cheftool.PortletConfig
 
getInitParameters() - Method in class org.sakaiproject.cheftool.PortletConfig
 
getInputStream() - Method in class org.sakaiproject.util.FileItem
 
getInt(String, int) - Method in class org.sakaiproject.util.ParameterParser
Get an int parameter by name, with default.
getInt(String) - Method in class org.sakaiproject.util.ParameterParser
Get an int parameter by name.
getIschecked() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the checked status of this item.
getIsContainer() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Does this item act as a container for other items?
getIsContainer() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Does this item act as a container for other items?
getIsContainer() - Method in class org.sakaiproject.cheftool.menu.MenuField
Does this item act as a container for other items?
getIsContainer() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Does this item act as a container for other items?
getIsCurrent() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
 
getIsCurrent() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
getIsCurrent() - Method in class org.sakaiproject.cheftool.menu.MenuField
 
getIsCurrent() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
 
getIsDivider() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Is this item a divider ?
getIsDivider() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Is this item a divider ?
getIsDivider() - Method in class org.sakaiproject.cheftool.menu.MenuField
Is this item a divider ?
getIsDivider() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Is this item a divider ?
getIsEnabled() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the enabled flag for the item.
getIsEnabled() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the enabled flag for the item.
getIsEnabled() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the enabled flag for the item.
getIsEnabled() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the enabled flag for the item.
getIsField() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the is-field (not a button) flag.
getIsField() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the is-field (not a button) flag.
getIsField() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the is-field (not a button) flag.
getIsField() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the is-field (not a button) flag.
getItem(int) - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access one sub-items of the item.
getItem(int) - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access one sub-items of the item.
getItem(int) - Method in class org.sakaiproject.cheftool.menu.MenuField
Access one sub-items of the item.
getItem(int) - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access one sub-items of the item.
getItems() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the sub-items of the item.
getItems() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the sub-items of the item.
getItems() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the sub-items of the item.
getItems() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the sub-items of the item.
getJs_peid() - Method in class org.sakaiproject.cheftool.JetspeedRunData
Returns the portlet id (PEID) referenced in this request
getKey() - Method in class org.sakaiproject.cheftool.ControllerState
Access a unique key for this state, combining the set id and the state id.
getMenu(HttpServletRequest) - Method in class org.sakaiproject.cheftool.ToolServlet
Access the Menu for the current request.
getNames() - Method in class org.sakaiproject.util.ParameterParser
Access the parameter names.
getParameters() - Method in class org.sakaiproject.cheftool.RunData
 
getPath() - Method in class org.sakaiproject.util.ParameterParser
Access the pathInfo.
getPid(HttpServletRequest) - Method in class org.sakaiproject.cheftool.ToolServlet
Access the "pid" - portlet window id, tool id, from the request
getPortletConfig() - Method in class org.sakaiproject.cheftool.VelocityPortlet
 
getPortletSessionState(String) - Method in class org.sakaiproject.cheftool.JetspeedRunData
Access the current request's PortletSession state object.
getProperties() - Method in class org.sakaiproject.util.ParameterParser
Access the parameter names.
getRequest() - Method in class org.sakaiproject.cheftool.RunData
 
getServletConfig() - Method in class org.sakaiproject.cheftool.VelocityPortlet
 
getSetId() - Method in class org.sakaiproject.cheftool.ControllerState
 
getShowdisabled() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access whether disabled items in this menu should be shown.
getState(HttpServletRequest) - Method in class org.sakaiproject.cheftool.ToolServlet
Access the SessionState for the current request.
getState(Context, RunData, Class) - Method in class org.sakaiproject.cheftool.VelocityPortletStateAction
Get the proper state for this instance (if portlet is not known, only context).
getState(VelocityPortlet, RunData, Class) - Method in class org.sakaiproject.cheftool.VelocityPortletStateAction
Get the proper state for this instance (if portlet is known).
getState(String, RunData, Class) - Method in class org.sakaiproject.cheftool.VelocityPortletStateAction
Get the proper state for this instance (if portlet id is known).
getString(String) - Method in class org.sakaiproject.cheftool.Configuration
 
getString(String) - Method in class org.sakaiproject.util.ParameterParser
Get a (String) parameter by name.
getStrings(String) - Method in class org.sakaiproject.util.ParameterParser
Get a (String[]) multi-valued parameter by name.
getTimeFormatString() - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Return a String array containing the "h", "m", "a", or "H" characters (corresponding to hour, minute, am/pm, or 24-hour) in the locale specific order
getTitle() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the display title for the item.
getTitle() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the display title for the item.
getTitle() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the display title for the item - this is really the form field name.
getTitle() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the display title for the item.
getTitle() - Method in class org.sakaiproject.cheftool.PortletConfig
 
getToolMode(HttpServletRequest) - Method in class org.sakaiproject.cheftool.ToolServlet
Access the tool mode for the current Portlet mode.
getUrl() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Access the full URL string for this item; what to do when the user clicks.
getUrl() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Access the full URL string for this item; what to do when the user clicks.
getUrl() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the full URL string for this item; what to do when the user clicks.
getUrl() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Access the full URL string for this item; what to do when the user clicks.
getValue() - Method in class org.sakaiproject.cheftool.menu.MenuField
Access the value string for this item - the initial value.
getVmReference(String, HttpServletRequest) - Method in class org.sakaiproject.vm.VmServlet
Access the object set in the velocity context for this name, if any.

H

handleRequest(HttpServletRequest, HttpServletResponse, Context) - Method in class org.sakaiproject.vm.VelocityServlet
main routine to handle a request.
hasNext() - Method in class org.sakaiproject.cheftool.EnumerationIterator
Deprecated.
 
HELPER_ID - Static variable in class org.sakaiproject.cheftool.ToolServlet
ToolSession attribute name holding the helper id, if we are in helper mode.
HELPER_LINK_MODE - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Constants to handle helper situations
HELPER_MODE_DONE - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
helperActionDispatch(String, String, HttpServletRequest, HttpServletResponse, String) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Dispatch to a "processAction" method based on reflection in a helper class.

I

includeVm(String, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.vm.VmServlet
Include the Velocity template, expanded with the current set of references
init() - Method in class org.sakaiproject.cheftool.ControllerState
Init to startup values
initState(SessionState, VelocityPortlet, JetspeedRunData) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Populate the state object, if needed, concerning paging
initState(SessionState, VelocityPortlet, JetspeedRunData) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Populate the state object, if needed, concerning paging
initState(SessionState, VelocityPortlet, JetspeedRunData) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Populate the state object, if needed, concerning paging
initState(SessionState, VelocityPortlet, JetspeedRunData) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Populate the state object, if needed, concerning paging
initState(SessionState, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Initialize for the first time the session state for this session.
initState(SessionState, VelocityPortlet, JetspeedRunData) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
initState(SessionState, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Initialize for the first time the session state for this session.
isEmpty() - Method in class org.sakaiproject.cheftool.AlertImpl
Check to see if the alert is empty, or has been populated.
isEmpty() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Check if there are any sub-items.
isEmpty() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Check if there are any sub-items.
isEmpty() - Method in class org.sakaiproject.cheftool.menu.MenuField
Check if there are any sub-items.
isEmpty() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Check if there are any sub-items.
isEmpty() - Method in class org.sakaiproject.cheftool.PortletConfig
 

J

JetspeedRunData - Class in org.sakaiproject.cheftool
 
JetspeedRunData(HttpServletRequest, SessionState, String, ParameterParser) - Constructor for class org.sakaiproject.cheftool.JetspeedRunData
 
justDelivered(SessionState) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Tell the main observer we have just delivered.

K

keySet() - Method in class org.sakaiproject.cheftool.PortletConfig
 

L

LAYOUT_MAIN - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
The panel name of the main panel - append the tool's id.
loadConfiguration(ServletConfig) - Method in class org.sakaiproject.vm.VelocityServlet
Called by the VelocityServlet init().

M

m_accessibilitylabel - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The acessibility label for the entry.
m_accessibilityLabel - Variable in class org.sakaiproject.cheftool.menu.MenuField
Optional accessibility info that can be set
m_action - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The action string for the entry.
m_action - Variable in class org.sakaiproject.cheftool.menu.MenuField
The action to perform.
m_base - Variable in class org.sakaiproject.vm.ActionURL
The base url to the portlet.
m_checked - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The checked status (@see MenuItem for values).
m_config - Variable in class org.sakaiproject.cheftool.VelocityPortlet
 
m_current - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The current flag for the entry.
m_enabled - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The enabled flag for the entry.
m_enabled - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The menu's enabled flag.
m_enum - Variable in class org.sakaiproject.cheftool.EnumerationIterator
Deprecated.
The enumeration over which this iterates.
m_form - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The form name string for the entry.
m_form - Variable in class org.sakaiproject.cheftool.menu.MenuField
The form name string for the entry.
m_form - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The form name string for the entry.
m_icon - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The icon name for the entry.
m_icon - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The menu's icon.
m_id - Variable in class org.sakaiproject.cheftool.VelocityPortlet
 
m_inputStream - Variable in class org.sakaiproject.util.FileItem
Stream from which body can be read
m_isAction - Variable in class org.sakaiproject.vm.ActionURL
Is this an Action URL
m_items - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The MenuItems, in order.
m_linkBaseUrl - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The base url for any action taken after clicking on the menu.
m_msg - Variable in class org.sakaiproject.cheftool.AlertImpl
The Alert text.
m_name - Variable in class org.sakaiproject.cheftool.menu.MenuField
The form field name.
m_name - Variable in class org.sakaiproject.util.FileItem
file name.
m_page - Variable in class org.sakaiproject.vm.ActionURL
The site pge, if any.
m_panel - Variable in class org.sakaiproject.vm.ActionURL
The panel, if any.
m_parameters - Variable in class org.sakaiproject.vm.ActionURL
parameters.
m_params - Variable in class org.sakaiproject.cheftool.RunData
 
m_pid - Variable in class org.sakaiproject.vm.ActionURL
The portlet window id, if any.
m_QueryString - Variable in class org.sakaiproject.vm.ActionURL
Pre-formatted query string, in lieu of parameters
m_req - Variable in class org.sakaiproject.cheftool.Context
 
m_req - Variable in class org.sakaiproject.cheftool.RunData
 
m_req - Variable in class org.sakaiproject.util.ParameterParser
The request.
m_request - Variable in class org.sakaiproject.vm.ActionURL
HttpServletRequest *
m_resourceBaseUrl - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The base url for any resources (images, etc.) required by the menu.
m_resourcePath - Variable in class org.sakaiproject.vm.ActionURL
Is this a Resource URL
m_showDisabled - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The menu's flag for whether to display disabled entries
m_site - Variable in class org.sakaiproject.vm.ActionURL
The site, if any.
m_title - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The display title for the entry.
m_title - Variable in class org.sakaiproject.cheftool.menu.MenuImpl
The menu's title.
m_type - Variable in class org.sakaiproject.util.FileItem
file type.
m_url - Variable in class org.sakaiproject.cheftool.menu.MenuEntry
The full URL string for the entry.
m_validator - Variable in class org.sakaiproject.cheftool.VmServlet
A validator.
m_value - Variable in class org.sakaiproject.cheftool.menu.MenuField
The value to display in the field.
MAIN_PANEL - Variable in class org.sakaiproject.cheftool.ToolServlet
The special panel name for the main.
mainPanelUpdateId(String) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Compute the courier update html element id for the main panel - add "." and other names for inner panels.
MENU_ATTR - Static variable in class org.sakaiproject.cheftool.ToolServlet
The state attribute name used to store the Menu.
MenuDivider - Class in org.sakaiproject.cheftool.menu
MenuDivider is a menu item that makes a visible divider in the menu.
MenuDivider() - Constructor for class org.sakaiproject.cheftool.menu.MenuDivider
Construct a menu divider.
MenuEntry - Class in org.sakaiproject.cheftool.menu
MenuEntry is a clickable entry in a menu.
MenuEntry(String, String, String, boolean, int, String, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuEntry(String, String, boolean, int, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuEntry(String, boolean, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuEntry(String, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuEntry(String, String, String, boolean, int, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuEntry(String, String, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuEntry(String, String, boolean, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
 
MenuEntry(String, String, boolean, int, String, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuEntry
Construct a menu.
MenuField - Class in org.sakaiproject.cheftool.menu
MenuField is a text entry field in a menu / toolbar.
MenuField(String, String, String, String, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuField
Construct.
MenuField(String, String, String, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuField
Construct.
MenuImpl - Class in org.sakaiproject.cheftool.menu
Menu is an ordered list of MenuItems.
MenuImpl(VelocityPortlet, RunData, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuImpl
 
MenuImpl(String, String, boolean) - Constructor for class org.sakaiproject.cheftool.menu.MenuImpl
Construct a menu (good for sub-menus).
MenuImpl(String, String, boolean, String) - Constructor for class org.sakaiproject.cheftool.menu.MenuImpl
Construct a menu (good for sub-menus).
MenuImpl() - Constructor for class org.sakaiproject.cheftool.menu.MenuImpl
Construct a menu (good for a menu bar).
MODE_OPTIONS - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Standard modes.

N

NewPagedResourceAction - Class in org.sakaiproject.cheftool
PagedResourceAction is a base class that handles paged display of lists of Resourecs.
NewPagedResourceAction() - Constructor for class org.sakaiproject.cheftool.NewPagedResourceAction
 
next() - Method in class org.sakaiproject.cheftool.EnumerationIterator
Deprecated.
 

O

org.sakaiproject.cheftool - package org.sakaiproject.cheftool
 
org.sakaiproject.cheftool.menu - package org.sakaiproject.cheftool.menu
 
org.sakaiproject.util - package org.sakaiproject.util
 
org.sakaiproject.vm - package org.sakaiproject.vm
 

P

PagedResourceAction - Class in org.sakaiproject.cheftool
PagedResourceAction is a base class that handles paged display of lists of Resourecs.
PagedResourceAction() - Constructor for class org.sakaiproject.cheftool.PagedResourceAction
 
PagedResourceActionII - Class in org.sakaiproject.cheftool
PagedResourceAction is a base class that handles paged display of lists of Resourecs with service support for paging.
PagedResourceActionII() - Constructor for class org.sakaiproject.cheftool.PagedResourceActionII
 
PagedResourceHelperAction - Class in org.sakaiproject.cheftool
PagedResourceAction is a base class that handles paged display of lists of Resourecs.
PagedResourceHelperAction() - Constructor for class org.sakaiproject.cheftool.PagedResourceHelperAction
 
PAGESIZES - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
pagingInfoToContext(SessionState, Context) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
 
panelMethodName(String) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Allow extension classes to control which build method gets called for this pannel
PARAM_ACTION - Static variable in class org.sakaiproject.cheftool.ToolServlet
The request parameter name whose value is the action.
PARAM_ACTION_COMBO - Static variable in class org.sakaiproject.cheftool.ToolServlet
The request parameter name root that has the action name following.
PARAM_PAGE - Static variable in class org.sakaiproject.vm.ActionURL
The parameter for page.
PARAM_PAGESIZE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
portlet configuration parameter names.
PARAM_PAGESIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
portlet configuration parameter names.
PARAM_PAGESIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
portlet configuration parameter names.
PARAM_PAGESIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
portlet configuration parameter names.
PARAM_PANEL - Static variable in class org.sakaiproject.vm.ActionURL
The parameter for paneld.
PARAM_PID - Static variable in class org.sakaiproject.vm.ActionURL
The parameter for portlet window id (pid).
PARAM_SITE - Static variable in class org.sakaiproject.vm.ActionURL
The parameter for site.
ParameterParser - Class in org.sakaiproject.util
ParameterParser is a wrapper over the request that provides compatibility with Sakai 1.5 and before.
ParameterParser(HttpServletRequest) - Constructor for class org.sakaiproject.util.ParameterParser
Construct with this request.
peekAlert() - Method in class org.sakaiproject.cheftool.AlertImpl
Access the alert message, but unlike getAlert(), do not clear the message.
pid - Variable in class org.sakaiproject.cheftool.JetspeedRunData
 
PortletConfig - Class in org.sakaiproject.cheftool
Provides read access to tool parameters, which are (name, value) pairs.
prepPage(SessionState) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Prepare the current page of items to display.
prepPage(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Prepare the current page of messages to display.
prepPage(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Prepare the current page of messages to display.
prepPage(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Prepare the current page of messages to display.
prepState(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Prepare state, either for first time or update
processAction(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Process a Portlet action.
processAction(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Process a Portlet action.
put(String, Object) - Method in class org.sakaiproject.cheftool.Context
 
put(Object, Object) - Method in class org.sakaiproject.cheftool.PortletConfig
Unsupported operation
putAll(Map) - Method in class org.sakaiproject.cheftool.PortletConfig
Unsupported operation

R

rb - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
rb_praII - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
readAllResources(SessionState) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Implement this to return alist of all the resources that there are to page.
readAllResources(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Implement this to return alist of all the resources that there are to page.
readAllResources(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Override this to return a list of all the resources that there are to page.
readResourcesPage(SessionState, int, int) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Implement this to return a list of all the resources in this record range, with search and sorting applied.
recycle() - Method in class org.sakaiproject.cheftool.ControllerState
Release any resources and restore the object to initial conditions to be reused.
releaseState(Context, RunData) - Method in class org.sakaiproject.cheftool.VelocityPortletStateAction
Release the proper state for this instance (if portlet is not known, only context).
releaseState(VelocityPortlet, RunData) - Method in class org.sakaiproject.cheftool.VelocityPortletStateAction
Release the proper state for this instance (if portlet is known).
releaseState(String, RunData) - Method in class org.sakaiproject.cheftool.VelocityPortletStateAction
Release the proper state for this instance (if portlet id is known).
remove() - Method in class org.sakaiproject.cheftool.EnumerationIterator
Deprecated.
 
remove(Object) - Method in class org.sakaiproject.cheftool.PortletConfig
Unsupported operation
reset() - Method in class org.sakaiproject.vm.ActionURL
"Reset" the URL by clearing the parameters.
resetPaging(SessionState) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Reset to the first page
resetPaging(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceAction
Reset to the first page
resetPaging(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Reset to the first page
resetPaging(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceHelperAction
Reset to the first page
resetTool(SessionState) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Reset the tool (state) to "home" conditions.
RunData - Class in org.sakaiproject.cheftool
 
RunData(HttpServletRequest, ParameterParser) - Constructor for class org.sakaiproject.cheftool.RunData
 

S

SAKAI_CSRF_TOKEN - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
The name of the param used for CSRF protection
saveOptions() - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Complete the options process with a save.
scheduleFocusRefresh(String[]) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Schedule a focus change.
schedulePeerFrameRefresh(String) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Schedule a refresh for a peer frame.
scheduleTopRefresh() - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Schedule a refresh for whole page
sendParentRedirect(HttpServletResponse, String) - Method in class org.sakaiproject.vm.ComponentServlet
Send a redirect so our parent ends up at the url, via javascript.
sendToHelper(HttpServletRequest, HttpServletResponse, String) - Method in class org.sakaiproject.cheftool.ToolServlet
 
service(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.vm.ComponentServlet
Override service, adding the setup for legacy.
setAction() - Method in class org.sakaiproject.vm.ActionURL
Set this URL to be an 'action' URL, one that usually does a Form POST
setAttribute(String, String, RunData) - Method in class org.sakaiproject.cheftool.VelocityPortlet
 
setId(String) - Method in class org.sakaiproject.cheftool.ControllerState
 
setIsCurrent(boolean) - Method in class org.sakaiproject.cheftool.menu.MenuEntry
If you set this to true, this menu item will be displayed as the current selected item.
setNoCacheHeaders(HttpServletResponse) - Method in class org.sakaiproject.vm.ComponentServlet
 
setPage(String) - Method in class org.sakaiproject.vm.ActionURL
Set or reset the page.
setPanel(String) - Method in class org.sakaiproject.vm.ActionURL
Set or reset the panel.
setParameter(String, String) - Method in class org.sakaiproject.vm.ActionURL
Set or replace (or remove if value is null) a parameter
setPid(String) - Method in class org.sakaiproject.vm.ActionURL
Set or reset the pid.
setQueryString(String) - Method in class org.sakaiproject.vm.ActionURL
 
setResourcePath(String) - Method in class org.sakaiproject.vm.ActionURL
 
setSetId(String) - Method in class org.sakaiproject.cheftool.ControllerState
 
setShowdisabled(boolean) - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Set whether disabled items in this menu should be shown.
setSite(String) - Method in class org.sakaiproject.vm.ActionURL
Set or reset the site.
setToolMode(String, HttpServletRequest) - Method in class org.sakaiproject.cheftool.ToolServlet
Set the tool mode.
setUrl(String) - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Set the full URL of the entry.
setUrl(String) - Method in class org.sakaiproject.cheftool.menu.MenuField
Set the full URL of the entry.
setVmCourier(HttpServletRequest, int) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Setup the vm context for a courier
setVmReference(String, Object, HttpServletRequest) - Method in class org.sakaiproject.vm.VmServlet
Add a reference object to the velocity context by name - if it's not already defined
setVmStdRef(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Add some standard references to the vm context.
setVmStdRef(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Add some standard references to the vm context.
setVmStdRef(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VmServlet
Add some standard references to the vm context.
setVmStdRef(HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.vm.VmServlet
Add some standard references to the vm context.
size() - Method in class org.sakaiproject.cheftool.menu.MenuDivider
Count the sub-items of the item.
size() - Method in class org.sakaiproject.cheftool.menu.MenuEntry
Count the sub-items of the item.
size() - Method in class org.sakaiproject.cheftool.menu.MenuField
Count the sub-items of the item.
size() - Method in class org.sakaiproject.cheftool.menu.MenuImpl
Count the sub-items of the item.
size() - Method in class org.sakaiproject.cheftool.PortletConfig
 
sizeResources(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Implement this to return the number of records that are currently selected.
startHelper(HttpServletRequest, String, String) - Method in class org.sakaiproject.cheftool.ToolServlet
Setup for a helper tool - all subsequent requests will be directed there, till the tool is done.
startHelper(HttpServletRequest, String) - Method in class org.sakaiproject.cheftool.ToolServlet
Setup for a helper tool - all subsequent requests will be directed there, till the tool is done.
state - Variable in class org.sakaiproject.cheftool.JetspeedRunData
 
STATE_ACTION - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_CURRENT_PAGE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_CURRENT_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_FIRST_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_FLOAT - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_GO_FIRST_PAGE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GO_FIRST_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_GO_FIRST_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_GO_FIRST_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_GO_LAST_PAGE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GO_LAST_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_GO_LAST_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_GO_LAST_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_GO_NEXT - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GO_NEXT - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_GO_NEXT - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_GO_NEXT - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_GO_NEXT_PAGE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GO_NEXT_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_GO_NEXT_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_GO_NEXT_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_GO_PREV - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GO_PREV - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_GO_PREV - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_GO_PREV - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_GO_PREV_PAGE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GO_PREV_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_GO_PREV_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_GO_PREV_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_GOTO_PAGE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_GOTO_PAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_HELPER - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
The currently active helper mode static class.
STATE_LAST_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_MANUAL_REFRESH - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_MANUAL_REFRESH - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_MANUAL_REFRESH - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_MANUAL_REFRESH - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_MENU - Static variable in class org.sakaiproject.cheftool.menu.MenuImpl
 
STATE_MESSAGE - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_MODE - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_NEW_PANEL - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_NEXT_EXISTS - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_NEXT_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_NEXT_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_NEXT_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_NEXT_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_NEXT_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_NEXT_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_NEXT_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_NOTIF - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_NUM_ITEMS - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_NUM_MESSAGES - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_NUM_MESSAGES - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_NUM_MESSAGES - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_OBSERVER - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_OBSERVER2 - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_PAGESIZE - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_PAGESIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_PAGESIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_PAGESIZE - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_PAGING - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_PRESENCE_OBSERVER - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_PREV_EXISTS - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_PREV_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_PREV_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_PREV_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_PREV_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_PREV_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_PREV_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_PREV_PAGE_EXISTS - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_SEARCH - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_SEARCH - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_SEARCH - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_SEARCH - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_SELECTED_VIEW - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_TOOL - Static variable in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
STATE_TOP_PAGE_ITEM - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_TOP_PAGE_MESSAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
 
STATE_TOP_PAGE_MESSAGE - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_TOP_PAGE_MESSAGE_ID - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
 
STATE_TOTAL_PAGENUMBER - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
 
STATE_TOTAL_PAGENUMBER - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
 
STATE_VIEW_ID - Static variable in class org.sakaiproject.cheftool.NewPagedResourceAction
state attribute names.
STATE_VIEW_ID - Static variable in class org.sakaiproject.cheftool.PagedResourceAction
state attribute names.
STATE_VIEW_ID - Static variable in class org.sakaiproject.cheftool.PagedResourceActionII
state attribute names.
STATE_VIEW_ID - Static variable in class org.sakaiproject.cheftool.PagedResourceHelperAction
state attribute names.
STREAM_BUFFER_SIZE - Static variable in class org.sakaiproject.util.FileItem
The chunk size used when streaming (100k).
switchPanel(SessionState, String) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Switch to a new panel

T

TITLE_PANEL - Variable in class org.sakaiproject.cheftool.ToolServlet
The special panel name for the title.
titlePanelUpdateId(String) - Static method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Compute the courier update html element id for the title panel.
TOOL_MODE_ATTR - Variable in class org.sakaiproject.cheftool.ToolServlet
The mode attribute name base - postfix with the portlet mode.
TOOL_MODE_DEFAULT - Variable in class org.sakaiproject.cheftool.ToolServlet
The mode value when no mode has been set.
toolModeDispatch(String, String, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Dispatch to a "do" method based on reflection.
toolModeDispatch(String, String, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Dispatch to a "do" method based on reflection.
ToolServlet - Class in org.sakaiproject.cheftool
ToolServlet is a Servlet that support CHEF tools.
ToolServlet() - Constructor for class org.sakaiproject.cheftool.ToolServlet
 
toString() - Method in class org.sakaiproject.vm.ActionURL
Reneder the URL with parameters
totalPageNumber(SessionState) - Method in class org.sakaiproject.cheftool.NewPagedResourceAction
Return the total page number
totalPageNumber(SessionState) - Method in class org.sakaiproject.cheftool.PagedResourceActionII
Return the total page number

U

update(Observable, Object) - Method in class org.sakaiproject.cheftool.ControllerState
This method is called whenever the observed object is changed.
updateState(SessionState, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.ToolServlet
Update for this request processing the session state.
updateState(SessionState, HttpServletRequest, HttpServletResponse) - Method in class org.sakaiproject.cheftool.VelocityPortletPaneledAction
Update for this request processing the session state.

V

values() - Method in class org.sakaiproject.cheftool.PortletConfig
 
VelocityPortlet - Class in org.sakaiproject.cheftool
 
VelocityPortlet(String, PortletConfig) - Constructor for class org.sakaiproject.cheftool.VelocityPortlet
 
VelocityPortletPaneledAction - Class in org.sakaiproject.cheftool
VelocityPortletPaneledAction ...
VelocityPortletPaneledAction() - Constructor for class org.sakaiproject.cheftool.VelocityPortletPaneledAction
 
VelocityPortletStateAction - Class in org.sakaiproject.cheftool
VelocityPortletStateAction is an extension of VelocityPortletAction which provides a way to associate Controller state with each instances of the portlet using this action.
VelocityPortletStateAction() - Constructor for class org.sakaiproject.cheftool.VelocityPortletStateAction
 
VelocityServlet - Class in org.sakaiproject.vm
Responds with the expansion of a Velocity Template.
VelocityServlet() - Constructor for class org.sakaiproject.vm.VelocityServlet
 
VmServlet - Class in org.sakaiproject.cheftool
VmServlet adds a standard validator to the VmServlet from the velocity module VmServlet.
VmServlet() - Constructor for class org.sakaiproject.cheftool.VmServlet
 
VmServlet - Class in org.sakaiproject.vm
VmServlet is a Servlet that makes use of the Velocity Template Engine.
VmServlet() - Constructor for class org.sakaiproject.vm.VmServlet
 
A B C D E F G H I J K L M N O P R S T U V 
Skip navigation links

Copyright © 2003–2021 Sakai Project. All rights reserved.