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.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,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 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
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()
SegmentMeasureList
getLarge()
The space-separated definition of the columns for 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(javax.faces.context.FacesContext context, Object state)
void
setCustomClass(CustomClass customClass)
void
setExtraLarge(SegmentMeasureList extraLarge)
void
setExtraSmall(SegmentMeasureList extraSmall)
void
setLarge(SegmentMeasureList large)
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 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, 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, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, 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 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 classjavax.faces.component.UIComponent
-
getExtraSmall
public SegmentMeasureList getExtraSmall()
The space-separated definition of the columns for extra small devices. Possible values are: segment values between 1 and 12, 'auto' and '*'. Example: '1seg 5seg * auto'- Specified by:
getExtraSmall
in classAbstractUISegmentLayout
-
setExtraSmall
public void setExtraSmall(SegmentMeasureList extraSmall)
-
getSmall
public SegmentMeasureList getSmall()
The space-separated definition of the columns for small devices. Possible values are: segment values between 1 and 12, 'auto' and '*'. Example: '1seg 5seg * auto'- Specified by:
getSmall
in classAbstractUISegmentLayout
-
setSmall
public void setSmall(SegmentMeasureList small)
-
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 classAbstractUISegmentLayout
-
setMarginExtraSmall
public void setMarginExtraSmall(String marginExtraSmall)
-
getLarge
public SegmentMeasureList getLarge()
The space-separated definition of the columns for large devices. Possible values are: segment values between 1 and 12, 'auto' and '*'. Example: '1seg 5seg * auto'- Specified by:
getLarge
in classAbstractUISegmentLayout
-
setLarge
public void setLarge(SegmentMeasureList large)
-
getExtraLarge
public SegmentMeasureList getExtraLarge()
The space-separated definition of the columns for extra large devices. Possible values are: segment values between 1 and 12, 'auto' and '*'. Example: '1seg 5seg * auto'- Specified by:
getExtraLarge
in classAbstractUISegmentLayout
-
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 classAbstractUISegmentLayout
-
setMarginExtraLarge
public void setMarginExtraLarge(String marginExtraLarge)
-
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 classAbstractUISegmentLayout
-
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 classAbstractUISegmentLayout
-
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
-
getMedium
public SegmentMeasureList getMedium()
The space-separated definition of the columns for medium devices. Possible values are: segment values between 1 and 12, 'auto' and '*'. Example: '1seg 5seg * auto'- Specified by:
getMedium
in classAbstractUISegmentLayout
-
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 classAbstractUISegmentLayout
-
setMarginLarge
public void setMarginLarge(String marginLarge)
-
restoreState
public void restoreState(javax.faces.context.FacesContext context, Object state)
- Specified by:
restoreState
in interfacejavax.faces.component.StateHolder
- Overrides:
restoreState
in classjavax.faces.component.UIComponentBase
-
-