Class 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.
    • Constructor Detail

      • UISegmentLayout

        public UISegmentLayout()
    • Method Detail

      • getFamily

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