Class UIPanel
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIPanel
- All Implemented Interfaces:
EventListener,javax.faces.component.behavior.ClientBehaviorHolder,javax.faces.component.PartialStateHolder,javax.faces.component.StateHolder,javax.faces.event.ComponentSystemEventListener,javax.faces.event.FacesListener,javax.faces.event.SystemEventListenerHolder,Visual
Intended for use in situations when only one UIComponent child can be
nested, such as in the case of facets.
UIComponent class, generated from template
component.stg with class
PanelTagDeclaration.-
Field Summary
FieldsFields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionEnum indicating the mode of the collapsed state of this component.Sets a CSS class in its parent, if the parent supports it.getTip()Text value to display as tooltip.booleanIndicating the collapsed state of this component.voidrestoreState(javax.faces.context.FacesContext context, Object state) voidsetCollapsed(boolean collapsed) voidsetCollapsedMode(CollapseMode collapsedMode) voidsetCustomClass(CustomClass customClass) voidvoidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPanel
encodeAllMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICollapsiblePanel
isNormalLifecycle, processDecodes, processState, processUpdates, processValidators, setSubmittedCollapsedMethods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTreeMethods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIPanel
public UIPanel()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjavax.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejavax.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjavax.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin classjavax.faces.component.UIPanel
-
getMarkup
-
setMarkup
-
isCollapsed
public boolean isCollapsed()Indicating the collapsed state of this component.
Default:false- Specified by:
isCollapsedin classAbstractUICollapsiblePanel
-
setCollapsed
public void setCollapsed(boolean collapsed) - Specified by:
setCollapsedin classAbstractUICollapsiblePanel
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code. -
setCustomClass
-
getTip
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIPanelBase
-
setTip
-
getCollapsedMode
Enum indicating the mode of the collapsed state of this component.
Default:none- Specified by:
getCollapsedModein classAbstractUICollapsiblePanel
-
setCollapsedMode
-
restoreState
- Specified by:
restoreStatein interfacejavax.faces.component.StateHolder- Overrides:
restoreStatein classjavax.faces.component.UIComponentBase
-