Class UIBox
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.PartialStateHolder,jakarta.faces.component.StateHolder,jakarta.faces.component.TransientStateHolder,jakarta.faces.event.ComponentSystemEventListener,jakarta.faces.event.FacesListener,jakarta.faces.event.SystemEventListenerHolder,EventListener,SupportsAutoSpacing,Visual
@Generated("component.stg")
public class UIBox
extends AbstractUIBox
implements jakarta.faces.component.behavior.ClientBehaviorHolder
Renders a panel with border and title.
UIComponent class, generated from template
component.stg with class
BoxTagDeclaration.-
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionAutomatically add spacing (margins/paddings) to the component for better positioning.Enum indicating the mode of the collapsed state of this component.Sets a CSS class in its parent, if the parent supports it.getLabel()A localized user presentable label for this component.getTip()Text value to display as tooltip.booleanIndicating the collapsed state of this component.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetAutoSpacing(Boolean autoSpacing) voidsetCollapsed(boolean collapsed) voidsetCollapsedMode(CollapseMode collapsedMode) voidsetCustomClass(CustomClass customClass) voidvoidvoidMethods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICollapsiblePanel
getSubmittedCollapsed, isNormalLifecycle, processDecodes, processState, processUpdates, processValidators, setSubmittedCollapsedMethods 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, visitTreeMethods 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, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.component.SupportsAutoSpacing
getAutoSpacingMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIBox
public UIBox()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIPanel
-
getAutoSpacing
Automatically add spacing (margins/paddings) to the component for better positioning. Default is 'true' except the component is inside a: - header - footer - bar - sheet - tree - link group - button group - before facet - after facet - label facet - bar facet- Specified by:
getAutoSpacingin interfaceSupportsAutoSpacing
-
setAutoSpacing
-
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.- Specified by:
getCustomClassin interfaceVisual
-
setCustomClass
- Specified by:
setCustomClassin interfaceVisual
-
getTip
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIPanelBase
-
setTip
-
getLabel
A localized user presentable label for this component.- Specified by:
getLabelin classAbstractUIBox
-
setLabel
-
getCollapsedMode
Enum indicating the mode of the collapsed state of this component.
Default:none- Specified by:
getCollapsedModein classAbstractUICollapsiblePanel
-
setCollapsedMode
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-