java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
org.apache.myfaces.tobago.internal.component.AbstractUILayoutBase
org.apache.myfaces.tobago.internal.component.AbstractUISegmentLayout
org.apache.myfaces.tobago.component.UISegmentLayout
- 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,SupportsSegmentLayout,Visual
@Generated("component.stg")
public class UISegmentLayout
extends AbstractUISegmentLayout
implements jakarta.faces.component.behavior.ClientBehaviorHolder
Renders a layout using a 12 columns grid.
Find more information on how the grid works in the Twitter Bootstrap documentation.
If no attribute is defined, extraSmall="12seg" will be used as default.
UIComponent class, generated from template
component.stg with class
SegmentLayoutTagDeclaration.-
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 TypeMethodDescriptionSets a CSS class in its parent, if the parent supports it.The space separated definition of the columns for extra extra large devices.The space separated definition of the columns for extra large devices.The space separated definition of the columns for extra small devices.The horizontal alignment of the elements inside of the grid, possible values are: {
Allowed Values:none,start,center,end,around,betweengetLarge()The space separated definition of the columns for large devices.The space separated definition of the column margins for extra extra large devices.The space separated definition of the column margins for extra large devices.The space separated definition of the column margins for extra small devices.The space separated definition of the column margins for large devices.The space separated definition of the column margins for medium devices.The space separated definition of the column margins for small devices.The space separated definition of the columns for medium devices.getSmall()The space separated definition of the columns for small devices.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetCustomClass(CustomClass customClass) voidsetExtra2Large(SegmentMeasureList extra2Large) voidsetExtraLarge(SegmentMeasureList extraLarge) voidsetExtraSmall(SegmentMeasureList extraSmall) voidsetJustify(SegmentJustify justify) voidsetLarge(SegmentMeasureList large) voidsetMarginExtra2Large(String marginExtra2Large) voidsetMarginExtraLarge(String marginExtraLarge) voidsetMarginExtraSmall(String marginExtraSmall) voidsetMarginLarge(String marginLarge) voidsetMarginMedium(String marginMedium) voidsetMarginSmall(String marginSmall) voidvoidsetMedium(SegmentMeasureList medium) voidsetSmall(SegmentMeasureList small) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISegmentLayout
toStringMethods 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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UISegmentLayout
public UISegmentLayout()
-
-
Method Details
-
getFamily
- Specified by:
getFamilyin classjakarta.faces.component.UIComponent
-
getSmall
The space separated definition of the columns for small devices. Possible values are: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg 1fr auto'- Specified by:
getSmallin interfaceSupportsSegmentLayout
-
setSmall
-
getExtra2Large
The space separated definition of the columns for extra extra large devices. Possible values are: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg 1fr auto'- Specified by:
getExtra2Largein interfaceSupportsSegmentLayout
-
setExtra2Large
-
getMarkup
-
setMarkup
-
getLarge
The space separated definition of the columns for large devices. Possible values are: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg 1fr auto'- Specified by:
getLargein interfaceSupportsSegmentLayout
-
setLarge
-
getMarginExtra2Large
The space separated definition of the column margins for extra extra large devices. Allowed values are: none, left, right, both Example: 'left none both'- Specified by:
getMarginExtra2Largein interfaceSupportsSegmentLayout
-
setMarginExtra2Large
-
getMedium
The space separated definition of the columns for medium devices. Possible values are: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg fr auto'- Specified by:
getMediumin interfaceSupportsSegmentLayout
-
setMedium
-
getMarginLarge
The space separated definition of the column margins for large devices. Allowed values are: none, left, right, both Example: 'left none both'- Specified by:
getMarginLargein interfaceSupportsSegmentLayout
-
setMarginLarge
-
getExtraSmall
The space separated definition of the columns for extra small devices. Possible values are: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg 1fr auto'- Specified by:
getExtraSmallin interfaceSupportsSegmentLayout
-
setExtraSmall
-
getMarginExtraSmall
The space separated definition of the column margins for extra small devices. Allowed values are: none, left, right, both Example: 'left none both'- Specified by:
getMarginExtraSmallin interfaceSupportsSegmentLayout
-
setMarginExtraSmall
-
getExtraLarge
The space separated definition of the columns for extra large devices. Possible values are: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg 1fr auto'- Specified by:
getExtraLargein interfaceSupportsSegmentLayout
-
setExtraLarge
-
getMarginExtraLarge
The space separated definition of the column margins for extra large devices. Allowed values are: none, left, right, both Example: 'left none both'- Specified by:
getMarginExtraLargein interfaceSupportsSegmentLayout
-
setMarginExtraLarge
-
getJustify
The horizontal alignment of the elements inside of the grid, possible values are: {
Allowed Values:none,start,center,end,around,between- Specified by:
getJustifyin interfaceSupportsSegmentLayout
-
setJustify
-
getMarginSmall
The space separated definition of the column margins for small devices. Allowed values are: none, left, right, both Example: 'left none both'- Specified by:
getMarginSmallin interfaceSupportsSegmentLayout
-
setMarginSmall
-
getMarginMedium
The space separated definition of the column margins for medium devices. Allowed values are: none, left, right, both Example: 'left none both'- Specified by:
getMarginMediumin interfaceSupportsSegmentLayout
-
setMarginMedium
-
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
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-