Package org.primefaces.component.api

Interface UIColumn

All Known Implementing Classes:
Column, ColumnBase, Columns, ColumnsBase, DynamicColumn
public interface UIColumn

  • Field Details

    • DEFAULT_FILTER_MATCH_MODE

      static final MatchMode DEFAULT_FILTER_MATCH_MODE

    • DYNAMIC_FIELD_VE_LEGACY_PATTERN

      static final Pattern DYNAMIC_FIELD_VE_LEGACY_PATTERN
      Used to extract bean's property from a value expression in dynamic columns (e.g. #{car[column.property]} = name)

    • STATIC_FIELD_VE_LEGACY_PATTERN

      static final Pattern STATIC_FIELD_VE_LEGACY_PATTERN
      Used to extract bean's property from a value expression in static columns (e.g. "#{car.year}" = year)

  • Method Details

    • resolveField

      default String resolveField(javax.faces.context.FacesContext context, javax.el.ValueExpression expression)
      Used to extract UIColumn#field if not defined. Supports strictly two kind of expressions: #{car.name}: name (for static columns) #{car[column.property]}: name (for dynamic columns)
      Parameters:
      context - the FacesContext
      expression - the ValueExpression like "filterBy" or "sortBy"
      Returns:
      the "field" name if found, otherwise null

    • createValueExpressionFromField

      static javax.el.ValueExpression createValueExpressionFromField(javax.faces.context.FacesContext context, String var, String field)
      Used to build a valid ValueExpression using UIData.getVar() and getField() Mostly used if sortBy and/or filterBy are not defined. var="car" and field="name" -> #{car.name}
      Parameters:
      context - the FacesContext
      var - the "var" attribute of the parent table
      field - the "field" attribute of the column
      Returns:
      the ValueExpression

    • getValueExpression

      javax.el.ValueExpression getValueExpression(String property)

    • getContainerClientId

      String getContainerClientId(javax.faces.context.FacesContext context)

    • getColumnKey

      String getColumnKey()

    • getColumnKey

      default String getColumnKey(javax.faces.component.UIComponent parent, int rowIndex)
      Special getColumnKey() method which must be used when we are inside e.g. the DataTable "row state".
      Parameters:
      parent -
      rowIndex -
      Returns:

    • getColumnKey

      String getColumnKey(javax.faces.component.UIComponent parent, String rowKey)
      Special getColumnKey() method which must be used when we are inside e.g. the DataTable "row state".
      Parameters:
      parent -
      rowKey -
      Returns:

    • getClientId

      String getClientId()

    • getClientId

      String getClientId(javax.faces.context.FacesContext context)

    • isSelectionBox

      boolean isSelectionBox()

    • isResizable

      boolean isResizable()

    • getTitle

      String getTitle()

    • getStyle

      String getStyle()

    • getStyleClass

      String getStyleClass()

    • getRowspan

      int getRowspan()

    • getColspan

      int getColspan()

    • getFilterPosition

      String getFilterPosition()

    • getFilterPlaceholder

      String getFilterPlaceholder()

    • getFacet

      javax.faces.component.UIComponent getFacet(String facet)

    • getFilterBy

      Object getFilterBy()

    • getFilterValue

      Object getFilterValue()

    • getHeaderText

      String getHeaderText()

    • getFooterText

      String getFooterText()

    • getFilterStyleClass

      String getFilterStyleClass()

    • getFilterStyle

      String getFilterStyle()

    • getFilterMatchMode

      String getFilterMatchMode()

    • getFilterMaxLength

      int getFilterMaxLength()

    • getCellEditor

      CellEditor getCellEditor()

    • isDynamic

      boolean isDynamic()

    • getSortFunction

      javax.el.MethodExpression getSortFunction()

    • getSortBy

      Object getSortBy()

    • getChildren

      List<javax.faces.component.UIComponent> getChildren()

    • isExportable

      boolean isExportable()

    • isRendered

      boolean isRendered()

    • encodeAll

      void encodeAll(javax.faces.context.FacesContext context) throws IOException
      Throws:
      IOException

    • renderChildren

      void renderChildren(javax.faces.context.FacesContext context) throws IOException
      Throws:
      IOException

    • getWidth

      String getWidth()

    • isToggleable

      boolean isToggleable()

    • isDraggable

      boolean isDraggable()

    • getFilterFunction

      javax.el.MethodExpression getFilterFunction()

    • getField

      String getField()

    • getResponsivePriority

      int getResponsivePriority()

    • isSortable

      boolean isSortable()

    • isFilterable

      boolean isFilterable()

    • isVisible

      boolean isVisible()

    • isSelectRow

      boolean isSelectRow()

    • getAriaHeaderText

      String getAriaHeaderText()

    • getExportFunction

      javax.el.MethodExpression getExportFunction()

    • getExportValue

      Object getExportValue()

    • getExportRowspan

      int getExportRowspan()

    • getExportColspan

      int getExportColspan()

    • isGroupRow

      boolean isGroupRow()

    • getExportHeaderValue

      Object getExportHeaderValue()

    • getExportFooterValue

      Object getExportFooterValue()

    • getExportTag

      String getExportTag()

    • getSortOrder

      String getSortOrder()

    • getSortPriority

      int getSortPriority()

    • getNullSortOrder

      int getNullSortOrder()

    • isCaseSensitiveSort

      boolean isCaseSensitiveSort()

    • getDisplayPriority

      int getDisplayPriority()

    • getConverter

      Object getConverter()

    • getFilterValueHolder

      default EditableValueHolderState getFilterValueHolder(javax.faces.context.FacesContext context)

    • setFilterValueToValueHolder

      default void setFilterValueToValueHolder(javax.faces.context.FacesContext context, Object value)

    • asUIComponent

      default javax.faces.component.UIComponent asUIComponent()