|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.portlet.GenericPortlet
org.apache.portals.bridges.common.GenericServletPortlet
org.apache.portals.bridges.jsf.FacesPortlet
public class FacesPortlet
FacesPortlet utilizes Java Server Faces to create the user interface in a portlet environment.
Field Summary | |
---|---|
static String |
ACTION_REQUEST
Action request. |
static String |
CUSTOM_REQUEST
Custom request. |
static String |
EDIT_REQUEST
Edit request. |
static String |
FACES_MESSAGES
FacesMessage objects on portlet session |
static String |
HELP_REQUEST
Help request. |
static String |
JSF_CUSTOM_ID
|
static String |
JSF_EDIT_ID
|
static String |
JSF_HELP_ID
|
static String |
JSF_VIEW_ID
The JSF_VIEW_ID used to maintain the state of the view action. |
static String |
PARAM_ACTION_PAGE
Name of portlet preference for Action page. |
static String |
PARAM_CUSTOM_PAGE
Name of portlet preference for Custom page. |
static String |
PARAM_EDIT_PAGE
Name of portlet preference for Edit page. |
static String |
PARAM_HELP_PAGE
Name of portlet preference for Edit page |
static String |
PARAM_UNIQUE_IDS
Override default behavior for Unique IDS |
static String |
PARAM_VIEW_PAGE
Name of portlet preference for View page |
static String |
REQUEST_SERVLET_PATH
The REQUEST_SERVLET_PATH used for externalContext.getRequestServletPath(). |
static String |
REQUEST_TYPE
The REQUEST_TYPE request attribute can be used to determine the Portlet request type ( ACTION_REQUEST , VIEW_REQUEST ,
HELP_REQUEST , EDIT_REQUEST or CUSTOM_REQUEST )
of the current request. |
static String |
VIEW_REQUEST
View request. |
static String |
VIEW_ROOT
The VIEW_ROOT used to keep track of action between the action request and the render request. |
Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet |
---|
PARAM_ALLOW_PREFERENCES, PARAM_MAX_PAGE |
Constructor Summary | |
---|---|
FacesPortlet()
|
Method Summary | |
---|---|
protected void |
cleanUpAfterPortal(javax.portlet.PortletRequest request,
javax.portlet.PortletResponse response)
Removes temporary JSF attributes from the request. |
void |
destroy()
Release all resources acquired at startup time. |
void |
doCustom(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doEdit(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doHelp(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
void |
doView(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
|
javax.faces.context.FacesContextFactory |
getFacesContextFactory()
Gets the FacesContextFactory . |
javax.faces.lifecycle.Lifecycle |
getLifecycle()
Get the faces life cycle. |
void |
init(javax.portlet.PortletConfig portletConfig)
Acquire the factory instance we will require. |
protected void |
preProcessFaces(javax.faces.context.FacesContext context)
|
void |
processAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
|
Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet |
---|
getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage |
Methods inherited from class javax.portlet.GenericPortlet |
---|
doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, render |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String VIEW_ROOT
public static final String REQUEST_SERVLET_PATH
public static final String REQUEST_TYPE
ACTION_REQUEST
, VIEW_REQUEST
,
HELP_REQUEST
, EDIT_REQUEST
or CUSTOM_REQUEST
)
of the current request.
public static final String JSF_VIEW_ID
public static final String JSF_EDIT_ID
public static final String JSF_HELP_ID
public static final String JSF_CUSTOM_ID
public static final String PARAM_ACTION_PAGE
public static final String PARAM_CUSTOM_PAGE
public static final String PARAM_EDIT_PAGE
public static final String PARAM_HELP_PAGE
public static final String PARAM_VIEW_PAGE
public static final String ACTION_REQUEST
public static final String VIEW_REQUEST
public static final String CUSTOM_REQUEST
public static final String EDIT_REQUEST
public static final String HELP_REQUEST
public static final String FACES_MESSAGES
public static final String PARAM_UNIQUE_IDS
Constructor Detail |
---|
public FacesPortlet()
Method Detail |
---|
public void destroy()
Release all resources acquired at startup time.
destroy
in interface javax.portlet.Portlet
destroy
in class javax.portlet.GenericPortlet
public void init(javax.portlet.PortletConfig portletConfig) throws javax.portlet.PortletException
Acquire the factory instance we will require.
init
in interface javax.portlet.Portlet
init
in class GenericServletPortlet
javax.portlet.PortletException
- if, for any reason, the startp of this Faces application
failed. This includes errors in the config file that is
parsed before or during the processing of this
init()
method.public void doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
doEdit
in class GenericServletPortlet
javax.portlet.PortletException
IOException
GenericPortlet.doEdit(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
public void doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
doHelp
in class GenericServletPortlet
javax.portlet.PortletException
IOException
GenericPortlet.doHelp(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
public void doCustom(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
doCustom
in class GenericServletPortlet
request
- The RenderRequest
.response
- The RenderResponse
.
javax.portlet.PortletException
- Throws a PortletException
.
IOException
- Throws a IOException
.public void doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) throws javax.portlet.PortletException, IOException
doView
in class GenericServletPortlet
javax.portlet.PortletException
IOException
GenericPortlet.doView(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
public void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) throws javax.portlet.PortletException, IOException
processAction
in interface javax.portlet.Portlet
processAction
in class GenericServletPortlet
javax.portlet.PortletException
IOException
Portlet.processAction(javax.portlet.ActionRequest,
javax.portlet.ActionResponse)
public javax.faces.context.FacesContextFactory getFacesContextFactory() throws javax.portlet.PortletException
Gets the FacesContextFactory
.
FacesContextFactory
.
javax.portlet.PortletException
- Throws a PortletException
.public javax.faces.lifecycle.Lifecycle getLifecycle() throws javax.portlet.PortletException
Get the faces life cycle.
Lifecycle
.
javax.portlet.PortletException
- Throws a PortletException
.protected void preProcessFaces(javax.faces.context.FacesContext context)
protected void cleanUpAfterPortal(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response)
request
- portlet request we are processingresponse
- portlet response we are processing
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |