org.apache.wicket.examples.portlet.menu
Class WicketExamplesMenuPortlet

java.lang.Object
  extended by javax.portlet.GenericPortlet
      extended by org.apache.wicket.protocol.http.portlet.WicketPortlet
          extended by org.apache.wicket.examples.portlet.menu.WicketExamplesMenuPortlet
All Implemented Interfaces:
javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public class WicketExamplesMenuPortlet
extends WicketPortlet

Author:
Ate Douma

Field Summary
static String EXAMPLE_APPLICATION_ATTR
           
static String EXAMPLE_APPLICATION_PREF
           
static String EXAMPLES
           
static String PARAM_HEADER_PAGE
          Name of portlet init Parameter for the ExampleHeader page
 
Fields inherited from class org.apache.wicket.protocol.http.portlet.WicketPortlet
CONFIG_PARAM_PREFIX, PARAM_ACTION_PAGE, PARAM_CUSTOM_PAGE, PARAM_EDIT_PAGE, PARAM_HELP_PAGE, PARAM_VIEW_PAGE, RESPONSE_STATE_ATTR, WICKET_FILTER_PATH, WICKET_FILTER_PATH_PARAM, WICKET_FILTER_QUERY, WICKET_PORTLET_PROPERTIES, WICKET_URL_PORTLET_PARAMETER, WICKET_URL_PORTLET_PARAMETER_ATTR
 
Constructor Summary
WicketExamplesMenuPortlet()
           
 
Method Summary
protected  List<ExampleApplication> discoverExamples(javax.portlet.PortletContext portletContext)
           
protected  String getWicketConfigParameter(javax.portlet.PortletRequest request, String paramName, String defaultValue)
          FIXME javadoc - definitely needs explanation - why is no lookup attempted?
protected  String getWicketURL(javax.portlet.PortletRequest request, String pageType, String defaultPage)
          Retrieves the Wicket URL from the request object as a request parameter, or if none exists returns the default URL.
protected  String getWicketUrlPortletParameter(javax.portlet.PortletRequest request)
           
 void init(javax.portlet.PortletConfig config)
           
protected  void processRequest(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, String pageType)
          Consumes and processes all portlet requests.
 
Methods inherited from class org.apache.wicket.protocol.http.portlet.WicketPortlet
buildWicketFilterPath, buildWicketFilterQuery, destroy, doCustom, doEdit, doHelp, doView, fixWicketUrl, getDefaultPage, getWicketFilterPath, getWicketPortletProperties, processAction, processActionResponseState, serveResource, validateDefaultPages
 
Methods inherited from class javax.portlet.GenericPortlet
doDispatch, doHeaders, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processEvent, render
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

EXAMPLE_APPLICATION_PREF

public static final String EXAMPLE_APPLICATION_PREF
See Also:
Constant Field Values

EXAMPLES

public static final String EXAMPLES

EXAMPLE_APPLICATION_ATTR

public static final String EXAMPLE_APPLICATION_ATTR

PARAM_HEADER_PAGE

public static final String PARAM_HEADER_PAGE
Name of portlet init Parameter for the ExampleHeader page

See Also:
Constant Field Values
Constructor Detail

WicketExamplesMenuPortlet

public WicketExamplesMenuPortlet()
Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException
Specified by:
init in interface javax.portlet.Portlet
Overrides:
init in class WicketPortlet
Throws:
javax.portlet.PortletException
See Also:
WicketPortlet.init(javax.portlet.PortletConfig)

getWicketConfigParameter

protected String getWicketConfigParameter(javax.portlet.PortletRequest request,
                                          String paramName,
                                          String defaultValue)
Description copied from class: WicketPortlet
FIXME javadoc - definitely needs explanation - why is no lookup attempted?

Overrides:
getWicketConfigParameter in class WicketPortlet
Returns:
See Also:
WicketPortlet.getWicketConfigParameter(javax.portlet.PortletRequest, java.lang.String, java.lang.String)

getWicketUrlPortletParameter

protected String getWicketUrlPortletParameter(javax.portlet.PortletRequest request)
Overrides:
getWicketUrlPortletParameter in class WicketPortlet
Returns:
The prefix for the parameter name for storing Wicket URLs.
See Also:
WicketPortlet.getWicketUrlPortletParameter(javax.portlet.PortletRequest)

getWicketURL

protected String getWicketURL(javax.portlet.PortletRequest request,
                              String pageType,
                              String defaultPage)
Description copied from class: WicketPortlet
Retrieves the Wicket URL from the request object as a request parameter, or if none exists returns the default URL. The name of the request parameter is stored as a request attribute.

This url is then used to pass on to the matching WicketFilter to process, by way of RequestDispatcher via the filters context path.

A "parameter" is a form field name/value pair passed from the HTML side of the world. Its value is a String.

An "attribute" is a Java object name/value pair passed only through the internal JavaServer processes. (I.e. it can come from a JSP or servlet but not an HTML page.) Its value is an Object.

Overrides:
getWicketURL in class WicketPortlet
defaultPage - url of the default page
Returns:
the Wicket URL from within the specified request
See Also:
WicketPortlet.getWicketURL(javax.portlet.PortletRequest, java.lang.String, java.lang.String)

processRequest

protected void processRequest(javax.portlet.PortletRequest request,
                              javax.portlet.PortletResponse response,
                              String pageType)
                       throws javax.portlet.PortletException,
                              IOException
Description copied from class: WicketPortlet
Consumes and processes all portlet requests. All the doX methods delegate to this method, including processAction and serveResource.

Overrides:
processRequest in class WicketPortlet
Throws:
javax.portlet.PortletException
IOException
See Also:
org.apache.wicket.protocol.http.portlet.WicketPortlet#processRequest(PortletRequest, PortletResponse, String, String)

discoverExamples

protected List<ExampleApplication> discoverExamples(javax.portlet.PortletContext portletContext)


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.