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 thesetRendererType()
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
PassthroughElement.PropertyKeys
-
Field Summary
Fields Modifier and Type Field Description static 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, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor Description PassthroughElement()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDefaultEventName()
This is a default implementation ofClientBehaviorHolder.getDefaultEventName()
.Collection<String>
getEventNames()
This is a default implementation ofClientBehaviorHolder.getEventNames()
.String
getOnclick()
Return the value of theonclick
property.String
getOndblclick()
Return the value of theondblclick
property.String
getOnkeydown()
Return the value of theonkeydown
property.String
getOnkeypress()
Return the value of theonkeypress
property.String
getOnkeyup()
Return the value of theonkeyup
property.String
getOnmousedown()
Return the value of theonmousedown
property.String
getOnmousemove()
Return the value of theonmousemove
property.String
getOnmouseout()
Return the value of theonmouseout
property.String
getOnmouseover()
Return the value of theonmouseover
property.String
getOnmouseup()
Return the value of theonmouseup
property.String
getStyle()
Return the value of thestyle
property.String
getStyleClass()
Return the value of thestyleClass
property.void
setOnclick(String onclick)
Set the value of theonclick
property.void
setOndblclick(String ondblclick)
Set the value of theondblclick
property.void
setOnkeydown(String onkeydown)
Set the value of theonkeydown
property.void
setOnkeypress(String onkeypress)
Set the value of theonkeypress
property.void
setOnkeyup(String onkeyup)
Set the value of theonkeyup
property.void
setOnmousedown(String onmousedown)
Set the value of theonmousedown
property.void
setOnmousemove(String onmousemove)
Set the value of theonmousemove
property.void
setOnmouseout(String onmouseout)
Set the value of theonmouseout
property.void
setOnmouseover(String onmouseover)
Set the value of theonmouseover
property.void
setOnmouseup(String onmouseup)
Set the value of theonmouseup
property.void
setStyle(String style)
Set the value of thestyle
property.void
setStyleClass(String styleClass)
Set the value of thestyleClass
property.-
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 Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
The standard component type for this component.
- See Also:
- Constant Field Values
-
-
Method Detail
-
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 theonclick
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 theondblclick
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 theonkeydown
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 theonkeypress
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 theonkeyup
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 theonmousedown
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 theonmousemove
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 theonmouseout
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 theonmouseover
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 theonmouseup
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 thestyle
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 thestyleClass
property.
-
getEventNames
public Collection<String> getEventNames()
Description copied from class:UIComponentBase
This is a default implementation of
ClientBehaviorHolder.getEventNames()
.UIComponent
does not implement theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must override this method to return a non-EmptyCollection
of the client event names that the component supports.- Specified by:
getEventNames
in interfaceClientBehaviorHolder
- Overrides:
getEventNames
in classUIComponentBase
- 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 theClientBehaviorHolder
interface, but provides default implementations for the methods defined byClientBehaviorHolder
to simplify subclass implementations. Subclasses that wish to support theClientBehaviorHolder
contract must declare that the subclass implementsClientBehaviorHolder
, and must provide an implementation ofClientBehaviorHolder.getEventNames()
.- Specified by:
getDefaultEventName
in interfaceClientBehaviorHolder
- Overrides:
getDefaultEventName
in classUIComponentBase
- Returns:
- the default event name.
-
-