org.apache.myfaces.tobago.internal.component
Class AbstractUIData

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIData
              extended by 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
Direct Known Subclasses:
AbstractUISheet, AbstractUITree

public abstract class AbstractUIData
extends javax.faces.component.UIData


Field Summary
static String SUFFIX_EXPANDED
           
static String SUFFIX_MARKED
          Deprecated. Since 2.0.0. The marked concept has been replaced by "selected".
static String SUFFIX_SELECTED
           
 
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
AbstractUIData()
           
 
Method Summary
protected  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 getDataModel()
           
abstract  ExpandedState getExpandedState()
           
 TreePath getPath()
           
 String getRowClientId()
           
 List<Integer> getRowIndicesOfChildren()
           
 String getRowParentClientId()
           
 Selectable getSelectableAsEnum()
          Will be obsolete later when selectable has the type TreeSelectable.
abstract  SelectedState getSelectedState()
           
 TreeDataModel getTreeDataModel()
           
 boolean hasRows()
          Deprecated. The name of this method is ambiguous. You may use the inverse of isRowsUnlimited(). Deprecated since 1.5.5.
 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()
           
 
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, visitTree
 
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
 

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
Constructor Detail

AbstractUIData

public AbstractUIData()
Method Detail

isTreeModel

public boolean isTreeModel()

getTreeDataModel

public TreeDataModel getTreeDataModel()

getDataModel

protected javax.faces.model.DataModel getDataModel()
Overrides:
getDataModel in class javax.faces.component.UIData

getSelectableAsEnum

public Selectable getSelectableAsEnum()
Will be obsolete later when selectable has the type TreeSelectable.


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 supports TreeNode out 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

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException
Overrides:
encodeBegin in class javax.faces.component.UIData
Throws:
IOException

getExpandedState

public abstract ExpandedState getExpandedState()

getSelectedState

public abstract SelectedState getSelectedState()

hasRows

@Deprecated
public boolean hasRows()
Deprecated. The name of this method is ambiguous. You may use the inverse of isRowsUnlimited(). Deprecated since 1.5.5.


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.


invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext facesContext,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException
Overrides:
invokeOnComponent in class javax.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.

getRowIndicesOfChildren

public List<Integer> getRowIndicesOfChildren()


Copyright © 2002-2014 The Apache Software Foundation. All Rights Reserved.