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.ClientBehaviorHolder
Renders a column with checkboxes to mark selected rows.
UIComponent class, generated from template
component.stg
with class
ColumnSelectorTagDeclaration
.-
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionSets a CSS class in its parent, if the parent supports it.Indicating the selection mode of the columnSelector.boolean
Flag indicating that this element is disabled.void
restoreState
(jakarta.faces.context.FacesContext context, Object state) void
setCustomClass
(CustomClass customClass) void
setDisabled
(boolean disabled) void
void
setSelectable
(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 Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIColumnSelector
public UIColumnSelector()
-
-
Method Details
-
getFamily
- Overrides:
getFamily
in classjakarta.faces.component.UIColumn
-
getMarkup
-
setMarkup
-
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:
getSelectable
in classAbstractUIColumnSelector
-
setSelectable
-
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 interfaceVisual
-
setCustomClass
- Specified by:
setCustomClass
in interfaceVisual
-
isDisabled
public boolean isDisabled()Flag indicating that this element is disabled.
Default:false
- Specified by:
isDisabled
in classAbstractUIColumnSelector
-
setDisabled
public void setDisabled(boolean disabled) -
restoreState
- Specified by:
restoreState
in interfacejakarta.faces.component.StateHolder
- Overrides:
restoreState
in classjakarta.faces.component.UIComponentBase
-