Class UIColumn

  • All Implemented Interfaces:
    jakarta.faces.component.behavior.ClientBehaviorHolder, jakarta.faces.component.PartialStateHolder, jakarta.faces.component.StateHolder, jakarta.faces.component.TransientStateHolder, jakarta.faces.event.ComponentSystemEventListener, jakarta.faces.event.FacesListener, jakarta.faces.event.SystemEventListenerHolder, EventListener, Visual

    @Generated("component.stg")
    public class UIColumn
    extends AbstractUIColumn
    implements jakarta.faces.component.behavior.ClientBehaviorHolder
    Renders a UIComponent that represents a single column of data within a parent UISheet component. UIComponent class, generated from template component.stg with class ColumnTagDeclaration.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • 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
      UIColumn()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      TextAlign getAlign()
      Horizontal alignment of this column.
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      String getLabel()
      A localized user presentable label for this component.
      Markup getMarkup()  
      String getTip()
      Text value to display as tooltip.
      VerticalAlign getVerticalAlign()
      Vertical alignment of this column.
      boolean isResizable()
      Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
      boolean isSortable()
      Flag indicating whether or not this column is sortable.
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setAlign​(TextAlign align)  
      void setCustomClass​(CustomClass customClass)  
      void setLabel​(String label)  
      void setMarkup​(Markup markup)  
      void setResizable​(boolean resizable)  
      void setSortable​(boolean sortable)  
      void setTip​(String tip)  
      void setVerticalAlign​(VerticalAlign verticalAlign)  
      • Methods inherited from class jakarta.faces.component.UIColumn

        getFooter, getHeader, getId, setFooter, setHeader
      • Methods inherited from class jakarta.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, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, 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 interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
    • Constructor Detail

      • UIColumn

        public UIColumn()
    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.faces.component.UIColumn
      • setVerticalAlign

        public void setVerticalAlign​(VerticalAlign verticalAlign)
      • isResizable

        public boolean isResizable()
        Flag indicating whether or not the width of this column in a sheet is resizable, by the user.
        Default: true
        Overrides:
        isResizable in class AbstractUIColumnBase
      • setResizable

        public void setResizable​(boolean resizable)
      • 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
      • getTip

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

        public void setTip​(String tip)
      • setLabel

        public void setLabel​(String label)
      • isSortable

        public boolean isSortable()
        Flag indicating whether or not this column is sortable. To make a column sortable the data of the sheet must be one of java.util.List or Object[].
        Default: false
      • setSortable

        public void setSortable​(boolean sortable)
      • getAlign

        public TextAlign getAlign()
        Horizontal alignment of this column. Possible values: {
        Allowed Values: left,right,center,justify
        Specified by:
        getAlign in class AbstractUIColumn
      • setAlign

        public void setAlign​(TextAlign align)
      • 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.UIComponentBase