public class SearchResults
extends org.apache.myfaces.trinidad.component.UIXCollection
implements javax.faces.component.ActionSource, javax.faces.component.ActionSource2
Modifier and Type | Field and Description |
---|---|
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 |
SEARCH_RESULTS_CLEARED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SEARCH_RESULTS_FIRST_VISIBLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SEARCH_RESULTS_NEXT_INDEX_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SEARCH_RESULTS_RENDERED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SEARCH_RESULTS_SELECTED_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 |
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Constructor and Description |
---|
SearchResults()
Constructs an instance of the SearchResults.
|
Modifier and Type | Method and Description |
---|---|
void |
addActionListener(javax.faces.event.ActionListener listener)
Adds a action listener.
|
void |
clearCachedClientIds() |
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 |
pSetupVisitingContext(javax.faces.context.FacesContext context) |
void |
pTearDownVisitingContext(javax.faces.context.FacesContext context) |
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
|
protected boolean |
visitData(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback) |
areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren, visitChildrenWithoutIterating, visitUnstampedFacets
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTION_EXPRESSION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTION_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VAR_STATUS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey RESULT_LISTENER_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTED_ROW_KEYS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SEARCH_RESULTS_RENDERED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SEARCH_RESULTS_CLEARED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SEARCH_RESULTS_FIRST_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SEARCH_RESULTS_SELECTED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SEARCH_RESULTS_NEXT_INDEX_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public SearchResults()
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public java.lang.String getRendererType()
getRendererType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void clearCachedClientIds()
clearCachedClientIds
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public final java.lang.Object getValue()
getValue
in class org.apache.myfaces.trinidad.component.UIXCollection
public final void setValue(java.lang.Object value)
value
- the search results modelpublic final javax.el.MethodExpression getResultListener()
public final void setResultListener(javax.el.MethodExpression actionListener)
resultListener
- the new resultListener valuepublic org.apache.myfaces.trinidad.model.CollectionModel createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel current, java.lang.Object value)
createCollectionModel
in class org.apache.myfaces.trinidad.component.UIXCollection
public java.lang.String getClientRowKey()
getClientRowKey
in class org.apache.myfaces.trinidad.component.UIXCollection
public java.lang.String getVarStatus()
getVarStatus
in class org.apache.myfaces.trinidad.component.UIXCollection
public final void setVarStatus(java.lang.String varStatus)
protected void processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
processFacetsAndChildren
in class org.apache.myfaces.trinidad.component.UIXCollection
public final java.lang.String getEmptyText()
public final void setEmptyText(java.lang.String emptyText)
emptyText
- the new emptyText valuepublic final int getFetchSize()
public final void setFetchSize(int fetchSize)
fetchSize
- the new fetchSize valuepublic final org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeys()
public final void setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys)
selectedRowKeys
- the new selectedRowKeys valuepublic javax.faces.el.MethodBinding getAction()
getAction
in interface javax.faces.component.ActionSource
public void setAction(javax.faces.el.MethodBinding binding)
setAction
in interface javax.faces.component.ActionSource
public final javax.el.MethodExpression getActionExpression()
getActionExpression
in interface javax.faces.component.ActionSource2
public final void setActionExpression(javax.el.MethodExpression actionExpression)
setActionExpression
in interface javax.faces.component.ActionSource2
actionExpression
- the new actionExpression valuepublic final javax.faces.el.MethodBinding getActionListener()
getActionListener
in interface javax.faces.component.ActionSource
public final void setActionListener(javax.faces.el.MethodBinding actionListener)
setActionListener
in interface javax.faces.component.ActionSource
actionListener
- the new actionListener valuepublic final void addActionListener(javax.faces.event.ActionListener listener)
addActionListener
in interface javax.faces.component.ActionSource
listener
- the action listener to addpublic final void removeActionListener(javax.faces.event.ActionListener listener)
removeActionListener
in interface javax.faces.component.ActionSource
listener
- the action listener to removepublic final javax.faces.event.ActionListener[] getActionListeners()
getActionListeners
in interface javax.faces.component.ActionSource
public boolean isImmediate()
isImmediate
in interface javax.faces.component.ActionSource
public void setImmediate(boolean immediate)
setImmediate
in interface javax.faces.component.ActionSource
protected boolean visitData(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)
visitData
in class org.apache.myfaces.trinidad.component.UIXCollection
public void pSetupVisitingContext(javax.faces.context.FacesContext context)
public void pTearDownVisitingContext(javax.faces.context.FacesContext context)