Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.faces.component.html
Class HtmlBody

    java.lang.Object
      javax.faces.component.UIComponent
          javax.faces.component.UIComponentBase
              javax.faces.component.UIOutput
                  javax.faces.component.html.HtmlBody

All Implemented Interfaces:
  EventListener, ClientBehaviorHolder, PartialStateHolder, StateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

    public class HtmlBody

extends UIOutput
implements ClientBehaviorHolder

NONE

By default, the `rendererType` property must be set to "`javax.faces.Body`". This value can be changed by calling the `setRendererType()` method.

Nested Class Summary
`protected static class` | `HtmlBody.PropertyKeys`

Field Summary
`static String` | `COMPONENT_TYPE` The standard component type for this component.

Fields inherited from class javax.faces.component.UIOutput
`COMPONENT_FAMILY`

Fields inherited from class javax.faces.component.UIComponent
`BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY`

Constructor Summary
`HtmlBody()`

Method Summary
`String` | `getDefaultEventName()` This is a default implementation of `ClientBehaviorHolder.getDefaultEventName()`.
`String` | `getDir()` Return the value of the `dir` property.
`Collection<String>` | `getEventNames()` This is a default implementation of `ClientBehaviorHolder.getEventNames()`.
`String` | `getLang()` Return the value of the `lang` property.
`String` | `getOnclick()` Return the value of the `onclick` property.
`String` | `getOndblclick()` Return the value of the `ondblclick` property.
`String` | `getOnkeydown()` Return the value of the `onkeydown` property.
`String` | `getOnkeypress()` Return the value of the `onkeypress` property.
`String` | `getOnkeyup()` Return the value of the `onkeyup` property.
`String` | `getOnload()` Return the value of the `onload` property.
`String` | `getOnmousedown()` Return the value of the `onmousedown` property.
`String` | `getOnmousemove()` Return the value of the `onmousemove` property.
`String` | `getOnmouseout()` Return the value of the `onmouseout` property.
`String` | `getOnmouseover()` Return the value of the `onmouseover` property.
`String` | `getOnmouseup()` Return the value of the `onmouseup` property.
`String` | `getOnunload()` Return the value of the `onunload` property.
`String` | `getStyle()` Return the value of the `style` property.
`String` | `getStyleClass()` Return the value of the `styleClass` property.
`String` | `getTitle()` Return the value of the `title` property.
`void` | `setDir(String dir)` Set the value of the `dir` property.
`void` | `setLang(String lang)` Set the value of the `lang` property.
`void` | `setOnclick(String onclick)` Set the value of the `onclick` property.
`void` | `setOndblclick(String ondblclick)` Set the value of the `ondblclick` property.
`void` | `setOnkeydown(String onkeydown)` Set the value of the `onkeydown` property.
`void` | `setOnkeypress(String onkeypress)` Set the value of the `onkeypress` property.
`void` | `setOnkeyup(String onkeyup)` Set the value of the `onkeyup` property.
`void` | `setOnload(String onload)` Set the value of the `onload` property.
`void` | `setOnmousedown(String onmousedown)` Set the value of the `onmousedown` property.
`void` | `setOnmousemove(String onmousemove)` Set the value of the `onmousemove` property.
`void` | `setOnmouseout(String onmouseout)` Set the value of the `onmouseout` property.
`void` | `setOnmouseover(String onmouseover)` Set the value of the `onmouseover` property.
`void` | `setOnmouseup(String onmouseup)` Set the value of the `onmouseup` property.
`void` | `setOnunload(String onunload)` Set the value of the `onunload` property.
`void` | `setStyle(String style)` Set the value of the `style` property.
`void` | `setStyleClass(String styleClass)` Set the value of the `styleClass` property.
`void` | `setTitle(String title)` Set the value of the `title` property.

Methods inherited from class javax.faces.component.UIOutput
`clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, restoreState, saveState, setConverter, setValue`

Methods inherited from class javax.faces.component.UIComponentBase
`addClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding`

Methods inherited from class javax.faces.component.UIComponent
`encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
`addClientBehavior, getClientBehaviors`

Field Detail

### COMPONENT_TYPE

    public static final String COMPONENT_TYPE

  The standard component type for this component.

  See Also:
    Constant Field Values

Constructor Detail

### HtmlBody

    public HtmlBody()

Method Detail

### getDir

    public String getDir()

  Return the value of the `dir` property.

  Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left).

### setDir

    public void setDir(String dir)

  Set the value of the `dir` property.

### getLang

    public String getLang()

  Return the value of the `lang` property.

  Contents: Code describing the language used in the generated markup for this component.

### setLang

    public void setLang(String lang)

  Set the value of the `lang` property.

### getOnclick

    public String getOnclick()

  Return the value of the `onclick` property.

  Contents: Javascript code executed when a pointer button is clicked over this element.

### setOnclick

    public void setOnclick(String onclick)

  Set the value of the `onclick` property.

### getOndblclick

    public String getOndblclick()

  Return the value of the `ondblclick` property.

  Contents: Javascript code executed when a pointer button is double clicked over this element.

### setOndblclick

    public void setOndblclick(String ondblclick)

  Set the value of the `ondblclick` property.

### getOnkeydown

    public String getOnkeydown()

  Return the value of the `onkeydown` property.

  Contents: Javascript code executed when a key is pressed down over this element.

### setOnkeydown

    public void setOnkeydown(String onkeydown)

  Set the value of the `onkeydown` property.

### getOnkeypress

    public String getOnkeypress()

  Return the value of the `onkeypress` property.

  Contents: Javascript code executed when a key is pressed and released over this element.

### setOnkeypress

    public void setOnkeypress(String onkeypress)

  Set the value of the `onkeypress` property.

### getOnkeyup

    public String getOnkeyup()

  Return the value of the `onkeyup` property.

  Contents: Javascript code executed when a key is released over this element.

### setOnkeyup

    public void setOnkeyup(String onkeyup)

  Set the value of the `onkeyup` property.

### getOnload

    public String getOnload()

  Return the value of the `onload` property.

### setOnload

    public void setOnload(String onload)

  Set the value of the `onload` property.

### getOnmousedown

    public String getOnmousedown()

  Return the value of the `onmousedown` property.

  Contents: Javascript code executed when a pointer button is pressed down over this element.

### setOnmousedown

    public void setOnmousedown(String onmousedown)

  Set the value of the `onmousedown` property.

### getOnmousemove

    public String getOnmousemove()

  Return the value of the `onmousemove` property.

  Contents: Javascript code executed when a pointer button is moved within this element.

### setOnmousemove

    public void setOnmousemove(String onmousemove)

  Set the value of the `onmousemove` property.

### getOnmouseout

    public String getOnmouseout()

  Return the value of the `onmouseout` property.

  Contents: Javascript code executed when a pointer button is moved away from this element.

### setOnmouseout

    public void setOnmouseout(String onmouseout)

  Set the value of the `onmouseout` property.

### getOnmouseover

    public String getOnmouseover()

  Return the value of the `onmouseover` property.

  Contents: Javascript code executed when a pointer button is moved onto this element.

### setOnmouseover

    public void setOnmouseover(String onmouseover)

  Set the value of the `onmouseover` property.

### getOnmouseup

    public String getOnmouseup()

  Return the value of the `onmouseup` property.

  Contents: Javascript code executed when a pointer button is released over this element.

### setOnmouseup

    public void setOnmouseup(String onmouseup)

  Set the value of the `onmouseup` property.

### getOnunload

    public String getOnunload()

  Return the value of the `onunload` property.

### setOnunload

    public void setOnunload(String onunload)

  Set the value of the `onunload` property.

### getStyle

    public String getStyle()

  Return the value of the `style` property.

  Contents: CSS style(s) to be applied when this component is rendered.

### setStyle

    public void setStyle(String style)

  Set the value of the `style` property.

### getStyleClass

    public String getStyleClass()

  Return the value of the `styleClass` property.

  Contents: Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.

### setStyleClass

    public void setStyleClass(String styleClass)

  Set the value of the `styleClass` property.

### getTitle

    public String getTitle()

  Return the value of the `title` property.

  Contents: Advisory title information about markup elements generated for this component.

### setTitle

    public void setTitle(String title)

  Set the value of the `title` property.

### getEventNames

    public Collection<String> getEventNames()

  Description copied from class: `UIComponentBase`

  This is a default implementation of `ClientBehaviorHolder.getEventNames()`. `UIComponent` does not implement the `ClientBehaviorHolder` interface, but provides default implementations for the methods defined by `ClientBehaviorHolder` to simplify subclass implementations. Subclasses that wish to support the `ClientBehaviorHolder` contract must declare that the subclass implements `ClientBehaviorHolder`, and must override this method to return a non-Empty `Collection` of the client event names that the component supports.

  Specified by:
    `getEventNames` in interface `ClientBehaviorHolder`
  Overrides:
    `getEventNames` in class `UIComponentBase`

### getDefaultEventName

    public String getDefaultEventName()

  Description copied from class: `UIComponentBase`

  This is a default implementation of `ClientBehaviorHolder.getDefaultEventName()`. `UIComponent` does not implement the `ClientBehaviorHolder` interface, but provides default implementations for the methods defined by `ClientBehaviorHolder` to simplify subclass implementations. Subclasses that wish to support the `ClientBehaviorHolder` contract must declare that the subclass implements `ClientBehaviorHolder`, and must provide an implementation of `ClientBehaviorHolder.getEventNames()`.

  Specified by:
    `getDefaultEventName` in interface `ClientBehaviorHolder`
  Overrides:
    `getDefaultEventName` in class `UIComponentBase`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2002-2009 Sun Microsystems, Inc. All Rights Reserved.