Class UISegmentLayout

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
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 template component.stg with class SegmentLayoutTagDeclaration.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     

    Fields inherited from class javax.faces.component.UIComponent

    BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Sets a CSS class in its parent, if the parent supports it.
    The space-separated definition of the columns for extra large devices.
    The space-separated definition of the columns for extra small devices.
     
    The space-separated definition of the columns for 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.
    The space-separated definition of the columns for small devices.
    void
    restoreState(javax.faces.context.FacesContext context, Object state)
     
    void
     
    void
     
    void
     
    void
     
    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
     
    void
     

    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 Details

  • Constructor Details

    • UISegmentLayout

      public UISegmentLayout()
  • Method Details

    • getFamily

      public String getFamily()
      Specified by:
      getFamily in class javax.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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • setMarginExtraSmall

      public void setMarginExtraSmall(String marginExtraSmall)
    • getMarkup

      public Markup getMarkup()
      Specified by:
      getMarkup in interface Visual
    • setMarkup

      public void setMarkup(Markup markup)
      Specified by:
      setMarkup in interface Visual
    • 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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • 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 interface Visual
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Specified by:
      setCustomClass in interface Visual
    • 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 class AbstractUISegmentLayout
    • 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 class AbstractUISegmentLayout
    • setMarginLarge

      public void setMarginLarge(String marginLarge)
    • restoreState

      public void restoreState(javax.faces.context.FacesContext context, Object state)
      Specified by:
      restoreState in interface javax.faces.component.StateHolder
      Overrides:
      restoreState in class javax.faces.component.UIComponentBase