|
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.ManagedRenderer oracle.portal.provider.v2.render.http.BaseManagedRenderer oracle.portal.provider.v2.render.http.FileRenderer
public class FileRenderer
When maintained by a RenderManager
,
a FileRenderer
renders a single page's contents from a static
file.
The properties contentType
, pageExpires
,
charSet
may be set at page level or defaulted at RenderManager
level. However the page
name must be set at page level via a call to
or by use of the setName(String)
<name>
provider.xml
tag.
Field Summary | |
---|---|
static int |
CHAR_BUFFER_SIZE
|
Constructor Summary | |
---|---|
FileRenderer()
Null Constructor. |
|
FileRenderer(RenderManager parent,
java.lang.String pageName)
Creates and initializes a FileRenderer owned by the given
RenderManager , describing a page with the given name. |
Method Summary | |
---|---|
java.lang.String |
getAppRoot()
Gets the root physical path for the renderer's pages. |
java.lang.String |
getCharSet()
Gets the Default IANA character encoding to be used for this renderer's pages. |
java.lang.String |
getName()
Gets the name of the page described by this Page . |
void |
renderBody(PortletRenderRequest pr)
Render the specified page's contents using the current appRoot and page name. |
void |
setAppRoot(java.lang.String path)
Sets the root physical path for the renderer's pages. |
void |
setCharSet(java.lang.String charSet)
Sets the Default IANA character encoding to be used for this renderer's pages. |
void |
setName(java.lang.String pageName)
Sets the name of the page described by this Page . |
void |
validate(java.lang.String context,
ValidationError errors)
Validates the internal state of this FileRenderer
instance. |
Methods inherited from class oracle.portal.provider.v2.render.http.BaseManagedRenderer |
---|
addParameter, getContentType, getGeneratesESI, postInitialize, preInitialize, prepareResponse, setContentType, setGeneratesESI, setGeneratesESI, setPageExpires, setPageExpires, setUseInvalidationCaching, setUseInvalidationCaching |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int CHAR_BUFFER_SIZE
Constructor Detail |
---|
public FileRenderer()
BaseManagedRenderer.preInitialize(Object)
method should be called after creating an object with this constructor
and the BaseManagedRenderer.postInitialize()
method should be
called after setting up page properties with the various accessor
methods. Normally a DefaultNodeHandler
takes care of these
details.
public FileRenderer(RenderManager parent, java.lang.String pageName) throws PortletException
FileRenderer
owned by the given
RenderManager
, describing a page with the given name.
parent
- the RenderManager
that owns this pagepageName
- the appPath
relative name of the renderer's
page
PortletException
- if an error occurs while initializing the
objectMethod Detail |
---|
public void setName(java.lang.String pageName)
Page
.
pageName
- appRoot
relative name of the pagepublic java.lang.String getName()
Page
.
appRoot
relative name of the pagepublic void setAppRoot(java.lang.String path)
path
- the root physical path for the renderer's pages.public java.lang.String getAppRoot()
public void setCharSet(java.lang.String charSet)
charSet
- IANA character encoding to be used for this renderer's
pagespublic java.lang.String getCharSet()
BaseManagedRenderer
, then the value returned by calling
the RenderManager.getCharSet()
method on the parent
RenderManager
is returned.
public void renderBody(PortletRenderRequest pr) throws PortletException
renderBody
in class ManagedRenderer
pr
- a PortletRenderRequest
PortletException
- if an error occurs while rendering.public void validate(java.lang.String context, ValidationError errors)
FileRenderer
instance. Errors found are reported using the supplied ValidationError
instance.
validate
in interface Validateable
validate
in class BaseManagedRenderer
context
- The context of the calling instance.errors
- The current list of errors.
|
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 |