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.TransientStateHolder
,javax.faces.component.UniqueIdVendor
,javax.faces.event.ComponentSystemEventListener
,javax.faces.event.FacesListener
,javax.faces.event.SystemEventListenerHolder
,Visual
- Direct Known Subclasses:
AbstractUISheet
,AbstractUITree
public abstract class AbstractUIData extends javax.faces.component.UIData implements Visual
Base class for sheet and tree.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SUFFIX_EXPANDED
static String
SUFFIX_MARKED
Deprecated.since 2.0.0.static String
SUFFIX_SELECTED
-
Constructor Summary
Constructors Constructor Description AbstractUIData()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
createTreeDataModel(Object value, boolean showRoot)
Creates the TreeDataModel which should be used.void
encodeBegin(javax.faces.context.FacesContext context)
javax.faces.component.UIComponent
findComponent(String searchId)
protected javax.faces.model.DataModel
getDataModel()
abstract ExpandedState
getExpandedState()
TreePath
getPath()
String
getRowClientId()
List<Integer>
getRowIndicesOfChildren()
String
getRowParentClientId()
abstract Selectable
getSelectable()
Selectable
getSelectableAsEnum()
Deprecated.since 3.0.0, please usegetSelectable()
abstract SelectedState
getSelectedState()
TreeDataModel
getTreeDataModel()
boolean
invokeOnComponent(javax.faces.context.FacesContext facesContext, String clientId, javax.faces.component.ContextCallback callback)
boolean
isFolder()
boolean
isRendersRowContainer()
The value describes, if the UIData renderer creates container elements to hold the row information.boolean
isRowsUnlimited()
boolean
isRowVisible()
abstract boolean
isShowRoot()
boolean
isShowRootJunction()
boolean
isTreeModel()
String
stripRowIndex(String initialSearchId)
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, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar
-
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, clearInitialState, decode, encodeAll, encodeChildren, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient
-
Methods inherited from class javax.faces.component.UIComponent
getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, 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 Detail
-
SUFFIX_MARKED
@Deprecated public static final String SUFFIX_MARKED
Deprecated.since 2.0.0. The marked concept has been replaced by "selected".- See Also:
- Constant Field Values
-
SUFFIX_SELECTED
public static final String SUFFIX_SELECTED
- See Also:
- Constant Field Values
-
SUFFIX_EXPANDED
public static final String SUFFIX_EXPANDED
- See Also:
- Constant Field Values
-
-
Method Detail
-
isTreeModel
public boolean isTreeModel()
-
getTreeDataModel
public TreeDataModel getTreeDataModel()
-
getDataModel
protected javax.faces.model.DataModel getDataModel()
- Overrides:
getDataModel
in classjavax.faces.component.UIData
-
getSelectableAsEnum
@Deprecated public Selectable getSelectableAsEnum()
Deprecated.since 3.0.0, please usegetSelectable()
-
getSelectable
public abstract Selectable getSelectable()
-
createTreeDataModel
protected void createTreeDataModel(Object value, boolean showRoot)
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
public void encodeBegin(javax.faces.context.FacesContext context) throws IOException
- Overrides:
encodeBegin
in classjavax.faces.component.UIData
- Throws:
IOException
-
getExpandedState
public abstract ExpandedState getExpandedState()
-
getSelectedState
public abstract SelectedState getSelectedState()
-
isRowVisible
public boolean isRowVisible()
-
getRowClientId
public String getRowClientId()
-
getRowParentClientId
public String 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.
-
findComponent
public javax.faces.component.UIComponent findComponent(String searchId)
- Overrides:
findComponent
in classjavax.faces.component.UIComponentBase
-
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
public TreePath getPath()
- Returns:
- The TreePath of the current row index.
-
isFolder
public boolean isFolder()
- Returns:
- Is the current row index representing a folder.
-
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
-
-