BaseRenderer (Struts Faces 1.3.10 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.faces.renderer
Class BaseRenderer

    java.lang.Object
      javax.faces.render.Renderer
          org.apache.struts.faces.renderer.AbstractRenderer
              org.apache.struts.faces.renderer.BaseRenderer

    public class BaseRenderer

extends AbstractRenderer

`Renderer` implementation for the `base` tag from the Struts-Faces Integration Library.

Version:
  $Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $

Constructor Summary
`BaseRenderer()`

Method Summary
`void` | `encodeEnd(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)` Render an HTML `base` element.
`protected boolean` | `isPortletRequest(javax.faces.context.FacesContext context)` Return `true` if this is a portlet request instance.
`protected boolean` | `isServletRequest(javax.faces.context.FacesContext context)` Return `true` if this is a servlet request instance.
`protected String` | `portletUri(javax.faces.context.FacesContext context)` Return an absolute URI for the current page suitable for use in a portlet environment.
`protected String` | `servletUri(javax.faces.context.FacesContext context)` Return an absolute URI for the current page suitable for use in a servlet environment.
`protected String` | `uri(javax.faces.context.FacesContext context)` Return the absolute URI to be rendered as the value of the `href` attribute.

Methods inherited from class org.apache.struts.faces.renderer.AbstractRenderer
`decode, encodeBegin, encodeChildren, encodeRecursive, getAsString, isDisabled, isReadOnly, renderAttributes, renderBoolean, renderEnd, renderPassThrough, renderStart, setSubmittedValue`

Methods inherited from class javax.faces.render.Renderer
`convertClientId, getConvertedValue, getRendersChildren`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### BaseRenderer

    public BaseRenderer()

Method Detail

### encodeEnd

    public void encodeEnd(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component)
                   throws IOException

  Render an HTML `base` element.

  Overrides:
    `encodeEnd` in class `AbstractRenderer`
  Parameters:
    `context` - FacesContext for the request we are processing
    `component` - UIComponent to be rendered
  Throws:
    `IOException` - if an input/output error occurs while rendering
    `NullPointerException` - if `context` or `component` is null

### isPortletRequest

    protected boolean isPortletRequest(javax.faces.context.FacesContext context)

  Return `true` if this is a portlet request instance. NOTE: Implementation must not require portlet API classes to be present.

  Parameters:
    `context` - `FacesContext` for the current request

### isServletRequest

    protected boolean isServletRequest(javax.faces.context.FacesContext context)

  Return `true` if this is a servlet request instance.

  Parameters:
    `context` - `FacesContext` for the current request

### portletUri

    protected String portletUri(javax.faces.context.FacesContext context)

  Return an absolute URI for the current page suitable for use in a portlet environment. NOTE: Implementation must not require portlet API classes to be present, so use reflection as needed.

  Parameters:
    `context` - `FacesContext` for the current request

### servletUri

    protected String servletUri(javax.faces.context.FacesContext context)

  Return an absolute URI for the current page suitable for use in a servlet environment.

  Parameters:
    `context` - `FacesContext` for the current request

### uri

    protected String uri(javax.faces.context.FacesContext context)

  Return the absolute URI to be rendered as the value of the `href` attribute.

  Parameters:
    `context` - `FacesContext` for the current request

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.