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 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 |
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 |
Event | Description |
---|---|
refineSearch |
Event which is fired when an attribute is selected or unselected. |
search |
Event is fired when the search button is clicked |
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. |
Method | Description |
---|---|
addAttribute |
Adds some attribute to the aggregation attributes. |
attachRefineSearch |
Attaches event handler When called, the context of the event handler (its Event which is fired when an attribute is selected or unselected. |
attachSearch |
Attaches event handler When called, the context of the event handler (its 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 The passed function and listener object must match the ones used for event registration. |
detachSearch |
Detaches event handler 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
|
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 |
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 |
setSettingsMenu |
Sets the aggregated settingsMenu. |
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 |
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 |
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 |
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 |
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 |
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 |
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. |
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. |
Gets content of aggregation attributes.
The attributes which shall be available to refine the search
Returns the ExactArea representing the result section. Arbitrary content can be added here.
Gets current value of property resultText.
A title text which is displayed above the result section
Gets content of aggregation settingsMenu.
Defines the 'Settings' button in the browse section tool bar
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 |
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 |
Removes all the controls from the aggregation attributes.
Additionally, it unregisters them from the hosting UIArea.
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 |
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 |
Sets the aggregated settingsMenu.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSettingsMenu | sap.ui.commons.Menu |
The settingsMenu to set |