|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.render.Renderer
org.apache.myfaces.trinidad.render.CoreRenderer
oracle.adf.view.rich.render.RichRenderer
public abstract class RichRenderer
Base class for renderers of Rich Client components.
Developers subclassing this will generally need to override four methods:
A variety of other methods may be overridden to affect decoding or encoding behavior. This class extends the Trinidad CoreRenderer API, which contains a number of useful utility methods.
To decode an event sent by the client, override decodeInternal(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.String)
and call getClientEvent(javax.faces.context.FacesContext, java.lang.String, java.lang.String)
with the type of the event you are expecting. A ClientEvent will contain a Map of objects with all the event-specific properties marshalled by the client.
RichRenderingContext contains a number of APIs useful for sending information to the client. To retrieve a RichRenderingContext, call getRichRenderingContext(org.apache.myfaces.trinidad.context.RenderingContext)
.
ClientComponent
, ClientMetadata
, RichRenderingContext
Field Summary | |
---|---|
static java.lang.String |
CHILDREN_THEME_PROPERTY |
static java.lang.String |
ENABLE_THEME_PROPERTY |
static java.lang.String |
THEME_ATTRIBUTE |
Fields inherited from class org.apache.myfaces.trinidad.render.CoreRenderer |
---|
CHAR_UNDEFINED, NO_CHILD_INDEX |
Constructor Summary | |
---|---|
protected |
RichRenderer(org.apache.myfaces.trinidad.bean.FacesBean.Type type) Creates a RichRenderer. |
Method Summary | ||
---|---|---|
protected void |
addAttributeChange(javax.faces.component.UIComponent comp, java.lang.String attrName, java.lang.Object attrValue) Adds an attribute change to persist the attribute value using change manager |
|
javax.faces.render.Renderer |
cloneWithType(org.apache.myfaces.trinidad.bean.FacesBean.Type type) Clone a Renderer instance with a new Type; part of the TypedRenderer API. |
|
static java.lang.String |
createClientSubId(java.lang.String clientId, java.lang.String name) Creates an identifier that can be used on the client to locate a piece of the DOM. |
|
DragSource |
createDefaultDragSource(javax.faces.component.UIComponent component, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties) Renderer implementations should override this method to return the DragSource instance specific to the component (for e.g., when it overrides the DefaultDragSourceFactory interface) |
|
java.lang.String |
createDefaultDragSourceBehavior(javax.faces.component.UIComponent component, DragSource dragSource, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties) Returns the JS clientDragSource initializer. |
|
java.lang.String |
createSubId(java.lang.String clientId, java.lang.String name) Creates an identifier that can be used on the client to locate a piece of the DOM. |
|
void |
decode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) Override of decode() to provide default rich client functionality. |
|
protected boolean |
decodeIncompatiblePropertyKey(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String clientId, org.apache.myfaces.trinidad.bean.FacesBean bean, org.apache.myfaces.trinidad.bean.PropertyKey pKey, java.lang.String value) Subclasses can override this method to decode property keys whose types cannot be coerced by default. |
|
void |
decodeInternal(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String clientId) Hook for providing per-component decoding |
|
protected void |
decodeUnknownKey(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String name, java.lang.Object value) Called when a key whose name is not known to the FacesBean has been synchronized. |
|
protected void |
delegateRenderer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, org.apache.myfaces.trinidad.render.CoreRenderer renderer) Delegate to a child Renderer, building attributes into the same client component. |
|
protected void |
delegateRenderer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent childComponent, org.apache.myfaces.trinidad.render.CoreRenderer renderer) Delegate to a child Renderer building attributes into the child's ClientComponent. |
|
protected void |
delegateRenderer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean, org.apache.myfaces.trinidad.render.CoreRenderer renderer) Delegate to a child Renderer without any attributes delivered to a client component. |
|
protected abstract void |
encodeAll(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) Hook for implementing renderer-specific rendering. |
|
protected void |
encodeAll(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean) Base rendering functionality for all rich renderers. |
|
protected void |
encodeChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent child) |
|
protected
|
encodeFlattenedComponents(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext, org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor, S callbackContext, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) Encode the flattened components. |
|
|
encodeFlattenedComponents(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext, org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor, S callbackContext, javax.faces.component.UIComponent component) Encode the flattened components. |
|
protected void |
encodeStretchedChild(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, java.lang.String parentPadding) Encodes the specified child including the additional styling to enable CSS stretching of the child. |
|
protected javax.faces.context.ResponseWriter |
encodeStretchedChildBegin(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String parentPadding) Prepares the FacesContext/ResponseWriter for encoding of a stretched child. |
|
protected javax.faces.context.ResponseWriter |
encodeStretchedChildBegin(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, java.lang.String parentTopPadding, java.lang.String parentRightPadding, java.lang.String parentBottomPadding, java.lang.String parentLeftPadding) Prepares the FacesContext/ResponseWriter for encoding of a stretched child. |
|
protected void |
encodeStretchedChildEnd(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter responseWriter) Completes the stretched child encoding which was initiated via a call to encodeStretchedChildBegin(). |
|
protected void |
findTypeConstants(org.apache.myfaces.trinidad.bean.FacesBean.Type type, ClientMetadata metadata) |
|
protected java.util.Set<java.lang.String> |
getCheckedUnsecurePropertyNames(org.apache.myfaces.trinidad.bean.FacesBean bean) Retrieves unsecure property from the bean, also checks that the unsecure key names don't contain properties that are always secure. |
|
protected java.util.Set<java.lang.String> |
getClientAttributes(org.apache.myfaces.trinidad.bean.FacesBean bean) Returns the set of client attributes. |
|
protected ClientComponent.Type |
getClientComponentType(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean) Hook to identify the state-dependent type of the client component. |
|
protected abstract java.lang.String |
getClientConstructor() Hook to provide the name of the client-side object representing this renderer. |
|
protected ClientEvent |
getClientEvent(javax.faces.context.FacesContext context, java.lang.String clientId, java.lang.String type) |
|
protected java.lang.String |
getClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ClientComponent client) A convenience method to return a clientId, taking advantage of the cached value in the ClientComponent if it is available. |
|
static java.lang.Iterable<java.lang.String> |
getClientIdsToDecode(javax.faces.context.FacesContext context) Returns an Iterable that identifies any client IDs that need to be decoded on this request, but have not yet been. |
|
protected ClientListenerSet |
getClientListeners(org.apache.myfaces.trinidad.bean.FacesBean bean) Returns the client listeners. |
|
protected ClientComponent.Type |
getDefaultClientComponentType() Return the default client component type; this defaults to CREATE_WITH_REQUIRED_ATTRS. |
|
protected java.lang.String |
getDefaultStyleClass(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean) Override to return the default style class for this renderer. |
|
java.lang.String |
getDefaultStyleClass(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component) Return the default style class for this renderer. |
|
DragSource |
getDragSource(javax.faces.component.UIComponent component) Returns the default DragSource for the provided component. |
|
java.lang.String |
getDragSourceKey() |
|
protected ClientMetadata |
getEncodeClientMetadata(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean) Hook that allows overriding the client metadata used for encoding. |
|
protected java.lang.String |
getInlineStyle(org.apache.myfaces.trinidad.bean.FacesBean bean) Returns the value of the "inlineStyle" property. |
|
protected java.lang.String |
getPrependedInlineStyle(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) Returns null or extra styles to prepend to the inlineStyle. |
|
static javax.faces.render.Renderer |
getRenderer(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) |
|
static
|
getRendererAs(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.Class<S> rendererClass) |
|
boolean |
getRendersChildren() Overridden to return true; all rich renderers are "renders children". |
|
static RichRenderer |
getRichRenderer(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) |
|
static RichRenderingContext |
getRichRenderingContext(org.apache.myfaces.trinidad.context.RenderingContext rc) Return the current RichRenderingContext. |
|
protected java.util.List<java.lang.String> |
getRootStateStyleClasses(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean) Deprecated. Use the getRootStateStyleClasses that also takes a UIComponent as a parameter. Also, if you upgrade your code to use the new API, make sure all your superclasses also use the new API. We currently call the old api from renderRootStyleAttributes (so people have time to migrate to the new API). |
|
protected java.util.List<java.lang.String> |
getRootStateStyleClasses(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean, javax.faces.component.UIComponent component) Override to return any state-based (selected, disabled, etc.) CSS style markers. |
|
protected java.lang.String |
getShortDesc(org.apache.myfaces.trinidad.bean.FacesBean bean) Returns the value of the "shortDesc" property. |
|
protected java.lang.String |
getStyleClass(org.apache.myfaces.trinidad.bean.FacesBean bean) Returns the value of the "styleClass" property. |
|
static java.lang.String |
getTheme(org.apache.myfaces.trinidad.context.RenderingContext renderingContext) Get the current theme from the rendering context's theme stack |
|
protected java.util.Set<java.lang.String> |
getUnsecurePropertyNames(org.apache.myfaces.trinidad.bean.FacesBean bean) Retrieves unsecure property from the bean |
|
protected boolean |
getVisible(org.apache.myfaces.trinidad.bean.FacesBean bean) Returns the visibility of the component. |
|
boolean |
hasDragSource(javax.faces.component.UIComponent component) Whether the component has a DragSource set. |
|
protected static boolean |
isChildVisible(javax.faces.component.UIComponent child) Returns true if a child is "visible" |
|
protected boolean |
isLeafRenderer(javax.faces.component.UIComponent component) Is this a "leaf" component - one without any children? The default returns false. |
|
boolean |
isNextElementToBeStretched(javax.faces.context.FacesContext context) Determines whether the next written element will have element stretching styles added to it. |
|
protected boolean |
isThemeEnabled(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.RenderingContext renderingContext, javax.faces.component.UIComponent uiComponent, org.apache.myfaces.trinidad.bean.FacesBean facesBean) Check if the component supports theming. |
|
protected static void |
makeNonEmpty(javax.faces.context.FacesContext context) Forces some non-visible content to be rendered to give the containing content *some* space. |
|
protected boolean |
needsExplicitId(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean) Returns true if the component has an explicitly set ID that should be rendered/sent to the client. |
|
protected boolean |
needsExplicitId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean) Deprecated. this version of the method doesn't specify a RenderingContext |
|
protected boolean |
needsExplicitId(javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean) Deprecated. this version of the method doesn't specify a FacesContext |
|
static java.lang.String |
popTheme(org.apache.myfaces.trinidad.context.RenderingContext renderingContext) Remove the last theme from the rendering context's theme stack |
|
static void |
pushTheme(org.apache.myfaces.trinidad.context.RenderingContext renderingContext, java.lang.String theme) Push the current theme onto the rendering context's theme stack. |
|
protected void |
renderAllRootAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) This should be called once on the root dom element. |
|
protected void |
renderAllRootAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, boolean renderStyleAttrs) Render the main renderer-specific attributes: "title", "class", "style", and all the Javascript attributes. |
|
protected void |
renderClickableIcon(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, boolean isTabStop, java.lang.String[] styleClasses, java.lang.String id, java.lang.String tooltipTextBundleKey, java.lang.String iconName) Deprecated. Use RichRenderUtils renderClickableIcon |
|
static void |
renderClickableIcon(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, boolean isTabStop, java.lang.String targetURL, java.lang.String[] styleClasses, java.lang.String id, java.lang.String tooltipString, java.lang.String iconName) Renders a clickable icon with specified id, style classes, tooltip, skinnable icon name tabstop and targetURL feature. |
|
protected void |
renderFormattedText(javax.faces.context.FacesContext context, java.lang.Object textValue) Renders text as "formatted" text, as if it were the value of an <outputFormatted> component. |
|
protected static void |
renderHAlign(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.Object hAlign) Renders an halign attribute, automatically transforming "start" and "end" into "left" and "right" as necessary depending on the current user's reading direction. |
|
static void |
renderHelpIcon(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, java.lang.String helpTopicId, java.lang.String styleClass, java.lang.String disabledStyleClass, java.lang.String iconName, java.lang.String altText) Renders the dynamic help icon. |
|
protected void |
renderId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ClientComponent client) Renders the client ID as an "id". |
|
protected void |
renderPossiblyFormattedText(javax.faces.context.FacesContext context, java.lang.Object textValue) Renders text; if the text begins with "", render it as formatted text, otherwise render it as plain text. |
|
protected void |
renderRootStyleAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) Deprecated. this version of the method doesn't specify a UIComponent |
|
protected void |
renderRootStyleAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String defaultStyleClass) Deprecated. this version of the method doesn't specify a UIComponent |
|
protected void |
renderRootStyleAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) Renders the root style attributes, merging in a defaultStyleClass (passed to this method) and any state style classes. |
|
protected void |
renderRootStyleAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String defaultStyleClass) Renders the root style attributes, merging in a defaultStyleClass (passed to this method) and any state style classes. |
|
protected void |
renderRootStyleClasses(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String defaultStyleClass, java.util.List<java.lang.String> stateStyleClasses) Renders the style classes on the root DOM element. |
|
protected void |
renderShortDescAttribute(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) Renders the shortDesc attribute as a "title" property, and adds it to the client component. |
|
protected void |
renderSpacer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String width, java.lang.String height) Renders a spacer. |
|
protected void |
renderSpacer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String width, java.lang.String height, java.lang.String id, java.lang.String shortDesc, javax.faces.component.UIComponent component) Renders a spacer. |
|
protected void |
renderSpacer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String width, java.lang.String height, java.lang.String id, java.lang.String shortDesc, javax.faces.component.UIComponent component, java.lang.String inlineStyle) Renders a spacer. |
|
static void |
renderStyleClass(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.RenderingContext renderingContext, java.lang.String styleClass) Renders a style class with the current theme, if available. |
|
static void |
renderStyleClasses(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.RenderingContext renderingContext, java.lang.String[] styleClasses) Renders style classes with the current theme, if available. |
|
protected void |
renderVerticalSpacer(javax.faces.context.FacesContext context, java.lang.Object height, java.lang.Object id, javax.faces.component.UIComponent comp) Renders a vertical spacer for a specified non-null height. |
|
void |
setDragSource(DragSource dragSource, javax.faces.component.UIComponent component) Sets the default DragSource for the component in its attributes Map. |
|
void |
setupEncodingContext(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, org.apache.myfaces.trinidad.component.UIXComponent component) |
|
protected boolean |
shouldRenderId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component) |
|
protected boolean |
skipDecode(javax.faces.context.FacesContext context) Can be overridden to detect if decoding this component should be skipped. |
|
static boolean |
supportsAccessKeys(org.apache.myfaces.trinidad.context.RenderingContext arc) Returns true if the agent supports access keys. |
|
boolean |
supportsCSSStretching(org.apache.myfaces.trinidad.context.RenderingContext arc) Tests whether the agent supports CSS (top/bottom/left/right) stretching |
|
protected boolean |
supportsMessages() Returns whether the component supports messages. |
|
static boolean |
supportsNavigation(org.apache.myfaces.trinidad.context.RenderingContext arc) Returns true if the agent supports page-to-page navigation. |
|
static boolean |
supportsScrolling(org.apache.myfaces.trinidad.context.RenderingContext rc) Returns whether scrolling is supported by the agent. |
|
void |
tearDownEncodingContext(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, org.apache.myfaces.trinidad.component.UIXComponent component) |
Methods inherited from class org.apache.myfaces.trinidad.render.CoreRenderer |
---|
afterEncode, beforeEncode, delegateRendererBegin, delegateRendererEnd, encodeAllChildren, encodeBegin, encodeBegin, encodeChildren, encodeEnd, encodeEnd, getClientId, getFacesBean, getFacet, getNextRenderedChildIndex, getRenderedChildCount, getRenderingProperty, hasRenderedChildren, isDesktop, isGecko, isGenericPDA, isIE, isInaccessibleMode, isIPhone, isKonqueror, isNokiaS60, isPDA, isScreenReaderMode, isWebKit, partialEncodeVisit, renderEncodedActionURI, renderEncodedResourceURI, renderId, setRenderingProperty, setupEncodingContext, tearDownEncodingContext, toActionUri, toChar, toInt, toLong, toResourceUri, toString, toUri |
Methods inherited from class javax.faces.render.Renderer |
---|
convertClientId, getConvertedValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String THEME_ATTRIBUTE
public static final java.lang.String ENABLE_THEME_PROPERTY
public static final java.lang.String CHILDREN_THEME_PROPERTY
Constructor Detail |
---|
protected RichRenderer(org.apache.myfaces.trinidad.bean.FacesBean.Type type)
Method Detail |
---|
public javax.faces.render.Renderer cloneWithType(org.apache.myfaces.trinidad.bean.FacesBean.Type type)
cloneWithType
in interface org.apache.myfaces.trinidad.render.TypedRenderer
public final boolean getRendersChildren()
getRendersChildren
in class javax.faces.render.Renderer
public static final java.lang.Iterable<java.lang.String> getClientIdsToDecode(javax.faces.context.FacesContext context)
public static RichRenderer getRichRenderer(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
public static <S> S getRendererAs(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.Class<S> rendererClass)
public static javax.faces.render.Renderer getRenderer(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
public final void decode(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
decode
in class javax.faces.render.Renderer
public void decodeInternal(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String clientId)
context
- the FacesContextcomponent
- the componentclientId
- the pre-computed clientId of this componentpublic static void renderClickableIcon(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, boolean isTabStop, java.lang.String targetURL, java.lang.String[] styleClasses, java.lang.String id, java.lang.String tooltipString, java.lang.String iconName) throws java.io.IOException
context
- the FacesContext.rc
- the RenderingContext.component
- the UIComponent that is rendered.isTabStop
- If true, the icon is rendered as tab stop and it can accept focus. Otherwise the icon is not tab stop and cannot accept focus.targetURL
- target URL when clicked.styleClasses
- Used to render style class names for the icon. If your style class uses background-image to display the icon, its attributes should ensure proper sizing in IE and FireFox. See ".AFClickableImageAnchor_16x16" in rich components-simple-desktop.css for an alias you may be able to use.id
- the html DOM id of the icon.tooltipString
- the tooltip for this element.iconName
- the icon name of the application skinned icon. It's normally used if you want a text-only icon or a accessible icon instead of a background-image on the styleClass.java.io.IOException
public static void renderHelpIcon(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, java.lang.String helpTopicId, java.lang.String styleClass, java.lang.String disabledStyleClass, java.lang.String iconName, java.lang.String altText) throws java.io.IOException
context
- the FacesContext.rc
- the RenderingContext.component
- the UIComponent that is rendered.helpTopicId
- the helpTopicId attribute.styleClass
- the style class to render on the help icon.disabledStyleClass
- the disabled style class to render if there is no help system link for the helpTopicId.iconName
- the icon style name of the help icon..altText
- the alt text to attempt to render if there is no definition text for accessibility.java.io.IOException
protected boolean decodeIncompatiblePropertyKey(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String clientId, org.apache.myfaces.trinidad.bean.FacesBean bean, org.apache.myfaces.trinidad.bean.PropertyKey pKey, java.lang.String value)
context
- the FacesContextcomponent
- the componentclientId
- the component's client IDbean
- the FacesBean for the componentpKey
- the PropertyKey being decodedvalue
- the String value of this property keyprotected void decodeUnknownKey(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String name, java.lang.Object value)
context
- the FacesContextcomponent
- the componentbean
- the FacesBean for the componentname
- the name of the propertyvalue
- the value of this property keyprotected ClientEvent getClientEvent(javax.faces.context.FacesContext context, java.lang.String clientId, java.lang.String type)
protected void findTypeConstants(org.apache.myfaces.trinidad.bean.FacesBean.Type type, ClientMetadata metadata)
protected void renderId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ClientComponent client) throws java.io.IOException
java.io.IOException
protected final boolean needsExplicitId(javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean)
protected final boolean needsExplicitId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean)
protected final boolean needsExplicitId(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean)
protected boolean shouldRenderId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component)
shouldRenderId
in class org.apache.myfaces.trinidad.render.CoreRenderer
protected void renderAllRootAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) throws java.io.IOException
java.io.IOException
protected void renderAllRootAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, boolean renderStyleAttrs) throws java.io.IOException
java.io.IOException
protected void renderShortDescAttribute(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) throws java.io.IOException
java.io.IOException
@Deprecated
protected final void renderRootStyleAttributes(javax.faces.context.FacesContext context,
org.apache.myfaces.trinidad.context.RenderingContext rc,
ClientComponent client,
org.apache.myfaces.trinidad.bean.FacesBean bean)
throws java.io.IOException
java.io.IOException
@Deprecated
protected final void renderRootStyleAttributes(javax.faces.context.FacesContext context,
org.apache.myfaces.trinidad.context.RenderingContext rc,
ClientComponent client,
org.apache.myfaces.trinidad.bean.FacesBean bean,
java.lang.String defaultStyleClass)
throws java.io.IOException
java.io.IOException
protected final void renderRootStyleAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) throws java.io.IOException
java.io.IOException
protected final void renderRootStyleAttributes(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String defaultStyleClass) throws java.io.IOException
java.io.IOException
protected java.util.List<java.lang.String> getRootStateStyleClasses(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean)
protected java.util.List<java.lang.String> getRootStateStyleClasses(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean, javax.faces.component.UIComponent component)
protected void renderRootStyleClasses(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, java.lang.String defaultStyleClass, java.util.List<java.lang.String> stateStyleClasses) throws java.io.IOException
java.io.IOException
protected java.lang.String getDefaultStyleClass(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean)
This value is used as the component selector in the skin to retrieve skin properties like -tr-enable-themes and -tr-children-theme. Returning a different value will prevent a component from being themed.
public DragSource createDefaultDragSource(javax.faces.component.UIComponent component, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
component
-allowedActions
- Set of DnDAction
allowed actions for the dragdefaultAction
- the defaultActiondiscriminant
-dragDropEndListener
-properties
-public java.lang.String createDefaultDragSourceBehavior(javax.faces.component.UIComponent component, DragSource dragSource, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
component
- Component that this client DragSource is created for.dragSource
- DragSource to create clientDragSource initializer forpublic DragSource getDragSource(javax.faces.component.UIComponent component)
component
- the UIComponentpublic java.lang.String getDragSourceKey()
public void setDragSource(DragSource dragSource, javax.faces.component.UIComponent component)
dragSource
- the default DragSource associated with the component.component
- the UIComponent.public boolean hasDragSource(javax.faces.component.UIComponent component)
public final java.lang.String getDefaultStyleClass(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component)
protected final java.lang.String getClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, ClientComponent client)
public static RichRenderingContext getRichRenderingContext(org.apache.myfaces.trinidad.context.RenderingContext rc)
rc
- the current RenderingContextprotected boolean isLeafRenderer(javax.faces.component.UIComponent component)
protected final void encodeAll(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean) throws java.io.IOException
encodeAll
in class org.apache.myfaces.trinidad.render.CoreRenderer
java.io.IOException
public final <S> boolean encodeFlattenedComponents(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext, org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor, S callbackContext, javax.faces.component.UIComponent component) throws java.io.IOException
UIXComponent.setUpEncodingContext(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext)
and UIXComponent.tearDownEncodingContext(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext)
on the component.java.io.IOException
protected <S> boolean encodeFlattenedComponents(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.component.ComponentProcessingContext cpContext, org.apache.myfaces.trinidad.component.ComponentProcessor<S> childProcessor, S callbackContext, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) throws java.io.IOException
UIXComponent.setUpEncodingContext(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext)
and UIXComponent.tearDownEncodingContext(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext)
on the component.java.io.IOException
protected abstract void encodeAll(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean) throws java.io.IOException
java.io.IOException
protected void delegateRenderer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean, org.apache.myfaces.trinidad.render.CoreRenderer renderer) throws java.io.IOException
java.io.IOException
protected void delegateRenderer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean, org.apache.myfaces.trinidad.render.CoreRenderer renderer) throws java.io.IOException
delegateRenderer
in class org.apache.myfaces.trinidad.render.CoreRenderer
java.io.IOException
protected void delegateRenderer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent childComponent, org.apache.myfaces.trinidad.render.CoreRenderer renderer) throws java.io.IOException
java.io.IOException
protected abstract java.lang.String getClientConstructor()
protected ClientMetadata getEncodeClientMetadata(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, org.apache.myfaces.trinidad.bean.FacesBean bean)
public java.lang.String createSubId(java.lang.String clientId, java.lang.String name)
clientId
- the client ID of this componentname
- the name of the piece of the DOMpublic static java.lang.String createClientSubId(java.lang.String clientId, java.lang.String name)
clientId
- the client ID of this componentname
- the name of the piece of the DOMprotected ClientComponent.Type getClientComponentType(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, org.apache.myfaces.trinidad.bean.FacesBean bean)
getDefaultClientComponentType()
.
Note that Components should never override the default value of clientComponent to be true
, but should instead return CREATE_WITH_ATTRS from this function (which is the default behavior)
protected ClientComponent.Type getDefaultClientComponentType()
protected boolean supportsMessages()
public static boolean supportsScrolling(org.apache.myfaces.trinidad.context.RenderingContext rc)
protected boolean getVisible(org.apache.myfaces.trinidad.bean.FacesBean bean)
protected java.lang.String getShortDesc(org.apache.myfaces.trinidad.bean.FacesBean bean)
protected java.util.Set<java.lang.String> getUnsecurePropertyNames(org.apache.myfaces.trinidad.bean.FacesBean bean)
bean
- FacesBean instanceprotected java.util.Set<java.lang.String> getCheckedUnsecurePropertyNames(org.apache.myfaces.trinidad.bean.FacesBean bean)
bean
- FacesBean instanceprotected java.lang.String getStyleClass(org.apache.myfaces.trinidad.bean.FacesBean bean)
protected java.lang.String getPrependedInlineStyle(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, javax.faces.component.UIComponent component, ClientComponent client, org.apache.myfaces.trinidad.bean.FacesBean bean)
protected java.lang.String getInlineStyle(org.apache.myfaces.trinidad.bean.FacesBean bean)
protected java.util.Set<java.lang.String> getClientAttributes(org.apache.myfaces.trinidad.bean.FacesBean bean)
protected ClientListenerSet getClientListeners(org.apache.myfaces.trinidad.bean.FacesBean bean)
protected static boolean isChildVisible(javax.faces.component.UIComponent child)
protected void encodeStretchedChild(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, javax.faces.component.UIComponent component, java.lang.String parentPadding) throws java.io.IOException
context
- The Faces contextcomponent
- The child component to encodeparentPadding
- The CSS padding value (eg. "1px").java.io.IOException
encodeStretchedChildBegin(FacesContext, RenderingContext, String)
, isNextElementToBeStretched(FacesContext)
protected javax.faces.context.ResponseWriter encodeStretchedChildBegin(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String parentPadding) throws java.io.IOException
java.io.IOException
encodeStretchedChild(FacesContext, RenderingContext, UIComponent, String)
, encodeStretchedChildEnd(FacesContext, ResponseWriter)
, isNextElementToBeStretched(FacesContext)
protected javax.faces.context.ResponseWriter encodeStretchedChildBegin(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, java.lang.String parentTopPadding, java.lang.String parentRightPadding, java.lang.String parentBottomPadding, java.lang.String parentLeftPadding) throws java.io.IOException
java.io.IOException
encodeStretchedChild(FacesContext, RenderingContext, UIComponent, String)
, encodeStretchedChildEnd(FacesContext, ResponseWriter)
, isNextElementToBeStretched(FacesContext)
protected void encodeStretchedChildEnd(javax.faces.context.FacesContext context, javax.faces.context.ResponseWriter responseWriter) throws java.io.IOException
java.io.IOException
public boolean isNextElementToBeStretched(javax.faces.context.FacesContext context)
context
- the FacesContextencodeStretchedChild(FacesContext, RenderingContext, UIComponent, String)
, encodeStretchedChildBegin(FacesContext, RenderingContext, String)
public boolean supportsCSSStretching(org.apache.myfaces.trinidad.context.RenderingContext arc)
@Deprecated
protected void renderClickableIcon(javax.faces.context.FacesContext context,
org.apache.myfaces.trinidad.context.RenderingContext rc,
javax.faces.component.UIComponent component,
boolean isTabStop,
java.lang.String[] styleClasses,
java.lang.String id,
java.lang.String tooltipTextBundleKey,
java.lang.String iconName)
throws java.io.IOException
context
- the FacesContext.rc
- the RenderingContext.component
- the UIComponent that is rendered.isTabStop
- If true, the icon is rendered as tab stop and it can accept focus. Otherwise the icon is not tab stop and cannot accept focus.styleClasses
- Used to render style class names for the icon. If your style class uses background-image to display the icon, its attributes should ensure proper sizing in IE and FireFox. See ".AFClickableImageAnchor_16x16" in rich components-simple-desktop.css for an alias you may be able to use.id
- the html DOM id of the icon.tooltipTextBundleKey
- the key for the translated string to be displayed as tooltip.iconName
- the icon name of the application skinned icon. It's normally used as text only icon. If a valid icon name is passed in, that icon will be displayed and background-image style in styleClasses will have no effect in UI.java.io.IOException
protected static void makeNonEmpty(javax.faces.context.FacesContext context) throws java.io.IOException
java.io.IOException
public static boolean supportsAccessKeys(org.apache.myfaces.trinidad.context.RenderingContext arc)
public static boolean supportsNavigation(org.apache.myfaces.trinidad.context.RenderingContext arc)
protected boolean skipDecode(javax.faces.context.FacesContext context)
skipDecode
in class org.apache.myfaces.trinidad.render.CoreRenderer
protected static void renderHAlign(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.Object hAlign) throws java.io.IOException
java.io.IOException
protected final void renderPossiblyFormattedText(javax.faces.context.FacesContext context, java.lang.Object textValue) throws java.io.IOException
java.io.IOException
protected final void renderFormattedText(javax.faces.context.FacesContext context, java.lang.Object textValue) throws java.io.IOException
RichOutputFormatted
.java.io.IOException
protected final void renderSpacer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String width, java.lang.String height) throws java.io.IOException
java.io.IOException
protected final void renderSpacer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String width, java.lang.String height, java.lang.String id, java.lang.String shortDesc, javax.faces.component.UIComponent component) throws java.io.IOException
java.io.IOException
protected final void renderSpacer(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext arc, java.lang.String width, java.lang.String height, java.lang.String id, java.lang.String shortDesc, javax.faces.component.UIComponent component, java.lang.String inlineStyle) throws java.io.IOException
java.io.IOException
protected final void renderVerticalSpacer(javax.faces.context.FacesContext context, java.lang.Object height, java.lang.Object id, javax.faces.component.UIComponent comp) throws java.io.IOException
java.io.IOException
protected void addAttributeChange(javax.faces.component.UIComponent comp, java.lang.String attrName, java.lang.Object attrValue)
comp
-attrName
-attrValue
-public void setupEncodingContext(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, org.apache.myfaces.trinidad.component.UIXComponent component)
setupEncodingContext
in class org.apache.myfaces.trinidad.render.CoreRenderer
public void tearDownEncodingContext(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.context.RenderingContext rc, org.apache.myfaces.trinidad.component.UIXComponent component)
tearDownEncodingContext
in class org.apache.myfaces.trinidad.render.CoreRenderer
protected void encodeChild(javax.faces.context.FacesContext context, javax.faces.component.UIComponent child) throws java.io.IOException
encodeChild
in class org.apache.myfaces.trinidad.render.CoreRenderer
java.io.IOException
protected boolean isThemeEnabled(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.RenderingContext renderingContext, javax.faces.component.UIComponent uiComponent, org.apache.myfaces.trinidad.bean.FacesBean facesBean)
Note that this is not related to if a component changes the theme by pushing the current theme onto the RichRenderingContext
.
setupEncodingContext(FacesContext, RenderingContext, UIXComponent)
facesContext
- facesContext instancerenderingContext
- current rendering contextuiComponent
- component being renderedfacesBean
- faces bean of the componentENABLE_THEME_PROPERTY
, setupEncodingContext(FacesContext, RenderingContext, UIXComponent)
, renderStyleClass(FacesContext, RenderingContext, String)
, renderStyleClasses(FacesContext, RenderingContext, String[])
public static void renderStyleClasses(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.RenderingContext renderingContext, java.lang.String[] styleClasses) throws java.io.IOException
CoreRenderer.renderStyleClasses(FacesContext, RenderingContext, String[])
to render a style classes. If there is a current theme, it is appended to the array of style classes.facesContext
- The current FacesContextrenderingContext
- The current RenderingContextstyleClasses
- The styleClasses to renderjava.io.IOException
- If rendering failspublic static void renderStyleClass(javax.faces.context.FacesContext facesContext, org.apache.myfaces.trinidad.context.RenderingContext renderingContext, java.lang.String styleClass) throws java.io.IOException
CoreRenderer.renderStyleClass(FacesContext, RenderingContext, String)
to render a style class. If there is a current theme, CoreRenderer.renderStyleClasses(FacesContext, RenderingContext, String[])
is used with the theme as the second style class in the array.facesContext
- The current FacesContextrenderingContext
- The current RenderingContextstyleClass
- The styleClass to renderjava.io.IOException
- If rendering failspublic static java.lang.String getTheme(org.apache.myfaces.trinidad.context.RenderingContext renderingContext)
renderingContext
- The current rendering contextpushTheme(RenderingContext, String)
public static void pushTheme(org.apache.myfaces.trinidad.context.RenderingContext renderingContext, java.lang.String theme)
renderingContext
- The current rendering contexttheme
- The new/current themeRichRenderingContext.pushTheme(String)
, popTheme(RenderingContext)
public static java.lang.String popTheme(org.apache.myfaces.trinidad.context.RenderingContext renderingContext)
renderingContext
- The current rendering contextpushTheme(RenderingContext, String)
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |