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
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(mParameters?)Fires event refineSearch to attached listeners.
fireSearch(mParameters?)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.
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:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
refineSearch(oControlEvent)
Event which is fired when an attribute is selected or unselected.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.queryThe query string which was entered in the search field
sap.ui.ux3.ExactAttributeoControlEvent.getParameters.changedAttributeThe attribute which was selected or unselected recently
objectoControlEvent.getParameters.allSelectedAttributesArray of all selected ExcatAttribute.
search(oControlEvent)
Event is fired when the search button is clicked
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.queryThe 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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated 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.MetadataMetadata object describing this class
addAttribute(oAttribute): sap.ui.ux3.Exact
Adds some attribute to the aggregation attributes.
Parameters:
sap.ui.ux3.ExactAttributeoAttributethe attribute to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ExactReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact itself
Returns:
sap.ui.ux3.ExactReference 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:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact itself
Returns:
sap.ui.ux3.ExactReference 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.ExactReference to this in order to allow method chaining
destroySettingsMenu(): sap.ui.ux3.Exact
Destroys the settingsMenu in the aggregation settingsMenu.
Returns:
sap.ui.ux3.ExactReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ExactReference 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:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.ux3.ExactReference to this in order to allow method chaining
fireRefineSearch(mParameters?): sap.ui.ux3.Exact
Fires event refineSearch to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.query?The query string which was entered in the search field
sap.ui.ux3.ExactAttributemParameters.changedAttribute?The attribute which was selected or unselected recently
objectmParameters.allSelectedAttributes?Array of all selected ExcatAttribute.
Returns:
sap.ui.ux3.ExactReference to this in order to allow method chaining
fireSearch(mParameters?): sap.ui.ux3.Exact
Fires event search to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.query?The query string which was entered in the search field.
Returns:
sap.ui.ux3.ExactReference 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:
stringValue 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.ExactAttributeoAttributeThe attribute whose index is looked for
Returns:
intThe 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.ExactAttributeoAttributethe attribute to insert; if empty, nothing is inserted
intiIndexthe 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.ExactReference 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.ExactAttributevAttributeThe attribute to remove or its index or id
Returns:
sap.ui.ux3.ExactAttributeThe 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:
stringsResultTextNew value for property resultText
Returns:
sap.ui.ux3.ExactReference to this in order to allow method chaining
setSettingsMenu(oSettingsMenu): sap.ui.ux3.Exact
Sets the aggregated settingsMenu.
Parameters:
sap.ui.commons.MenuoSettingsMenuThe settingsMenu to set
Returns:
sap.ui.ux3.ExactReference to this in order to allow method chaining