Class AbstractUIData

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUIData
All Implemented Interfaces:
EventListener, Visual
Direct Known Subclasses:
AbstractUISheet, AbstractUITree
public abstract class AbstractUIData extends Object implements Visual
Base class for sheet and tree.

  • Field Details

  • Constructor Details

    • AbstractUIData

      public AbstractUIData()

  • Method Details

    • isTreeModel

      public boolean isTreeModel()

    • getTreeDataModel

      public TreeDataModel getTreeDataModel()

    • getDataModel

      protected jakarta.faces.model.DataModel getDataModel()

    • getSelectableAsEnum

      @Deprecated(since="3.0.0", forRemoval=true) public Selectable getSelectableAsEnum()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.
      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(jakarta.faces.context.FacesContext context) throws IOException
      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 jakarta.faces.component.UIComponent findComponent(String searchId)

    • stripRowIndex

      public String stripRowIndex(String initialSearchId)

    • invokeOnComponent

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

    • setFooter

      public void setFooter(jakarta.faces.component.UIComponent arg0)

    • getFooter

      public jakarta.faces.component.UIComponent getFooter()

    • setHeader

      public void setHeader(jakarta.faces.component.UIComponent arg0)

    • getHeader

      public jakarta.faces.component.UIComponent getHeader()

    • isRowAvailable

      public boolean isRowAvailable()

    • getRowCount

      public int getRowCount()

    • getRowData

      public Object getRowData()

    • getRowIndex

      public int getRowIndex()

    • setRowIndex

      public void setRowIndex(int arg0)

    • markInitialState

      public void markInitialState()

    • restoreState

      public void restoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveState

      public Object saveState(jakarta.faces.context.FacesContext arg0)

    • setValueExpression

      public void setValueExpression(String arg0, jakarta.el.ValueExpression arg1)

    • getContainerClientId

      public String getContainerClientId(jakarta.faces.context.FacesContext arg0)

    • queueEvent

      public void queueEvent(jakarta.faces.event.FacesEvent arg0)

    • broadcast

      public void broadcast(jakarta.faces.event.FacesEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • createUniqueId

      public String createUniqueId(jakarta.faces.context.FacesContext arg0, String arg1)

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • processDecodes

      public void processDecodes(jakarta.faces.context.FacesContext arg0)

    • processValidators

      public void processValidators(jakarta.faces.context.FacesContext arg0)

    • processUpdates

      public void processUpdates(jakarta.faces.context.FacesContext arg0)

    • setDataModel

      protected void setDataModel(jakarta.faces.model.DataModel arg0)

    • getValue

      public Object getValue()

    • setValue

      public void setValue(Object arg0)

    • getFirst

      public int getFirst()

    • setFirst

      public void setFirst(int arg0)

    • getRows

      public int getRows()

    • setRows

      public void setRows(int arg0)

    • getVar

      public String getVar()

    • visitTree

      public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1)

    • setVar

      public void setVar(String arg0)

    • isRowStatePreserved

      public boolean isRowStatePreserved()

    • setRowStatePreserved

      public void setRowStatePreserved(boolean arg0)

    • getFamily

      public String getFamily()

    • setId

      public void setId(String arg0)

    • setParent

      public void setParent(jakarta.faces.component.UIComponent arg0)

    • addClientBehavior

      public void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • clearInitialState

      public void clearInitialState()

    • decode

      public void decode(jakarta.faces.context.FacesContext arg0)

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeChildren

      public void encodeChildren(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • getAttributes

      public Map<String,Object> getAttributes()

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes(boolean arg0)

    • getChildCount

      public int getChildCount()

    • getChildren

      public List<jakarta.faces.component.UIComponent> getChildren()

    • getClientBehaviors

      public Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getClientId

      public String getClientId(jakarta.faces.context.FacesContext arg0)

    • getDefaultEventName

      public String getDefaultEventName()

    • getEventNames

      public Collection<String> getEventNames()

    • getFacet

      public jakarta.faces.component.UIComponent getFacet(String arg0)

    • getFacetCount

      public int getFacetCount()

    • getFacets

      public Map<String, jakarta.faces.component.UIComponent> getFacets()

    • getFacetsAndChildren

      public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

    • getId

      public String getId()

    • getParent

      public jakarta.faces.component.UIComponent getParent()

    • getRendererType

      public String getRendererType()

    • getRendersChildren

      public boolean getRendersChildren()

    • isRendered

      public boolean isRendered()

    • isTransient

      public boolean isTransient()

    • addFacesListener

      protected void addFacesListener(jakarta.faces.event.FacesListener arg0)

    • getFacesContext

      protected jakarta.faces.context.FacesContext getFacesContext()

    • getFacesListeners

      protected jakarta.faces.event.FacesListener[] getFacesListeners(Class arg0)

    • getRenderer

      protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0)

    • removeFacesListener

      protected void removeFacesListener(jakarta.faces.event.FacesListener arg0)

    • processSaveState

      public Object processSaveState(jakarta.faces.context.FacesContext arg0)

    • processRestoreState

      public void processRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • setTransient

      public void setTransient(boolean arg0)

    • saveAttachedState

      public static Object saveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • restoreAttachedState

      public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException
      Throws:
      IllegalStateException

    • setRendered

      public void setRendered(boolean arg0)

    • setRendererType

      public void setRendererType(String arg0)

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes()

    • initialStateMarked

      public boolean initialStateMarked()

    • isCompositeComponent

      public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0)

    • isInView

      public boolean isInView()

    • isVisitable

      protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0)

    • getClientId

      public String getClientId()

    • getCompositeComponentParent

      public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0)

    • getCurrentComponent

      public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0)

    • getCurrentCompositeComponent

      public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0)

    • getListenersForEventClass

      public List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0)

    • getNamingContainer

      public jakarta.faces.component.UIComponent getNamingContainer()

    • setInView

      public void setInView(boolean arg0)

    • getResourceBundleMap

      public Map<String,String> getResourceBundleMap()

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression(String arg0)

    • processEvent

      public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • subscribeToEvent

      public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • unsubscribeFromEvent

      public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper()

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0)

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper()

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0)

    • restoreTransientState

      public void restoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveTransientState

      public Object saveTransientState(jakarta.faces.context.FacesContext arg0)

    • popComponentFromEL

      public void popComponentFromEL(jakarta.faces.context.FacesContext arg0)

    • pushComponentToEL

      public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)