A B C D E F G H I J L N O P R S T U V

A

ABORT - Static variable in interface org.sakaiproject.portal.api.PortalHandler
Return codes, stop processing immediately
addHandler(Portal, PortalHandler) - Method in interface org.sakaiproject.portal.api.PortalService
Add a PortalHandler to the portal Handler map for the named context.
addHandler(String, PortalHandler) - Method in interface org.sakaiproject.portal.api.PortalService
Add a PortalHandler when you don't have a reference to the portal.
addPortal(Portal) - Method in interface org.sakaiproject.portal.api.PortalService
Remove a portal from the portal service this should perform all the necessary cleanup
addRenderEngine(String, PortalRenderEngine) - Method in interface org.sakaiproject.portal.api.PortalService
add a render engine to the available render engines.
allowTool(Site, Placement) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
 
ATTR_ERROR - Static variable in interface org.sakaiproject.portal.api.Portal
ThreadLocal attribute set while we are processing an error.
ATTR_MAXIMIZED_URL - Static variable in interface org.sakaiproject.portal.api.Portal
Session variable passing a maximized URL between a portlet and the portal
ATTR_SITE_PAGE - Static variable in interface org.sakaiproject.portal.api.Portal
Session attribute root for storing a site's last page visited - just append the site id.

B

BaseEditor - Class in org.sakaiproject.portal.api
Nominal implementation of the Editor interface.
BaseEditor() - Constructor for class org.sakaiproject.portal.api.BaseEditor
 
BaseEditor(String, String, String, String) - Constructor for class org.sakaiproject.portal.api.BaseEditor
 
BaseEditor(String, String, String, String, String) - Constructor for class org.sakaiproject.portal.api.BaseEditor
 

C

calcSiteType(String) - Method in interface org.sakaiproject.portal.api.Portal
work out the type of the site based on the site id.
CONFIG_AUTO_RESET - Static variable in interface org.sakaiproject.portal.api.Portal
Configuration option to enable/disable state reset on navigation change
CONFIG_DEFAULT_TABS - Static variable in interface org.sakaiproject.portal.api.Portal
Configuration option for default number of site tabs to display to users

D

decodeToolState(Map<String, String[]>, String) - Method in interface org.sakaiproject.portal.api.PortalService
Inverts the operation of encodeToolState, and returns the URL stub which was supplied for the supplied placementId.
DEFAULT_PORTAL_CONTEXT - Static variable in interface org.sakaiproject.portal.api.Portal
The default portal name is none is specified.
deregister(Portal) - Method in interface org.sakaiproject.portal.api.PortalHandler
deregister the the portal, invoked by the portal
doError(HttpServletRequest, HttpServletResponse, Session, int) - Method in interface org.sakaiproject.portal.api.Portal
populate the model with error status
doGatewaySiteList() - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
 
doGet(String[], HttpServletRequest, HttpServletResponse, Session) - Method in interface org.sakaiproject.portal.api.PortalHandler
Perform a get, the method should inspect parts[] and other parameters to determin if it should perform the operation, returning one of the above codes
doLogin(HttpServletRequest, HttpServletResponse, Session, String, boolean) - Method in interface org.sakaiproject.portal.api.Portal
perform login
doLogout(HttpServletRequest, HttpServletResponse, Session, String) - Method in interface org.sakaiproject.portal.api.Portal
Process a logout
doPost(String[], HttpServletRequest, HttpServletResponse, Session) - Method in interface org.sakaiproject.portal.api.PortalHandler
perform a post but only accept it the handler accepts a post.
dump() - Method in interface org.sakaiproject.portal.api.PortalRenderContext
Convert the render context to a string suitable for dumping to a log file or console.

E

Editor - Interface in org.sakaiproject.portal.api
Interface to encapsulate information needed to register pluggable editors and use them within the Sakai portal and Tool system.
EditorRegistry - Interface in org.sakaiproject.portal.api
 
encodeToolState(String, String) - Method in interface org.sakaiproject.portal.api.PortalService
Returns a parameter map suitable for appending to a portal URL, representing that the URL state of a tool being shown with the specified placementId will be equal to the URLstub.
END - Static variable in interface org.sakaiproject.portal.api.PortalHandler
Stop processing
equals(Object) - Method in class org.sakaiproject.portal.api.BaseEditor
 
ERROR_GALLERY - Static variable in interface org.sakaiproject.portal.api.Portal
 
ERROR_SITE - Static variable in interface org.sakaiproject.portal.api.Portal
Error response modes.
ERROR_WORKSITE - Static variable in interface org.sakaiproject.portal.api.Portal
 

F

filter(List, Site) - Method in interface org.sakaiproject.portal.api.PageFilter
 
filterPlacements(List<Map>, Site) - Method in interface org.sakaiproject.portal.api.PageFilter
Filter the list of placements, potentially making them hierachical if required
findCookie(HttpServletRequest, String) - Method in interface org.sakaiproject.portal.api.Portal
Find a cookie by this name from the request
FORCE_CLASSIC_COOKIE_VALUE - Static variable in interface org.sakaiproject.portal.api.Portal
Value that this cookie will have if we are forcing classic mode
FORCE_CLASSIC_REQ_PARAM - Static variable in interface org.sakaiproject.portal.api.Portal
Parameter to signal that we should force the request back to the normal portal view rather than the PDA portal view.
forwardPortal(ActiveTool, HttpServletRequest, HttpServletResponse, ToolConfiguration, String, String, String) - Method in interface org.sakaiproject.portal.api.Portal
forward to a portal url
forwardTool(ActiveTool, HttpServletRequest, HttpServletResponse, Placement, String, String, String) - Method in interface org.sakaiproject.portal.api.Portal
forward the request to a tool
FRAMESET_SUPPORT - Static variable in interface org.sakaiproject.portal.api.Portal
Configuration option indicaing support for frame set mode.

G

generateJavaScript(String) - Method in interface org.sakaiproject.portal.api.StyleAbleProvider
Generate the javascript in the header for the user
generateStyleSheet(String) - Method in interface org.sakaiproject.portal.api.StyleAbleProvider
Generate the StyleSheet in the header for the user
getActiveEditor() - Method in interface org.sakaiproject.portal.api.PortalService
Retrieve the activated system-wide Editor.
getActiveEditor(Placement) - Method in interface org.sakaiproject.portal.api.PortalService
Retrieve the activated Editor, considering the tool Placement.
getApplicationContext() - Method in interface org.sakaiproject.portal.api.PortletApplicationDescriptor
The name of the context (servlet context)
getApplicationId() - Method in interface org.sakaiproject.portal.api.PortletApplicationDescriptor
The application ID
getApplicationName() - Method in interface org.sakaiproject.portal.api.PortletApplicationDescriptor
The name of the portlet
getBrowserCollectionId(Placement) - Method in interface org.sakaiproject.portal.api.PortalService
Retrieves the site collection ID for a placement for file browsing to an appropriate location.
getContentHostingService() - Method in interface org.sakaiproject.portal.api.PortalService
Bean getter for Content Hosting dependency.
getEditor(String) - Method in interface org.sakaiproject.portal.api.EditorRegistry
Retrieve an Editor by its ID.
getEditorRegistry() - Method in interface org.sakaiproject.portal.api.PortalService
Bean getter for Editor Registry.
getEditors() - Method in interface org.sakaiproject.portal.api.EditorRegistry
Retrieve a list of all registered Editors.
getEditorUrl() - Method in class org.sakaiproject.portal.api.BaseEditor
 
getEditorUrl() - Method in interface org.sakaiproject.portal.api.Editor
Retrieve the URL of the Editor's primary script.
getGatewaySiteId() - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
 
getHandlerMap(Portal) - Method in interface org.sakaiproject.portal.api.PortalService
Get the PortalHandler map for the portal Context.
getId() - Method in class org.sakaiproject.portal.api.BaseEditor
 
getId() - Method in interface org.sakaiproject.portal.api.Editor
Retrieve the unique identifier of this Editor.
getInstance() - Static method in class org.sakaiproject.portal.api.cover.PortalService
Access the component instance: special cover only method.
getLaunchUrl() - Method in class org.sakaiproject.portal.api.BaseEditor
 
getLaunchUrl() - Method in interface org.sakaiproject.portal.api.Editor
Retrieve the URL of the Sakai launch script for this Editor.
getMyWorkspace(Session) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
 
getName() - Method in class org.sakaiproject.portal.api.BaseEditor
 
getName() - Method in interface org.sakaiproject.portal.api.Editor
Retrieve the formal name of this Editor.
getPageFilter() - Method in interface org.sakaiproject.portal.api.Portal
Get a the page Filter Implementation
getPlacement(HttpServletRequest, HttpServletResponse, Session, String, boolean) - Method in interface org.sakaiproject.portal.api.Portal
get the placement for the request
getPlacement() - Method in interface org.sakaiproject.portal.api.StoredState
Get the placement of the stored state
getPortalContext() - Method in interface org.sakaiproject.portal.api.Portal
Get the context name of the portal.
getPortalPageUrl(ToolConfiguration) - Method in interface org.sakaiproject.portal.api.Portal
get the portal page URL base on the tool supplied
getPortletId() - Method in interface org.sakaiproject.portal.api.PortletDescriptor
the ID of the portlet
getPortletName() - Method in interface org.sakaiproject.portal.api.PortletDescriptor
The name of the portlet
getPortlets() - Method in interface org.sakaiproject.portal.api.PortletApplicationDescriptor
An interator of portlet descriptions
getPreloadScript() - Method in class org.sakaiproject.portal.api.BaseEditor
 
getPreloadScript() - Method in interface org.sakaiproject.portal.api.Editor
Retrieve any inline script that should be run before loading this Editor.
getRegisteredApplications() - Method in interface org.sakaiproject.portal.api.PortalService
Get an Iterator of Portlet Application Descriptors from the whole of the application
getRenderContextObject() - Method in interface org.sakaiproject.portal.api.SiteView
gets the representation for the render context
getRenderEngine() - Method in interface org.sakaiproject.portal.api.PortalRenderContext
Get the render engine associated with this context.
getRenderEngine(String, HttpServletRequest) - Method in interface org.sakaiproject.portal.api.PortalService
get a render engine possibly based on the request
getRequest(HttpServletRequest) - Method in interface org.sakaiproject.portal.api.StoredState
Get the request of the stored state
getResetState() - Method in interface org.sakaiproject.portal.api.PortalService
get the state of the state of the portal reset flag
getResetStateParam() - Method in interface org.sakaiproject.portal.api.PortalService
Get the parameter used to communicate reset state operations on the URL
getServletContext() - Method in interface org.sakaiproject.portal.api.Portal
Get the servlet context associated with the portal
getSiteHelper() - Method in interface org.sakaiproject.portal.api.Portal
 
getSiteNeighbourhoodService() - Method in interface org.sakaiproject.portal.api.Portal
 
getSiteNeighbourhoodService() - Method in interface org.sakaiproject.portal.api.PortalService
 
getSitesAtNode(HttpServletRequest, Session, boolean) - Method in interface org.sakaiproject.portal.api.SiteNeighbourhoodService
Get a list of sites at the current node as defined by the request
getSitesView(SiteView.View, HttpServletRequest, Session, String) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
Generates a SiteView object from the current request and location
getSiteVisit(String) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
 
getSkin() - Method in interface org.sakaiproject.portal.api.StoredState
Get the skin associated with the stored state
getStoredState() - Method in interface org.sakaiproject.portal.api.PortalService
get the StoredState object that is used to hold initial request state on direct access to a portlet state or on GET or POST that requires other initial actions.
getStylableService() - Method in interface org.sakaiproject.portal.api.PortalService
Get the implimentation of the StylableService from the portal impl
getToolContextPath() - Method in interface org.sakaiproject.portal.api.StoredState
Get the Tool Context Path that the state was stored against
getToolPathInfo() - Method in interface org.sakaiproject.portal.api.StoredState
Get the Path info to the target tool
getUrlFragment() - Method in interface org.sakaiproject.portal.api.PortalHandler
get the fragment of the URL that represents part[1] and is used to register the handler in the portal.
getUserEidBasedSiteId(String) - Method in interface org.sakaiproject.portal.api.Portal
get the site id for the user

H

hashCode() - Method in class org.sakaiproject.portal.api.BaseEditor
 

I

includeBottom(PortalRenderContext) - Method in interface org.sakaiproject.portal.api.Portal
include the model section that relates to the bottom of the page.
includeLogin(PortalRenderContext, HttpServletRequest, Session) - Method in interface org.sakaiproject.portal.api.Portal
include the part od the view tree needed to render login
includePortal(HttpServletRequest, HttpServletResponse, Session, String, String, String, String, boolean, boolean, boolean, boolean) - Method in interface org.sakaiproject.portal.api.Portal
populate the view tree for the model
includeSubSites(PortalRenderContext, HttpServletRequest, Session, String, String, String, boolean) - Method in interface org.sakaiproject.portal.api.Portal
Return the sub sites below a particular site Map.
includeTool(HttpServletResponse, HttpServletRequest, ToolConfiguration) - Method in interface org.sakaiproject.portal.api.Portal
include the tool part of the view tree
init() - Method in interface org.sakaiproject.portal.api.PortalRenderEngine
Initialise the render engine
isEmpty() - Method in interface org.sakaiproject.portal.api.SiteView
is the SiteView empty.
isEnableDirect() - Method in interface org.sakaiproject.portal.api.PortalService
Is the direct URL mechnism enabled in the configation file.
isPortletPlacement(Placement) - Method in interface org.sakaiproject.portal.api.Portal
Indicate if a placement is a JSR-168 placement
isResetRequested(HttpServletRequest) - Method in interface org.sakaiproject.portal.api.PortalService
Was a reset requested

J

JSR_168_PRE_RENDER - Static variable in interface org.sakaiproject.portal.api.Portal
Tool property used to indicate if JSR_168 tools are to be pre-rendered as they are being placed in the context.

L

lookupPageToAlias(String, SitePage) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
Find an alias for a page.
lookupSiteAlias(String, String) - Method in interface org.sakaiproject.portal.api.SiteNeighbourhoodService
Convert an ID that is normally displayed in the URL into something more readable.
lookupSitePage(String, Site) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
 

N

newRenderContext(HttpServletRequest) - Method in interface org.sakaiproject.portal.api.PortalRenderEngine
generate a non thread safe render context for the current request/thread/operation
newStoredState(String, String) - Method in interface org.sakaiproject.portal.api.PortalService
Create a new Stored State
NEXT - Static variable in interface org.sakaiproject.portal.api.PortalHandler
try next handler

O

org.sakaiproject.portal.api - package org.sakaiproject.portal.api
 
org.sakaiproject.portal.api.cover - package org.sakaiproject.portal.api.cover
 

P

PageFilter - Interface in org.sakaiproject.portal.api
 
pageListToMap(HttpServletRequest, boolean, Site, SitePage, String, String, boolean, boolean, boolean) - Method in interface org.sakaiproject.portal.api.PortalSiteHelper
Iterate through the pages in a site and return information in a Map.
PARAM_FORCE_LOGIN - Static variable in interface org.sakaiproject.portal.api.Portal
Parameter value to allow anonymous users of gallery mode to be sent to the gateway site as anonymous user (like the /portal URL) instead of making them log in (like worksite, site, and tool URLs).
PARAM_FORCE_LOGOUT - Static variable in interface org.sakaiproject.portal.api.Portal
 
parseSiteAlias(String) - Method in interface org.sakaiproject.portal.api.SiteNeighbourhoodService
Attempt to convert an alias back into a site reference.
PLACEMENT_ATTRIBUTE - Static variable in interface org.sakaiproject.portal.api.PortalService
A portal request scope attribute that reprenset the placement id of the current request.
Portal - Interface in org.sakaiproject.portal.api
This interface represents a portal and is used mainly by portal handlers that will not know the details of the portal implimentation.
PORTAL_MODE_COOKIE_NAME - Static variable in interface org.sakaiproject.portal.api.Portal
Name of cookie that is set to signal what view we want It is an abstract name to we can later set other preferred modes into same cookie if desired
PortalHandler - Interface in org.sakaiproject.portal.api
Tools that want to add handlers into the portal URL space may impliment this interface.
PortalHandlerException - Exception in org.sakaiproject.portal.api
Throw when a portal handler fails to handle a request
PortalHandlerException() - Constructor for exception org.sakaiproject.portal.api.PortalHandlerException
 
PortalHandlerException(String) - Constructor for exception org.sakaiproject.portal.api.PortalHandlerException
 
PortalHandlerException(Throwable) - Constructor for exception org.sakaiproject.portal.api.PortalHandlerException
 
PortalHandlerException(String, Throwable) - Constructor for exception org.sakaiproject.portal.api.PortalHandlerException
 
PortalRenderContext - Interface in org.sakaiproject.portal.api
This interface represent the Render Context, it allows the portal implementation to put values into the render context.
PortalRenderEngine - Interface in org.sakaiproject.portal.api
Repesents the API used by the protal to comunicate with the RenderEngine implimentation.
PortalService - Class in org.sakaiproject.portal.api.cover
A cover to the portal service.
PortalService() - Constructor for class org.sakaiproject.portal.api.cover.PortalService
 
PortalService - Interface in org.sakaiproject.portal.api
Portal Service acts as a focus for all Portal based activities, the service implementation should act as a holder to enable the varous webapps to communicate with one annother.
PortalSiteHelper - Interface in org.sakaiproject.portal.api
 
PortletApplicationDescriptor - Interface in org.sakaiproject.portal.api
Describes a Portlet application when it is loaded into the Web Container
PortletDescriptor - Interface in org.sakaiproject.portal.api
Describes the Portlet
PREFER_MAXIMIZE - Static variable in interface org.sakaiproject.portal.api.Portal
Tool property used to indicate if a tool prefers a maximized view with minimal portal navigation.
put(String, Object) - Method in interface org.sakaiproject.portal.api.PortalRenderContext
Set a value agaaisnt a Key, normally a value might be a String, Collection or a Map, but depending on the render engine technology other objects may be acceptable.

R

redirectIfLoggedOut(HttpServletResponse) - Method in interface org.sakaiproject.portal.api.Portal
perform a redirect if logged out
register(Editor) - Method in interface org.sakaiproject.portal.api.EditorRegistry
Registers an instantiated Editor for portal use.
register(String, String, String, String, String) - Method in interface org.sakaiproject.portal.api.EditorRegistry
Registers an editor for portal use by supplying requisite values instead of an instance.
register(Portal, PortalService, ServletContext) - Method in interface org.sakaiproject.portal.api.PortalHandler
register this handler with the portal, invoked by the portal
removeHandler(Portal, String) - Method in interface org.sakaiproject.portal.api.PortalService
Remove the Portal Handler identitied by the URL fragment associated with the portal Context
removeHandler(String, String) - Method in interface org.sakaiproject.portal.api.PortalService
Remove a PortalHandler when you don't have a reference to the portal.
removePortal(Portal) - Method in interface org.sakaiproject.portal.api.PortalService
Add a portal to the portal service
removeRenderEngine(String, PortalRenderEngine) - Method in interface org.sakaiproject.portal.api.PortalService
remove a render engine from the avaialble render engines
render(String, PortalRenderContext, Writer) - Method in interface org.sakaiproject.portal.api.PortalRenderEngine
Render a PortalRenderContext against a template.
RESET_DONE - Static variable in interface org.sakaiproject.portal.api.PortalHandler
stop processing and mark reset as done

S

SAKAI_NAV_MINIMIZED - Static variable in interface org.sakaiproject.portal.api.Portal
Name of cookie that is set to signal that the user wants us to start minimized
SAKAI_PORTAL_ALLOW_NEO - Static variable in interface org.sakaiproject.portal.api.Portal
Constants for SAK-19455 - The NEO Portlet Feature that allows a portlet to suppress its title and add to the system breadcrumbs.
SAKAI_PORTAL_BREADCRUMBS - Static variable in interface org.sakaiproject.portal.api.Portal
 
SAKAI_PORTAL_HELP_ACTION - Static variable in interface org.sakaiproject.portal.api.Portal
 
SAKAI_PORTAL_RESET_ACTION - Static variable in interface org.sakaiproject.portal.api.Portal
 
SAKAI_PORTAL_SUPPRESSTITLE - Static variable in interface org.sakaiproject.portal.api.Portal
 
sendResponse(PortalRenderContext, HttpServletResponse, String, String) - Method in interface org.sakaiproject.portal.api.Portal
prepare the response and send it to the render engine
setContentHostingService(ContentHostingService) - Method in interface org.sakaiproject.portal.api.PortalService
Bean setter for Content Hosting dependency.
setDoPages(boolean) - Method in interface org.sakaiproject.portal.api.SiteView
 
setEditorRegistry(EditorRegistry) - Method in interface org.sakaiproject.portal.api.PortalService
Bean setter for Editor Registry.
setEditorUrl(String) - Method in class org.sakaiproject.portal.api.BaseEditor
 
setExpandSite(boolean) - Method in interface org.sakaiproject.portal.api.SiteView
 
setId(String) - Method in class org.sakaiproject.portal.api.BaseEditor
 
setIncludeSummary(boolean) - Method in interface org.sakaiproject.portal.api.SiteView
 
setLaunchUrl(String) - Method in class org.sakaiproject.portal.api.BaseEditor
 
setName(String) - Method in class org.sakaiproject.portal.api.BaseEditor
 
setPageFilter(PageFilter) - Method in interface org.sakaiproject.portal.api.Portal
Set page Filter
setPlacement(Placement) - Method in interface org.sakaiproject.portal.api.StoredState
set the placement
setPrefix(String) - Method in interface org.sakaiproject.portal.api.SiteView
The prefix for creating site URLs.
setPreloadScript(String) - Method in class org.sakaiproject.portal.api.BaseEditor
 
setRequest(HttpServletRequest) - Method in interface org.sakaiproject.portal.api.StoredState
Set the request in the stored state
setResetState(String) - Method in interface org.sakaiproject.portal.api.PortalService
ste the state of the portal reset flag.
setResetTools(boolean) - Method in interface org.sakaiproject.portal.api.SiteView
 
setSkin(String) - Method in interface org.sakaiproject.portal.api.StoredState
set the skin
setStoredState(StoredState) - Method in interface org.sakaiproject.portal.api.PortalService
set the StoredState of the request for later retrieval
setToolContextPath(String) - Method in interface org.sakaiproject.portal.api.SiteView
required
setToolContextPath(String) - Method in interface org.sakaiproject.portal.api.StoredState
set the tool context
setToolPathInfo(String) - Method in interface org.sakaiproject.portal.api.StoredState
set the tool path info
setupForward(HttpServletRequest, HttpServletResponse, Placement, String) - Method in interface org.sakaiproject.portal.api.Portal
setup in preparation for a forward
setupForward(HttpServletRequest, HttpServletResponse, Placement, String) - Method in interface org.sakaiproject.portal.api.PortalRenderEngine
prepare for a forward operation in the render engine, this might include modifying the request attributes.
setupMobileDevice(HttpServletRequest, PortalRenderContext) - Method in interface org.sakaiproject.portal.api.Portal
Look at the user agent and add Mobile Browser related material to the context.
SiteNeighbourhoodService - Interface in org.sakaiproject.portal.api
The SiteNeighbourhoodService provides a list of sites in the neighbourhood of the current context.
SiteView - Interface in org.sakaiproject.portal.api
This interface represents a view of a the Site cloud from a particuar view point.
SiteView.View - Enum in org.sakaiproject.portal.api
 
startPageContext(String, String, String, HttpServletRequest) - Method in interface org.sakaiproject.portal.api.Portal
get a new render context from the render engine
StoredState - Interface in org.sakaiproject.portal.api
Stored state is used to store the request state over a number of requests, It is used to restore state over a login sequence of during a direct placement into a tool state.
StyleAbleProvider - Interface in org.sakaiproject.portal.api
This interface should be implemented by a Stylable provider to control the portal in the browser either by CSS or by javascript manipulation of the DOM in the browser.

T

TOOL_PORTLET_APP_NAME - Static variable in interface org.sakaiproject.portal.api.PortalService
this is the property in the tool config that defines the name of the portlet application
TOOL_PORTLET_CONTEXT_PATH - Static variable in interface org.sakaiproject.portal.api.PortalService
this is the property in the tool config that defines the portlet context of tool.
TOOL_PORTLET_NAME - Static variable in interface org.sakaiproject.portal.api.PortalService
this is the property in the tool config that defines the name of the portlet
TOOLCONFIG_HELP_DOCUMENT_ID - Static variable in interface org.sakaiproject.portal.api.Portal
 
TOOLCONFIG_HELP_DOCUMENT_URL - Static variable in interface org.sakaiproject.portal.api.Portal
 
TOOLCONFIG_SHOW_HELP_BUTTON - Static variable in interface org.sakaiproject.portal.api.Portal
 
TOOLCONFIG_SHOW_RESET_BUTTON - Static variable in interface org.sakaiproject.portal.api.Portal
Names of tool config/registration attributes that control the rendering of the tool's titlebar

U

unregister(Editor) - Method in interface org.sakaiproject.portal.api.EditorRegistry
Unregister an Editor, making it unavailable.
unregister(String) - Method in interface org.sakaiproject.portal.api.EditorRegistry
Unregister an Editor by its ID, making it unavailable.
uses(String) - Method in interface org.sakaiproject.portal.api.PortalRenderContext
Return true if the context needs this part of the portal

V

valueOf(String) - Static method in enum org.sakaiproject.portal.api.SiteView.View
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.sakaiproject.portal.api.SiteView.View
Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I J L N O P R S T U V

Copyright © 2003-2012 Sakai Project. All Rights Reserved.