Class UISegmentLayout
- 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 templatecomponent.stg
with classSegmentLayoutTagDeclaration
.
-
-
Field Summary
Fields Modifier and Type Field Description static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UISegmentLayout()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomClass
getCustomClass()
Sets a CSS class in its parent, if the parent supports it.SegmentMeasureList
getExtra2Large()
The space separated definition of the columns for extra extra large devices.SegmentMeasureList
getExtraLarge()
The space separated definition of the columns for extra large devices.SegmentMeasureList
getExtraSmall()
The space separated definition of the columns for extra small devices.String
getFamily()
SegmentJustify
getJustify()
The horizontal alignment of the elements inside of the grid, possible values are: {
Allowed Values:none,start,center,end,around,between
SegmentMeasureList
getLarge()
The space separated definition of the columns for large devices.String
getMarginExtra2Large()
The space separated definition of the column margins for extra extra large devices.String
getMarginExtraLarge()
The space separated definition of the column margins for extra large devices.String
getMarginExtraSmall()
The space separated definition of the column margins for extra small devices.String
getMarginLarge()
The space separated definition of the column margins for large devices.String
getMarginMedium()
The space separated definition of the column margins for medium devices.String
getMarginSmall()
The space separated definition of the column margins for small devices.Markup
getMarkup()
SegmentMeasureList
getMedium()
The space separated definition of the columns for medium devices.SegmentMeasureList
getSmall()
The space separated definition of the columns for small devices.void
restoreState(jakarta.faces.context.FacesContext context, Object state)
void
setCustomClass(CustomClass customClass)
void
setExtra2Large(SegmentMeasureList extra2Large)
void
setExtraLarge(SegmentMeasureList extraLarge)
void
setExtraSmall(SegmentMeasureList extraSmall)
void
setJustify(SegmentJustify justify)
void
setLarge(SegmentMeasureList large)
void
setMarginExtra2Large(String marginExtra2Large)
void
setMarginExtraLarge(String marginExtraLarge)
void
setMarginExtraSmall(String marginExtraSmall)
void
setMarginLarge(String marginLarge)
void
setMarginMedium(String marginMedium)
void
setMarginSmall(String marginSmall)
void
setMarkup(Markup markup)
void
setMedium(SegmentMeasureList medium)
void
setSmall(SegmentMeasureList small)
-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISegmentLayout
toString
-
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, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, 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, 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()
- Specified by:
getFamily
in classjakarta.faces.component.UIComponent
-
getSmall
public SegmentMeasureList 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:
getSmall
in interfaceSupportsSegmentLayout
-
setSmall
public void setSmall(SegmentMeasureList small)
-
getExtra2Large
public SegmentMeasureList 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:
getExtra2Large
in interfaceSupportsSegmentLayout
-
setExtra2Large
public void setExtra2Large(SegmentMeasureList extra2Large)
-
getLarge
public SegmentMeasureList 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:
getLarge
in interfaceSupportsSegmentLayout
-
setLarge
public void setLarge(SegmentMeasureList large)
-
getMarginExtra2Large
public String 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:
getMarginExtra2Large
in interfaceSupportsSegmentLayout
-
setMarginExtra2Large
public void setMarginExtra2Large(String marginExtra2Large)
-
getMedium
public SegmentMeasureList 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:
getMedium
in interfaceSupportsSegmentLayout
-
setMedium
public void setMedium(SegmentMeasureList medium)
-
getMarginLarge
public String 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:
getMarginLarge
in interfaceSupportsSegmentLayout
-
setMarginLarge
public void setMarginLarge(String marginLarge)
-
getExtraSmall
public SegmentMeasureList 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:
getExtraSmall
in interfaceSupportsSegmentLayout
-
setExtraSmall
public void setExtraSmall(SegmentMeasureList extraSmall)
-
getMarginExtraSmall
public String 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:
getMarginExtraSmall
in interfaceSupportsSegmentLayout
-
setMarginExtraSmall
public void setMarginExtraSmall(String marginExtraSmall)
-
getExtraLarge
public SegmentMeasureList 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:
getExtraLarge
in interfaceSupportsSegmentLayout
-
setExtraLarge
public void setExtraLarge(SegmentMeasureList extraLarge)
-
getMarginExtraLarge
public String 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:
getMarginExtraLarge
in interfaceSupportsSegmentLayout
-
setMarginExtraLarge
public void setMarginExtraLarge(String marginExtraLarge)
-
getJustify
public SegmentJustify getJustify()
The horizontal alignment of the elements inside of the grid, possible values are: {
Allowed Values:none,start,center,end,around,between
- Specified by:
getJustify
in interfaceSupportsSegmentLayout
-
setJustify
public void setJustify(SegmentJustify justify)
-
getMarginSmall
public String 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:
getMarginSmall
in interfaceSupportsSegmentLayout
-
setMarginSmall
public void setMarginSmall(String marginSmall)
-
getMarginMedium
public String 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:
getMarginMedium
in interfaceSupportsSegmentLayout
-
setMarginMedium
public void setMarginMedium(String marginMedium)
-
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
-
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
-
-