OracleJavaScript API Reference for Oracle ADF Faces

 Overview   Package   Class   Tree   Deprecated   Index   Help 
Oracle Fusion Middleware Javascript API Reference for Oracle ADF Faces
12c (12.2.1.3)
E80085-01
 PREV   NEXT  FRAMES    NO FRAMES    Warning: private items are visible  
SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlInputSearchPeer

Warning:

org.ecmascript.object.Object
   |
   +--oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlValuePeer
         |
         +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
               |
               +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputBasePeer
                     |
                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputSearchPeer

public class AdfDhtmlInputSearchPeer
extends AdfDhtmlInputBasePeer
Stateful Peer for InputSearch component


Field Summary
private static Object
_AUTOCOMPLETE_ANNOUNCE_MSG
private static Object
_BUTTON_SUB_ID
private static Object
_CONTENT_CONTAINER
private static Object
_CONTENT_HEADER_SUB_ID
private static Object
_CONTENT_MODE_LIST
private static Object
_CONTENT_MODE_TABLE
private static Object
_CONTENT_STAMP_SUB_ID
private static Object
_CONTENT_SUB_ID
private static Object
_CRITERIA_CONTAINS
private static Object
_CRITERIA_STARTS_WITH
private static Object
_CUSTOM_NAME_EXPANDO
private static Object
_FOOTER_COMPONENT_PLACEHOLDER_SUB_ID
private static Object
_FOOTER_COMPONENT_SUB_ID
private static Object
_LABEL_NO_DATA
private static Object
_LIST_ITEMS_CONTAINER_STYLE_CLASS
private static Object
_LOADING_INDICATOR_STYLE_CLASS
private static Object
_LOADING_INDICATOR_SUB_ID
private static Object
_MSG_AUTCOMPLETE_FAILED_DETAIL
private static Object
_MSG_AUTOCOMPLETE_FAILED
private static Object
_NO_SUGGESTIONS_MESSAGE_STYLE_CLASS
private static Object
_ROW_ITEMS_CONTAINER_STYLE_CLASS
private static Object
_SEARCH_SECTION_CONTAINER_SUB_ID
private static Object
_SEARCH_SECTION_TYPE_DEFAULT
private static Object
_SELECTION_PROPERTY
private Object
_setTemplateAttributes
 static Object
__SUGGEST_ITEM_SUB_ID
private static Object
_SUGGESTION_ITEM_MATCHING_TEXT_STYLE_CLASS
private static Object
_SUGGESTION_LIST_ITEM_STYLE_CLASS
private static Object
_SUGGESTION_ROW_HEADER_STYLE_CLASS
private static Object
_SUGGESTION_ROW_ITEM_STYLE_CLASS
private static Object
_SUGGESTIONS_BODY_SUB_ID
private static Object
_SUGGESTIONS_CONTAINER_PLACEHOLDER_SUB_ID
private static Object
_SUGGESTIONS_CONTAINER_SUB_ID
private static Object
_SUGGESTIONS_COUNT_MSG
private static Object
_SUGGESTIONS_POPUP_SUB_ID
 static Object
__SUGGESTIONS_RENDERING_CHUNK_SIZE
private static Object
_VALUE_ATTRIBUTE_DATA_TYPE
private static Object
_VALUE_ATTRIBUTE_EXPANDO
private static Object
_VALUE_UPDATING_STYLE_CLASS


Fields inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
ComponentLabelChanged, ComponentShowRequiredChanged


Fields inherited from org.ecmascript.object.Object
constructor, prototype


Constructor Summary
public
AdfDhtmlInputSearchPeer()
Stateful Peer for InputSearch component


Method Summary
private Object
_adjustHeightToRowCount(Object options)
Sets the height of the suggestions panel to display the first 'X' suggestion items as configured on the rowCount attribute of the component.
private static Object
_appendContentHeader(Object component, Object suggestionsDomFragment)
private Object
_appendSuggestions(Object suggestionsDomFragment, Object suggestions, Object shouldHighlight, Object startIndex, Object endIndex)
private Boolean
_autoComplete(Object component)
Attempt to autoComplete the input element value
private static Object
_buildFilterAttributeValues(Object filterAttributes, Object suggestionItem)
private static AdfSuggestionCollection
_buildSuggestionsAfterLookup(Object component, Object searchSectionSuggestions, Object lookupSuggestions)
Consolidates the keys in the suggestions against the master lookup table and returns a complete list of objects to be rendered in the suggestions panel
private Object
_cacheSuggestions(Object data)
private Object
_clearAndDismissSuggestions(Object component)
private Object
_clearSuggestionsContainer(Object suggestionsContainer)
private Object
_clearTemporaryStorage()
private static Object
_cloneSimpleObject(Object object)
protected Object
ComponentValueChanged(Object component, Object domElement, Object newValues, Object oldValues)
private static Object
_containsFilter(Object component, Object searchText, Object data)
private static Object
_createHiddenValueElement(Object clientId, Object contentContainer)
private static Object
_createSampleListItem(Object isTableMode, Object listSize)
private Object
_createSuggestionsDomFragemnt(Object suggestions, Object options, Object startIndex, Object size)
private static Array
_defaultDisplayValueDerivation(Object component, Object suggestions, Object newValues)
Computes the display string with value of the display attributes separated by a space.
private static Array
_deriveDisplayValueFromConv(Object component, Object converter, Object newValues)
Invokes converter.getAsString on each value of the component
private Object
_fetch(Object component, Object options)
Make a REST call for the af:searchSection component of type specified
private Object
_fetchAll(Object component)
Make a REST call for each af:searchSection component Called from init/prefetch and upon first rendering of the search suggestions popup when all the sections have to be displayed in one go.
private Object
_fetchComplete(Object response, Object options)
Callback invoked on successful REST fetch
private Object
_fetchFailed(Object statusCode, Object response, Object options)
Callback invoked if HTTP status code is 4xx or 5xx
private Object
_filterSuggestions(Object component)
private Object
_filterSuggestionsCallback(Object component)
private Object
_filterSuggestionsImpl(Object component)
private Object
_getCachedSuggestions()
protected Object
GetComponentValue(Object component, Object domElement)
Reads the component value from the hidden input element
private static Object
_getContainsFilterRegex(Object searchText)
Builds a regex from the passed in searchText to match a string which has words that contains the words present in searchText.
private static Object
_getContentHeaderFacet(Object component)
private static Object
_getContentStampContainer(Object component)
public Object
getConvertedObject(Object component, Object newValues)
Converts the valueAttribute value to displayAttributes value.
public Object
getConvertedValue(Object component, Object submittedValue)
private static Object
_getCurrentSelectedItem(Object contentNode)
private static Object
_getFooterComponent(Object component)
private static Object
_getHiddenValueElements(Object component, Object domElement)
Fetches all the hidden submission fields of the component
private static Object
_getHighlightRegex(Object component)
private static Object
_getHighlightTextWrapperHtml(Object component)
protected Object
GetInlineEditor(Event event)
Override to return an inline editor that edits the inputSearch's label property
private static String
_getListItemContent(Object data, Object matchRegex, Object replaceStr, Object template, Object templateAttributes)
Returns the client template based suggestion content for the suggestion data passed.
private static Object
_getNextSuggestion(Object component, Object isFindNextItem, Object currentItem)
protected Object
GetNullDefault()
public Object
getSearchSections(Object component)
Returns all the SearchSections that belong to the InputSearch component.
private static Object
_getStartsWithFilterRegex(Object searchText)
Builds a regex from the passed in searchText to match a string which has words that start-with words present in searchText
protected Object
GetSubmittedValue(Object component, Object domElement)
Returns the submittedValue by getting the value of the input dom node.
private static Object
_getSuggestionElement(Object element, Object clientId)
Finds the closest ancestor element that is a suggestion item.
public Array
getSuggestions()
Returns the currently displayed suggestions This method is invoked from the component
private static Object
_getSuggestionsBody(Object component)
private static Object
_getSuggestionsContainer(Object component)
private static Object
_getSuggestionsPopup(Object component)
private Object
_getSuggestionsPopupHints(Object component)
private Object
_getTemplateAttributes()
protected Object
HandleComponentBlur(Object componentEvent)
protected Object
HandleComponentClick(Object componentEvent)
protected Object
HandleComponentKeyDown(Object componentEvent)
protected Object
HandleComponentKeyUp(Object componentEvent)
protected Object
HandleComponentMouseDown(Object componentEvent)
private Object
_handleEnterKey(Object component, Object contentNode)
private Object
_handleSuggestionsFromContentNode(Object keyDownEvent, Object contentNode)
private Object
_handleSuggestionsPopupClosed(Object component)
private Object
_handleSuggestionsPopupOpening(Object component)
private Object
_hasValueChanged(Object contentNodeValue)
private Object
_hideSuggestionPopup(Object component)
protected Object
InitDomElement(Object component, Object element)
Pre-fetch the data from searchSections
protected static Object
InitSubclass()
private static Object
_initSuggestionsContainer(Object component, Object suggestionsContainer)
private Object
_isSuggestionPopupVisible(Object component)
static Boolean
__isSuggestItem(HTMLElement element)
Determine if the element is a suggest item
private static Array
_parse(Object xhrResponse)
Parses the raw data after it's returned from the data service and returns the collection object
public Object
prefetch(Object component, Object searchSection)
Prefetch data for the af:searchSection component Invoked from af:searchSection peer.
private static Object
_preFilter(Object component, Object collection)
private static Object
_propagateValueAttributeDataType(Object component, Object rawCollectionData)
private static Object
_renderLoadingIndicator(Object component, Object suggestionsContainer, Object maintainDimensions)
private Object
_renderNonDefaultSearchSections(AdfUIComponent component, Object sectionResults)
Renders all the non-default search sections as per their order in the JSF component tree
private static Object
_renderNoSuggestionsMessage(Object component)
private Object
_renderSearchSections(Object component, Object options)
private Object
_renderSuggestions(AdfUIComponent component, AdfSuggestionCollection suggestions, Object shouldHighlight)
Renders the suggestions in the dropdown
private static Object
_selectNewItem(AdfUIComponent component, HTMLElement contentNode, HTMLElement suggestionsContainer, Boolean isFindNextItem)
Determines and selects a new item when Up/Down arrow key is pressed
private Object
_setComponentValue(Object component, Object newValue)
Sets the component value from the supplied selected item
private Object
_setDisplayedSuggestions(Object suggestionsArray)
protected Object
SetDisplayValue(Object component, Object domElement, Object newValues)
private Object
_setHiddenValueElementsValue(Object component, Object domElement, Object newValues, Object oldValues)
private Object
_setSelection(Object component, Object newValues)
private Object
_setTemplateAttributes(Object component)
private static Object
_showFacesMessage(Object component, Object messageType, Object summaryKey, Object detailKey)
private Object
_showSuggestionsPopup(Object component, Object isFiltering)
private static Object
_splitAndSort(Object str)
private static Object
_startsWithFilter(Object component, Object searchText, Object data)
private Object
_updateDisplayValue(Object response, Object options)
Callback from REST call to update the display value
private Object
_updateDisplayValueFailure(Object statusCode, Object response, Object options)
Callback invoked if HTTP status code is 4xx or 5xx while updating the display value
protected Object
Validate(Object component, Object submittedValue)
Attempts to autoComplete the submittedValue Override
private Object
_willBeBlurWithinComponent(Object component, Object eventTarget)
Returns true if the element losing focus is the contentNode
private static Object
_wrapSuggestions(Object collection, Object keyAttribute)


Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlInputBasePeer
CheckLength, getLastValue, HandleComponentFocus, initialize, needsFocusTargetStyleClass, NeedsSpuriousDirtyValueTracking, preventNextValueSubmission, RunValidation, setLastValue, ShouldShowHint, __simulateBlur, UpdateLastValue, VetoBlurValidation, WasSubmitted


Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
autoSubmit, BindToComponent, ComponentChanged, __componentLabelChanged, ComponentSubmittedValueChanged, disableBrowserAutoComplete, Focus, GetComponentLabel, GetComponentSubmittedValue, getContentNode, GetContentNode, GetContentNodeId, GetDisplayValue, GetLabelText, getLastSubmittedValue, getMarkDirtyFlag, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HideNoteWindow, IsInitialized, IsNoteWindowVisible, __isSpuriousDirtyValue, LazyInitialize, MessageNotify, MessageShow, __resetSpuriousDirtyValue, __restoreDisplayValue, setLastSubmittedValue, setMarkDirtyFlag, ShowNoteWindow, ShowNoteWindowMouseOver, StashOldValue, StopArrowKeyBubbling, ValidateAndStashNewValue, ValidateIfStashedOldValue, VetoShowNoteWindow


Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlValuePeer
GetBestMatchSubId, GetSubIdDomElement


Field Detail


_AUTOCOMPLETE_ANNOUNCE_MSG

private static Object _AUTOCOMPLETE_ANNOUNCE_MSG

_BUTTON_SUB_ID

private static Object _BUTTON_SUB_ID

_CONTENT_CONTAINER

private static Object _CONTENT_CONTAINER

_CONTENT_HEADER_SUB_ID

private static Object _CONTENT_HEADER_SUB_ID

_CONTENT_MODE_LIST

private static Object _CONTENT_MODE_LIST

_CONTENT_MODE_TABLE

private static Object _CONTENT_MODE_TABLE

_CONTENT_STAMP_SUB_ID

private static Object _CONTENT_STAMP_SUB_ID

_CONTENT_SUB_ID

private static Object _CONTENT_SUB_ID

_CRITERIA_CONTAINS

private static Object _CRITERIA_CONTAINS

_CRITERIA_STARTS_WITH

private static Object _CRITERIA_STARTS_WITH

_CUSTOM_NAME_EXPANDO

private static Object _CUSTOM_NAME_EXPANDO

_FOOTER_COMPONENT_PLACEHOLDER_SUB_ID

private static Object _FOOTER_COMPONENT_PLACEHOLDER_SUB_ID

_FOOTER_COMPONENT_SUB_ID

private static Object _FOOTER_COMPONENT_SUB_ID

_LABEL_NO_DATA

private static Object _LABEL_NO_DATA

_LIST_ITEMS_CONTAINER_STYLE_CLASS

private static Object _LIST_ITEMS_CONTAINER_STYLE_CLASS

_LOADING_INDICATOR_STYLE_CLASS

private static Object _LOADING_INDICATOR_STYLE_CLASS

_LOADING_INDICATOR_SUB_ID

private static Object _LOADING_INDICATOR_SUB_ID

_MSG_AUTCOMPLETE_FAILED_DETAIL

private static Object _MSG_AUTCOMPLETE_FAILED_DETAIL

_MSG_AUTOCOMPLETE_FAILED

private static Object _MSG_AUTOCOMPLETE_FAILED

_NO_SUGGESTIONS_MESSAGE_STYLE_CLASS

private static Object _NO_SUGGESTIONS_MESSAGE_STYLE_CLASS

_ROW_ITEMS_CONTAINER_STYLE_CLASS

private static Object _ROW_ITEMS_CONTAINER_STYLE_CLASS

_SEARCH_SECTION_CONTAINER_SUB_ID

private static Object _SEARCH_SECTION_CONTAINER_SUB_ID

_SEARCH_SECTION_TYPE_DEFAULT

private static Object _SEARCH_SECTION_TYPE_DEFAULT

_SELECTION_PROPERTY

private static Object _SELECTION_PROPERTY

_setTemplateAttributes

private Object _setTemplateAttributes

__SUGGEST_ITEM_SUB_ID

static Object __SUGGEST_ITEM_SUB_ID

_SUGGESTION_ITEM_MATCHING_TEXT_STYLE_CLASS

private static Object _SUGGESTION_ITEM_MATCHING_TEXT_STYLE_CLASS

_SUGGESTION_LIST_ITEM_STYLE_CLASS

private static Object _SUGGESTION_LIST_ITEM_STYLE_CLASS

_SUGGESTION_ROW_HEADER_STYLE_CLASS

private static Object _SUGGESTION_ROW_HEADER_STYLE_CLASS

_SUGGESTION_ROW_ITEM_STYLE_CLASS

private static Object _SUGGESTION_ROW_ITEM_STYLE_CLASS

_SUGGESTIONS_BODY_SUB_ID

private static Object _SUGGESTIONS_BODY_SUB_ID

_SUGGESTIONS_CONTAINER_PLACEHOLDER_SUB_ID

private static Object _SUGGESTIONS_CONTAINER_PLACEHOLDER_SUB_ID

_SUGGESTIONS_CONTAINER_SUB_ID

private static Object _SUGGESTIONS_CONTAINER_SUB_ID

_SUGGESTIONS_COUNT_MSG

private static Object _SUGGESTIONS_COUNT_MSG

_SUGGESTIONS_POPUP_SUB_ID

private static Object _SUGGESTIONS_POPUP_SUB_ID

__SUGGESTIONS_RENDERING_CHUNK_SIZE

static Object __SUGGESTIONS_RENDERING_CHUNK_SIZE

_VALUE_ATTRIBUTE_DATA_TYPE

private static Object _VALUE_ATTRIBUTE_DATA_TYPE

_VALUE_ATTRIBUTE_EXPANDO

private static Object _VALUE_ATTRIBUTE_EXPANDO

_VALUE_UPDATING_STYLE_CLASS

private static Object _VALUE_UPDATING_STYLE_CLASS

Constructor Detail


AdfDhtmlInputSearchPeer

public AdfDhtmlInputSearchPeer()

Stateful Peer for InputSearch component

Method Detail


_adjustHeightToRowCount

private Object _adjustHeightToRowCount(Object options)

Sets the height of the suggestions panel to display the first 'X' suggestion items as configured on the rowCount attribute of the component. Also initializes the scrollbar for virtual scrolling view

Parameters:
options    
Return:
Object

_appendContentHeader

private static Object _appendContentHeader(Object component,
                                           Object suggestionsDomFragment)

Parameters:
component    
suggestionsDomFragment    
Return:
Object

_appendSuggestions

private Object _appendSuggestions(Object suggestionsDomFragment,
                                  Object suggestions,
                                  Object shouldHighlight,
                                  Object startIndex,
                                  Object endIndex)

Parameters:
suggestionsDomFragment    
suggestions    
shouldHighlight    
startIndex    
endIndex    
Return:
Object

_autoComplete

private Boolean _autoComplete(Object component)

Attempt to autoComplete the input element value

Parameters:
component    
Return:
Boolean - Returns true if autoComplete succeeded, else false

_buildFilterAttributeValues

private static Object _buildFilterAttributeValues(Object filterAttributes,
                                                  Object suggestionItem)

Parameters:
filterAttributes    
suggestionItem    
Return:
Object

_buildSuggestionsAfterLookup

private static AdfSuggestionCollection _buildSuggestionsAfterLookup(Object component,
                                                                    Object searchSectionSuggestions,
                                                                    Object lookupSuggestions)

Consolidates the keys in the suggestions against the master lookup table and returns a complete list of objects to be rendered in the suggestions panel

Parameters:
component    
searchSectionSuggestions    
lookupSuggestions    
Return:
AdfSuggestionCollection - A new search model comprising of only the rows corresponding to the keys passed in as 'searchSectionSuggestions'

_cacheSuggestions

private Object _cacheSuggestions(Object data)

Parameters:
data    
Return:
Object

_clearAndDismissSuggestions

private Object _clearAndDismissSuggestions(Object component)

Parameters:
component    
Return:
Object

_clearSuggestionsContainer

private Object _clearSuggestionsContainer(Object suggestionsContainer)

Parameters:
suggestionsContainer    
Return:
Object

_clearTemporaryStorage

private Object _clearTemporaryStorage()

Return:
Object

_cloneSimpleObject

private static Object _cloneSimpleObject(Object object)

Parameters:
object    
Return:
Object

ComponentValueChanged

protected Object ComponentValueChanged(Object component,
                                       Object domElement,
                                       Object newValues,
                                       Object oldValues)

Parameters:
component    
domElement    
newValues    
oldValues    
Return:
Object

_containsFilter

private static Object _containsFilter(Object component,
                                      Object searchText,
                                      Object data)

Parameters:
component    
searchText    
data    
Return:
Object

_createHiddenValueElement

private static Object _createHiddenValueElement(Object clientId,
                                                Object contentContainer)

Parameters:
clientId    
contentContainer    
Return:
Object

_createSampleListItem

private static Object _createSampleListItem(Object isTableMode,
                                            Object listSize)

Parameters:
isTableMode    
listSize    
Return:
Object

_createSuggestionsDomFragemnt

private Object _createSuggestionsDomFragemnt(Object suggestions,
                                             Object options,
                                             Object startIndex,
                                             Object size)

Parameters:
suggestions    
options    
startIndex    
size    
Return:
Object

_defaultDisplayValueDerivation

private static Array _defaultDisplayValueDerivation(Object component,
                                                    Object suggestions,
                                                    Object newValues)

Computes the display string with value of the display attributes separated by a space.

Parameters:
component    
suggestions    
newValues    
Return:
Array - Display values

_deriveDisplayValueFromConv

private static Array _deriveDisplayValueFromConv(Object component,
                                                 Object converter,
                                                 Object newValues)

Invokes converter.getAsString on each value of the component

Parameters:
component    
converter    
newValues    
Return:
Array - Display values

_fetch

private Object _fetch(Object component,
                      Object options)

Make a REST call for the af:searchSection component of type specified

Parameters:
component    
options    
Return:
Object

_fetchAll

private Object _fetchAll(Object component)

Make a REST call for each af:searchSection component Called from init/prefetch and upon first rendering of the search suggestions popup when all the sections have to be displayed in one go.

Parameters:
component    
Return:
Object

_fetchComplete

private Object _fetchComplete(Object response,
                              Object options)

Callback invoked on successful REST fetch

Parameters:
response    
options    
Return:
Object

_fetchFailed

private Object _fetchFailed(Object statusCode,
                            Object response,
                            Object options)

Callback invoked if HTTP status code is 4xx or 5xx

Parameters:
statusCode    
response    
options    
Return:
Object

_filterSuggestions

private Object _filterSuggestions(Object component)

Parameters:
component    
Return:
Object

_filterSuggestionsCallback

private Object _filterSuggestionsCallback(Object component)

Parameters:
component    
Return:
Object

_filterSuggestionsImpl

private Object _filterSuggestionsImpl(Object component)

Parameters:
component    
Return:
Object

_getCachedSuggestions

private Object _getCachedSuggestions()

Return:
Object

GetComponentValue

protected Object GetComponentValue(Object component,
                                   Object domElement)

Reads the component value from the hidden input element

Parameters:
component    
domElement    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.GetComponentValue(Object, Object)

_getContainsFilterRegex

private static Object _getContainsFilterRegex(Object searchText)

Builds a regex from the passed in searchText to match a string which has words that contains the words present in searchText. The regex also provides a capture group to retrieve the letters preceding the matched portion of the word. This capture group is to help identify if the match is a startsWith match

Parameters:
searchText    
Return:
Object

_getContentHeaderFacet

private static Object _getContentHeaderFacet(Object component)

Parameters:
component    
Return:
Object

_getContentStampContainer

private static Object _getContentStampContainer(Object component)

Parameters:
component    
Return:
Object

getConvertedObject

public Object getConvertedObject(Object component,
                                 Object newValues)

Converts the valueAttribute value to displayAttributes value.

Parameters:
component    
newValues    
Return:
Object

getConvertedValue

public Object getConvertedValue(Object component,
                                Object submittedValue)

Parameters:
component    
submittedValue    
Return:
Object

_getCurrentSelectedItem

private static Object _getCurrentSelectedItem(Object contentNode)

Parameters:
contentNode    
Return:
Object

_getFooterComponent

private static Object _getFooterComponent(Object component)

Parameters:
component    
Return:
Object

_getHiddenValueElements

private static Object _getHiddenValueElements(Object component,
                                              Object domElement)

Fetches all the hidden submission fields of the component

Parameters:
component    
domElement    
Return:
Object

_getHighlightRegex

private static Object _getHighlightRegex(Object component)

Parameters:
component    
Return:
Object

_getHighlightTextWrapperHtml

private static Object _getHighlightTextWrapperHtml(Object component)

Parameters:
component    
Return:
Object

GetInlineEditor

protected Object GetInlineEditor(Event event)

Override to return an inline editor that edits the inputSearch's label property

Parameters:
event  -  DOM Event that triggered the inline edit
Return:
Object

_getListItemContent

private static String _getListItemContent(Object data,
                                          Object matchRegex,
                                          Object replaceStr,
                                          Object template,
                                          Object templateAttributes)

Returns the client template based suggestion content for the suggestion data passed.

Parameters:
data    
matchRegex    
replaceStr    
template    
templateAttributes    
Return:
String - Mustache evaluated client template with the matching portion of the text wrapped in a span.

_getNextSuggestion

private static Object _getNextSuggestion(Object component,
                                         Object isFindNextItem,
                                         Object currentItem)

Parameters:
component    
isFindNextItem    
currentItem    
Return:
Object

GetNullDefault

protected Object GetNullDefault()

Return:
Object

getSearchSections

public Object getSearchSections(Object component)

Returns all the SearchSections that belong to the InputSearch component. This method is invoked from the component

Parameters:
component    
Return:
Object - An object with searchSection type as key and the searchSection object as value

_getStartsWithFilterRegex

private static Object _getStartsWithFilterRegex(Object searchText)

Builds a regex from the passed in searchText to match a string which has words that start-with words present in searchText

Parameters:
searchText    
Return:
Object

GetSubmittedValue

protected Object GetSubmittedValue(Object component,
                                   Object domElement)

Returns the submittedValue by getting the value of the input dom node.

Parameters:
component    
domElement    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.GetSubmittedValue(Object, Object)

_getSuggestionElement

private static Object _getSuggestionElement(Object element,
                                            Object clientId)

Finds the closest ancestor element that is a suggestion item.

Parameters:
element    
clientId    
Return:
Object

getSuggestions

public Array getSuggestions()

Returns the currently displayed suggestions This method is invoked from the component

Return:
Array - Array of row objects. The row object will have the structure below
  • data: The raw row data
  • index: The index for the row
  • key: The key value for the row

_getSuggestionsBody

private static Object _getSuggestionsBody(Object component)

Parameters:
component    
Return:
Object

_getSuggestionsContainer

private static Object _getSuggestionsContainer(Object component)

Parameters:
component    
Return:
Object

_getSuggestionsPopup

private static Object _getSuggestionsPopup(Object component)

Parameters:
component    
Return:
Object

_getSuggestionsPopupHints

private Object _getSuggestionsPopupHints(Object component)

Parameters:
component    
Return:
Object

_getTemplateAttributes

private Object _getTemplateAttributes()

Return:
Object

HandleComponentBlur

protected Object HandleComponentBlur(Object componentEvent)

Parameters:
componentEvent    
Return:
Object
Overrides:
AdfDhtmlInputBasePeer.HandleComponentBlur(Object)

HandleComponentClick

protected Object HandleComponentClick(Object componentEvent)

Parameters:
componentEvent    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.HandleComponentClick(Object)

HandleComponentKeyDown

protected Object HandleComponentKeyDown(Object componentEvent)

Parameters:
componentEvent    
Return:
Object

HandleComponentKeyUp

protected Object HandleComponentKeyUp(Object componentEvent)

Parameters:
componentEvent    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.HandleComponentKeyUp(Object)

HandleComponentMouseDown

protected Object HandleComponentMouseDown(Object componentEvent)

Parameters:
componentEvent    
Return:
Object

_handleEnterKey

private Object _handleEnterKey(Object component,
                               Object contentNode)

Parameters:
component    
contentNode    
Return:
Object

_handleSuggestionsFromContentNode

private Object _handleSuggestionsFromContentNode(Object keyDownEvent,
                                                 Object contentNode)

Parameters:
keyDownEvent    
contentNode    
Return:
Object

_handleSuggestionsPopupClosed

private Object _handleSuggestionsPopupClosed(Object component)

Parameters:
component    
Return:
Object

_handleSuggestionsPopupOpening

private Object _handleSuggestionsPopupOpening(Object component)

Parameters:
component    
Return:
Object

_hasValueChanged

private Object _hasValueChanged(Object contentNodeValue)

Parameters:
contentNodeValue    
Return:
Object

_hideSuggestionPopup

private Object _hideSuggestionPopup(Object component)

Parameters:
component    
Return:
Object

InitDomElement

protected Object InitDomElement(Object component,
                                Object element)

Pre-fetch the data from searchSections

Parameters:
component    
element    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.InitDomElement(Object, Object)

InitSubclass

protected static Object InitSubclass()

Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.InitSubclass()

_initSuggestionsContainer

private static Object _initSuggestionsContainer(Object component,
                                                Object suggestionsContainer)

Parameters:
component    
suggestionsContainer    
Return:
Object

_isSuggestionPopupVisible

private Object _isSuggestionPopupVisible(Object component)

Parameters:
component    
Return:
Object

__isSuggestItem

static Boolean __isSuggestItem(HTMLElement element)

Determine if the element is a suggest item

Parameters:
element  -  The element to check
Return:
Boolean - true if element is a suggest item, false otherwise

_parse

private static Array _parse(Object xhrResponse)

Parses the raw data after it's returned from the data service and returns the collection object

Parameters:
xhrResponse    
Return:
Array - The collection object

prefetch

public Object prefetch(Object component,
                       Object searchSection)

Prefetch data for the af:searchSection component Invoked from af:searchSection peer.

Parameters:
component    
searchSection    
Return:
Object

_preFilter

private static Object _preFilter(Object component,
                                 Object collection)

Parameters:
component    
collection    
Return:
Object

_propagateValueAttributeDataType

private static Object _propagateValueAttributeDataType(Object component,
                                                       Object rawCollectionData)

Parameters:
component    
rawCollectionData    
Return:
Object

_renderLoadingIndicator

private static Object _renderLoadingIndicator(Object component,
                                              Object suggestionsContainer,
                                              Object maintainDimensions)

Parameters:
component    
suggestionsContainer    
maintainDimensions    
Return:
Object

_renderNonDefaultSearchSections

private Object _renderNonDefaultSearchSections(AdfUIComponent component,
                                               Object sectionResults)

Renders all the non-default search sections as per their order in the JSF component tree

Parameters:
component    
sectionResults  -  All the suggest items from all non-default SearchSections
Return:
Object

_renderNoSuggestionsMessage

private static Object _renderNoSuggestionsMessage(Object component)

Parameters:
component    
Return:
Object

_renderSearchSections

private Object _renderSearchSections(Object component,
                                     Object options)

Parameters:
component    
options    
Return:
Object

_renderSuggestions

private Object _renderSuggestions(AdfUIComponent component,
                                  AdfSuggestionCollection suggestions,
                                  Object shouldHighlight)

Renders the suggestions in the dropdown

Parameters:
component  -  instance
suggestions    
shouldHighlight    
Return:
Object

_selectNewItem

private static Object _selectNewItem(AdfUIComponent component,
                                     HTMLElement contentNode,
                                     HTMLElement suggestionsContainer,
                                     Boolean isFindNextItem)

Determines and selects a new item when Up/Down arrow key is pressed

Parameters:
component  -  The inputSearch component
contentNode  -  The editable input field
suggestionsContainer  -  The container of suggestion items
isFindNextItem  -  If true, next item is to be selected. Else, previous item is to be selected
Return:
Object

_setComponentValue

private Object _setComponentValue(Object component,
                                  Object newValue)

Sets the component value from the supplied selected item

Parameters:
component    
newValue    
Return:
Object

_setDisplayedSuggestions

private Object _setDisplayedSuggestions(Object suggestionsArray)

Parameters:
suggestionsArray    
Return:
Object

SetDisplayValue

protected Object SetDisplayValue(Object component,
                                 Object domElement,
                                 Object newValues)

Parameters:
component    
domElement    
newValues    
Return:
Object

_setHiddenValueElementsValue

private Object _setHiddenValueElementsValue(Object component,
                                            Object domElement,
                                            Object newValues,
                                            Object oldValues)

Parameters:
component    
domElement    
newValues    
oldValues    
Return:
Object

_setSelection

private Object _setSelection(Object component,
                             Object newValues)

Parameters:
component    
newValues    
Return:
Object

_setTemplateAttributes

private Object _setTemplateAttributes(Object component)

Parameters:
component    
Return:
Object

_showFacesMessage

private static Object _showFacesMessage(Object component,
                                        Object messageType,
                                        Object summaryKey,
                                        Object detailKey)

Parameters:
component    
messageType    
summaryKey    
detailKey    
Return:
Object

_showSuggestionsPopup

private Object _showSuggestionsPopup(Object component,
                                     Object isFiltering)

Parameters:
component    
isFiltering    
Return:
Object

_splitAndSort

private static Object _splitAndSort(Object str)

Parameters:
str    
Return:
Object

_startsWithFilter

private static Object _startsWithFilter(Object component,
                                        Object searchText,
                                        Object data)

Parameters:
component    
searchText    
data    
Return:
Object

_updateDisplayValue

private Object _updateDisplayValue(Object response,
                                   Object options)

Callback from REST call to update the display value

Parameters:
response    
options    
Return:
Object

_updateDisplayValueFailure

private Object _updateDisplayValueFailure(Object statusCode,
                                          Object response,
                                          Object options)

Callback invoked if HTTP status code is 4xx or 5xx while updating the display value

Parameters:
statusCode    
response    
options    
Return:
Object

Validate

protected Object Validate(Object component,
                          Object submittedValue)

Attempts to autoComplete the submittedValue Override

Parameters:
component    
submittedValue    
Return:
Object
Overrides:
AdfDhtmlEditableValuePeer.Validate(Object, Object)

_willBeBlurWithinComponent

private Object _willBeBlurWithinComponent(Object component,
                                          Object eventTarget)

Returns true if the element losing focus is the contentNode

Parameters:
component    
eventTarget    
Return:
Object

_wrapSuggestions

private static Object _wrapSuggestions(Object collection,
                                       Object keyAttribute)

Parameters:
collection    
keyAttribute    
Return:
Object
SUMMARY: FIELD | CONSTR | METHOD    DETAIL: FIELD | CONSTR | METHOD

 Overview   Package   Class   Tree   Deprecated   Index   Help 
Oracle Fusion Middleware Javascript API Reference for Oracle ADF Faces
12c (12.2.1.3)
E80085-01
 PREV   NEXT  FRAMES    NO FRAMES    Warning: private items are visible  
Generated on 2017.04.19 06:37 UTC
Copyright (c) 1998, 2015, Oracle and/or its affiliates. All rights reserved.