Class AbstractUIData
java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
- All Implemented Interfaces:
- jakarta.faces.component.NamingContainer,- jakarta.faces.component.PartialStateHolder,- jakarta.faces.component.StateHolder,- jakarta.faces.component.TransientStateHolder,- jakarta.faces.component.UniqueIdVendor,- jakarta.faces.event.ComponentSystemEventListener,- jakarta.faces.event.FacesListener,- jakarta.faces.event.SystemEventListenerHolder,- EventListener,- Visual
- Direct Known Subclasses:
- AbstractUISheet,- AbstractUITree
Base class for sheet and tree.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringDeprecated, for removal: This API element is subject to removal in a future version.The marked concept has been replaced by "selected".static final StringFields inherited from class jakarta.faces.component.UIDataCOMPONENT_FAMILY, COMPONENT_TYPEFields inherited from class jakarta.faces.component.UIComponentATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEYFields inherited from interface jakarta.faces.component.NamingContainerSEPARATOR_CHAR
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidcreateTreeDataModel(Object value, boolean showRoot) Creates the TreeDataModel which should be used.voidencodeBegin(jakarta.faces.context.FacesContext context) jakarta.faces.component.UIComponentfindComponent(String searchId) protected jakarta.faces.model.DataModelabstract ExpandedStategetPath()abstract SelectableDeprecated, for removal: This API element is subject to removal in a future version.Please usegetSelectable()abstract SelectedStatebooleaninvokeOnComponent(jakarta.faces.context.FacesContext facesContext, String clientId, jakarta.faces.component.ContextCallback callback) booleanisFolder()booleanThe value describes, if the UIData renderer creates container elements to hold the row information.booleanbooleanabstract booleanbooleanbooleanstripRowIndex(String initialSearchId) Methods inherited from class jakarta.faces.component.UIDatabroadcast, createUniqueId, encodeEnd, getContainerClientId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueExpression, setVar, visitTreeMethods inherited from class jakarta.faces.component.UIComponentBaseaddClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransientMethods inherited from class jakarta.faces.component.UIComponentgetClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.myfaces.tobago.component.VisualgetCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
- 
Field Details- 
SUFFIX_MARKEDDeprecated, for removal: This API element is subject to removal in a future version.The marked concept has been replaced by "selected".- See Also:
 
- 
SUFFIX_SELECTED- See Also:
 
- 
SUFFIX_EXPANDED- See Also:
 
 
- 
- 
Constructor Details- 
AbstractUIDatapublic AbstractUIData()
 
- 
- 
Method Details- 
isTreeModelpublic boolean isTreeModel()
- 
getTreeDataModel
- 
getDataModelprotected jakarta.faces.model.DataModel getDataModel()- Overrides:
- getDataModelin class- jakarta.faces.component.UIData
 
- 
getSelectableAsEnumDeprecated, for removal: This API element is subject to removal in a future version.Please usegetSelectable()
- 
getSelectable
- 
createTreeDataModelCreates the TreeDataModel which should be used. Override this method to use a custom model for an unsupported tree model. (Currently Tobago supportsTreeNodeout of the box.- Parameters:
- value- The reference to the data model (comes from the value attribute of the- UIData)
- showRoot- comes from the showRoot attribute.
 
- 
encodeBegin- Overrides:
- encodeBeginin class- jakarta.faces.component.UIData
- Throws:
- IOException
 
- 
getExpandedState
- 
getSelectedState
- 
isRowVisiblepublic boolean isRowVisible()
- 
getRowClientId
- 
getRowParentClientId
- 
isShowRootpublic abstract boolean isShowRoot()
- 
isShowRootJunctionpublic boolean isShowRootJunction()
- 
isRowsUnlimitedpublic boolean isRowsUnlimited()- Returns:
- Is the (maximum) number of rows to display set to zero?
 
- 
isRendersRowContainerpublic boolean isRendersRowContainer()The value describes, if the UIData renderer creates container elements to hold the row information. This information is important for the TreeNodeRenderer to set the visible state in the output or not. Typically the Sheet returns true and a Tree returns false, because the sheet renders the HTML TR tags, the the sheet also is responsible for the visible state.
- 
findComponent- Overrides:
- findComponentin class- jakarta.faces.component.UIComponentBase
 
- 
stripRowIndex
- 
invokeOnComponentpublic boolean invokeOnComponent(jakarta.faces.context.FacesContext facesContext, String clientId, jakarta.faces.component.ContextCallback callback) throws jakarta.faces.FacesException - Overrides:
- invokeOnComponentin class- jakarta.faces.component.UIData
- Throws:
- jakarta.faces.FacesException
 
- 
getPath- Returns:
- The TreePath of the current row index.
 
- 
isFolderpublic boolean isFolder()- Returns:
- Is the current row index representing a folder.
 
- 
getRowIndicesOfChildren
 
-