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.Set a CSS class on the component.booleanFlag indicating that this element is disabled.booleanFlag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetCustomClass(CustomClass customClass) voidsetDisabled(boolean disabled) voidsetImmediate(boolean immediate) voidvoidsetSelectable(Selectable selectable) voidsetStyleClass(CustomClass styleClass) Methods inherited from class AbstractUIColumnBase
isResizableMethods inherited from class jakarta.faces.component.UIColumn
getFooter, getHeader, getId, setFooter, setHeaderMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, 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, visitTreeMethods 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, unsubscribeFromEventMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviorsMethods inherited from interface Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIColumnSelector
public UIColumnSelector()
-
-
Method Details
-
getEventNames
- Specified by:
getEventNamesin interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getEventNamesin classjakarta.faces.component.UIComponentBase
-
getDefaultEventName
- Specified by:
getDefaultEventNamein interfacejakarta.faces.component.behavior.ClientBehaviorHolder- Overrides:
getDefaultEventNamein classjakarta.faces.component.UIComponentBase
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIColumn
-
getMarkup
-
setMarkup
-
isImmediate
public boolean isImmediate()Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase.
Default:false- Specified by:
isImmediatein classAbstractUIColumnSelector
-
setImmediate
public void setImmediate(boolean immediate) -
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
-
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
- 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) -
getStyleClass
Set a CSS class on the component. This attribute is equivalent to<tc:style customClass="..."/>
. -
setStyleClass
-
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-