# JavaScript 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.4.0) E81451-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.subids
Class AdfDhtmlQueryPeer

## Warning:

- This is an unsupported, internal implementation class.
- Use an API class that might provide equivalent functionality instead.
- This class will change without notice.
- It is not recommended that you use anything in this class.

    org.ecmascript.object.Object
       |
       +--oracle.adfinternal.view.js.laf.dhtml.rich.subids.AdfDhtmlQueryPeer

    public class AdfDhtmlQueryPeer
    extends Object

query component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [search_button] - search button (mapped programmatically) 2. [reset_button] - reset button (mapped programmatically) 3. [save_button] - save button (mapped programmatically) 4. [mode_button] - mode button (mapped programmatically) 5. [saved_search --> saveSrch] - Saved Search dropdown 6. [disclosure_icon --> _afrDscl] - Disclosure icon 7. [search_header --> _afrTtxt] - Search header 8. [addFields_button --> adFlds] - addFields button 9. [match_type --> conj] - Match type 10. [deleteCriterion[(value)] --> delCrtn. For example value=1. Here the digit refers to criterion index.] - deleteCriterion (by rendered suffix e.g. deleteCriterion[0] --> deleteCriterion0) 11. [criterion_operator[(value)] --> oper. For example value=1. Here the digit refers to criterion index.] - operator (by rendered suffix e.g. criterion_operator[0] --> operator0) 12. [criterion_value[(value)] --> val. For example value=20. Here the first digit refers to criterion index and second digit is the index of the value field of that criterion. As in case "Between" operator there are two value fields having "value" such as 20 and 21.] - value (by rendered suffix e.g. criterion_value[20] --> value20). Here the first digit refers to criterion no. and second digit is the value no. for that criterion. 13. [saveSearch_popup --> SSPop] - Create Save Search Popup 14. [saveSearch_name --> SS_name] - Create Save Search Name field 15. [saveSearch_dialog --> SSD] - Create Save Search Dialog 16. [personalizeSearch_popup --> PSSPop] - Personalize Saved Search Popup 17. [personalizeSearch_searches --> PSS_Srchs] - Personalize Saved Searches Dropdown list 18. [personalizeSearch_dialog --> PSSD] - Personalize Saved Searches Dialog 19. [personalizeSearch_delete --> delete] - Personalize Saved Searches Delete Button 20. [personalizeSearch_duplicate --> duplicate] - Personalize Saved Searches Duplicate Button 21. [personalizeSearch_apply --> apply] - Personalize Saved Searches Apply Button 22. [personalizeSearch_Name --> PSS_name] - Personalize Saved Searches Name field 23. [deleteWarning_popup --> DWPop] - Personalize Saved Searches Delete Warning Popup 24. [deleteWarning_dialog --> DWD] - Personalize Saved Searches Delete Warning Dialog 25. [overrideWarning_popup --> OWPop] - Create Saved Searches Override Warning Popup 26. [overrideWarning_dialog --> OWD] - Create Saved Searches Override Warning Dialog 27. [overrideError_popup --> OEPop] - Create Saved Searches Override Error Popup 28. [overrideError_dialog --> OED] - Create Saved Searches Override Error Dialog 29. [criterion_label[(value)] --> crtnLab] - For example: criterion_label[0] is subId for first criterion label. Here the "value" refers to criterion index. 30. [addFields['menu Item label'] --> fldItemx] - For example: addFields['Hire Date'] for menu item with label "Hire Date" which is not inside any menu/UICategory. 31. [addFields['menu label'] --> adFldGrpMenu] - For example: addFields['Confidential'] for menu with label Confidential. 32. [addFields['menu label']['menu item label'] --> fldItemx] - For example: addFields['Confidential']['salary of employee'] for menu item salary inside menu confidential. 33. [addFields['menu label'][ALL_FIELDS] --> adFldGrpAddAllItem] - For example: addFields['Confidential'][ALL_FIELDS] for All Fields menu item inside menu with label Confidential. 34. [saveSearchSetAsDefault --> SS_def] - Create Save search dialog Set As Default Checkbox 35. [saveSearchAutoExecute --> SS_autoEx] - Create Save search dialog run automatically Checkbox 36. [saveSearchSaveLayout--> SS_SL] - Create Save search dialog save result layout Checkbox 37. [personalizeSearchSetAsDefault --> PSS_def] - Personalize Saved Searches set as default Checkbox 38. [personalizeSearchAutoExecute --> PSS_autoEx] - Personalize Saved Searches run automatically Checkbox 39. [personalizeSearchShowInList --> PSS_SiL] - Personalize Saved Searches Show in List Checkbox 40. [deleteWarningMessage --> DWDMsg] - Personalize Saved Searches Delete Warning Dialog - message subid 41. [overrideWarningMessage --> OWDMsg] - Create Saved Searches Override Warning Dialog - message subid 42. [reorderButton --> reorder] - Reorder button which opens the reorder Dialog -(mapped programmatically) 43. [reorderPopup --> REPop] - Reorder Popup 44. [reorderDialog --> REDlg] - Reorder Dialog 45. [reorderTree[(index)] --> RETree] - Reorder Tree - Rich tree component For ex: reorderTree[1] for node at index '1' of the tree 46. [reorderMoveTopButton --> move-top] - Reorder Dialog - Move to the start button 47. [reorderMoveUpButton --> move-up] - Reorder Dialog - Move up button 48. [reorderMoveDownButton --> move-down] - Reorder Dialog - Move down button 49. [reorderMoveBottomButton --> move-bottom] - Reorder Dialog - Move to the end button {External indexing example --> Internal indexing example} 1) getAttribute("rich=testTemplate:testQuery#criterion_operator[0]

## Field Summary
`private static Object` | `_ADD_FIELDS_MENU_SEPARATOR`
`private static Object` | `_ADDFIELDS_BUTTON_ID`
`private static Object` | `_ADDFIELDS_GROUP_MENU_ADDALL_ITEM_SUBID`
`private static Object` | `_ADDFIELDS_GROUP_MENU_ID`
`private static Object` | `_ADDFIELDS_MENU_ID`
`private static Object` | `_APPLY_BUTTON_SUBID`
`private static Object` | `_BUSY`
`private static Object` | `_BUTTON_ID_MAP` Map of button ids, which are used differently for new vs.
`public static Object` | `CONTENT_SUBID`
`private static Object` | `_DELETE_BUTTON_SUBID`
`private static Object` | `_DISCLOSE_SUBID`
`private static Object` | `_DUPLICATE_BUTTON_SUBID`
`private static Object` | `_INDEXED_FIELD`
`private static Object` | `_MODE_BUTTON_SUBID`
`private static Object` | `_MSG_SAVED_SEARCH_DELETE_WARNING`
`private static Object` | `_MSG_SAVED_SEARCH_OVERRIDE_ERROR`
`private static Object` | `_MSG_SAVED_SEARCH_OVERRIDE_WARNING`
`private static Object` | `_NAMING_SEP`
`private static Object` | `_OLD_INTERNAL_SUBID_MAP` Map of old clientIds (subids) Vs the new one.
`private static Object` | `_OVERRIDE_ERROR_DLG_SUBID`
`private static Object` | `_OVERRIDE_ERROR_MSG_SUBID`
`private static Object` | `_OVERRIDE_ERROR_POPUP_SUBID`
`private static Object` | `_OVERRIDE_WARNING_DLG_SUBID`
`private static Object` | `_OVERRIDE_WARNING_MSG_SUBID`
`private static Object` | `_OVERRIDE_WARNING_POPUP_SUBID`
`private static Object` | `_PERSONALIZE_SSEARCH_KEY`
`private static Object` | `_PSS_POPUP_VISIBLE_STATUS`
`private static Object` | `_PSSDLG_ID`
`private static Object` | `_REORDER_BUTTON_MOVE_BOTTOM`
`private static Object` | `_REORDER_BUTTON_MOVE_BOTTOM_SUBID`
`private static Object` | `_REORDER_BUTTON_MOVE_DOWN`
`private static Object` | `_REORDER_BUTTON_MOVE_DOWN_SUBID`
`private static Object` | `_REORDER_BUTTON_MOVE_TOP`
`private static Object` | `_REORDER_BUTTON_MOVE_TOP_SUBID`
`private static Object` | `_REORDER_BUTTON_MOVE_UP`
`private static Object` | `_REORDER_BUTTON_MOVE_UP_SUBID`
`private static Object` | `_REORDER_BUTTON_SUBID`
`private static Object` | `_REORDER_DIALOG_SUBIID`
`private static Object` | `_REORDER_PANEL_GROUP_SUBID`
`private static Object` | `_REORDER_POPUP_SUBID`
`private static Object` | `_REORDER_SHOW_DETAIL_SUBID`
`private static Object` | `_REORDER_TREE_NDSTAMP_ID`
`private static Object` | `_REORDER_TREE_SUBID`
`private static Object` | `_RESET_BUTTON_SUBID`
`private static Object` | `_SAVE_BUTTON_SUBID`
`private static Object` | `_SEARCH_BUTTON_SUBID`
`private static Object` | `_SEPARATOR_KEY`
`private static Object` | `_skinVisibileItems`
`private static Object` | `_SSDLG_ID`
`private static Object` | `_SUB_ID_MAP_UNIFIED_BUTTON_DIALOG` query component publishes the following sub ids.
`private static Object` | `_UIHINT_AUTOEXECUTE`
`private static Object` | `_UIHINT_DEFAULT`
`private static Object` | `_UIHINT_NAME`
`private static Object` | `_UIHINT_SAVE_RESULTS_LAYOUT`
`private static Object` | `_UIHINT_SHOW_IN_LIST`
`private static Object` | `_usesUnifiedButtonsInDialog`

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

## Constructor Summary
`public` | `AdfDhtmlQueryPeer()` query component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.

## Method Summary
`private Object` | `_checkDefaultSavedSearchHidden(Object component, Object clientId)` checks set default is set and show in list is not set and throws an error.
`private Object` | `_clearPageProperty(Object propertyKey)` Pushes propertyKey -> propertyValue into the page state map
`protected Object` | `ComponentDisclosedChanged(Object component, Object domElement, Object newValue, Object oldValue)`
`private Object` | `_evaluateAddFieldsExpandoScript()`
`private Object` | `_getAddFieldsSubIdDomElement(Object subElementId, Object component, Object addFieldsIndex)`
`private Object` | `_getAddFieldsSubIdFromPrunedClientId(Object prunedClientId)`
`protected Object` | `GetBestMatchSubId(Object domElement)` Returns the best match subId for the given domElement.
`private Object` | `_getContentDomElement()`
`private Object` | `_getCreateOrUpdateValue(Object component, Object dlgId)` Creates a Map of return values that reflects the selecions/changes made to the content in the Saved Search dialogs.
`protected String` | `GetDomElementSubId(Object subIdElement)` Returns the subId for a given dom element for query.
`private Object` | `_getNestedSubIdIndexForProgSubId(Object clientId, Object subIdFragment)`
`private Object` | `_getPageProperty(Object propertyKey)` Retreives value for 'propertyKey' stored on the page state map by 'component'
`private Object` | `_getPopupComponent(Object clientId, Object isPersonalize)` Returns the popup component for the personalize popup if isPersonalize is true, else the component for the create popup.
`private Object` | `_getQueryButtonId(Object buttonId)` Get the id for the query button
`public static Object` | `getSavedSearchNames()` Returns the stored saved search names by concatenating user search names and system search names otherwise a blank array.
`private Object` | `_getSearchNameInCSSDialog(Object component)` Returns the value of the saved search name in Create Save Search Dialog
`private Object` | `_getSelectedSearchName(Object component, Object isPersonalize)` Returns the value of the saved search that is currently selected, either in the Personalize Saved Search dialog or in the search panel.
`private Object` | `_getSSNameComponent(Object clientId, Object isPsz)` Helper function that returns the Saved search name component in either dialog.
`protected HTMLElement` | `GetSubIdDomElement(String subElementIdLocator)` Returns the dom element for a given subElementId for query.
`private Object` | `_getSubIdFromPrunedClientId(Object clientId)`
`public static Object` | `getSystemSavedSearchNames()` Returns the stored system saved search names.
`public static Object` | `getUserSavedSearchNames()` Returns the stored saved search names.
`private Object` | `_getWarningPopupComponent(Object isDeletePopup, Object isWarningPopup)` Returns the delete/override warning(error) popup component.
`private Object` | `_handleCheckboxClick(Object componentEvent, Object checkboxId)` Handles checkbox selections in both the dialogs.
`private Object` | `_handleClickOnReorderButtons(Object componentEvent, Object buttonClicked)`
`Object` | `__handleClientSideDisclosure(Boolean disclosed)` Client side optimized disclosure function
`protected Object` | `HandleComponentAction(Object componentEvent)` Action Event handler for the Apply button in PSS dialog.
`protected Object` | `HandleComponentClick(Object componentEvent)` Handler for the component mouse click events.
`private Object` | `_handleComponentClickInDialog(Object componentEvent)` Handles component click events generated from components within the dialog.
`protected Object` | `HandleComponentDialog(Object componentEvent)` Takes the appropriate action when the dialog buttons OK and Cancel are clicked in the Saved Search dialogs or YES/NO are clicked in the delete/override warning(error) dialog.
`protected Object` | `HandleComponentDisclosure(Object componentEvent)`
`protected Object` | `HandleComponentKeyDown(Object componentEvent)` When query component is used inside a dialog and the Enter key pressed, keydown event is not bubbles up to the dialog potentially causing it to close, especially if the dialog has an OK outcome.
`protected Object` | `HandleComponentKeyPress(Object componentEvent)` When query component is used inside a dialog and the Enter key pressed, keydown event is not bubbles up to the dialog potentially causing it to close, especially if the dialog has an OK outcome.
`protected Object` | `HandleComponentKeyUp(Object componentEvent)` The query component has a built-in notion of a defaultCommand that should execute a search when user hits the Enter key.
`private Object` | `_handleComponentOperation(Object componentEvent)`
`protected Object` | `HandleComponentPopupOpening(Object componentEvent)` Handler for the popup opening event, modified the hints for the popup as needed
`protected Object` | `HandleComponentValueChange(Object componentEvent)` Handles any value change event that happens within the query component.
`private Object` | `_handleConjunctionSelection(Object query, Object componentEvent)` Queues a QueryInternalEvent when a conjunction is selected.
`protected Object` | `HidePopupDialog(Object clientId, Object isPersonalize)` Hides the popup dialog when OK or Cancel is pressed on either dialog.
`protected Object` | `Init(Object component)`
`protected Object` | `InitDomElement(AdfUIComponent component, Object domElement)` Initialize the associated domElement when the peer is created.
`public Object` | `initialize(Object component)`
`protected static Object` | `InitSubclass()` Initializes variables and adds component event handlers.
`private Object` | `_isCheckboxClicked(Object componentEvent, Object rootId, Object sourceClientId)` Determines if the checkbox was clicked.
`private Object` | `_isClickInClientComponent(Object node, Object id)` Checks to see if the clientId of the component with "id" is indeed the component that this event originated from.
`private Object` | `_isClickInReorderDialogButtons(Object componentEvent)`
`private Object` | `_isClickInSubComponent(Object elem, Object subId)` Checks to see if the clientId of the component with "subid" matches the id of the component this event originated from.
`private Boolean` | `_isEnterKeyNotConsumed(Object componentEvent)` Return true if Enter key is pressed on a component that does not consume it else return false.
`private Object` | `_isEventTargetInChoiceComponent(Object componentEvent)` Returns true if the event source is one of the select subcomponent in Query.
`private Object` | `_isHeaderless(ADfUIComponent component)` Checks if the query component is rendered in a headerless manner.
`private Object` | `_passSavedSearchNameCheck(Object component, Object isPsz)` Validates the entered name by performing the following checks 1.
`private Object` | `_passSystemSearchNameCheck(Object queryName)` Validates the entered name by searching it in System Searches
`private Object` | `_populateSubIdMap()` query component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1.
`protected Object` | `PopupClosed(Object component, Object contentDom)` Callback method called when the popup is closed.
`private Object` | `_queueQueryEvent(Object component)`
`private Object` | `_queueResultComponentEvent(Object component)`
`protected Object` | `ResizeNotify(Object oldWidth, Object oldHeight, Object newWidth, Object newHeight)` Resize notification callback - we perform geometry management here
`private HTMLElement` | `_returnButtonElement(String buttonId)` Convenience method to handle both new af:buttons and old af:commandButtons.
`private Object` | `_setAddFieldsVisibleItems(Object component)` This is used to set the no.
`protected Object` | `SetBusy(Object isBusy)`
`private Object` | `_setComponentError(Object component, Object summaryKey, Object detailKey, Object trResourceKey)` Adds the error message to the component if the component passed in is valid, otherwise it displays a page level error.
`private Object` | `_setPageProperty(Object propertyKey, Object propertyValue)` Pushes propertyKey -> propertyValue into the page state map
`public static Object` | `setSystemSavedSearchNames(Object names)` This method is used to store the user saved search names.
`public static Object` | `setUserSavedSearchNames(Object names)` This method is used to store the user saved search names.
`private Object` | `_showWarningPopup(Object isDeletePopup, Object isWarningPopup)` Shows the delete/override warning(error) dialog popup.
`private Object` | `_stripStartingColons(Object prunedClientId)`
`public Boolean` | `validateCriterionFields()` Internal framework use only.

## Field Detail

### _ADD_FIELDS_MENU_SEPARATOR

`private static Object _ADD_FIELDS_MENU_SEPARATOR`

### _ADDFIELDS_BUTTON_ID

`private static Object _ADDFIELDS_BUTTON_ID`

### _ADDFIELDS_GROUP_MENU_ADDALL_ITEM_SUBID

`private static Object _ADDFIELDS_GROUP_MENU_ADDALL_ITEM_SUBID`

### _ADDFIELDS_GROUP_MENU_ID

`private static Object _ADDFIELDS_GROUP_MENU_ID`

### _ADDFIELDS_MENU_ID

`private static Object _ADDFIELDS_MENU_ID`

### _APPLY_BUTTON_SUBID

`private static Object _APPLY_BUTTON_SUBID`

### _BUSY

`private static Object _BUSY`

### _BUTTON_ID_MAP

`private static Object _BUTTON_ID_MAP`
  Map of button ids, which are used differently for new vs. old button impl.

### CONTENT_SUBID

`public static Object CONTENT_SUBID`

### _DELETE_BUTTON_SUBID

`private static Object _DELETE_BUTTON_SUBID`

### _DISCLOSE_SUBID

`private static Object _DISCLOSE_SUBID`

### _DUPLICATE_BUTTON_SUBID

`private static Object _DUPLICATE_BUTTON_SUBID`

### _INDEXED_FIELD

`private static Object _INDEXED_FIELD`

### _MODE_BUTTON_SUBID

`private static Object _MODE_BUTTON_SUBID`

### _MSG_SAVED_SEARCH_DELETE_WARNING

`private static Object _MSG_SAVED_SEARCH_DELETE_WARNING`

### _MSG_SAVED_SEARCH_OVERRIDE_ERROR

`private static Object _MSG_SAVED_SEARCH_OVERRIDE_ERROR`

### _MSG_SAVED_SEARCH_OVERRIDE_WARNING

`private static Object _MSG_SAVED_SEARCH_OVERRIDE_WARNING`

### _NAMING_SEP

`private static Object _NAMING_SEP`

### _OLD_INTERNAL_SUBID_MAP

`private static Object _OLD_INTERNAL_SUBID_MAP`
  Map of old clientIds (subids) Vs the new one.

### _OVERRIDE_ERROR_DLG_SUBID

`private static Object _OVERRIDE_ERROR_DLG_SUBID`

### _OVERRIDE_ERROR_MSG_SUBID

`private static Object _OVERRIDE_ERROR_MSG_SUBID`

### _OVERRIDE_ERROR_POPUP_SUBID

`private static Object _OVERRIDE_ERROR_POPUP_SUBID`

### _OVERRIDE_WARNING_DLG_SUBID

`private static Object _OVERRIDE_WARNING_DLG_SUBID`

### _OVERRIDE_WARNING_MSG_SUBID

`private static Object _OVERRIDE_WARNING_MSG_SUBID`

### _OVERRIDE_WARNING_POPUP_SUBID

`private static Object _OVERRIDE_WARNING_POPUP_SUBID`

### _PERSONALIZE_SSEARCH_KEY

`private static Object _PERSONALIZE_SSEARCH_KEY`

### _PSS_POPUP_VISIBLE_STATUS

`private static Object _PSS_POPUP_VISIBLE_STATUS`

### _PSSDLG_ID

`private static Object _PSSDLG_ID`

### _REORDER_BUTTON_MOVE_BOTTOM

`private static Object _REORDER_BUTTON_MOVE_BOTTOM`

### _REORDER_BUTTON_MOVE_BOTTOM_SUBID

`private static Object _REORDER_BUTTON_MOVE_BOTTOM_SUBID`

### _REORDER_BUTTON_MOVE_DOWN

`private static Object _REORDER_BUTTON_MOVE_DOWN`

### _REORDER_BUTTON_MOVE_DOWN_SUBID

`private static Object _REORDER_BUTTON_MOVE_DOWN_SUBID`

### _REORDER_BUTTON_MOVE_TOP

`private static Object _REORDER_BUTTON_MOVE_TOP`

### _REORDER_BUTTON_MOVE_TOP_SUBID

`private static Object _REORDER_BUTTON_MOVE_TOP_SUBID`

### _REORDER_BUTTON_MOVE_UP

`private static Object _REORDER_BUTTON_MOVE_UP`

### _REORDER_BUTTON_MOVE_UP_SUBID

`private static Object _REORDER_BUTTON_MOVE_UP_SUBID`

### _REORDER_BUTTON_SUBID

`private static Object _REORDER_BUTTON_SUBID`

### _REORDER_DIALOG_SUBIID

`private static Object _REORDER_DIALOG_SUBIID`

### _REORDER_PANEL_GROUP_SUBID

`private static Object _REORDER_PANEL_GROUP_SUBID`

### _REORDER_POPUP_SUBID

`private static Object _REORDER_POPUP_SUBID`

### _REORDER_SHOW_DETAIL_SUBID

`private static Object _REORDER_SHOW_DETAIL_SUBID`

### _REORDER_TREE_NDSTAMP_ID

`private static Object _REORDER_TREE_NDSTAMP_ID`

### _REORDER_TREE_SUBID

`private static Object _REORDER_TREE_SUBID`

### _RESET_BUTTON_SUBID

`private static Object _RESET_BUTTON_SUBID`

### _SAVE_BUTTON_SUBID

`private static Object _SAVE_BUTTON_SUBID`

### _SEARCH_BUTTON_SUBID

`private static Object _SEARCH_BUTTON_SUBID`

### _SEPARATOR_KEY

`private static Object _SEPARATOR_KEY`

### _skinVisibileItems

`private static Object _skinVisibileItems`

### _SSDLG_ID

`private static Object _SSDLG_ID`

### _SUB_ID_MAP_UNIFIED_BUTTON_DIALOG

`private static Object _SUB_ID_MAP_UNIFIED_BUTTON_DIALOG`
  query component publishes the following sub ids. This map is used when unified buttons are used in the dialogs across the application [External Subid --> Internal Client SubId]:- 1. [saveSearch_dialog] - search button (mapped programmatically) 2. [personalizeSearch_dialog] - reset button (mapped programmatically)

### _UIHINT_AUTOEXECUTE

`private static Object _UIHINT_AUTOEXECUTE`

### _UIHINT_DEFAULT

`private static Object _UIHINT_DEFAULT`

### _UIHINT_NAME

`private static Object _UIHINT_NAME`

### _UIHINT_SAVE_RESULTS_LAYOUT

`private static Object _UIHINT_SAVE_RESULTS_LAYOUT`

### _UIHINT_SHOW_IN_LIST

`private static Object _UIHINT_SHOW_IN_LIST`

### _usesUnifiedButtonsInDialog

`private static Object _usesUnifiedButtonsInDialog`

## Constructor Detail

### AdfDhtmlQueryPeer

`public AdfDhtmlQueryPeer()`
  query component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [search_button] - search button (mapped programmatically) 2. [reset_button] - reset button (mapped programmatically) 3. [save_button] - save button (mapped programmatically) 4. [mode_button] - mode button (mapped programmatically) 5. [saved_search --> saveSrch] - Saved Search dropdown 6. [disclosure_icon --> _afrDscl] - Disclosure icon 7. [search_header --> _afrTtxt] - Search header 8. [addFields_button --> adFlds] - addFields button 9. [match_type --> conj] - Match type 10. [deleteCriterion[(value)] --> delCrtn. For example value=1. Here the digit refers to criterion index.] - deleteCriterion (by rendered suffix e.g. deleteCriterion[0] --> deleteCriterion0) 11. [criterion_operator[(value)] --> oper. For example value=1. Here the digit refers to criterion index.] - operator (by rendered suffix e.g. criterion_operator[0] --> operator0) 12. [criterion_value[(value)] --> val. For example value=20. Here the first digit refers to criterion index and second digit is the index of the value field of that criterion. As in case "Between" operator there are two value fields having "value" such as 20 and 21.] - value (by rendered suffix e.g. criterion_value[20] --> value20). Here the first digit refers to criterion no. and second digit is the value no. for that criterion. 13. [saveSearch_popup --> SSPop] - Create Save Search Popup 14. [saveSearch_name --> SS_name] - Create Save Search Name field 15. [saveSearch_dialog --> SSD] - Create Save Search Dialog 16. [personalizeSearch_popup --> PSSPop] - Personalize Saved Search Popup 17. [personalizeSearch_searches --> PSS_Srchs] - Personalize Saved Searches Dropdown list 18. [personalizeSearch_dialog --> PSSD] - Personalize Saved Searches Dialog 19. [personalizeSearch_delete --> delete] - Personalize Saved Searches Delete Button 20. [personalizeSearch_duplicate --> duplicate] - Personalize Saved Searches Duplicate Button 21. [personalizeSearch_apply --> apply] - Personalize Saved Searches Apply Button 22. [personalizeSearch_Name --> PSS_name] - Personalize Saved Searches Name field 23. [deleteWarning_popup --> DWPop] - Personalize Saved Searches Delete Warning Popup 24. [deleteWarning_dialog --> DWD] - Personalize Saved Searches Delete Warning Dialog 25. [overrideWarning_popup --> OWPop] - Create Saved Searches Override Warning Popup 26. [overrideWarning_dialog --> OWD] - Create Saved Searches Override Warning Dialog 27. [overrideError_popup --> OEPop] - Create Saved Searches Override Error Popup 28. [overrideError_dialog --> OED] - Create Saved Searches Override Error Dialog 29. [criterion_label[(value)] --> crtnLab] - For example: criterion_label[0] is subId for first criterion label. Here the "value" refers to criterion index. 30. [addFields['menu Item label'] --> fldItemx] - For example: addFields['Hire Date'] for menu item with label "Hire Date" which is not inside any menu/UICategory. 31. [addFields['menu label'] --> adFldGrpMenu] - For example: addFields['Confidential'] for menu with label Confidential. 32. [addFields['menu label']['menu item label'] --> fldItemx] - For example: addFields['Confidential']['salary of employee'] for menu item salary inside menu confidential. 33. [addFields['menu label'][ALL_FIELDS] --> adFldGrpAddAllItem] - For example: addFields['Confidential'][ALL_FIELDS] for All Fields menu item inside menu with label Confidential. 34. [saveSearchSetAsDefault --> SS_def] - Create Save search dialog Set As Default Checkbox 35. [saveSearchAutoExecute --> SS_autoEx] - Create Save search dialog run automatically Checkbox 36. [saveSearchSaveLayout--> SS_SL] - Create Save search dialog save result layout Checkbox 37. [personalizeSearchSetAsDefault --> PSS_def] - Personalize Saved Searches set as default Checkbox 38. [personalizeSearchAutoExecute --> PSS_autoEx] - Personalize Saved Searches run automatically Checkbox 39. [personalizeSearchShowInList --> PSS_SiL] - Personalize Saved Searches Show in List Checkbox 40. [deleteWarningMessage --> DWDMsg] - Personalize Saved Searches Delete Warning Dialog - message subid 41. [overrideWarningMessage --> OWDMsg] - Create Saved Searches Override Warning Dialog - message subid 42. [reorderButton --> reorder] - Reorder button which opens the reorder Dialog -(mapped programmatically) 43. [reorderPopup --> REPop] - Reorder Popup 44. [reorderDialog --> REDlg] - Reorder Dialog 45. [reorderTree[(index)] --> RETree] - Reorder Tree - Rich tree component For ex: reorderTree[1] for node at index '1' of the tree 46. [reorderMoveTopButton --> move-top] - Reorder Dialog - Move to the start button 47. [reorderMoveUpButton --> move-up] - Reorder Dialog - Move up button 48. [reorderMoveDownButton --> move-down] - Reorder Dialog - Move down button 49. [reorderMoveBottomButton --> move-bottom] - Reorder Dialog - Move to the end button {External indexing example --> Internal indexing example} 1) getAttribute("rich=testTemplate:testQuery#criterion_operator[0]

## Method Detail

### _checkDefaultSavedSearchHidden

`private Object _checkDefaultSavedSearchHidden(Object component,
Object clientId)`
  checks set default is set and show in list is not set and throws an error.
  Parameters:

    `component` | - | component on which error popup should be shown
    `clientId` | - | RichQuery Id

  Return:
    `Object`

### _clearPageProperty

`private Object _clearPageProperty(Object propertyKey)`
  Pushes propertyKey -> propertyValue into the page state map
  Parameters:

    `propertyKey` |  |

  Return:
    `Object`

### ComponentDisclosedChanged

`protected Object ComponentDisclosedChanged(Object component,
Object domElement,
Object newValue,
Object oldValue)`
  Parameters:

    `component` |  |
    `domElement` |  |
    `newValue` |  |
    `oldValue` |  |

  Return:
    `Object`

### _evaluateAddFieldsExpandoScript

`private Object _evaluateAddFieldsExpandoScript()`
  Return:
    `Object`

### _getAddFieldsSubIdDomElement

`private Object _getAddFieldsSubIdDomElement(Object subElementId,
Object component,
Object addFieldsIndex)`
  Parameters:

    `subElementId` |  |
    `component` |  |
    `addFieldsIndex` |  |

  Return:
    `Object`

### _getAddFieldsSubIdFromPrunedClientId

`private Object _getAddFieldsSubIdFromPrunedClientId(Object prunedClientId)`
  Parameters:

    `prunedClientId` |  |

  Return:
    `Object`

### GetBestMatchSubId

`protected Object GetBestMatchSubId(Object domElement)`
  Returns the best match subId for the given domElement. This can be overridden by components to return programmatically determined subIds. WARNING - You must make sure to bind the component to the peer before calling this function.
  Parameters:

    `domElement` |  |

  Return:
    `Object`
  See also:
    `AdfRichUIPeer.GetSubIdDomElement(Object)`

### _getContentDomElement

`private Object _getContentDomElement()`
  Return:
    `Object`

### _getCreateOrUpdateValue

`private Object _getCreateOrUpdateValue(Object component,
Object dlgId)`
  Creates a Map of return values that reflects the selecions/changes made to the content in the Saved Search dialogs.
  Parameters:

    `component` | - | the component that this peer will be associated with
    `dlgId` | - | the id of the dialog whose content is packaged.

  Return:
    `Object` - a Map of values.

### GetDomElementSubId

`protected String GetDomElementSubId(Object subIdElement)`
  Returns the subId for a given dom element for query.
  Parameters:

    `subIdElement` |  |

  Return:
    `String` - subElementIdLocator the id of the child dom element or component The HTML element may have the following examples of clientId. For the complete list of clientId and locators supported, please check the comment given in the top of this file. e.g. 1. dmoTpl:highSalariedClerksQueryId::PSS_Srchs::content 2. dmoTpl:highSalariedClerksQueryId::PSS_Srchs 3. dmoTpl:highSalariedClerksQueryId:val00::increment 4. dmoTpl:highSalariedClerksQueryId:val00 5. dmoTpl:highSalariedClerksQueryId:oper0 6. dmoTpl:highSalariedClerksQueryId:val10_afrLovInternalQueryId:RETree:1:ndStOut (Reorder dialog field inside LOV inside query) In the above e.g. the first two subIds are owned by query however 3. subid is owned by the inputNumberSpinBox We have to handle the subids owned by query and simple suffix the ones owned by sub components.

### _getNestedSubIdIndexForProgSubId

`private Object _getNestedSubIdIndexForProgSubId(Object clientId,
Object subIdFragment)`
  Parameters:

    `clientId` |  |
    `subIdFragment` |  |

  Return:
    `Object`

### _getPageProperty

`private Object _getPageProperty(Object propertyKey)`
  Retreives value for 'propertyKey' stored on the page state map by 'component'
  Parameters:

    `propertyKey` |  |

  Return:
    `Object`

### _getPopupComponent

`private Object _getPopupComponent(Object clientId,
Object isPersonalize)`
  Returns the popup component for the personalize popup if isPersonalize is true, else the component for the create popup.
  Parameters:

    `clientId` |  |
    `isPersonalize` |  |

  Return:
    `Object` - the AdfRichPopup component instance or null.

### _getQueryButtonId

`private Object _getQueryButtonId(Object buttonId)`
  Get the id for the query button
  Parameters:

    `buttonId` | - | the id specific for the button

  Return:
    `Object` - the full query button client id

### getSavedSearchNames

`public static Object getSavedSearchNames()`
  Returns the stored saved search names by concatenating user search names and system search names otherwise a blank array.
  Return:
    `Object` - array of saved search names

### _getSearchNameInCSSDialog

`private Object _getSearchNameInCSSDialog(Object component)`
  Returns the value of the saved search name in Create Save Search Dialog
  Parameters:

    `component` | - | the component that this peer is associated with.

  Return:
    `Object` - the saved search name that is currently in CSS dialog.

### _getSelectedSearchName

`private Object _getSelectedSearchName(Object component,
Object isPersonalize)`
  Returns the value of the saved search that is currently selected, either in the Personalize Saved Search dialog or in the search panel.
  Parameters:

    `component` | - | the component that this peer is associated with.
    `isPersonalize` | - | whether we are in personalize dialog or not.

  Return:
    `Object` - the saved search that is currently selected or null.

### _getSSNameComponent

`private Object _getSSNameComponent(Object clientId,
Object isPsz)`
  Helper function that returns the Saved search name component in either dialog.
  Parameters:

    `clientId` | - | a String that is the clientId for the savedSearch component
    `isPsz` | - | a boolean indicating whether the personalize dialog is open.

  Return:
    `Object`

### GetSubIdDomElement

`protected HTMLElement GetSubIdDomElement(String subElementIdLocator)`
  Returns the dom element for a given subElementId for query.
  Parameters:

    `subElementIdLocator` | - | the id of the child dom element or component

  Return:
    `HTMLElement` - the DOM within the component related to scopedId

### _getSubIdFromPrunedClientId

`private Object _getSubIdFromPrunedClientId(Object clientId)`
  Parameters:

    `clientId` |  |

  Return:
    `Object`

### getSystemSavedSearchNames

`public static Object getSystemSavedSearchNames()`
  Returns the stored system saved search names. If _existingSystemSearchNames is null or undefined it returns a blank array object.
  Return:
    `Object` - array of saved search names

### getUserSavedSearchNames

`public static Object getUserSavedSearchNames()`
  Returns the stored saved search names. If _existingUserSearchNames is null or undefined it returns a blank array object.
  Return:
    `Object` - array of saved search names

### _getWarningPopupComponent

`private Object _getWarningPopupComponent(Object isDeletePopup,
Object isWarningPopup)`
  Returns the delete/override warning(error) popup component.
  Parameters:

    `isDeletePopup` |  |
    `isWarningPopup` |  |

  Return:
    `Object` - the AdfRichPopup component instance or null.

### _handleCheckboxClick

`private Object _handleCheckboxClick(Object componentEvent,
Object checkboxId)`
  Handles checkbox selections in both the dialogs.
  Parameters:

    `componentEvent` | - | componentEvent generated by the checkbox click
    `checkboxId` | - | the id associated with the node (usually a checkbox) that generated the event

  Return:
    `Object`

### _handleClickOnReorderButtons

`private Object _handleClickOnReorderButtons(Object componentEvent,
Object buttonClicked)`
  Parameters:

    `componentEvent` |  |
    `buttonClicked` |  |

  Return:
    `Object`

### __handleClientSideDisclosure

`Object __handleClientSideDisclosure(Boolean disclosed)`
  Client side optimized disclosure function
  Parameters:

    `disclosed` | - | true if the new state is disclosed

  Return:
    `Object`

### HandleComponentAction

`protected Object HandleComponentAction(Object componentEvent)`
  Action Event handler for the Apply button in PSS dialog. If we don't handle action event here, there is PPR on pressing Apply button and the error message is cleared due to the PPR.
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Handler for the component mouse click events. Handles click events generated by the buttons ( Search, Reset, Save, Cancel, Ok, Disclose, Delete and Duplicate) and the UIHint check boxes in both the dialogs.
  Parameters:

    `componentEvent` | - | the component event generated by mouse click.

  Return:
    `Object`

### _handleComponentClickInDialog

`private Object _handleComponentClickInDialog(Object componentEvent)`
  Handles component click events generated from components within the dialog.
  Parameters:

    `componentEvent` | - | the component event generated by mouse click.

  Return:
    `Object`

### HandleComponentDialog

`protected Object HandleComponentDialog(Object componentEvent)`
  Takes the appropriate action when the dialog buttons OK and Cancel are clicked in the Saved Search dialogs or YES/NO are clicked in the delete/override warning(error) dialog. All of these actions additionally close the dialog.
  Parameters:

    `componentEvent` | - | the component event generated from a button click.

  Return:
    `Object`

### HandleComponentDisclosure

`protected Object HandleComponentDisclosure(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentKeyDown

`protected Object HandleComponentKeyDown(Object componentEvent)`
  When query component is used inside a dialog and the Enter key pressed, keydown event is not bubbles up to the dialog potentially causing it to close, especially if the dialog has an OK outcome. Canceling the keydown event, when it is not consumed by any of the subcomponents of the query does, is therefore required.
  Parameters:

    `componentEvent` | - | the component event generated by enter key down.

  Return:
    `Object`
  See also:
    `AdfDhtmlDialogPeer.HandleComponentKeyDown(AdfUIInputEvent)`

### HandleComponentKeyPress

`protected Object HandleComponentKeyPress(Object componentEvent)`
  When query component is used inside a dialog and the Enter key pressed, keydown event is not bubbles up to the dialog potentially causing it to close, especially if the dialog has an OK outcome. Canceling the keydown event, when it is not consumed by any of the subcomponents of the query does, is therefore required.
  Parameters:

    `componentEvent` | - | the component event generated by enter key press.

  Return:
    `Object`
  See also:
    `AdfDhtmlDialogPeer.HandleComponentKeyPress(AdfUIInputEvent)`

### HandleComponentKeyUp

`protected Object HandleComponentKeyUp(Object componentEvent)`
  The query component has a built-in notion of a defaultCommand that should execute a search when user hits the Enter key. But we need to exclude the cases where Enter key actually means something to the native target: a. when focus is in a textarea (inserts a new line) b. when focus is on an anchor (executes a command or is a GET) c. when focus is on a button (input type=button, input type=submit, input type=reset, or plain button) d. when the key event has been canceled specifically by another component/peer (e.g. there may be other input components that want to cancel this key and prevent executing a search. - Enter on operator dropdown autoSubmits to refresh the value fields - Enter on saved search dropdown handles ValueChange and queues an QueryInternalEvent Outside of the above special cases is the Enter key is pressed on a component that does not consume it , then queue a QueryEvent.
  Parameters:

    `componentEvent` | - | the component event generated by enter key up.

  Return:
    `Object`

### _handleComponentOperation

`private Object _handleComponentOperation(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentPopupOpening

`protected Object HandleComponentPopupOpening(Object componentEvent)`
  Handler for the popup opening event, modified the hints for the popup as needed
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentValueChange

`protected Object HandleComponentValueChange(Object componentEvent)`
  Handles any value change event that happens within the query component. Specifically when the source of the ValueChange event was the saved search dropdwon in the Personalize Saved Search dialog or the main search panel.
  Parameters:

    `componentEvent` | - | event through which selection was made, e.g. mouse click

  Return:
    `Object`

### _handleConjunctionSelection

`private Object _handleConjunctionSelection(Object query,
Object componentEvent)`
  Queues a QueryInternalEvent when a conjunction is selected.
  Parameters:

    `query` |  |
    `componentEvent` |  |

  Return:
    `Object`

### HidePopupDialog

`protected Object HidePopupDialog(Object clientId,
Object isPersonalize)`
  Hides the popup dialog when OK or Cancel is pressed on either dialog.
  Parameters:

    `clientId` | - | of the query component
    `isPersonalize` |  |

  Return:
    `Object`

### Init

`protected Object Init(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(AdfUIComponent component,
Object domElement)`
  Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called.
  Parameters:

    `component` | - | Component that this peer will be associated with
    `domElement` | - | Root DOM element of this peer

  Return:
    `Object`

### initialize

`public Object initialize(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### InitSubclass

`protected static Object InitSubclass()`
  Initializes variables and adds component event handlers.
  Return:
    `Object`

### _isCheckboxClicked

`private Object _isCheckboxClicked(Object componentEvent,
Object rootId,
Object sourceClientId)`
  Determines if the checkbox was clicked.
  Parameters:

    `componentEvent` |  |
    `rootId` |  |
    `sourceClientId` |  |

  Return:
    `Object`

### _isClickInClientComponent

`private Object _isClickInClientComponent(Object node,
Object id)`
  Checks to see if the clientId of the component with "id" is indeed the component that this event originated from.
  Parameters:

    `node` | - | the dom node that is the event source
    `id` | - | of the component, whose client id is checked for match against the event Source component's clientId

  Return:
    `Object`

### _isClickInReorderDialogButtons

`private Object _isClickInReorderDialogButtons(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### _isClickInSubComponent

`private Object _isClickInSubComponent(Object elem,
Object subId)`
  Checks to see if the clientId of the component with "subid" matches the id of the component this event originated from.
  Parameters:

    `elem` | - | the dom node that is the event source
    `subId` |  |

  Return:
    `Object`

### _isEnterKeyNotConsumed

`private Boolean _isEnterKeyNotConsumed(Object componentEvent)`
  Return true if Enter key is pressed on a component that does not consume it else return false. We need to track the cases where Enter key actually means something to the native target: a. when focus is in a textarea (inserts a new line) b. when focus is on an anchor (executes a command or is a GET) c. when focus is on a button (input type=button, input type=submit, input type=reset, or plain button) d. when the key event has been canceled specifically by another component/peer (e.g. there may be other input components that want to cancel this key and prevent executing a search. Outside of the above special cases is the Enter key is pressed on a component that does not consume it , then return false.
  Parameters:

    `componentEvent` | - | the component event

  Return:
    `Boolean` - true if Enter key is pressed on a component that does not consume it

### _isEventTargetInChoiceComponent

`private Object _isEventTargetInChoiceComponent(Object componentEvent)`
  Returns true if the event source is one of the select subcomponent in Query.
  Parameters:

    `componentEvent` | - | the component event - Enter on operator dropdown autoSubmits to refresh the value fields - Enter on saved search dropdown handles ValueChange and queues an QueryInternalEvent

  Return:
    `Object`

### _isHeaderless

`private Object _isHeaderless(ADfUIComponent component)`
  Checks if the query component is rendered in a headerless manner. For displayMode="simple|design", there is no header
  Parameters:

    `component` | - | the query client component instance

  Return:
    `Object` - true if the query panel is headerless, else false

### _passSavedSearchNameCheck

`private Object _passSavedSearchNameCheck(Object component,
Object isPsz)`
  Validates the entered name by performing the following checks 1. if the input node is disabled returns true. 2. if the name is empty adds a NOTNULL error message 3. if there are saved searches with the same name as entered adds a DUPLICATE_NAME error message. The new name is always checked against the full list of saved search names.
  Parameters:

    `component` | - | the component that this peer binds to
    `isPsz` | - | a boolean whose true value indicates that we are in the personalize saved search dialog and a false value indicates the Create Saved Search dialog

  Return:
    `Object` - false if there is an existing saved search with the same name. true otherwise.

### _passSystemSearchNameCheck

`private Object _passSystemSearchNameCheck(Object queryName)`
  Validates the entered name by searching it in System Searches
  Parameters:

    `queryName` |  |

  Return:
    `Object` - true if there is an existing saved search with the same name. false otherwise.

### _populateSubIdMap

`private Object _populateSubIdMap()`
  query component publishes the following sub ids [External Subid --> Internal Client SubId]:- 1. [search_button] - search button (mapped programmatically) 2. [reset_button] - reset button (mapped programmatically) 3. [save_button] - save button (mapped programmatically) 4. [mode_button] - mode button (mapped programmatically) 5. [saved_search --> saveSrch] - Saved Search dropdown 6. [disclosure_icon --> _afrDscl] - Disclosure icon 7. [search_header --> _afrTtxt] - Search header 8. [addFields_button --> adFlds] - addFields button 9. [match_type --> conj] - Match type 10. [deleteCriterion[(value)] --> delCrtn. For example value=1. Here the digit refers to criterion index.] - deleteCriterion (by rendered suffix e.g. deleteCriterion[0] --> deleteCriterion0) 11. [criterion_operator[(value)] --> oper. For example value=1. Here the digit refers to criterion index.] - operator (by rendered suffix e.g. criterion_operator[0] --> operator0) 12. [criterion_value[(value)] --> val. For example value=20. Here the first digit refers to criterion index and second digit is the index of the value field of that criterion. As in case "Between" operator there are two value fields having "value" such as 20 and 21.] - value (by rendered suffix e.g. criterion_value[20] --> value20). Here the first digit refers to criterion no. and second digit is the value no. for that criterion. 13. [saveSearch_popup --> SSPop] - Create Save Search Popup 14. [saveSearch_name --> SS_name] - Create Save Search Name field 15. [saveSearch_dialog --> SSD] - Create Save Search Dialog 16. [personalizeSearch_popup --> PSSPop] - Personalize Saved Search Popup 17. [personalizeSearch_searches --> PSS_Srchs] - Personalize Saved Searches Dropdown list 18. [personalizeSearch_dialog --> PSSD] - Personalize Saved Searches Dialog 19. [personalizeSearch_delete --> delete] - Personalize Saved Searches Delete Button 20. [personalizeSearch_duplicate --> duplicate] - Personalize Saved Searches Duplicate Button 21. [personalizeSearch_apply --> apply] - Personalize Saved Searches Apply Button 22. [personalizeSearch_Name --> PSS_name] - Personalize Saved Searches Name field 23. [deleteWarning_popup --> DWPop] - Personalize Saved Searches Delete Warning Popup 24. [deleteWarning_dialog --> DWD] - Personalize Saved Searches Delete Warning Dialog 25. [overrideWarning_popup --> OWPop] - Create Saved Searches Override Warning Popup 26. [overrideWarning_dialog --> OWD] - Create Saved Searches Override Warning Dialog 27. [overrideError_popup --> OEPop] - Create Saved Searches Override Error Popup 28. [overrideError_dialog --> OED] - Create Saved Searches Override Error Dialog 29. [criterion_label[(value)] --> crtnLab] - For example: criterion_label[0] is subId for first criterion label. Here the "value" refers to criterion index. 30. [addFields['menu Item label'] --> fldItemx] - For example: addFields['Hire Date'] for menu item with label "Hire Date" which is not inside any menu/UICategory. 31. [addFields['menu label'] --> adFldGrpMenu] - For example: addFields['Confidential'] for menu with label Confidential. 32. [addFields['menu label']['menu item label'] --> fldItemx] - For example: addFields['Confidential']['salary of employee'] for menu item salary inside menu confidential. 33. [addFields['menu label'][ALL_FIELDS] --> adFldGrpAddAllItem] - For example: addFields['Confidential'][ALL_FIELDS] for All Fields menu item inside menu with label Confidential. 34. [saveSearchSetAsDefault --> SS_def] - Create Save search dialog Set As Default Checkbox 35. [saveSearchAutoExecute --> SS_autoEx] - Create Save search dialog run automatically Checkbox 36. [saveSearchSaveLayout--> SS_SL] - Create Save search dialog save result layout Checkbox 37. [personalizeSearchSetAsDefault --> PSS_def] - Personalize Saved Searches set as default Checkbox 38. [personalizeSearchAutoExecute --> PSS_autoEx] - Personalize Saved Searches run automatically Checkbox 39. [personalizeSearchShowInList --> PSS_SiL] - Personalize Saved Searches Show in List Checkbox 40. [deleteWarningMessage --> DWDMsg] - Personalize Saved Searches Delete Warning Dialog - message subid 41. [overrideWarningMessage --> OWDMsg] - Create Saved Searches Override Warning Dialog - message subid 42. [reorderButton --> reorder] - Reorder button which opens the reorder Dialog -(mapped programmatically) 43. [reorderPopup --> REPop] - Reorder Popup 44. [reorderDialog --> REDlg] - Reorder Dialog 45. [reorderTree[(index)] --> RETree] - Reorder Tree - Rich tree component For ex: reorderTree[1] for node at index '1' of the tree 46. [reorderMoveTopButton --> move-top] - Reorder Dialog - Move to the start button 47. [reorderMoveUpButton --> move-up] - Reorder Dialog - Move up button 48. [reorderMoveDownButton --> move-down] - Reorder Dialog - Move down button 49. [reorderMoveBottomButton --> move-bottom] - Reorder Dialog - Move to the end button {External indexing example --> Internal indexing example} 1) getAttribute("rich=testTemplate:testQuery#criterion_operator[0]
  Return:
    `Object`

### PopupClosed

`protected Object PopupClosed(Object component,
Object contentDom)`
  Callback method called when the popup is closed. This is used to do clean up after close.
  Parameters:

    `component` |  |
    `contentDom` |  |

  Return:
    `Object`

### _queueQueryEvent

`private Object _queueQueryEvent(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### _queueResultComponentEvent

`private Object _queueResultComponentEvent(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### ResizeNotify

`protected Object ResizeNotify(Object oldWidth,
Object oldHeight,
Object newWidth,
Object newHeight)`
  Resize notification callback - we perform geometry management here
  Parameters:

    `oldWidth` |  |
    `oldHeight` |  |
    `newWidth` |  |
    `newHeight` |  |

  Return:
    `Object`

### _returnButtonElement

`private HTMLElement _returnButtonElement(String buttonId)`
  Convenience method to handle both new af:buttons and old af:commandButtons.
  Parameters:

    `buttonId` | - | the partial id used for the child button

  Return:
    `HTMLElement` - the DOM within the component related to scopedId

### _setAddFieldsVisibleItems

`private Object _setAddFieldsVisibleItems(Object component)`
  This is used to set the no. of visible-items on the menu peer.
  Parameters:

    `component` |  |

  Return:
    `Object`

### SetBusy

`protected Object SetBusy(Object isBusy)`
  Parameters:

    `isBusy` |  |

  Return:
    `Object`

### _setComponentError

`private Object _setComponentError(Object component,
Object summaryKey,
Object detailKey,
Object trResourceKey)`
  Adds the error message to the component if the component passed in is valid, otherwise it displays a page level error.
  Parameters:

    `component` | - | the component instance to which the error needs to be added.
    `summaryKey` | - | the key to use retrieve the translated message summary.
    `detailKey` | - | the key to use to retrieve the translated message detail
    `trResourceKey` |  |

  Return:
    `Object`

### _setPageProperty

`private Object _setPageProperty(Object propertyKey,
Object propertyValue)`
  Pushes propertyKey -> propertyValue into the page state map
  Parameters:

    `propertyKey` |  |
    `propertyValue` |  |

  Return:
    `Object`

### setSystemSavedSearchNames

`public static Object setSystemSavedSearchNames(Object names)`
  This method is used to store the user saved search names. This function is referenced from the method _renderSavedSearchListScript() of QueryRenderer class to pass the system saved search names.
  Parameters:

    `names` | - | array of saved search names

  Return:
    `Object`

### setUserSavedSearchNames

`public static Object setUserSavedSearchNames(Object names)`
  This method is used to store the user saved search names. This function is referenced from the method _renderSavedSearchListScript() of QueryRenderer class to pass the user saved search names.
  Parameters:

    `names` | - | array of saved search names

  Return:
    `Object`

### _showWarningPopup

`private Object _showWarningPopup(Object isDeletePopup,
Object isWarningPopup)`
  Shows the delete/override warning(error) dialog popup.
  Parameters:

    `isDeletePopup` | - | if the Delete Warning popup was clicked.
    `isWarningPopup` | - | if the Override Warning popup was clicked.

  Return:
    `Object`

### _stripStartingColons

`private Object _stripStartingColons(Object prunedClientId)`
  Parameters:

    `prunedClientId` |  |

  Return:
    `Object`

### validateCriterionFields

`public Boolean validateCriterionFields()`
  Internal framework use only. (Used in AdfDhtmlInputListOfValuesSuperBasePeer.js) Returns false if any of the required criterion value field is null (or empty) and show the value component in error else true or none of the selectively required fields provided with a non null value.
  Return:
    `Boolean` - false if validation fails else true

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.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.