Class UISection
- 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 UISection extends AbstractUISection implements jakarta.faces.component.behavior.ClientBehaviorHolderRenders a section or subsection. UIComponent class, generated from templatecomponent.stgwith classSectionTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UISection()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleangetAutoSpacing()Automatically add spacing (margins/paddings) to the component for better positioning.CollapseModegetCollapsedMode()Enum indicating the mode of the collapsed state of this component.CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()StringgetImage()Url to an image to display.StringgetLabel()A localized user presentable label for this component.IntegergetLevel()Level of the title.MarkupgetMarkup()StringgetTip()Text value to display as tooltip.booleanisCollapsed()Indicating 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)voidsetImage(String image)voidsetLabel(String label)voidsetLevel(Integer level)voidsetMarkup(Markup markup)voidsetTip(String tip)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISection
encodeBegin
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUICollapsiblePanel
getSubmittedCollapsed, isNormalLifecycle, processDecodes, processState, processUpdates, processValidators, setSubmittedCollapsed
-
Methods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, 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.SupportsAutoSpacing
getAutoSpacing
-
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:
getFamilyin classjakarta.faces.component.UIPanel
-
getImage
public String getImage()
Url to an image to display.- Specified by:
getImagein classAbstractUISection
-
setImage
public void setImage(String image)
-
getAutoSpacing
public Boolean 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
public void setAutoSpacing(Boolean autoSpacing)
-
getLevel
public Integer getLevel()
Level of the title. Lower value means bigger title, greater value means smaller title. Value goes from 1 to 6.- Specified by:
getLevelin classAbstractUISection
-
setLevel
public void setLevel(Integer level)
- Specified by:
setLevelin classAbstractUISection
-
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
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:
getCustomClassin interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClassin interfaceVisual
-
getTip
public String getTip()
Text value to display as tooltip.- Specified by:
getTipin classAbstractUIPanelBase
-
setTip
public void setTip(String tip)
-
getLabel
public String getLabel()
A localized user presentable label for this component.- Specified by:
getLabelin classAbstractUISection
-
setLabel
public void setLabel(String label)
-
getCollapsedMode
public CollapseMode getCollapsedMode()
Enum indicating the mode of the collapsed state of this component.
Default:none- Specified by:
getCollapsedModein classAbstractUICollapsiblePanel
-
setCollapsedMode
public void setCollapsedMode(CollapseMode collapsedMode)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-
-