Top Description Inners Fields Constructors Methods
jakarta.faces.component.html

public Class HtmlPanelGroup

extends UIPanel
implements ClientBehaviorHolder
Class Inheritance
All Implemented Interfaces
jakarta.faces.component.behavior.ClientBehaviorHolder
Imports
java.util.ArrayList, .Arrays, .Collection, .Collections, .List, jakarta.el.ValueExpression, jakarta.faces.component.UIPanel, jakarta.faces.component.behavior.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.Group". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum
HtmlPanelGroup.PropertyKeys

Properties used by this component

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides jakarta.faces.component.UIPanel.COMPONENT_TYPE.

The standard component type for this component.

private static final Collection<String>
private static final String
Inherited from jakarta.faces.component.UIPanel:
COMPONENT_FAMILY

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String
getDefaultEventName()

Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation.

public Collection<String>
getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

public String

Returns:

the property value

Contents: The type of layout markup to use when rendering this group. If the value is "block" the renderer must produce an HTML "div" element. Otherwise HTML "span" element must be produced.

getLayout
()

Return the value of the layout property.

public String

Returns:

the property value

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

getOnclick
()

Return the value of the onclick property.

public String

Returns:

the property value

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

getOndblclick
()

Return the value of the ondblclick property.

public String

Returns:

the property value

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

getOnkeydown
()

Return the value of the onkeydown property.

public String

Returns:

the property value

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

getOnkeypress
()

Return the value of the onkeypress property.

public String

Returns:

the property value

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

getOnkeyup
()

Return the value of the onkeyup property.

public String

Returns:

the property value

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

getOnmousedown
()

Return the value of the onmousedown property.

public String

Returns:

the property value

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

getOnmousemove
()

Return the value of the onmousemove property.

public String

Returns:

the property value

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

getOnmouseout
()

Return the value of the onmouseout property.

public String

Returns:

the property value

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

getOnmouseover
()

Return the value of the onmouseover property.

public String

Returns:

the property value

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

getOnmouseup
()

Return the value of the onmouseup property.

public String

Returns:

the property value

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

getStyle
()

Return the value of the style property.

public String

Returns:

the property value

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.

getStyleClass
()

Return the value of the styleClass property.

private void
public void
setLayout(String
the new property value
layout
)

Set the value of the layout property.

public void
setOnclick(String
the new property value
onclick
)

Set the value of the onclick property.

public void
setOndblclick(String
the new property value
ondblclick
)

Set the value of the ondblclick property.

public void
setOnkeydown(String
the new property value
onkeydown
)

Set the value of the onkeydown property.

public void
setOnkeypress(String
the new property value
onkeypress
)

Set the value of the onkeypress property.

public void
setOnkeyup(String
the new property value
onkeyup
)

Set the value of the onkeyup property.

public void
setOnmousedown(String
the new property value
onmousedown
)

Set the value of the onmousedown property.

public void
setOnmousemove(String
the new property value
onmousemove
)

Set the value of the onmousemove property.

public void
setOnmouseout(String
the new property value
onmouseout
)

Set the value of the onmouseout property.

public void
setOnmouseover(String
the new property value
onmouseover
)

Set the value of the onmouseover property.

public void
setOnmouseup(String
the new property value
onmouseup
)

Set the value of the onmouseup property.

public void
setStyle(String
the new property value
style
)

Set the value of the style property.

public void
setStyleClass(String
the new property value
styleClass
)

Set the value of the styleClass property.

Inherited from jakarta.faces.component.UIPanel:
getFamily

Field Detail

COMPONENT_TYPEback to summary
public static final String COMPONENT_TYPE

Hides jakarta.faces.component.UIPanel.COMPONENT_TYPE.

The standard component type for this component.

EVENT_NAMESback to summary
private static final Collection<String> EVENT_NAMES
OPTIMIZED_PACKAGEback to summary
private static final String OPTIMIZED_PACKAGE

Constructor Detail

HtmlPanelGroupback to summary
public HtmlPanelGroup()

Method Detail

getDefaultEventNameback to summary
public String getDefaultEventName()

Overrides jakarta.faces.component.UIComponentBase.getDefaultEventName.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getDefaultEventName.

Returns the default event name for this ClientBehaviorHolder implementation. This must be one of the event names returned by getEventNames or null if the component does not have a default event.

Returns:String

the default event name.

Annotations
@Override
getEventNamesback to summary
public Collection<String> getEventNames()

Overrides jakarta.faces.component.UIComponentBase.getEventNames.

Implements jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Doc from jakarta.faces.component.behavior.ClientBehaviorHolder.getEventNames.

Returns a non-null, unmodifiable Collection containing the names of the logical events supported by the component implementing this interface.

Returns:Collection<String>

an unmodifiable collection of event names.

Annotations
@Override
getLayoutback to summary
public String getLayout()

Return the value of the layout property.

Returns:String

the property value

Contents: The type of layout markup to use when rendering this group. If the value is "block" the renderer must produce an HTML "div" element. Otherwise HTML "span" element must be produced.

getOnclickback to summary
public String getOnclick()

Return the value of the onclick property.

Returns:String

the property value

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

getOndblclickback to summary
public String getOndblclick()

Return the value of the ondblclick property.

Returns:String

the property value

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

getOnkeydownback to summary
public String getOnkeydown()

Return the value of the onkeydown property.

Returns:String

the property value

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

getOnkeypressback to summary
public String getOnkeypress()

Return the value of the onkeypress property.

Returns:String

the property value

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

getOnkeyupback to summary
public String getOnkeyup()

Return the value of the onkeyup property.

Returns:String

the property value

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

getOnmousedownback to summary
public String getOnmousedown()

Return the value of the onmousedown property.

Returns:String

the property value

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

getOnmousemoveback to summary
public String getOnmousemove()

Return the value of the onmousemove property.

Returns:String

the property value

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

getOnmouseoutback to summary
public String getOnmouseout()

Return the value of the onmouseout property.

Returns:String

the property value

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

getOnmouseoverback to summary
public String getOnmouseover()

Return the value of the onmouseover property.

Returns:String

the property value

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

getOnmouseupback to summary
public String getOnmouseup()

Return the value of the onmouseup property.

Returns:String

the property value

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

getStyleback to summary
public String getStyle()

Return the value of the style property.

Returns:String

the property value

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

getStyleClassback to summary
public String getStyleClass()

Return the value of the styleClass property.

Returns:String

the property value

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.

handleAttributeback to summary
private void handleAttribute(String name, Object value)
setLayoutback to summary
public void setLayout(String layout)

Set the value of the layout property.

Parameters
layout:String

the new property value

setOnclickback to summary
public void setOnclick(String onclick)

Set the value of the onclick property.

Parameters
onclick:String

the new property value

setOndblclickback to summary
public void setOndblclick(String ondblclick)

Set the value of the ondblclick property.

Parameters
ondblclick:String

the new property value

setOnkeydownback to summary
public void setOnkeydown(String onkeydown)

Set the value of the onkeydown property.

Parameters
onkeydown:String

the new property value

setOnkeypressback to summary
public void setOnkeypress(String onkeypress)

Set the value of the onkeypress property.

Parameters
onkeypress:String

the new property value

setOnkeyupback to summary
public void setOnkeyup(String onkeyup)

Set the value of the onkeyup property.

Parameters
onkeyup:String

the new property value

setOnmousedownback to summary
public void setOnmousedown(String onmousedown)

Set the value of the onmousedown property.

Parameters
onmousedown:String

the new property value

setOnmousemoveback to summary
public void setOnmousemove(String onmousemove)

Set the value of the onmousemove property.

Parameters
onmousemove:String

the new property value

setOnmouseoutback to summary
public void setOnmouseout(String onmouseout)

Set the value of the onmouseout property.

Parameters
onmouseout:String

the new property value

setOnmouseoverback to summary
public void setOnmouseover(String onmouseover)

Set the value of the onmouseover property.

Parameters
onmouseover:String

the new property value

setOnmouseupback to summary
public void setOnmouseup(String onmouseup)

Set the value of the onmouseup property.

Parameters
onmouseup:String

the new property value

setStyleback to summary
public void setStyle(String style)

Set the value of the style property.

Parameters
style:String

the new property value

setStyleClassback to summary
public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters
styleClass:String

the new property value

jakarta.faces.component.html back to summary

protected final Enum HtmlPanelGroup.PropertyKeys

extends Enum<HtmlPanelGroup.PropertyKeys>
Class Inheritance

Properties used by this component

Field Summary

Modifier and TypeField and Description
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
public static final HtmlPanelGroup.PropertyKeys
pack-priv String

Constructor Summary

AccessConstructor and Description
private
PropertyKeys(String toString)

private

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.
public static HtmlPanelGroup.PropertyKeys
public static HtmlPanelGroup.PropertyKeys[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

layoutback to summary
public static final HtmlPanelGroup.PropertyKeys layout
onclickback to summary
public static final HtmlPanelGroup.PropertyKeys onclick
ondblclickback to summary
public static final HtmlPanelGroup.PropertyKeys ondblclick
onkeydownback to summary
public static final HtmlPanelGroup.PropertyKeys onkeydown
onkeypressback to summary
public static final HtmlPanelGroup.PropertyKeys onkeypress
onkeyupback to summary
public static final HtmlPanelGroup.PropertyKeys onkeyup
onmousedownback to summary
public static final HtmlPanelGroup.PropertyKeys onmousedown
onmousemoveback to summary
public static final HtmlPanelGroup.PropertyKeys onmousemove
onmouseoutback to summary
public static final HtmlPanelGroup.PropertyKeys onmouseout
onmouseoverback to summary
public static final HtmlPanelGroup.PropertyKeys onmouseover
onmouseupback to summary
public static final HtmlPanelGroup.PropertyKeys onmouseup
styleback to summary
public static final HtmlPanelGroup.PropertyKeys style
styleClassback to summary
public static final HtmlPanelGroup.PropertyKeys styleClass
toStringback to summary
pack-priv String toString

Constructor Detail

PropertyKeysback to summary
private PropertyKeys(String toString)
PropertyKeysback to summary
private PropertyKeys()

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static HtmlPanelGroup.PropertyKeys valueOf(String name)
valuesback to summary
public static HtmlPanelGroup.PropertyKeys[] values()