|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
com.sun.webui.jsf.component.Body
public class Body
The Body component is used to contain the other components of the page.
Field Summary | |
---|---|
static java.lang.String |
FOCUS_PARAM
Deprecated. |
static java.lang.String |
JAVASCRIPT_OBJECT
Deprecated. |
Constructor Summary | |
---|---|
Body()
Default constructor. |
Method Summary | |
---|---|
java.lang.String |
getFamily()
Return the family for this component. |
java.lang.String |
getFocus()
Specify the ID of the component that should receive focus when the page is loaded. |
java.lang.String |
getFocusID(javax.faces.context.FacesContext context)
Deprecated. |
java.lang.String |
getImageURL()
The path to an image to be used as a background for the page. |
java.lang.String |
getJavaScriptObjectName(javax.faces.context.FacesContext context)
Deprecated. |
java.lang.String |
getOnBlur()
Scripting code executed when this element loses focus. |
java.lang.String |
getOnClick()
Scripting code executed when a mouse click occurs over this component. |
java.lang.String |
getOnDblClick()
Scripting code that executes when a mouse double click occurs over this component. |
java.lang.String |
getOnFocus()
Scripting code that executes when this component receives focus. |
java.lang.String |
getOnKeyDown()
Scripting code that executes when the user presses down on a key while the component has focus. |
java.lang.String |
getOnKeyPress()
Scripting code that executes when the user presses and releases a key while the component has focus. |
java.lang.String |
getOnKeyUp()
Scripting code that executes when the user releases a key while the component has focus. |
java.lang.String |
getOnLoad()
Scripting code that executes when when this page is loaded in a browser. |
java.lang.String |
getOnMouseDown()
Scripting code that executes when the user presses a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnMouseMove()
Scripting code that executes when the user moves the mouse pointer while over the component. |
java.lang.String |
getOnMouseOut()
Scripting code that executes when a mouse out movement occurs over this component. |
java.lang.String |
getOnMouseOver()
Scripting code that executes when the user moves the mouse pointer into the boundary of this component. |
java.lang.String |
getOnMouseUp()
Scripting code that executes when the user releases a mouse button while the mouse pointer is on the component. |
java.lang.String |
getOnUnload()
Scripting code that executes when this page is unloaded from a browser as a user exits the page. |
java.lang.String |
getStyle()
CSS style or styles to be applied to the outermost HTML element when this component is rendered. |
java.lang.String |
getStyleClass()
CSS style class or classes to be applied to the outermost HTML element when the body component is rendered. |
boolean |
isPreserveFocus()
Indicates whether the last element to have the focus, receives the focus the next time the page is rendered. |
boolean |
isPreserveScroll()
Use the preserveScroll attribute to indicate whether the page should remember the scroll position when navigating to and from the page. |
boolean |
isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setFocus(java.lang.String focus)
Specify the ID of the component that should receive focus when the page is loaded. |
void |
setId(java.lang.String id)
The component identifier for this component. |
void |
setImageURL(java.lang.String imageURL)
The path to an image to be used as a background for the page. |
void |
setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus. |
void |
setOnClick(java.lang.String onClick)
Scripting code executed when a mouse click occurs over this component. |
void |
setOnDblClick(java.lang.String onDblClick)
Scripting code that executes when a mouse double click occurs over this component. |
void |
setOnFocus(java.lang.String onFocus)
Scripting code that executes when this component receives focus. |
void |
setOnKeyDown(java.lang.String onKeyDown)
Scripting code that executes when the user presses down on a key while the component has focus. |
void |
setOnKeyPress(java.lang.String onKeyPress)
Scripting code that executes when the user presses and releases a key while the component has focus. |
void |
setOnKeyUp(java.lang.String onKeyUp)
Scripting code that executes when the user releases a key while the component has focus. |
void |
setOnLoad(java.lang.String onLoad)
Scripting code that executes when when this page is loaded in a browser. |
void |
setOnMouseDown(java.lang.String onMouseDown)
Scripting code that executes when the user presses a mouse button while the mouse pointer is on the component. |
void |
setOnMouseMove(java.lang.String onMouseMove)
Scripting code that executes when the user moves the mouse pointer while over the component. |
void |
setOnMouseOut(java.lang.String onMouseOut)
Scripting code that executes when a mouse out movement occurs over this component. |
void |
setOnMouseOver(java.lang.String onMouseOver)
Scripting code that executes when the user moves the mouse pointer into the boundary of this component. |
void |
setOnMouseUp(java.lang.String onMouseUp)
Scripting code that executes when the user releases a mouse button while the mouse pointer is on the component. |
void |
setOnUnload(java.lang.String onUnload)
Scripting code that executes when this page is unloaded from a browser as a user exits the page. |
void |
setPreserveFocus(boolean preserveFocus)
Indicates whether the last element to have the focus, receives the focus the next time the page is rendered. |
void |
setPreserveScroll(boolean preserveScroll)
Use the preserveScroll attribute to indicate whether the page should remember the scroll position when navigating to and from the page. |
void |
setRendered(boolean rendered)
Use the rendered attribute to indicate whether the HTML code for the component should be included in the rendered HTML page. |
void |
setStyle(java.lang.String style)
CSS style or styles to be applied to the outermost HTML element when this component is rendered. |
void |
setStyleClass(java.lang.String styleClass)
CSS style class or classes to be applied to the outermost HTML element when the body component is rendered. |
void |
setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FOCUS_PARAM
public static final java.lang.String JAVASCRIPT_OBJECT
Constructor Detail |
---|
public Body()
Method Detail |
---|
public java.lang.String getFamily()
Return the family for this component.
getFamily
in class javax.faces.component.UIComponent
public java.lang.String getFocusID(javax.faces.context.FacesContext context)
getFocus()
public java.lang.String getJavaScriptObjectName(javax.faces.context.FacesContext context)
public void setId(java.lang.String id)
setId
in class javax.faces.component.UIComponentBase
public void setRendered(boolean rendered)
setRendered
in class javax.faces.component.UIComponentBase
public java.lang.String getFocus()
Specify the ID of the component that should receive focus when the page is loaded. If the focus attribute is not set, or if the value is null, no component has focus when the page is initially rendered. If the page is submitted and reloaded, the component that submitted the page receives focus. By setting the focus attribute, you can ensure that a particular component receives focus each time.
public void setFocus(java.lang.String focus)
Specify the ID of the component that should receive focus when the page is loaded. If the focus attribute is not set, or if the value is null, no component has focus when the page is initially rendered. If the page is submitted and reloaded, the component that submitted the page receives focus. By setting the focus attribute, you can ensure that a particular component receives focus each time.
getFocus()
public java.lang.String getImageURL()
The path to an image to be used as a background for the page.
public void setImageURL(java.lang.String imageURL)
The path to an image to be used as a background for the page.
getImageURL()
public java.lang.String getOnBlur()
Scripting code executed when this element loses focus.
public void setOnBlur(java.lang.String onBlur)
Scripting code executed when this element loses focus.
getOnBlur()
public java.lang.String getOnClick()
Scripting code executed when a mouse click occurs over this component.
public void setOnClick(java.lang.String onClick)
Scripting code executed when a mouse click occurs over this component.
getOnClick()
public java.lang.String getOnDblClick()
Scripting code that executes when a mouse double click occurs over this component.
public void setOnDblClick(java.lang.String onDblClick)
Scripting code that executes when a mouse double click occurs over this component.
getOnDblClick()
public java.lang.String getOnFocus()
Scripting code that executes when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.
public void setOnFocus(java.lang.String onFocus)
Scripting code that executes when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.
getOnFocus()
public java.lang.String getOnKeyDown()
Scripting code that executes when the user presses down on a key while the component has focus.
public void setOnKeyDown(java.lang.String onKeyDown)
Scripting code that executes when the user presses down on a key while the component has focus.
getOnKeyDown()
public java.lang.String getOnKeyPress()
Scripting code that executes when the user presses and releases a key while the component has focus.
public void setOnKeyPress(java.lang.String onKeyPress)
Scripting code that executes when the user presses and releases a key while the component has focus.
getOnKeyPress()
public java.lang.String getOnKeyUp()
Scripting code that executes when the user releases a key while the component has focus.
public void setOnKeyUp(java.lang.String onKeyUp)
Scripting code that executes when the user releases a key while the component has focus.
getOnKeyUp()
public java.lang.String getOnLoad()
Scripting code that executes when when this page is loaded in a browser.
public void setOnLoad(java.lang.String onLoad)
Scripting code that executes when when this page is loaded in a browser.
getOnLoad()
public java.lang.String getOnMouseDown()
Scripting code that executes when the user presses a mouse button while the mouse pointer is on the component.
public void setOnMouseDown(java.lang.String onMouseDown)
Scripting code that executes when the user presses a mouse button while the mouse pointer is on the component.
getOnMouseDown()
public java.lang.String getOnMouseMove()
Scripting code that executes when the user moves the mouse pointer while over the component.
public void setOnMouseMove(java.lang.String onMouseMove)
Scripting code that executes when the user moves the mouse pointer while over the component.
getOnMouseMove()
public java.lang.String getOnMouseOut()
Scripting code that executes when a mouse out movement occurs over this component.
public void setOnMouseOut(java.lang.String onMouseOut)
Scripting code that executes when a mouse out movement occurs over this component.
getOnMouseOut()
public java.lang.String getOnMouseOver()
Scripting code that executes when the user moves the mouse pointer into the boundary of this component.
public void setOnMouseOver(java.lang.String onMouseOver)
Scripting code that executes when the user moves the mouse pointer into the boundary of this component.
getOnMouseOver()
public java.lang.String getOnMouseUp()
Scripting code that executes when the user releases a mouse button while the mouse pointer is on the component.
public void setOnMouseUp(java.lang.String onMouseUp)
Scripting code that executes when the user releases a mouse button while the mouse pointer is on the component.
getOnMouseUp()
public java.lang.String getOnUnload()
Scripting code that executes when this page is unloaded from a browser as a user exits the page.
public void setOnUnload(java.lang.String onUnload)
Scripting code that executes when this page is unloaded from a browser as a user exits the page.
getOnUnload()
public boolean isPreserveFocus()
Indicates whether the last
element to have the focus, receives the focus the
next time the page is rendered. If this is set to true
the
focus is preserved; if set to false
it is not.
If set to false
and the focus
attribute
is set then the element identified by that id receives the
focus. The default value is true.
public void setPreserveFocus(boolean preserveFocus)
Indicates whether the last
element to have the focus, receives the focus the
next time the page is rendered. If this is set to true
the
focus is preserved; if set to false
it is not.
If set to false
and the focus
attribute
is set then the element identified by that id receives the
focus. The default value is true.
public boolean isPreserveScroll()
Use the preserveScroll attribute to indicate whether the page
should remember the scroll position when navigating to and from
the page. The default value is true
public void setPreserveScroll(boolean preserveScroll)
Use the preserveScroll attribute to indicate whether the page
should remember the scroll position when navigating to and from
the page. The default value is true
public java.lang.String getStyle()
CSS style or styles to be applied to the outermost HTML element when this component is rendered.
public void setStyle(java.lang.String style)
CSS style or styles to be applied to the outermost HTML element when this component is rendered.
getStyle()
public java.lang.String getStyleClass()
CSS style class or classes to be applied to the outermost HTML element when the body component is rendered.
public void setStyleClass(java.lang.String styleClass)
CSS style class or classes to be applied to the outermost HTML element when the body component is rendered.
getStyleClass()
public boolean isVisible()
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
public void setVisible(boolean visible)
Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page. If set to false, the HTML code for the component is present in the page, but the component is hidden with style attributes. By default, visible is set to true, so HTML for the component HTML is included and visible to the user. If the component is not visible, it can still be processed on subsequent form submissions because the HTML is present.
isVisible()
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
Restore the state of this component.
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIComponentBase
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
Save the state of this component.
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |