Class AbstractUIData
java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
- All Implemented Interfaces:
EventListener
,javax.faces.component.NamingContainer
,javax.faces.component.PartialStateHolder
,javax.faces.component.StateHolder
,javax.faces.component.UniqueIdVendor
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,Visual
- Direct Known Subclasses:
AbstractUISheet
,AbstractUITree
Base class for sheet and tree.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
Deprecated.since 2.0.0.static final String
Fields inherited from class javax.faces.component.UIData
COMPONENT_FAMILY, COMPONENT_TYPE
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createTreeDataModel
(Object value, boolean showRoot) Creates the TreeDataModel which should be used.void
encodeBegin
(javax.faces.context.FacesContext context) protected javax.faces.model.DataModel
abstract ExpandedState
getPath()
abstract Selectable
Deprecated.since 3.0.0, please usegetSelectable()
abstract SelectedState
boolean
invokeOnComponent
(javax.faces.context.FacesContext facesContext, String clientId, javax.faces.component.ContextCallback callback) boolean
isFolder()
boolean
The value describes, if the UIData renderer creates container elements to hold the row information.boolean
boolean
abstract boolean
boolean
boolean
boolean
visitTree
(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback) This is, because we need to visit the UIRow for each row, which is not done in the base implementation.Methods inherited from class javax.faces.component.UIData
broadcast, createUniqueId, encodeEnd, getContainerClientId, getFamily, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, processDecodes, processUpdates, processValidators, queueEvent, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setValue, setValueExpression, setVar
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, subscribeToEvent, unsubscribeFromEvent
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.myfaces.tobago.component.Visual
getCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
-
Field Details
-
SUFFIX_MARKED
Deprecated.since 2.0.0. The marked concept has been replaced by "selected".- See Also:
-
SUFFIX_SELECTED
- See Also:
-
SUFFIX_EXPANDED
- See Also:
-
-
Constructor Details
-
AbstractUIData
public AbstractUIData()
-
-
Method Details
-
isTreeModel
public boolean isTreeModel() -
getTreeDataModel
-
getDataModel
protected javax.faces.model.DataModel getDataModel()- Overrides:
getDataModel
in classjavax.faces.component.UIData
-
getSelectableAsEnum
Deprecated.since 3.0.0, please usegetSelectable()
-
getSelectable
-
createTreeDataModel
Creates the TreeDataModel which should be used. Override this method to use a custom model for an unsupported tree model. (Currently Tobago supportsTreeNode
out of the box.- Parameters:
value
- The reference to the data model (comes from the value attribute of theUIData
)showRoot
- comes from the showRoot attribute.
-
encodeBegin
- Overrides:
encodeBegin
in classjavax.faces.component.UIData
- Throws:
IOException
-
getExpandedState
-
getSelectedState
-
isRowVisible
public boolean isRowVisible() -
getRowClientId
-
getRowParentClientId
-
isShowRoot
public abstract boolean isShowRoot() -
isShowRootJunction
public boolean isShowRootJunction() -
isRowsUnlimited
public boolean isRowsUnlimited()- Returns:
- Is the (maximum) number of rows to display set to zero?
-
isRendersRowContainer
public 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. -
invokeOnComponent
public boolean invokeOnComponent(javax.faces.context.FacesContext facesContext, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException - Overrides:
invokeOnComponent
in classjavax.faces.component.UIData
- Throws:
javax.faces.FacesException
-
getPath
- Returns:
- The TreePath of the current row index.
-
isFolder
public boolean isFolder()- Returns:
- Is the current row index representing a folder.
-
getRowIndicesOfChildren
-
visitTree
public boolean visitTree(javax.faces.component.visit.VisitContext context, javax.faces.component.visit.VisitCallback callback) This is, because we need to visit the UIRow for each row, which is not done in the base implementation.- Overrides:
visitTree
in classjavax.faces.component.UIData
-