Class UIColumnSelector
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIColumn
-
- org.apache.myfaces.tobago.internal.component.AbstractUIColumnBase
-
- org.apache.myfaces.tobago.internal.component.AbstractUIColumnSelector
-
- org.apache.myfaces.tobago.component.UIColumnSelector
-
- 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 UIColumnSelector extends AbstractUIColumnSelector implements jakarta.faces.component.behavior.ClientBehaviorHolderRenders a column with checkboxes to mark selected rows. UIComponent class, generated from templatecomponent.stgwith classColumnSelectorTagDeclaration.
-
-
Field Summary
Fields Modifier and Type Field Description static StringCOMPONENT_FAMILYstatic StringCOMPONENT_TYPE
-
Constructor Summary
Constructors Constructor Description UIColumnSelector()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomClassgetCustomClass()Sets a CSS class in its parent, if the parent supports it.StringgetFamily()MarkupgetMarkup()SelectablegetSelectable()Indicating the selection mode of the columnSelector.booleanisDisabled()Flag indicating that this element is disabled.voidrestoreState(jakarta.faces.context.FacesContext context, Object state)voidsetCustomClass(CustomClass customClass)voidsetDisabled(boolean disabled)voidsetMarkup(Markup markup)voidsetSelectable(Selectable selectable)-
Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIColumnBase
isResizable
-
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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
-
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
-
-
-
Field Detail
-
COMPONENT_TYPE
public static final String COMPONENT_TYPE
-
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getFamily
public String getFamily()
- Overrides:
getFamilyin classjakarta.faces.component.UIColumn
-
getSelectable
public Selectable getSelectable()
Indicating the selection mode of the columnSelector. Only effective if sheet selection mode is none. Use case: Show details with tc:row event and columnSelector for action on selected rows.
Allowed Values:single,singleOrNone,multi- Specified by:
getSelectablein classAbstractUIColumnSelector
-
setSelectable
public void setSelectable(Selectable selectable)
-
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:
getCustomClassin interfaceVisual
-
setCustomClass
public void setCustomClass(CustomClass customClass)
- Specified by:
setCustomClassin interfaceVisual
-
isDisabled
public boolean isDisabled()
Flag indicating that this element is disabled.
Default:false- Specified by:
isDisabledin classAbstractUIColumnSelector
-
setDisabled
public void setDisabled(boolean disabled)
-
restoreState
public void restoreState(jakarta.faces.context.FacesContext context, Object state)- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-
-