class sap.ui.ux3.Exact

Control sample: sap.ui.ux3.Exact
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/Exact
Application Component: CA-UI5-CTR

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").


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.ux3.Exact(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
resultText string

A title text which is displayed above the result section

Visibility: public

Aggregations

Default Aggregation: attributes

Name Cardinality Type Description
attributes (default) 0..n sap.ui.ux3.ExactAttribute

The attributes which shall be available to refine the search

controls 0..n sap.ui.core.Control

Controls managed by the Exact control

settingsMenu 0..1 sap.ui.commons.Menu

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


Events Overview

Event Description
refineSearch

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

search

Event is fired when the search button is clicked

refineSearch

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

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
query string

The query string which was entered in the search field

changedAttribute sap.ui.ux3.ExactAttribute

The attribute which was selected or unselected recently

allSelectedAttributes object

Array of all selected ExcatAttribute.

search

Event is fired when the search button is clicked

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
query string

The query string which was entered in the search field.


Methods Overview

Method Description
addAttribute

Adds some attribute to the aggregation attributes.

attachRefineSearch

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.

attachSearch

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

destroyAttributes

Destroys all the attributes in the aggregation attributes.

destroySettingsMenu

Destroys the settingsMenu in the aggregation settingsMenu.

detachRefineSearch

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.

detachSearch

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.

sap.ui.ux3.Exact.extend

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.

fireRefineSearch

Fires event refineSearch to attached listeners.

fireSearch

Fires event search to attached listeners.

getAttributes

Gets content of aggregation attributes.

The attributes which shall be available to refine the search

sap.ui.ux3.Exact.getMetadata

Returns a metadata object for class sap.ui.ux3.Exact.

getResultArea

Returns the ExactArea representing the result section. Arbitrary content can be added here.

getResultText

Gets current value of property resultText.

A title text which is displayed above the result section

getSearchField

Returns the SearchField control which is used by the Exact control.

getSettingsMenu

Gets content of aggregation settingsMenu.

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

indexOfAttribute

Checks for the provided sap.ui.ux3.ExactAttribute in the aggregation attributes. and returns its index if found or -1 otherwise.

insertAttribute

Inserts a attribute into the aggregation attributes.

removeAllAttributes

Removes all the controls from the aggregation attributes.

Additionally, it unregisters them from the hosting UIArea.

removeAttribute

Removes a attribute from the aggregation attributes.

setResultText

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.

setSettingsMenu

Sets the aggregated settingsMenu.

addAttribute

Adds some attribute to the aggregation attributes.

Param Type DefaultValue Description
oAttribute sap.ui.ux3.ExactAttribute

The attribute to add; if empty, nothing is inserted

attachRefineSearch

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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact itself

attachSearch

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

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.ux3.Exact itself

destroyAttributes

Destroys all the attributes in the aggregation attributes.

destroySettingsMenu

Destroys the settingsMenu in the aggregation settingsMenu.

detachRefineSearch

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

detachSearch

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.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.ux3.Exact.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

fireRefineSearch

Fires event refineSearch to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

query string

The query string which was entered in the search field

changedAttribute sap.ui.ux3.ExactAttribute

The attribute which was selected or unselected recently

allSelectedAttributes object

Array of all selected ExcatAttribute.

fireSearch

Fires event search to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

query string

The query string which was entered in the search field.

getAttributes

Gets content of aggregation attributes.

The attributes which shall be available to refine the search

sap.ui.ux3.Exact.getMetadata

Returns a metadata object for class sap.ui.ux3.Exact.

getResultArea

Returns the ExactArea representing the result section. Arbitrary content can be added here.

getResultText

Gets current value of property resultText.

A title text which is displayed above the result section

getSearchField

Returns the SearchField control which is used by the Exact control.

getSettingsMenu

Gets content of aggregation settingsMenu.

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

indexOfAttribute

Checks for the provided sap.ui.ux3.ExactAttribute in the aggregation attributes. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oAttribute sap.ui.ux3.ExactAttribute

The attribute whose index is looked for

insertAttribute

Inserts a attribute into the aggregation attributes.

Param Type DefaultValue Description
oAttribute sap.ui.ux3.ExactAttribute

The attribute to insert; if empty, nothing is inserted

iIndex int

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

removeAllAttributes

Removes all the controls from the aggregation attributes.

Additionally, it unregisters them from the hosting UIArea.

removeAttribute

Removes a attribute from the aggregation attributes.

Param Type DefaultValue Description
vAttribute int string sap.ui.ux3.ExactAttribute

The attribute to remove or its index or id

setResultText

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.

Param Type DefaultValue Description
sResultText string

New value for property resultText

setSettingsMenu

Sets the aggregated settingsMenu.

Param Type DefaultValue Description
oSettingsMenu sap.ui.commons.Menu

The settingsMenu to set