com.sun.rave.web.ui.component
Class Legend

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              com.sun.rave.web.ui.component.LegendBase
                  com.sun.rave.web.ui.component.Legend

All Implemented Interfaces:

javax.faces.component.StateHolder, javax.faces.component.ValueHolder

public class Legend

extends LegendBase

The Legend component.

Field Summary

static java.lang.String	LEGEND_IMAGE_FACET Facet name and id
static java.lang.String	LEGEND_IMAGE_FACET_ID

Fields inherited from class javax.faces.component.UIOutput

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

Legend()

Method Summary

javax.faces.component.UIComponent

getLegendImage() Get or create the legend image.

Methods inherited from class com.sun.rave.web.ui.component.LegendBase

getFamily, getPosition, getStyle, getStyleClass, getText, isVisible, restoreState, saveState, setPosition, setStyle, setStyleClass, setText, setVisible

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

LEGEND_IMAGE_FACET

public static final java.lang.String LEGEND_IMAGE_FACET

Facet name and id

See Also:

Constant Field Values

LEGEND_IMAGE_FACET_ID

public static final java.lang.String LEGEND_IMAGE_FACET_ID

See Also:

Constant Field Values

Constructor Detail

Legend

public Legend()

Method Detail

getLegendImage

public javax.faces.component.UIComponent getLegendImage()

Get or create the legend image. Return the facet if specified, or else create one using the default required field indicator, and return it.

Returns:

A legend image (or facet)