|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.portal.provider.v2.render.PortletContainerRenderer
public abstract class PortletContainerRenderer
A PortletContainerRenderer is a utility class that renders the container for a portlet. The container that is renderered may vary depending on the SHOW mode that is being requested. For example, Edit, Edit Defaults. Help, About, and Show Details are all rendered in "full screen" mode whereas the regular Show and Preview modes have variable size containers depending on the size of the portlet.
Field Summary | |
---|---|
static java.lang.String |
ACTION_PARAM_NAME
This is the key used in the parameter map of the render methods in this class to override the name of the hidden field that indicates the button clicked in EDIT or EDIT_DEFAULTS mode ( "OK" or
"APPLY" ). |
static java.lang.String |
CUSTOMIZE_FORM_NAME
Default form name. |
static java.lang.String |
DEFAULT_ACTION_PARAM
Default action parameter name. |
static java.lang.String |
EDIT_FORM_NAME
This is the key used in the parameter map of the render methods in this class to override the name of the edit form object (as referenced by javascript code) when the mode to be rendered is EDIT or EDIT_DEFAULTS. |
static java.lang.String |
HELP_URL
This is the key used in the parameter map of the render methods in this class to pass a URL that displays context sensitive help for the current screen (does not apply in SHOW mode). |
static java.lang.String |
PORTLET_TITLE
This is the key used in the parameter map of the render methods in this class to override the portlet title to be rendered. |
static java.lang.String |
PRINT_WRITER
This is the key used in the parameter map of the render methods in this class to specify the Writer to output to. |
static java.lang.String |
RENDER_CUSTOMIZE
This is the key used in the parameter map of the render methods in this class to specify whether a header should be rendered when the mode to be rendered is EDIT or EDIT_DEFAULTS. |
static java.lang.String |
RENDER_MODE
This is the key used in the parameter map of the render methods in this class to override the mode to be rendered. |
Constructor Summary | |
---|---|
PortletContainerRenderer()
|
Method Summary | |
---|---|
void |
renderAboutFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet ABOUT mode |
void |
renderAboutFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderAboutFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderAboutHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet ABOUT mode |
void |
renderAboutHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderAboutHeader(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderDetailsFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet SHOW_DETAILS mode |
void |
renderDetailsFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderDetailsFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderDetailsHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet SHOW_DETAILS mode |
void |
renderDetailsHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderDetailsHeader(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderEditDefaultsFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet EDIT_DEFAULTS mode |
void |
renderEditDefaultsFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderEditDefaultsFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderEditDefaultsHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet EDIT_DEFAULTS mode |
void |
renderEditDefaultsHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderEditDefaultsHeader(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderEditFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet EDIT mode |
void |
renderEditFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderEditFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderEditHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet EDIT mode |
void |
renderEditHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderEditHeader(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderHelpFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet HELP mode |
void |
renderHelpFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderHelpFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderHelpHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet HELP mode |
void |
renderHelpHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderHelpHeader(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderPortletFooter(PortletRenderRequest request,
java.util.Map params)
Renders a portlet footer. |
void |
renderPortletFooter(PortletRenderRequest request,
ParameterMap params)
Deprecated. use renderPortletFooter(PortletRenderRequest,
Map) |
void |
renderPortletHeader(PortletRenderRequest request,
java.util.Map params)
Renders a portlet header. |
void |
renderPortletHeader(PortletRenderRequest request,
ParameterMap params)
Deprecated. use renderPortletHeader(PortletRenderRequest,
Map) |
void |
renderPreviewFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet PREVIEW mode |
void |
renderPreviewFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderPreviewFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderPreviewHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet PREVIEW mode |
void |
renderPreviewHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderPreviewHeader(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderShowFooter(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the footer for the portlet SHOW mode |
void |
renderShowFooter(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderShowFooter(PortletRenderRequest,
PrintWriter,
Map) |
void |
renderShowHeader(PortletRenderRequest request,
java.io.PrintWriter out,
java.util.Map params)
Renders the header for the portlet SHOW mode |
void |
renderShowHeader(PortletRenderRequest request,
java.io.PrintWriter out,
ParameterMap params)
Deprecated. use renderShowHeader(PortletRenderRequest,
PrintWriter,
Map) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PORTLET_TITLE
java.lang.String
. If not specified in the
map, this defaults to the customized portlet title or portlet title in
provider.xml in SHOW mode and a mode specific title describing the mode
in other modes.
public static final java.lang.String RENDER_MODE
PortletRenderer
, wrapped as a
java.lang.Integer
. If not specified in the map, the render
mode will be determined from the PortletRenderRequest. This parameter
is included for backwards compatibility with PortletRendererUtil.renderPortletHeader(PortletRenderRequest,
java.io.Writer, String, int)
.
public static final java.lang.String RENDER_CUSTOMIZE
java.lang.Boolean
. When true
(the default), a
header and footer are rendered in EDIT mode.
public static final java.lang.String EDIT_FORM_NAME
java.lang.String
. If not specified in the map, this
defaults to the value CUSTOMIZE_FORM_NAME
.
public static final java.lang.String ACTION_PARAM_NAME
"OK"
or
"APPLY"
). It should be mapped to a value of type
java.lang.String
. If not specified in the map, this
defaults to the value DEFAULT_ACTION_PARAM
.
public static final java.lang.String HELP_URL
java.lang.String
. If not specified in
the map, no context sensitive help link is generated.
public static final java.lang.String PRINT_WRITER
Writer
to output to. It should be
mapped to a value of type java.io.Writer
. If not specified
in the map, the PrintWriter
returned by PortletRenderRequest.getWriter()
will be used. If you are calling
RenderPortletHeader or RenderPortletFooter from a JSP, it is important
that you use the same Writer to render all the JSP content - either the
JSPWriter or PortletRenderRequest.getWriter(). Mixing writers can cause
output to be displayed out of sequence due to buffering in the
JSPWriter.
public static final java.lang.String CUSTOMIZE_FORM_NAME
public static final java.lang.String DEFAULT_ACTION_PARAM
Constructor Detail |
---|
public PortletContainerRenderer()
Method Detail |
---|
public void renderPortletHeader(PortletRenderRequest request, java.util.Map params) throws PortletException
The container that is rendered should be dependent on the mode that is being renderered
request
- PortletRenderRequest for this rendering.params
- Map
specifying parameters which override the
default rendering behaviour. May be null
if the default
rendering behaviour is acceptable. Keys should be one of the string key
constants defined in this class. See the description of each key
constant for acceptable mapped values.
PortletException
public void renderPortletFooter(PortletRenderRequest request, java.util.Map params) throws PortletException
request
- PortletRenderRequest for this renderingparams
- Map
specifying parameters which override the
default rendering behaviour. May be null
if the default
rendering behaviour is acceptable. Keys should be one of the string key
constants defined in this class. See the description of each key
constant for acceptable mapped values.
PortletException
public void renderShowHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderShowFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderPreviewHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderPreviewFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderDetailsHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderDetailsFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderEditHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderEditFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderEditDefaultsHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderEditDefaultsFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderHelpHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderHelpFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderAboutHeader(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderAboutFooter(PortletRenderRequest request, java.io.PrintWriter out, java.util.Map params) throws PortletException, java.io.IOException
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- Map
specifying parameters which override the
default rendering behaviour. May be empty if the default rendering
behaviour is acceptable. Keys should be one of the string key constants
defined in this class. See the description of each key constant for
acceptable mapped values.
PortletException
java.io.IOException
public void renderPortletHeader(PortletRenderRequest request, ParameterMap params) throws PortletException
renderPortletHeader(PortletRenderRequest,
Map)
request
- PortletRenderRequest for this rendering.params
- Parameters for rendering the container
PortletException
public void renderPortletFooter(PortletRenderRequest request, ParameterMap params) throws PortletException
renderPortletFooter(PortletRenderRequest,
Map)
request
- PortletRenderRequest for this rendering.params
- Parameters for rendering the container
PortletException
public void renderShowHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderShowHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderShowFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderShowFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderPreviewHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderPreviewHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderPreviewFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderPreviewFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderDetailsHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderDetailsHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderDetailsFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderDetailsFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderEditHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderEditHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderEditFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderEditFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderEditDefaultsHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderEditDefaultsHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderEditDefaultsFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderEditDefaultsFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderHelpHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderHelpHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderHelpFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderHelpFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderAboutHeader(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderAboutHeader(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
public void renderAboutFooter(PortletRenderRequest request, java.io.PrintWriter out, ParameterMap params) throws PortletException, java.io.IOException
renderAboutFooter(PortletRenderRequest,
PrintWriter,
Map)
request
- the portlet render requestout
- PrintWriter that should be used to write the portlet headerparams
- additional parameters passed in by the PortletRenderer
PortletException
java.io.IOException
|
Oracle Fusion Middleware Java API Reference for Oracle PDK Java 11g Release 1 (11.1.1) E10691-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |