Class UISegmentLayout

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUILayoutBase
org.apache.myfaces.tobago.internal.component.AbstractUISegmentLayout
org.apache.myfaces.tobago.component.UISegmentLayout
All Implemented Interfaces:
EventListener, SupportsSegmentLayout, Visual
@Generated("component.stg") public class UISegmentLayout extends AbstractUISegmentLayout
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 Details

  • Constructor Details

    • UISegmentLayout

      public UISegmentLayout()

  • Method Details

    • getFamily

      public String getFamily()

    • 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

    • 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 interface SupportsSegmentLayout

    • setExtra2Large

      public void setExtra2Large(SegmentMeasureList extra2Large)

    • 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: [1-12]seg, 'auto' and <n>fr. Where <n> is a positive integer. Example: '1seg 5seg 1fr auto'
      Specified by:
      getLarge in interface SupportsSegmentLayout

    • 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 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

    • 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 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

    • 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 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

    • 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 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

    • 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 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

    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Specified by:
      setCustomClass in interface Visual

    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext context, Object state)

    • addClientBehavior

      void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • getClientBehaviors

      Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getDefaultEventName

      String getDefaultEventName()

    • getEventNames

      Collection<String> getEventNames()

    • setId

      public void setId(String arg0)

    • setParent

      public void setParent(jakarta.faces.component.UIComponent arg0)

    • addClientBehavior

      public void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • broadcast

      public void broadcast(jakarta.faces.event.FacesEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • clearInitialState

      public void clearInitialState()

    • decode

      public void decode(jakarta.faces.context.FacesContext arg0)

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeBegin

      public void encodeBegin(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeChildren

      public void encodeChildren(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • findComponent

      public jakarta.faces.component.UIComponent findComponent(String arg0)

    • getAttributes

      public Map<String,Object> getAttributes()

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes(boolean arg0)

    • getChildCount

      public int getChildCount()

    • getChildren

      public List<jakarta.faces.component.UIComponent> getChildren()

    • getClientBehaviors

      public Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getClientId

      public String getClientId(jakarta.faces.context.FacesContext arg0)

    • getDefaultEventName

      public String getDefaultEventName()

    • getEventNames

      public Collection<String> getEventNames()

    • getFacet

      public jakarta.faces.component.UIComponent getFacet(String arg0)

    • getFacetCount

      public int getFacetCount()

    • getFacets

      public Map<String, jakarta.faces.component.UIComponent> getFacets()

    • getFacetsAndChildren

      public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

    • getId

      public String getId()

    • getParent

      public jakarta.faces.component.UIComponent getParent()

    • getRendererType

      public String getRendererType()

    • getRendersChildren

      public boolean getRendersChildren()

    • invokeOnComponent

      public boolean invokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) throws jakarta.faces.FacesException
      Throws:
      jakarta.faces.FacesException

    • visitTree

      public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1)

    • isRendered

      public boolean isRendered()

    • isTransient

      public boolean isTransient()

    • markInitialState

      public void markInitialState()

    • addFacesListener

      protected void addFacesListener(jakarta.faces.event.FacesListener arg0)

    • getFacesContext

      protected jakarta.faces.context.FacesContext getFacesContext()

    • getFacesListeners

      protected jakarta.faces.event.FacesListener[] getFacesListeners(Class arg0)

    • getRenderer

      protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0)

    • removeFacesListener

      protected void removeFacesListener(jakarta.faces.event.FacesListener arg0)

    • queueEvent

      public void queueEvent(jakarta.faces.event.FacesEvent arg0)

    • processDecodes

      public void processDecodes(jakarta.faces.context.FacesContext arg0)

    • processValidators

      public void processValidators(jakarta.faces.context.FacesContext arg0)

    • processUpdates

      public void processUpdates(jakarta.faces.context.FacesContext arg0)

    • processSaveState

      public Object processSaveState(jakarta.faces.context.FacesContext arg0)

    • processRestoreState

      public void processRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • setTransient

      public void setTransient(boolean arg0)

    • saveAttachedState

      public static Object saveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • restoreAttachedState

      public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException
      Throws:
      IllegalStateException

    • saveState

      public Object saveState(jakarta.faces.context.FacesContext arg0)

    • setRendered

      public void setRendered(boolean arg0)

    • setRendererType

      public void setRendererType(String arg0)

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes()

    • initialStateMarked

      public boolean initialStateMarked()

    • isCompositeComponent

      public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0)

    • isInView

      public boolean isInView()

    • isVisitable

      protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0)

    • setValueExpression

      public void setValueExpression(String arg0, jakarta.el.ValueExpression arg1)

    • getClientId

      public String getClientId()

    • getCompositeComponentParent

      public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0)

    • getContainerClientId

      public String getContainerClientId(jakarta.faces.context.FacesContext arg0)

    • getCurrentComponent

      public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0)

    • getCurrentCompositeComponent

      public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0)

    • getListenersForEventClass

      public List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0)

    • getNamingContainer

      public jakarta.faces.component.UIComponent getNamingContainer()

    • setInView

      public void setInView(boolean arg0)

    • getResourceBundleMap

      public Map<String,String> getResourceBundleMap()

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression(String arg0)

    • processEvent

      public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • subscribeToEvent

      public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • unsubscribeFromEvent

      public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper()

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0)

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper()

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0)

    • restoreTransientState

      public void restoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveTransientState

      public Object saveTransientState(jakarta.faces.context.FacesContext arg0)

    • popComponentFromEL

      public void popComponentFromEL(jakarta.faces.context.FacesContext arg0)

    • pushComponentToEL

      public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)