Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.6.0)

E12063-07

oracle.adf.view.faces.bi.component.hierarchyViewer
Class SearchResults

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCollection
                  extended by oracle.adf.view.faces.bi.component.hierarchyViewer.SearchResults
All Implemented Interfaces:
javax.faces.component.ActionSource, javax.faces.component.ActionSource2, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class SearchResults
extends org.apache.myfaces.trinidad.component.UIXCollection
implements javax.faces.component.ActionSource, javax.faces.component.ActionSource2


Field Summary
static org.apache.myfaces.trinidad.bean.PropertyKey ACTION_EXPRESSION_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey ACTION_LISTENER_KEY
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey RESULT_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_ROW_KEYS_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey VAR_STATUS_KEY
           
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXCollection
VAR_KEY
 
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
SearchResults()
          Constructs an instance of the SearchResults.
 
Method Summary
 void addActionListener(javax.faces.event.ActionListener listener)
          Adds a action listener.
 org.apache.myfaces.trinidad.model.CollectionModel createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel current, java.lang.Object value)
           
 javax.faces.el.MethodBinding getAction()
           
 javax.el.MethodExpression getActionExpression()
          Gets a reference to an action method sent by the command component, or the static outcome of an action.
 javax.faces.el.MethodBinding getActionListener()
          Gets a method reference to an action listener
 javax.faces.event.ActionListener[] getActionListeners()
          Returns an array of attached action listeners.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.lang.String getClientRowKey()
           
 java.lang.String getEmptyText()
          Gets the text of an empty table.
 java.lang.String getFamily()
           
 int getFetchSize()
          Gets the number of rows in the data fetch block
 java.lang.String getRendererType()
           
 javax.el.MethodExpression getResultListener()
          Gets a method reference to a result listener
 org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeys()
          Gets the action state for this component.
 java.lang.Object getValue()
          Retrieves the search result's data model, which should be an instance of DataModel.
 java.lang.String getVarStatus()
           
 boolean isImmediate()
           
protected  void processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
           
 void removeActionListener(javax.faces.event.ActionListener listener)
          Removes a action listener.
 void setAction(javax.faces.el.MethodBinding binding)
           
 void setActionExpression(javax.el.MethodExpression actionExpression)
          Sets a reference to an action method sent by the command component, or the static outcome of an action.
 void setActionListener(javax.faces.el.MethodBinding actionListener)
          Sets a method reference to an action listener
 void setEmptyText(java.lang.String emptyText)
          Sets the text of an empty table.
 void setFetchSize(int fetchSize)
          Sets the number of rows in the data fetch block
 void setImmediate(boolean immediate)
           
 void setResultListener(javax.el.MethodExpression actionListener)
          Sets a method reference to a result listener
 void setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys)
          Sets the action state for this component.
 void setValue(java.lang.Object value)
          Specifies the search result's data model, which should be an instance of DataModel.
 void setVarStatus(java.lang.String varStatus)
          For internal use only
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getCachingStrategy, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

ACTION_EXPRESSION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTION_EXPRESSION_KEY

ACTION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTION_LISTENER_KEY

VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY

VAR_STATUS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VAR_STATUS_KEY

RESULT_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey RESULT_LISTENER_KEY

SELECTED_ROW_KEYS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_ROW_KEYS_KEY

EMPTY_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY

FETCH_SIZE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

SearchResults

public SearchResults()
Constructs an instance of the SearchResults.

Method Detail

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getRendererType

public java.lang.String getRendererType()
Overrides:
getRendererType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

getValue

public final java.lang.Object getValue()
Retrieves the search result's data model, which should be an instance of DataModel.

Specified by:
getValue in class org.apache.myfaces.trinidad.component.UIXCollection
Returns:
the data model

setValue

public final void setValue(java.lang.Object value)
Specifies the search result's data model, which should be an instance of DataModel.

Parameters:
value - the search results model

getResultListener

public final javax.el.MethodExpression getResultListener()
Gets a method reference to a result listener

Returns:
the new resultListener value

setResultListener

public final void setResultListener(javax.el.MethodExpression actionListener)
Sets a method reference to a result listener

Parameters:
resultListener - the new resultListener value

createCollectionModel

public org.apache.myfaces.trinidad.model.CollectionModel createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel current,
                                                                               java.lang.Object value)
Specified by:
createCollectionModel in class org.apache.myfaces.trinidad.component.UIXCollection

getClientRowKey

public java.lang.String getClientRowKey()
Overrides:
getClientRowKey in class org.apache.myfaces.trinidad.component.UIXCollection

getVarStatus

public java.lang.String getVarStatus()
Specified by:
getVarStatus in class org.apache.myfaces.trinidad.component.UIXCollection

setVarStatus

public final void setVarStatus(java.lang.String varStatus)
For internal use only


processFacetsAndChildren

protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                        javax.faces.event.PhaseId phaseId)
Specified by:
processFacetsAndChildren in class org.apache.myfaces.trinidad.component.UIXCollection

getEmptyText

public final java.lang.String getEmptyText()
Gets the text of an empty table.

Returns:
the new emptyText value

setEmptyText

public final void setEmptyText(java.lang.String emptyText)
Sets the text of an empty table.

Parameters:
emptyText - the new emptyText value

getFetchSize

public final int getFetchSize()
Gets the number of rows in the data fetch block

Returns:
the new fetchSize value

setFetchSize

public final void setFetchSize(int fetchSize)
Sets the number of rows in the data fetch block

Parameters:
fetchSize - the new fetchSize value

getSelectedRowKeys

public final org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeys()
Gets the action state for this component.

Returns:
the new selectedRowKeys value

setSelectedRowKeys

public final void setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys)
Sets the action state for this component.

Parameters:
selectedRowKeys - the new selectedRowKeys value

getAction

public javax.faces.el.MethodBinding getAction()
Specified by:
getAction in interface javax.faces.component.ActionSource

setAction

public void setAction(javax.faces.el.MethodBinding binding)
Specified by:
setAction in interface javax.faces.component.ActionSource

getActionExpression

public final javax.el.MethodExpression getActionExpression()
Gets a reference to an action method sent by the command component, or the static outcome of an action. If the action starts with "dialog:", useWindow attribute must be set to true.

Specified by:
getActionExpression in interface javax.faces.component.ActionSource2
Returns:
the new actionExpression value

setActionExpression

public final void setActionExpression(javax.el.MethodExpression actionExpression)
Sets a reference to an action method sent by the command component, or the static outcome of an action. If the action starts with "dialog:", useWindow attribute must be set to true.

Specified by:
setActionExpression in interface javax.faces.component.ActionSource2
Parameters:
actionExpression - the new actionExpression value

getActionListener

public final javax.faces.el.MethodBinding getActionListener()
Gets a method reference to an action listener

Specified by:
getActionListener in interface javax.faces.component.ActionSource
Returns:
the new actionListener value

setActionListener

public final void setActionListener(javax.faces.el.MethodBinding actionListener)
Sets a method reference to an action listener

Specified by:
setActionListener in interface javax.faces.component.ActionSource
Parameters:
actionListener - the new actionListener value

addActionListener

public final void addActionListener(javax.faces.event.ActionListener listener)
Adds a action listener.

Specified by:
addActionListener in interface javax.faces.component.ActionSource
Parameters:
listener - the action listener to add

removeActionListener

public final void removeActionListener(javax.faces.event.ActionListener listener)
Removes a action listener.

Specified by:
removeActionListener in interface javax.faces.component.ActionSource
Parameters:
listener - the action listener to remove

getActionListeners

public final javax.faces.event.ActionListener[] getActionListeners()
Returns an array of attached action listeners.

Specified by:
getActionListeners in interface javax.faces.component.ActionSource
Returns:
an array of attached action listeners.

isImmediate

public boolean isImmediate()
Specified by:
isImmediate in interface javax.faces.component.ActionSource

setImmediate

public void setImmediate(boolean immediate)
Specified by:
setImmediate in interface javax.faces.component.ActionSource

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.6.0)

E12063-07

Copyright © 1997, 2011, Oracle. All rights reserved.