org.openfaces.renderkit
Interface AjaxPortionRenderer

All Known Implementing Classes:
AbstractTableRenderer, AjaxSettingsRenderer, ChartPopupRenderer, CompositeFilterRenderer, DataTableRenderer, DayTableRenderer, DropDownFieldRenderer, FoldingPanelRenderer, LayeredPaneRenderer, MonthTableRenderer, MultiPageContainerRenderer, SelectOneMenuRenderer, SuggestionFieldRenderer, TabbedPaneRenderer, TimeScaleTableRenderer, TimetableViewRenderer, TreeTableRenderer, WeekTableRenderer

public interface AjaxPortionRenderer


Method Summary
 JSONObject encodeAjaxPortion(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String portionName, JSONObject jsonParam)
          This method is required for inner components rendering in case when parent component does not know which HTML appearance inner component should have.
 

Method Detail

encodeAjaxPortion

JSONObject encodeAjaxPortion(javax.faces.context.FacesContext context,
                             javax.faces.component.UIComponent component,
                             java.lang.String portionName,
                             JSONObject jsonParam)
                             throws java.io.IOException,
                                    JSONException
This method is required for inner components rendering in case when parent component does not know which HTML appearance inner component should have. For example some components may have additional initialization javascript along with their HTML representations.

Parameters:
context - instance of FacesContext
component - parent component for which inner controls should be rendered
portionName - actually a server-side id for the inner component to be rendered. In further, there may be an extension for this method to support not only inner components rendering, but data retrieval too. Or maybe other method will be declared.
jsonParam - the JSON object that is passed as a parameter to O$.Ajax.requestComponentPortions on the client-side, or null if no parameter was passed.
Throws:
java.io.IOException - propagates any IO exceptions that might occur inside of this method
JSONException - in case of any JSON manipulation failure. It is declared as a checked exception here just to free the implementations of this method from having to catch them. Invoker of this method will just re-throw this exception as RuntimeException.


Copyright © 1998-2010 TeamDev Ltd. All Rights Reserved.