Skip navigation links

oracle.adf.view.rich.render
Interface RichRenderingContext

public interface RichRenderingContext

Interface for rich client specific rendering operations. A RichRenderingContext can be retrieved from a RenderingContext with RichRenderer.getRichRenderingContext(org.apache.myfaces.trinidad.context.RenderingContext).

Method Summary

ClientComponent	addClientComponent(ClientComponent.Type type, ClientMetadata metadata, java.lang.String constructorName, java.lang.String clientId) Creates a ClientComponent of a specified type, metadata, constructor, and ID.
void	addClientIcon(java.lang.String iconKey, java.lang.String altText) Sends an icon to the client.
void	addClientSkinProperty(java.lang.String propertyKey, java.lang.Object propertyValue) Sends a skin property to the client.
void	addFeature(java.lang.String featureName) Adds a dependency on the specified feature, ensuring that the corresponding JavaScript code is provided.
void	addStreamingComponent(javax.faces.component.UIComponent targetComponent, java.lang.Object fetchConstraint, ClientEvent fetchEvent) Marks a component as taking part in data streaming.
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
java.lang.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.
java.lang.String	getTheme() Get the current component theme.
java.lang.String	popTheme() Pop the current theme from the component theme stack.
void	pushTheme(java.lang.String theme) Set the current component theme by pushing a theme onto the theme stack.

Method Detail

addClientComponent

ClientComponent addClientComponent(ClientComponent.Type type,
                                   ClientMetadata metadata,
                                   java.lang.String constructorName,
                                   java.lang.String clientId)
                                   throws java.io.IOException

Creates a ClientComponent of a specified type, metadata, constructor, and ID. Note that the ClientComponent will not necessarily be instantiated; depending on the type, metadata, and what attributes are added to the returned ClientComponent instance, it is possible that no component object will actually be instantiated on the client.

Throws:

java.io.IOException

getClientComponentsForced

boolean getClientComponentsForced()

Returns 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

Returns:

true if client components should currently be generated for all server components.

addClientIcon

void addClientIcon(java.lang.String iconKey,
                   java.lang.String altText)

Sends an icon to the client. The icon can then be retrieved by calling AdfPage.PAGE.getLookAndFeel().getIcon(). This method must be called while rendering the content of the component that requires the icon.

addClientSkinProperty

void addClientSkinProperty(java.lang.String propertyKey,
                           java.lang.Object propertyValue)

Sends a skin property to the client. Skin properties can then be retrieved by calling AdfPage.PAGE.getLookAndFeel().getSkinProperty(). This method must be called while rendering the content of the component that requires the icon.

addStreamingComponent

void addStreamingComponent(javax.faces.component.UIComponent targetComponent,
                           java.lang.Object fetchConstraint,
                           ClientEvent fetchEvent)

Marks a component as taking part in data streaming. The targetComponent should have a value attribute containing a AsyncFetch model.

Parameters:

targetComponent - Component to register for streaming data

fetchConstraint - 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.

Throws:

java.lang.IllegalArgumentException - if targetComponent isn't specified, the fetchConstraint is specified but not Serializable or the fetchEvent has the component property set.

See Also:

AsyncFetch

getTheme

java.lang.String getTheme()

Get the current component theme. The theme allows for components to be styled in a scope smaller than the skin. Typical themes are: dark, medium, light, default.

Returns:

the current theme or null if none has been set

See Also:

pushTheme(String)

pushTheme

void pushTheme(java.lang.String theme)

Set the current component theme by pushing a theme onto the theme stack.

Parameters:

theme - the theme to push onto the stack

See Also:

popTheme()

popTheme

java.lang.String popTheme()

Pop the current theme from the component theme stack. This returns the theme to the previous theme.

Returns:

the them that was removed from the stack

See Also:

pushTheme(String)

getClientEncoder

ClientEncoder getClientEncoder()

Returns the appropriate client encoder for marshalling objects to the client environement

Returns:

the ClientEncoder instance

addFeature

void addFeature(java.lang.String featureName)

Adds a dependency on the specified feature, ensuring that the corresponding JavaScript code is provided.

Parameters:

featureName - Name of a feature defined by an adf-js-features.xml configuration file.

getLazyDataFetchAllowed

boolean getLazyDataFetchAllowed(javax.faces.component.UIComponent component)

Determines whether lazey data fetch is allowed

Parameters:

component -

Returns:

true if the lazy data fetch is allowed for the component

getSuppressIdHint

SuppressId getSuppressIdHint(javax.faces.component.UIComponent component)

Returns a hint indicating what type of id suppression is allowed for the specified component.

Parameters:

component - the component to check

Returns:

one of the hints defined by SuppressId

getContextualText

java.lang.String getContextualText()

Retrieve contextual text generated by a stamping component during render response phase for use by stamped child components

Returns:

contextual text

Skip navigation links