Class UISegmentLayout
java.lang.Object
javax.faces.component.UIComponent
javax.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:
EventListener
,javax.faces.component.behavior.ClientBehaviorHolder
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.TransientStateHolder
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,SupportsSegmentLayout
,Visual
@Generated("component.stg")
public class UISegmentLayout
extends AbstractUISegmentLayout
implements javax.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 javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, 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,between
getLarge()
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.void
restoreState
(javax.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
void
setMedium
(SegmentMeasureList medium) void
setSmall
(SegmentMeasureList small) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUISegmentLayout
toString
Methods inherited from class javax.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, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
Methods inherited from class javax.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 javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
Methods 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:
getFamily
in classjavax.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:
getSmall
in 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:
getExtra2Large
in 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:
getLarge
in 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:
getMarginExtra2Large
in 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:
getMedium
in 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:
getMarginLarge
in 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:
getExtraSmall
in 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:
getMarginExtraSmall
in 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:
getExtraLarge
in 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:
getMarginExtraLarge
in 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:
getJustify
in 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:
getMarginSmall
in 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:
getMarginMedium
in 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:
getCustomClass
in interfaceVisual
-
setCustomClass
- Specified by:
setCustomClass
in interfaceVisual
-
restoreState
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-