Klasse AbstractUIData

java.lang.Object
javax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.apache.myfaces.tobago.internal.component.AbstractUIData
Alle implementierten Schnittstellen:
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
Bekannte direkte Unterklassen:
AbstractUISheet, AbstractUITree

public abstract class AbstractUIData extends javax.faces.component.UIData implements Visual
Base class for sheet and tree.
  • Feldübersicht

    Felder
    Modifizierer und Typ
    Feld
    Beschreibung
    static final String
     
    static final String
    Veraltet.
    since 2.0.0.
    static final String
     

    Von Klasse geerbte Felder javax.faces.component.UIData

    COMPONENT_FAMILY, COMPONENT_TYPE

    Von Klasse geerbte Felder javax.faces.component.UIComponent

    ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

    Von Schnittstelle geerbte Felder javax.faces.component.NamingContainer

    SEPARATOR_CHAR
  • Konstruktorübersicht

    Konstruktoren
    Konstruktor
    Beschreibung
     
  • Methodenübersicht

    Modifizierer und Typ
    Methode
    Beschreibung
    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
     
    protected javax.faces.model.DataModel
     
    abstract ExpandedState
     
     
     
     
     
    abstract Selectable
     
    Veraltet.
    since 3.0.0, please use getSelectable()
    abstract SelectedState
     
     
    boolean
    invokeOnComponent(javax.faces.context.FacesContext facesContext, String clientId, javax.faces.component.ContextCallback callback)
     
    boolean
     
    boolean
    The value describes, if the UIData renderer creates container elements to hold the row information.
    boolean
     
    boolean
     
    abstract boolean
     
    boolean
     
    boolean
     
    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.

    Von Klasse geerbte Methoden 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

    Von Klasse geerbte Methoden 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

    Von Klasse geerbte Methoden 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

    Von Klasse geerbte Methoden java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Von Schnittstelle geerbte Methoden org.apache.myfaces.tobago.component.Visual

    getCustomClass, getMarkup, getRendererType, isPlain, setCustomClass, setMarkup
  • Felddetails

  • Konstruktordetails

    • AbstractUIData

      public AbstractUIData()
  • Methodendetails

    • isTreeModel

      public boolean isTreeModel()
    • getTreeDataModel

      public TreeDataModel getTreeDataModel()
    • getDataModel

      protected javax.faces.model.DataModel getDataModel()
      Setzt außer Kraft:
      getDataModel in Klasse javax.faces.component.UIData
    • getSelectableAsEnum

      @Deprecated public Selectable getSelectableAsEnum()
      Veraltet.
      since 3.0.0, please use getSelectable()
    • 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 supports TreeNode out of the box.
      Parameter:
      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
      Setzt außer Kraft:
      encodeBegin in Klasse javax.faces.component.UIData
      Löst aus:
      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()
      Gibt zurück:
      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)
      Setzt außer Kraft:
      findComponent in Klasse javax.faces.component.UIComponentBase
    • stripRowIndex

      public String stripRowIndex(String initialSearchId)
    • invokeOnComponent

      public boolean invokeOnComponent(javax.faces.context.FacesContext facesContext, String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
      Setzt außer Kraft:
      invokeOnComponent in Klasse javax.faces.component.UIData
      Löst aus:
      javax.faces.FacesException
    • getPath

      public TreePath getPath()
      Gibt zurück:
      The TreePath of the current row index.
    • isFolder

      public boolean isFolder()
      Gibt zurück:
      Is the current row index representing a folder.
    • getRowIndicesOfChildren

      public List<Integer> 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.
      Setzt außer Kraft:
      visitTree in Klasse javax.faces.component.UIData