|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.myfaces.trinidad.context.RenderingContext
public abstract class RenderingContext
The RenderingContext holds context information about the current rendering. The RenderingContext is useful for Renderers. The RenderingContext is passed in to the CoreRenderer. For example, a renderer may need to render differently if it is rendering to a browser in right-to-left mode, or if accessibility mode is on, etc. Some values are promoted up from RequestContext for ease of use while rendering.
CoreRenderer.encodeAll(javax.faces.context.FacesContext, org.apache.myfaces.trinidad.context.RenderingContext, javax.faces.component.UIComponent, org.apache.myfaces.trinidad.bean.FacesBean)
,
RequestContext
Constructor Summary | |
---|---|
RenderingContext()
|
Method Summary | |
---|---|
protected void |
attach()
Attaches an RenderingContext to the current thread. |
abstract void |
clearFormData()
Clear the FormData that is on the RenderingContext |
abstract RequestContext.Accessibility |
getAccessibilityMode()
Get the accessibility mode (e.g., DEFAULT, INACCESSIBLE, etc) that is attached to this RenderingContext |
abstract AccessibilityProfile |
getAccessibilityProfile()
Get the AccessibilityProfile (a set of accessibility-related properties that are applied to the current request, e.g., color contrast, font size, etc) that is attached to this RenderingContext. |
abstract Agent |
getAgent()
Get the Agent attached to the RenderingContext. |
String |
getCurrentClientId()
Get the current client id for this RenderingContext |
static RenderingContext |
getCurrentInstance()
Retrieves the RenderingContext active for the current thread. |
abstract FormData |
getFormData()
Get the FormData that is on the RenderingContext. |
abstract Icon |
getIcon(String iconName)
Get the Icon attached to this RenderingContext, give the iconName. |
abstract LocaleContext |
getLocaleContext()
Get the LocaleContext attached to the RenderingContext |
abstract String |
getOutputMode()
Returns the output mode for this RenderingContext. |
abstract PartialPageContext |
getPartialPageContext()
Get the ParialPageContext that is attached to this RenderingContext |
abstract Map<Object,Object> |
getProperties()
Get a map of properties specific to rendering. |
abstract Skin |
getSkin()
Get the Skin that is attached to this RenderingContext. |
abstract Map<String,String> |
getSkinResourceKeyMap()
Get the skin resource key map that is attached to the RenderingContext. |
abstract String |
getStyleClass(String styleClass)
Get a styleClass given a styleClass. |
Styles |
getStyles()
Get the Styles object that is attached to this RenderingContext. |
String |
getTranslatedString(String key)
Get the translated String given a translation key. |
abstract boolean |
isAnimationEnabled()
Returns true or false for whether animation is enabled. |
abstract boolean |
isRightToLeft()
Returns a boolean to indicate whether or not the RenderingContext is in right-to-left reading direction mode. |
void |
release()
|
void |
setCurrentClientId(String currentClientId)
Set the current client id for this RenderingContext |
abstract void |
setFormData(FormData data)
Set FormData on the RenderingContext. |
abstract void |
setSkinResourceKeyMap(Map<String,String> mapping)
Set the skin resource key map on the RenderingContext. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public RenderingContext()
Method Detail |
---|
public static RenderingContext getCurrentInstance()
public abstract Map<Object,Object> getProperties()
public abstract Agent getAgent()
public abstract LocaleContext getLocaleContext()
public abstract FormData getFormData()
public abstract void setFormData(FormData data)
data
- public abstract void clearFormData()
public abstract Skin getSkin()
public String getTranslatedString(String key)
key
-
public abstract Icon getIcon(String iconName)
iconName
-
public abstract String getStyleClass(String styleClass)
styleClass
- the styleClass name that you want to render
public Styles getStyles()
public abstract void setSkinResourceKeyMap(Map<String,String> mapping)
mapping
- getSkinResourceKeyMap()
public abstract Map<String,String> getSkinResourceKeyMap()
setSkinResourceKeyMap(java.util.Map)
public abstract boolean isRightToLeft()
public abstract String getOutputMode()
public abstract RequestContext.Accessibility getAccessibilityMode()
public abstract AccessibilityProfile getAccessibilityProfile()
public abstract boolean isAnimationEnabled()
public String getCurrentClientId()
public void setCurrentClientId(String currentClientId)
currentClientId
- public abstract PartialPageContext getPartialPageContext()
public void release()
protected void attach()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |