jakarta.faces.component.html.HtmlPanelGroup Maven / Gradle / Ivy
Show all versions of jakarta.faces-api Show documentation
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package jakarta.faces.component.html;
import static jakarta.faces.component.html.HtmlComponentUtils.handleAttribute;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import jakarta.faces.component.UIPanel;
import 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.
*
*/
public class HtmlPanelGroup extends UIPanel implements ClientBehaviorHolder {
public HtmlPanelGroup() {
super();
setRendererType("jakarta.faces.Group");
}
/**
*
* The standard component type for this component.
*
*/
public static final String COMPONENT_TYPE = "jakarta.faces.HtmlPanelGroup";
/**
* Properties used by this component
*
*/
protected enum PropertyKeys {
layout, onclick, ondblclick, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, style, styleClass,;
String toString;
PropertyKeys(String toString) {
this.toString = toString;
}
PropertyKeys() {
}
@Override
public String toString() {
return toString != null ? toString : super.toString();
}
}
/**
*
* Return the value of the layout property.
*
*
* @return 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.
*/
public java.lang.String getLayout() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.layout);
}
/**
*
* Set the value of the layout property.
*
*
* @param layout the new property value
*/
public void setLayout(java.lang.String layout) {
getStateHelper().put(PropertyKeys.layout, layout);
}
/**
*
* Return the value of the onclick property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is clicked over this element.
*/
public java.lang.String getOnclick() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onclick);
}
/**
*
* Set the value of the onclick property.
*
*
* @param onclick the new property value
*/
public void setOnclick(java.lang.String onclick) {
getStateHelper().put(PropertyKeys.onclick, onclick);
handleAttribute(this, "onclick", onclick);
}
/**
*
* Return the value of the ondblclick property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is double clicked over this element.
*/
public java.lang.String getOndblclick() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.ondblclick);
}
/**
*
* Set the value of the ondblclick property.
*
*
* @param ondblclick the new property value
*/
public void setOndblclick(java.lang.String ondblclick) {
getStateHelper().put(PropertyKeys.ondblclick, ondblclick);
handleAttribute(this, "ondblclick", ondblclick);
}
/**
*
* Return the value of the onkeydown property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a key is pressed down over this element.
*/
public java.lang.String getOnkeydown() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onkeydown);
}
/**
*
* Set the value of the onkeydown property.
*
*
* @param onkeydown the new property value
*/
public void setOnkeydown(java.lang.String onkeydown) {
getStateHelper().put(PropertyKeys.onkeydown, onkeydown);
handleAttribute(this, "onkeydown", onkeydown);
}
/**
*
* Return the value of the onkeypress property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a key is pressed and released over this element.
*/
public java.lang.String getOnkeypress() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onkeypress);
}
/**
*
* Set the value of the onkeypress property.
*
*
* @param onkeypress the new property value
*/
public void setOnkeypress(java.lang.String onkeypress) {
getStateHelper().put(PropertyKeys.onkeypress, onkeypress);
handleAttribute(this, "onkeypress", onkeypress);
}
/**
*
* Return the value of the onkeyup property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a key is released over this element.
*/
public java.lang.String getOnkeyup() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onkeyup);
}
/**
*
* Set the value of the onkeyup property.
*
*
* @param onkeyup the new property value
*/
public void setOnkeyup(java.lang.String onkeyup) {
getStateHelper().put(PropertyKeys.onkeyup, onkeyup);
handleAttribute(this, "onkeyup", onkeyup);
}
/**
*
* Return the value of the onmousedown property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is pressed down over this element.
*/
public java.lang.String getOnmousedown() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmousedown);
}
/**
*
* Set the value of the onmousedown property.
*
*
* @param onmousedown the new property value
*/
public void setOnmousedown(java.lang.String onmousedown) {
getStateHelper().put(PropertyKeys.onmousedown, onmousedown);
handleAttribute(this, "onmousedown", onmousedown);
}
/**
*
* Return the value of the onmousemove property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is moved within this element.
*/
public java.lang.String getOnmousemove() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmousemove);
}
/**
*
* Set the value of the onmousemove property.
*
*
* @param onmousemove the new property value
*/
public void setOnmousemove(java.lang.String onmousemove) {
getStateHelper().put(PropertyKeys.onmousemove, onmousemove);
handleAttribute(this, "onmousemove", onmousemove);
}
/**
*
* Return the value of the onmouseout property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is moved away from this element.
*/
public java.lang.String getOnmouseout() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmouseout);
}
/**
*
* Set the value of the onmouseout property.
*
*
* @param onmouseout the new property value
*/
public void setOnmouseout(java.lang.String onmouseout) {
getStateHelper().put(PropertyKeys.onmouseout, onmouseout);
handleAttribute(this, "onmouseout", onmouseout);
}
/**
*
* Return the value of the onmouseover property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is moved onto this element.
*/
public java.lang.String getOnmouseover() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmouseover);
}
/**
*
* Set the value of the onmouseover property.
*
*
* @param onmouseover the new property value
*/
public void setOnmouseover(java.lang.String onmouseover) {
getStateHelper().put(PropertyKeys.onmouseover, onmouseover);
handleAttribute(this, "onmouseover", onmouseover);
}
/**
*
* Return the value of the onmouseup property.
*
*
* @return the property value
*
* Contents: Javascript code executed when a pointer button is released over this element.
*/
public java.lang.String getOnmouseup() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.onmouseup);
}
/**
*
* Set the value of the onmouseup property.
*
*
* @param onmouseup the new property value
*/
public void setOnmouseup(java.lang.String onmouseup) {
getStateHelper().put(PropertyKeys.onmouseup, onmouseup);
handleAttribute(this, "onmouseup", onmouseup);
}
/**
*
* Return the value of the style property.
*
*
* @return the property value
*
* Contents: CSS style(s) to be applied when this component is rendered.
*/
public java.lang.String getStyle() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.style);
}
/**
*
* Set the value of the style property.
*
*
* @param style the new property value
*/
public void setStyle(java.lang.String style) {
getStateHelper().put(PropertyKeys.style, style);
handleAttribute(this, "style", style);
}
/**
*
* Return the value of the styleClass property.
*
*
* @return 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.
*/
public java.lang.String getStyleClass() {
return (java.lang.String) getStateHelper().eval(PropertyKeys.styleClass);
}
/**
*
* Set the value of the styleClass property.
*
*
* @param styleClass the new property value
*/
public void setStyleClass(java.lang.String styleClass) {
getStateHelper().put(PropertyKeys.styleClass, styleClass);
}
private static final Collection EVENT_NAMES = Collections.unmodifiableCollection(
Arrays.asList("click", "dblclick", "keydown", "keypress", "keyup", "mousedown", "mousemove", "mouseout", "mouseover", "mouseup"));
@Override
public Collection getEventNames() {
return EVENT_NAMES;
}
@Override
public String getDefaultEventName() {
return null;
}
}