com.sun.webui.jsf.component
Class Body

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.webui.jsf.component.Body
All Implemented Interfaces:
javax.faces.component.StateHolder

public class Body
extends javax.faces.component.UIComponentBase

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

FOCUS_PARAM

public static final java.lang.String FOCUS_PARAM
Deprecated. 
See Also:
Constant Field Values

JAVASCRIPT_OBJECT

public static final java.lang.String JAVASCRIPT_OBJECT
Deprecated. 
See Also:
Constant Field Values
Constructor Detail

Body

public Body()
Default constructor.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Specified by:
getFamily in class javax.faces.component.UIComponent

getFocusID

public java.lang.String getFocusID(javax.faces.context.FacesContext context)
Deprecated. 

See Also:
getFocus()

getJavaScriptObjectName

public java.lang.String getJavaScriptObjectName(javax.faces.context.FacesContext context)
Deprecated. 


setId

public void setId(java.lang.String id)
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.

Overrides:
setId in class javax.faces.component.UIComponentBase

setRendered

public 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. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.

Overrides:
setRendered in class javax.faces.component.UIComponentBase

getFocus

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.


setFocus

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.

See Also:
getFocus()

getImageURL

public java.lang.String getImageURL()

The path to an image to be used as a background for the page.


setImageURL

public void setImageURL(java.lang.String imageURL)

The path to an image to be used as a background for the page.

See Also:
getImageURL()

getOnBlur

public java.lang.String getOnBlur()

Scripting code executed when this element loses focus.


setOnBlur

public void setOnBlur(java.lang.String onBlur)

Scripting code executed when this element loses focus.

See Also:
getOnBlur()

getOnClick

public java.lang.String getOnClick()

Scripting code executed when a mouse click occurs over this component.


setOnClick

public void setOnClick(java.lang.String onClick)

Scripting code executed when a mouse click occurs over this component.

See Also:
getOnClick()

getOnDblClick

public java.lang.String getOnDblClick()

Scripting code that executes when a mouse double click occurs over this component.


setOnDblClick

public void setOnDblClick(java.lang.String onDblClick)

Scripting code that executes when a mouse double click occurs over this component.

See Also:
getOnDblClick()

getOnFocus

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.


setOnFocus

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.

See Also:
getOnFocus()

getOnKeyDown

public java.lang.String getOnKeyDown()

Scripting code that executes when the user presses down on a key while the component has focus.


setOnKeyDown

public void setOnKeyDown(java.lang.String onKeyDown)

Scripting code that executes when the user presses down on a key while the component has focus.

See Also:
getOnKeyDown()

getOnKeyPress

public java.lang.String getOnKeyPress()

Scripting code that executes when the user presses and releases a key while the component has focus.


setOnKeyPress

public void setOnKeyPress(java.lang.String onKeyPress)

Scripting code that executes when the user presses and releases a key while the component has focus.

See Also:
getOnKeyPress()

getOnKeyUp

public java.lang.String getOnKeyUp()

Scripting code that executes when the user releases a key while the component has focus.


setOnKeyUp

public void setOnKeyUp(java.lang.String onKeyUp)

Scripting code that executes when the user releases a key while the component has focus.

See Also:
getOnKeyUp()

getOnLoad

public java.lang.String getOnLoad()

Scripting code that executes when when this page is loaded in a browser.


setOnLoad

public void setOnLoad(java.lang.String onLoad)

Scripting code that executes when when this page is loaded in a browser.

See Also:
getOnLoad()

getOnMouseDown

public java.lang.String getOnMouseDown()

Scripting code that executes when the user presses a mouse button while the mouse pointer is on the component.


setOnMouseDown

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.

See Also:
getOnMouseDown()

getOnMouseMove

public java.lang.String getOnMouseMove()

Scripting code that executes when the user moves the mouse pointer while over the component.


setOnMouseMove

public void setOnMouseMove(java.lang.String onMouseMove)

Scripting code that executes when the user moves the mouse pointer while over the component.

See Also:
getOnMouseMove()

getOnMouseOut

public java.lang.String getOnMouseOut()

Scripting code that executes when a mouse out movement occurs over this component.


setOnMouseOut

public void setOnMouseOut(java.lang.String onMouseOut)

Scripting code that executes when a mouse out movement occurs over this component.

See Also:
getOnMouseOut()

getOnMouseOver

public java.lang.String getOnMouseOver()

Scripting code that executes when the user moves the mouse pointer into the boundary of this component.


setOnMouseOver

public void setOnMouseOver(java.lang.String onMouseOver)

Scripting code that executes when the user moves the mouse pointer into the boundary of this component.

See Also:
getOnMouseOver()

getOnMouseUp

public java.lang.String getOnMouseUp()

Scripting code that executes when the user releases a mouse button while the mouse pointer is on the component.


setOnMouseUp

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.

See Also:
getOnMouseUp()

getOnUnload

public java.lang.String getOnUnload()

Scripting code that executes when this page is unloaded from a browser as a user exits the page.


setOnUnload

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.

See Also:
getOnUnload()

isPreserveFocus

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.


setPreserveFocus

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.


isPreserveScroll

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


setPreserveScroll

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


getStyle

public java.lang.String getStyle()

CSS style or styles to be applied to the outermost HTML element when this component is rendered.


setStyle

public void setStyle(java.lang.String style)

CSS style or styles to be applied to the outermost HTML element when this component is rendered.

See Also:
getStyle()

getStyleClass

public java.lang.String getStyleClass()

CSS style class or classes to be applied to the outermost HTML element when the body component is rendered.


setStyleClass

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.

See Also:
getStyleClass()

isVisible

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.


setVisible

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.

See Also:
isVisible()

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.UIComponentBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.

Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.UIComponentBase


Copyright © 2008 Sun Microsystems, Inc. All Rights Reserved.