Class UIPaginatorRow

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
All Implemented Interfaces:
jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.component.ValueHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, SupportFieldId, Visual

@Generated("component.stg") public class UIPaginatorRow extends AbstractUIPaginatorRow
Renders a paginator to show and change the row position. UIComponent class, generated from template component.stg with class PaginatorRowTagDeclaration.
  • Field Summary

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

    Fields inherited from class jakarta.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, 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.
     
    Id of the component, this is related to.
     
    Text value to display as tooltip.
    boolean
    Flag indicating that the control show should be displayed in call cases, whether it is necessary or not (if there are a low number of rows).
    boolean
    Flag indicating that this component will prohibit changes by the user.
    void
    restoreState(jakarta.faces.context.FacesContext context, Object state)
     
    void
    setAlwaysVisible(boolean alwaysVisible)
     
    void
     
    void
    setFor(String forComponent)
     
    void
    setMarkup(Markup markup)
     
    void
    setReadonly(boolean readonly)
     
    void
     

    Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIPaginator

    getFieldId, getPageable

    Methods inherited from class jakarta.faces.component.UIOutput

    clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, saveState, setConverter, setValue

    Methods inherited from class jakarta.faces.component.UIComponentBase

    addClientBehavior, addFacesListener, broadcast, 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, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

    Methods inherited from class jakarta.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, toString, wait, wait, wait

    Methods inherited from interface org.apache.myfaces.tobago.component.Visual

    getRendererType, isPlain
  • Field Details

  • Constructor Details

    • UIPaginatorRow

      public UIPaginatorRow()
  • Method Details

    • getFamily

      public String getFamily()
      Overrides:
      getFamily in class jakarta.faces.component.UIOutput
    • getMarkup

      public Markup getMarkup()
    • setMarkup

      public void setMarkup(Markup markup)
    • isReadonly

      public boolean isReadonly()
      Flag indicating that this component will prohibit changes by the user.
      Default: false
    • setReadonly

      public void setReadonly(boolean readonly)
    • isAlwaysVisible

      public boolean isAlwaysVisible()
      Flag indicating that the control show should be displayed in call cases, whether it is necessary or not (if there are a low number of rows).
      Default: false
      Specified by:
      isAlwaysVisible in class AbstractUIPaginator
    • setAlwaysVisible

      public void setAlwaysVisible(boolean alwaysVisible)
    • getFor

      public String getFor()
      Id of the component, this is related to.
      Specified by:
      getFor in class AbstractUIPaginator
    • setFor

      public void setFor(String forComponent)
    • 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.
    • setCustomClass

      public void setCustomClass(CustomClass customClass)
    • getTip

      public String getTip()
      Text value to display as tooltip.
    • setTip

      public void setTip(String tip)
    • restoreState

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