Skip navigation links

org.apache.myfaces.trinidad.component.html
Class HtmlBody

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.html.HtmlBody

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlBody

extends UIXComponentBase

<html:p> Tag for the HTML body element. In addition to providing support for the standard HTML body functionality, the Trinidad body component enables partial-page rendering (PPR) support and assigning initial page focus. </html:p>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	FIRST_CLICK_PASSED_KEY
static PropertyKey	INITIAL_FOCUS_ID_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONLOAD_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	ONUNLOAD_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	HtmlBody() Construct an instance of the HtmlBody.
protected	HtmlBody(java.lang.String rendererType) Construct an instance of the HtmlBody.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getInitialFocusId() Gets the id of the component to which you want the focus to be when the full page renders.
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnload() Gets an onload Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String	getOnunload() Gets an onunload Javascript handler.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
boolean	isFirstClickPassed() Gets whether or not Trinidad will allow the first click to go through in certain instances.
void	setFirstClickPassed(boolean firstClickPassed) Sets whether or not Trinidad will allow the first click to go through in certain instances.
void	setInitialFocusId(java.lang.String initialFocusId) Sets the id of the component to which you want the focus to be when the full page renders.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnload(java.lang.String onload) Sets an onload Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setOnunload(java.lang.String onunload) Sets an onunload Javascript handler.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FacesBean.Type TYPE

FIRST_CLICK_PASSED_KEY

public static final PropertyKey FIRST_CLICK_PASSED_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

ONLOAD_KEY

public static final PropertyKey ONLOAD_KEY

ONUNLOAD_KEY

public static final PropertyKey ONUNLOAD_KEY

INITIAL_FOCUS_ID_KEY

public static final PropertyKey INITIAL_FOCUS_ID_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlBody

public HtmlBody()

Construct an instance of the HtmlBody.

HtmlBody

protected HtmlBody(java.lang.String rendererType)

Construct an instance of the HtmlBody.

Method Detail

isFirstClickPassed

public final boolean isFirstClickPassed()

Gets whether or not Trinidad will allow the first click to go through in certain instances. When a PPR event occurs, we block all subsequent user input until it completes. However, there may be instances where the client wants to receive the very first click. For example, if the user entered text in an inputText that fires a PPR request, then the user immediately clicked a submit button two events will be triggered - an onchange followed by an onclick. The onchange will trigger the client action which will immediately start the PPR blocking, so the onclick will get consumed by the blocking code and no submit will occur. Setting this value to true will allow the click to go through.

Returns:

the new firstClickPassed value

setFirstClickPassed

public final void setFirstClickPassed(boolean firstClickPassed)

Sets whether or not Trinidad will allow the first click to go through in certain instances. When a PPR event occurs, we block all subsequent user input until it completes. However, there may be instances where the client wants to receive the very first click. For example, if the user entered text in an inputText that fires a PPR request, then the user immediately clicked a submit button two events will be triggered - an onchange followed by an onclick. The onchange will trigger the client action which will immediately start the PPR blocking, so the onclick will get consumed by the blocking code and no submit will occur. Setting this value to true will allow the click to go through.

Parameters:

firstClickPassed - the new firstClickPassed value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

Parameters:

shortDesc - the new shortDesc value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Parameters:

partialTriggers - the new partialTriggers value

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

Returns:

the new onclick value

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

Parameters:

onclick - the new onclick value

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

Returns:

the new ondblclick value

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

Parameters:

ondblclick - the new ondblclick value

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

Returns:

the new onmousedown value

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

Parameters:

onmousedown - the new onmousedown value

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

Returns:

the new onmouseup value

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

Parameters:

onmouseup - the new onmouseup value

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

Returns:

the new onmouseover value

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

Parameters:

onmouseover - the new onmouseover value

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

Returns:

the new onmousemove value

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

Parameters:

onmousemove - the new onmousemove value

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

Returns:

the new onmouseout value

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

Parameters:

onmouseout - the new onmouseout value

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

Returns:

the new onkeypress value

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

Parameters:

onkeypress - the new onkeypress value

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

Returns:

the new onkeydown value

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

Parameters:

onkeydown - the new onkeydown value

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

Returns:

the new onkeyup value

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

Parameters:

onkeyup - the new onkeyup value

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

Parameters:

styleClass - the new styleClass value

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

Parameters:

inlineStyle - the new inlineStyle value

getOnload

public final java.lang.String getOnload()

Gets an onload Javascript handler.

Returns:

the new onload value

setOnload

public final void setOnload(java.lang.String onload)

Sets an onload Javascript handler.

Parameters:

onload - the new onload value

getOnunload

public final java.lang.String getOnunload()

Gets an onunload Javascript handler.

Returns:

the new onunload value

setOnunload

public final void setOnunload(java.lang.String onunload)

Sets an onunload Javascript handler.

Parameters:

onunload - the new onunload value

getInitialFocusId

public final java.lang.String getInitialFocusId()

Gets the id of the component to which you want the focus to be when the full page renders. The accessibility-mode must be set to "inaccessible" for this feature to be on.

Returns:

the new initialFocusId value

setInitialFocusId

public final void setInitialFocusId(java.lang.String initialFocusId)

Sets the id of the component to which you want the focus to be when the full page renders. The accessibility-mode must be set to "inaccessible" for this feature to be on.

Parameters:

initialFocusId - the new initialFocusId value

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase

Skip navigation links