Class sap.ui.ux3.ExactModule: sap/ui/ux3/Exact

extends Control

A comprehensive UI design approach with graphical and functional elements for searching data, exploring data, and acting on the data ("Explore and Act (Exact) Pattern").

Deprecated API:Since version 1.38.

Experimental API:Since version 1.2. API is not yet finished and might change completely

Constructor Summary
new sap.ui.ux3.Exact(sId?, mSettings?)Constructor for a new Exact.
Event Summary
refineSearch(oControlEvent)Event which is fired when an attribute is selected or unselected.
search(oControlEvent)Event is fired when the search button is clicked
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.ux3.Exact.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.Exact with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.Exact.getMetadata()Returns a metadata object for class sap.ui.ux3.Exact.
addAttribute(oAttribute)Adds some attribute to the aggregation attributes.
attachRefineSearch(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the refineSearch event of this sap.ui.ux3.Exact.
attachSearch(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the search event of this sap.ui.ux3.Exact.
destroyAttributes()Destroys all the attributes in the aggregation attributes.
destroySettingsMenu()Destroys the settingsMenu in the aggregation settingsMenu.
detachRefineSearch(fnFunction, oListener)Detaches event handler fnFunction from the refineSearch event of this sap.ui.ux3.Exact.
detachSearch(fnFunction, oListener)Detaches event handler fnFunction from the search event of this sap.ui.ux3.Exact.
fireRefineSearch(mArguments?)Fires event refineSearch to attached listeners.
fireSearch(mArguments?)Fires event search to attached listeners.
getAttributes()Gets content of aggregation attributes.
getResultArea()Returns the ExactArea representing the result section.
getResultText()Gets current value of property resultText.
getSearchField()Returns the SearchField control which is used by the Exact control.
getSettingsMenu()Gets content of aggregation settingsMenu.
indexOfAttribute(oAttribute)Checks for the provided sap.ui.ux3.ExactAttribute in the aggregation attributes.
insertAttribute(oAttribute, iIndex)Inserts a attribute into the aggregation attributes.
removeAllAttributes()Removes all the controls from the aggregation attributes.
removeAttribute(vAttribute)Removes a attribute from the aggregation attributes.
setResultText(sResultText)Sets a new value for property resultText.
setSettingsMenu(oSettingsMenu)Sets the aggregated settingsMenu.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.ux3.Exact(sId?, mSettings?)
Constructor for a new Exact.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
  • Events
    • search : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • refineSearch : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.38.
Event Detail
refineSearch(oControlEvent)
Event which is fired when an attribute is selected or unselected.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.query The query string which was entered in the search field
{sap.ui.ux3.ExactAttribute}oControlEvent.getParameters.changedAttribute The attribute which was selected or unselected recently
{object}oControlEvent.getParameters.allSelectedAttributes Array of all selected ExcatAttribute.
search(oControlEvent)
Event is fired when the search button is clicked
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.query The query string which was entered in the search field.
Method Detail
sap.ui.ux3.Exact.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.Exact with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.ux3.Exact.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.Exact.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAttribute(oAttribute): sap.ui.ux3.Exact
Adds some attribute to the aggregation attributes.
Parameters:
{sap.ui.ux3.ExactAttribute}oAttribute the attribute to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
attachRefineSearch(oData?, fnFunction, oListener?): sap.ui.ux3.Exact
Attaches event handler fnFunction to the refineSearch event of this sap.ui.ux3.Exact.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Exact itself.

Event which is fired when an attribute is selected or unselected.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact itself
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
attachSearch(oData?, fnFunction, oListener?): sap.ui.ux3.Exact
Attaches event handler fnFunction to the search event of this sap.ui.ux3.Exact.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.ux3.Exact itself.

Event is fired when the search button is clicked

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact itself
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
destroyAttributes(): sap.ui.ux3.Exact
Destroys all the attributes in the aggregation attributes.
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
destroySettingsMenu(): sap.ui.ux3.Exact
Destroys the settingsMenu in the aggregation settingsMenu.
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
detachRefineSearch(fnFunction, oListener): sap.ui.ux3.Exact
Detaches event handler fnFunction from the refineSearch event of this sap.ui.ux3.Exact.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
detachSearch(fnFunction, oListener): sap.ui.ux3.Exact
Detaches event handler fnFunction from the search event of this sap.ui.ux3.Exact.

The passed function and listener object must match the ones used for event registration.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
fireRefineSearch(mArguments?): sap.ui.ux3.Exact
Fires event refineSearch to attached listeners.

Expects the following event parameters:

  • query of type stringThe query string which was entered in the search field
  • changedAttribute of type sap.ui.ux3.ExactAttributeThe attribute which was selected or unselected recently
  • allSelectedAttributes of type objectArray of all selected ExcatAttribute.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
fireSearch(mArguments?): sap.ui.ux3.Exact
Fires event search to attached listeners.

Expects the following event parameters:

  • query of type stringThe query string which was entered in the search field.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
getAttributes(): sap.ui.ux3.ExactAttribute[]
Gets content of aggregation attributes.

The attributes which shall be available to refine the search

Returns:
{sap.ui.ux3.ExactAttribute[]}
getResultArea(): sap.ui.ux3.ExactArea
Returns the ExactArea representing the result section. Arbitrary content can be added here.
Returns:
{sap.ui.ux3.ExactArea}
getResultText(): string
Gets current value of property resultText.

A title text which is displayed above the result section

Returns:
{string} Value of property resultText
getSearchField(): sap.ui.commons.SearchField
Returns the SearchField control which is used by the Exact control.
Returns:
{sap.ui.commons.SearchField}
getSettingsMenu(): sap.ui.commons.Menu
Gets content of aggregation settingsMenu.

Defines the 'Settings' button in the browse section tool bar

Returns:
{sap.ui.commons.Menu}
indexOfAttribute(oAttribute): int
Checks for the provided sap.ui.ux3.ExactAttribute in the aggregation attributes. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.ux3.ExactAttribute}oAttribute The attribute whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertAttribute(oAttribute, iIndex): sap.ui.ux3.Exact
Inserts a attribute into the aggregation attributes.
Parameters:
{sap.ui.ux3.ExactAttribute}oAttribute the attribute to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the attribute should be inserted at; for a negative value of iIndex, the attribute is inserted at position 0; for a value greater than the current size of the aggregation, the attribute is inserted at the last position
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
removeAllAttributes(): sap.ui.ux3.ExactAttribute[]
Removes all the controls from the aggregation attributes.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.ux3.ExactAttribute[]} An array of the removed elements (might be empty)
removeAttribute(vAttribute): sap.ui.ux3.ExactAttribute
Removes a attribute from the aggregation attributes.
Parameters:
{int|string|sap.ui.ux3.ExactAttribute}vAttribute The attributeto remove or its index or id
Returns:
{sap.ui.ux3.ExactAttribute} The removed attribute or null
setResultText(sResultText): sap.ui.ux3.Exact
Sets a new value for property resultText.

A title text which is displayed above the result section

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sResultText New value for property resultText
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining
setSettingsMenu(oSettingsMenu): sap.ui.ux3.Exact
Sets the aggregated settingsMenu.
Parameters:
{sap.ui.commons.Menu}oSettingsMenu The settingsMenu to set
Returns:
{sap.ui.ux3.Exact} Reference to this in order to allow method chaining