Class UIPopup
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIPanel
-
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder
,jakarta.faces.component.NamingContainer
,jakarta.faces.component.PartialStateHolder
,jakarta.faces.component.StateHolder
,jakarta.faces.component.TransientStateHolder
,jakarta.faces.event.ComponentSystemEventListener
,jakarta.faces.event.FacesListener
,jakarta.faces.event.SystemEventListenerHolder
,EventListener
,Visual
@Generated("component.stg") public class UIPopup extends AbstractUIPopup implements jakarta.faces.component.behavior.ClientBehaviorHolder
Renders a popup panel. UIComponent class, generated from templatecomponent.stg
with classPopupTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIPopup()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CollapseMode
getCollapsedMode()
CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.String
getFamily()
Markup
getMarkup()
String
getTip()
Text value to display as tooltip.boolean
isCollapsed()
Indicating the collapsed state of this component.boolean
isModal()
If "true", a click on the backdrop does not close the popup.void
restoreState(jakarta.faces.context.FacesContext context, Object state)
void
setCollapsed(boolean collapsed)
void
setCollapsedMode(CollapseMode collapsedMode)
void
setCustomClass(CustomClass customClass)
void
setMarkup(Markup markup)
void
setModal(boolean modal)
void
setTip(String tip)
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPopup
processUpdates
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICollapsiblePanel
getSubmittedCollapsed, isNormalLifecycle, processDecodes, processState, processValidators, setSubmittedCollapsed
-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTree
-
Methods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
-
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, getDefaultEventName, getEventNames
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamily
in classjakarta.faces.component.UIPanel
-
isCollapsed
public boolean isCollapsed()
Indicating the collapsed state of this component.
Default:true
- Specified by:
isCollapsed
in classAbstractUICollapsiblePanel
-
setCollapsed
public void setCollapsed(boolean collapsed)
- Specified by:
setCollapsed
in classAbstractUICollapsiblePanel
-
getCustomClass
public CustomClass 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.- Specified by:
getCustomClass
in interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClass
in interfaceVisual
-
getTip
public String getTip()
Text value to display as tooltip.- Specified by:
getTip
in classAbstractUIPanelBase
-
setTip
public void setTip(String tip)
-
getCollapsedMode
public CollapseMode getCollapsedMode()
- Specified by:
getCollapsedMode
in classAbstractUICollapsiblePanel
-
setCollapsedMode
public void setCollapsedMode(CollapseMode collapsedMode)
-
isModal
public boolean isModal()
If "true", a click on the backdrop does not close the popup. Default value is "false" and can be configured in the tobago-config.xml.- Specified by:
isModal
in classAbstractUIPopup
-
setModal
public void setModal(boolean modal)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIComponentBase
-
-