class sap.ui.ux3.ExactBrowser

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

Attribute browse area used within the Exact pattern. The main benefit of this control is the high flexibility when large data amounts shall be displayed in the form of structured data sets with a high or low interdependency level. From lists - which can be nested according to the defined attributes - the user can choose entries and thereby trigger the display of further information, depending on the chosen entry/entries (multiple selection supported).


Constructor

Constructor for a new ExactBrowser.

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.ExactBrowser(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
enableListClose boolean false

Enables the close icons of the displayed lists.

Visibility: public
enableReset boolean true

Whether the reset functionality should be available in the header area.

Visibility: public
enableSave boolean false

Whether the save button should be available in the header area.

Since: 1.9.2.

Visibility: public
headerTitle string

Title text in the header of the Exact Browser.

Visibility: public
listHeight int 290

The height of the list area in px.

Visibility: public
showHeader boolean false

Whether the header area of the ExactBrowser should be shown.

Visibility: public
showTopList boolean true

Whether the top list of the ExactBrowser should be shown. When the property is set to false the application must ensure to select top level attributes appropriately.

Since: 1.7.0.

Visibility: public
title string

Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.

Visibility: public
topListOrder sap.ui.ux3.ExactOrder Select

The order how the sublists of the top level list should be displayed.

Since: 1.7.1.

Visibility: public
topListWidth int 168

Specifies the width of the top list in pixels. The value must be between 70 and 500.

Since: 1.7.0.

Visibility: public

Aggregations

Default Aggregation: attributes

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

The attributes which shall be available.

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

Controls managed by this ExactBrowser

optionsMenu 0..1 sap.ui.commons.Menu

Menu with options. The menu can not used when the property showTopList is set to false.

rootAttribute 0..1 sap.ui.core.Element

root attribute managed by this ExactBrowser


Associations

Name Cardinality Type Description
followUpControl 0..1 sap.ui.core.Control

The successor control of the Exact Browser. The id of this control is used in the ARIA description of the control.


Events Overview

Event Description
attributeSelected

Event is fired when an attribute is selected or unselected.

save

Event is fired when an attribute is selected or unselected.

attributeSelected

Event is fired when an attribute is selected or unselected.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object
attribute sap.ui.ux3.ExactAttribute

The attribute which was selected or unselected recently

allAttributes object

Array of all selected ExactAttributes

save

Event is fired when an attribute is selected or unselected.

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

Methods Overview

Method Description
addAttribute

Adds some attribute to the aggregation attributes.

attachAttributeSelected

Attaches event handler fnFunction to the attributeSelected event of this sap.ui.ux3.ExactBrowser.

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.ExactBrowser itself.

Event is fired when an attribute is selected or unselected.

attachSave

Attaches event handler fnFunction to the save event of this sap.ui.ux3.ExactBrowser.

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.ExactBrowser itself.

Event is fired when an attribute is selected or unselected.

destroyAttributes

Destroys all the attributes in the aggregation attributes.

destroyOptionsMenu

Destroys the optionsMenu in the aggregation optionsMenu.

detachAttributeSelected

Detaches event handler fnFunction from the attributeSelected event of this sap.ui.ux3.ExactBrowser.

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

detachSave

Detaches event handler fnFunction from the save event of this sap.ui.ux3.ExactBrowser.

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

sap.ui.ux3.ExactBrowser.extend

Creates a new subclass of class sap.ui.ux3.ExactBrowser 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.

fireAttributeSelected

Fires event attributeSelected to attached listeners.

fireSave

Fires event save to attached listeners.

getAttributes

Gets content of aggregation attributes.

The attributes which shall be available.

getEnableListClose

Gets current value of property enableListClose.

Enables the close icons of the displayed lists.

Default value is false.

getEnableReset

Gets current value of property enableReset.

Whether the reset functionality should be available in the header area.

Default value is true.

getEnableSave

Gets current value of property enableSave.

Whether the save button should be available in the header area.

Default value is false.

getFollowUpControl

ID of the element which is the current target of the association followUpControl, or null.

getHeaderTitle

Gets current value of property headerTitle.

Title text in the header of the Exact Browser.

getListHeight

Gets current value of property listHeight.

The height of the list area in px.

Default value is 290.

sap.ui.ux3.ExactBrowser.getMetadata

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

getOptionsMenu

Gets content of aggregation optionsMenu.

Menu with options. The menu can not used when the property showTopList is set to false.

getShowHeader

Gets current value of property showHeader.

Whether the header area of the ExactBrowser should be shown.

Default value is false.

getShowTopList

Gets current value of property showTopList.

Whether the top list of the ExactBrowser should be shown. When the property is set to false the application must ensure to select top level attributes appropriately.

Default value is true.

getTitle

Gets current value of property title.

Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.

getTopListOrder

Gets current value of property topListOrder.

The order how the sublists of the top level list should be displayed.

Default value is Select.

getTopListWidth

Gets current value of property topListWidth.

Specifies the width of the top list in pixels. The value must be between 70 and 500.

Default value is 168.

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.

reset

Deselects all currently selected attributes and closes all attribute lists.

setEnableListClose

Sets a new value for property enableListClose.

Enables the close icons of the displayed lists.

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

Default value is false.

setEnableReset

Sets a new value for property enableReset.

Whether the reset functionality should be available in the header area.

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

Default value is true.

setEnableSave

Sets a new value for property enableSave.

Whether the save button should be available in the header area.

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

Default value is false.

setFollowUpControl

Sets the associated followUpControl.

setHeaderTitle

Sets a new value for property headerTitle.

Title text in the header of the Exact Browser.

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

setListHeight

Sets a new value for property listHeight.

The height of the list area in px.

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

Default value is 290.

setOptionsMenu

Sets the aggregated optionsMenu.

setShowHeader

Sets a new value for property showHeader.

Whether the header area of the ExactBrowser should be shown.

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

Default value is false.

setShowTopList

Sets a new value for property showTopList.

Whether the top list of the ExactBrowser should be shown. When the property is set to false the application must ensure to select top level attributes appropriately.

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

Default value is true.

setTitle

Sets a new value for property title.

Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.

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

setTopListOrder

Sets a new value for property topListOrder.

The order how the sublists of the top level list should be displayed.

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

Default value is Select.

setTopListWidth

Sets a new value for property topListWidth.

Specifies the width of the top list in pixels. The value must be between 70 and 500.

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

Default value is 168.

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

attachAttributeSelected

Attaches event handler fnFunction to the attributeSelected event of this sap.ui.ux3.ExactBrowser.

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.ExactBrowser itself.

Event 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.ExactBrowser itself

attachSave

Attaches event handler fnFunction to the save event of this sap.ui.ux3.ExactBrowser.

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.ExactBrowser itself.

Event 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.ExactBrowser itself

destroyAttributes

Destroys all the attributes in the aggregation attributes.

destroyOptionsMenu

Destroys the optionsMenu in the aggregation optionsMenu.

detachAttributeSelected

Detaches event handler fnFunction from the attributeSelected event of this sap.ui.ux3.ExactBrowser.

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

detachSave

Detaches event handler fnFunction from the save event of this sap.ui.ux3.ExactBrowser.

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.ExactBrowser.extend

Creates a new subclass of class sap.ui.ux3.ExactBrowser 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

fireAttributeSelected

Fires event attributeSelected to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

attribute sap.ui.ux3.ExactAttribute

The attribute which was selected or unselected recently

allAttributes object

Array of all selected ExactAttributes

fireSave

Fires event save to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

getAttributes

Gets content of aggregation attributes.

The attributes which shall be available.

getEnableListClose

Gets current value of property enableListClose.

Enables the close icons of the displayed lists.

Default value is false.

getEnableReset

Gets current value of property enableReset.

Whether the reset functionality should be available in the header area.

Default value is true.

getEnableSave

Gets current value of property enableSave.

Whether the save button should be available in the header area.

Default value is false.

getFollowUpControl

ID of the element which is the current target of the association followUpControl, or null.

getHeaderTitle

Gets current value of property headerTitle.

Title text in the header of the Exact Browser.

getListHeight

Gets current value of property listHeight.

The height of the list area in px.

Default value is 290.

sap.ui.ux3.ExactBrowser.getMetadata

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

getOptionsMenu

Gets content of aggregation optionsMenu.

Menu with options. The menu can not used when the property showTopList is set to false.

getShowHeader

Gets current value of property showHeader.

Whether the header area of the ExactBrowser should be shown.

Default value is false.

getShowTopList

Gets current value of property showTopList.

Whether the top list of the ExactBrowser should be shown. When the property is set to false the application must ensure to select top level attributes appropriately.

Default value is true.

getTitle

Gets current value of property title.

Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.

getTopListOrder

Gets current value of property topListOrder.

The order how the sublists of the top level list should be displayed.

Default value is Select.

getTopListWidth

Gets current value of property topListWidth.

Specifies the width of the top list in pixels. The value must be between 70 and 500.

Default value is 168.

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

reset

Deselects all currently selected attributes and closes all attribute lists.

setEnableListClose

Sets a new value for property enableListClose.

Enables the close icons of the displayed lists.

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

Default value is false.

Param Type DefaultValue Description
bEnableListClose boolean false

New value for property enableListClose

setEnableReset

Sets a new value for property enableReset.

Whether the reset functionality should be available in the header area.

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

Default value is true.

Param Type DefaultValue Description
bEnableReset boolean true

New value for property enableReset

setEnableSave

Sets a new value for property enableSave.

Whether the save button should be available in the header area.

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

Default value is false.

Param Type DefaultValue Description
bEnableSave boolean false

New value for property enableSave

setFollowUpControl

Sets the associated followUpControl.

Param Type DefaultValue Description
oFollowUpControl sap.ui.core.ID sap.ui.core.Control

ID of an element which becomes the new target of this followUpControl association; alternatively, an element instance may be given

setHeaderTitle

Sets a new value for property headerTitle.

Title text in the header of the Exact Browser.

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

Param Type DefaultValue Description
sHeaderTitle string

New value for property headerTitle

setListHeight

Sets a new value for property listHeight.

The height of the list area in px.

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

Default value is 290.

Param Type DefaultValue Description
iListHeight int 290

New value for property listHeight

setOptionsMenu

Sets the aggregated optionsMenu.

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

The optionsMenu to set

setShowHeader

Sets a new value for property showHeader.

Whether the header area of the ExactBrowser should be shown.

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

Default value is false.

Param Type DefaultValue Description
bShowHeader boolean false

New value for property showHeader

setShowTopList

Sets a new value for property showTopList.

Whether the top list of the ExactBrowser should be shown. When the property is set to false the application must ensure to select top level attributes appropriately.

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

Default value is true.

Param Type DefaultValue Description
bShowTopList boolean true

New value for property showTopList

setTitle

Sets a new value for property title.

Title text in the list area of the Exact Browser. The title is not shown when the property showTopList is set to false.

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

Param Type DefaultValue Description
sTitle string

New value for property title

setTopListOrder

Sets a new value for property topListOrder.

The order how the sublists of the top level list should be displayed.

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

Default value is Select.

Param Type DefaultValue Description
sTopListOrder sap.ui.ux3.ExactOrder Select

New value for property topListOrder

setTopListWidth

Sets a new value for property topListWidth.

Specifies the width of the top list in pixels. The value must be between 70 and 500.

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

Default value is 168.

Param Type DefaultValue Description
iTopListWidth int 168

New value for property topListWidth