Module jakarta.faces

Package com.sun.faces.component

Class PassthroughElement

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIPanel

com.sun.faces.component.PassthroughElement

All Implemented Interfaces:

ClientBehaviorHolder, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

public class PassthroughElement
extends UIPanel
implements ClientBehaviorHolder

Causes all child components of this component to be rendered. This is useful in scenarios where a parent component is expecting a single component to be present, but the application wishes to render more than one.

By default, the rendererType property must be set to "jakarta.faces.passthrough.Element". This value can be changed by calling the setRendererType() method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	PassthroughElement.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_TYPE	The standard component type for this component.

Fields inherited from class jakarta.faces.component.UIPanel

COMPONENT_FAMILY

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
PassthroughElement()

Method Summary

Modifier and Type	Method	Description
String	getDefaultEventName()	This is a default implementation of ClientBehaviorHolder.getDefaultEventName().
Collection<String>	getEventNames()	This is a default implementation of ClientBehaviorHolder.getEventNames().
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	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	getStyle()	Return the value of the style property.
String	getStyleClass()	Return the value of the styleClass 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	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	setStyle(String style)	Set the value of the style property.
void	setStyleClass(String styleClass)	Set the value of the styleClass property.

Methods inherited from class jakarta.faces.component.UIPanel

getFamily

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

See Also:

• Constant Field Values

Constructor Details

PassthroughElement

public PassthroughElement()

Method Details

getOnclick

public String getOnclick()

Return the value of the onclick property.

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

Returns:

the value of the onclick property.

setOnclick

public void setOnclick(String onclick)

Set the value of the onclick property.

Parameters:

onclick - 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.

Returns:

the value of the ondblclick property.

setOndblclick

public void setOndblclick(String ondblclick)

Set the value of the ondblclick property.

Parameters:

ondblclick - 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.

Returns:

the value of the onkeydown property.

setOnkeydown

public void setOnkeydown(String onkeydown)

Set the value of the onkeydown property.

Parameters:

onkeydown - 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.

Returns:

the value of the onkeypress property.

setOnkeypress

public void setOnkeypress(String onkeypress)

Set the value of the onkeypress property.

Parameters:

onkeypress - 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.

Returns:

the value of the onkeyup property.

setOnkeyup

public void setOnkeyup(String onkeyup)

Set the value of the onkeyup property.

Parameters:

onkeyup - the value of the onkeyup 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.

Returns:

the value of the onmousedown property.

setOnmousedown

public void setOnmousedown(String onmousedown)

Set the value of the onmousedown property.

Parameters:

onmousedown - 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.

Returns:

the value of the onmousemove property.

setOnmousemove

public void setOnmousemove(String onmousemove)

Set the value of the onmousemove property.

Parameters:

onmousemove - 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.

Returns:

the value of the onmouseout property.

setOnmouseout

public void setOnmouseout(String onmouseout)

Set the value of the onmouseout property.

Parameters:

onmouseout - 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.

Returns:

the value of the onmouseover property.

setOnmouseover

public void setOnmouseover(String onmouseover)

Set the value of the onmouseover property.

Parameters:

onmouseover - 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.

Returns:

the value of the onmouseup property.

setOnmouseup

public void setOnmouseup(String onmouseup)

Set the value of the onmouseup property.

Parameters:

onmouseup - the value of the onmouseup property.

getStyle

public String getStyle()

Return the value of the style property.

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

Returns:

the value of the style property.

setStyle

public void setStyle(String style)

Set the value of the style property.

Parameters:

style - 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" property on generated markup.

Returns:

the value of the styleClass property.

setStyleClass

public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters:

styleClass - the value of the styleClass 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

Returns:

the collection of event names.

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

Returns:

the default event name.