public interface RichRenderingContext
RichRenderer.getRichRenderingContext(org.apache.myfaces.trinidad.context.RenderingContext)
. ADF Faces provides the only implementations of this interface. As such, we reserve the right to add new methods to RichRenderingContext as the need arises.Modifier and Type | Method and Description |
---|---|
ClientComponent |
addClientComponent(ClientComponent.Type type, ClientMetadata metadata, String constructorName, String clientId)
Creates a ClientComponent of a specified type, metadata, constructor, and ID.
|
void |
addClientIcon(String iconKey, String altText)
Sends an icon to the client.
|
void |
addClientSkinProperty(String propertyKey, Object propertyValue)
Sends a skin property to the client.
|
void |
addFeature(String featureName)
Adds a dependency on the specified feature, ensuring that the corresponding JavaScript code is provided.
|
void |
addStreamingComponent(javax.faces.component.UIComponent targetComponent, Object fetchConstraint, ClientEvent fetchEvent)
Marks a component as taking part in data streaming.
|
AdfFacesContext |
getAdfFacesContext()
Returns the AdfFacesContext for this request.
|
boolean |
getClientComponentsForced()
Returns
true if client components should currently be generated for all server components. |
ClientEncoder |
getClientEncoder()
Returns the appropriate client encoder for marshalling objects to the client environement
|
String |
getContextualText()
Retrieve contextual text generated by a stamping component during render response phase for use by stamped child components
|
boolean |
getLazyDataFetchAllowed(javax.faces.component.UIComponent component)
Determines whether lazey data fetch is allowed
|
SuppressId |
getSuppressIdHint(javax.faces.component.UIComponent component)
Returns a hint indicating what type of id suppression is allowed for the specified component.
|
String |
getTheme()
Get the current component theme.
|
String |
popTheme()
Pop the current theme from the component theme stack.
|
void |
pushTheme(String theme)
Set the current component theme by pushing a theme onto the theme stack.
|
AdfFacesContext getAdfFacesContext()
ClientComponent addClientComponent(ClientComponent.Type type, ClientMetadata metadata, String constructorName, String clientId) throws IOException
IOException
boolean getClientComponentsForced()
true
if client components should currently be generated for all server components.
An example of when this is true is when testing automation is enabled
true
if client components should currently be generated for all server components.void addClientIcon(String iconKey, String altText)
void addClientSkinProperty(String propertyKey, Object propertyValue)
void addStreamingComponent(javax.faces.component.UIComponent targetComponent, Object fetchConstraint, ClientEvent fetchEvent)
targetComponent
- Component to register for streaming datafetchConstraint
- Optional Serializable criteria to pass to AsyncFetch model when the data is actually fetched while streaming.fetchEvent
- Optional event made available when the targetComponent is rendering the result of the stremaing data fetch. The event must not have the component property specified since this event must last between requests. Components already supporting client fetch events can use a single code path for both their fetch events and their streaming events by passing their fetch ClientEvent here.IllegalArgumentException
- if targetComponent isn't specified, the fetchConstraint is specified but not Serializable or the fetchEvent has the component property set.AsyncFetch
String getTheme()
pushTheme(String)
void pushTheme(String theme)
theme
- the theme to push onto the stackpopTheme()
String popTheme()
pushTheme(String)
ClientEncoder getClientEncoder()
void addFeature(String featureName)
featureName
- Name of a feature defined by an adf-js-features.xml configuration file.boolean getLazyDataFetchAllowed(javax.faces.component.UIComponent component)
component
-true
if the lazy data fetch is allowed for the componentSuppressId getSuppressIdHint(javax.faces.component.UIComponent component)
component
- the component to checkSuppressId
String getContextualText()