Class sap.ui.ux3.ExactBrowserModule: sap/ui/ux3/ExactBrowser

extends Control

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).
Deprecated API:
Since version 1.38.
Constructor Summary
new sap.ui.ux3.ExactBrowser(sId?, mSettings?)Constructor for a new ExactBrowser.
Event Summary
attributeSelected(oControlEvent)Event is fired when an attribute is selected or unselected.
save(oControlEvent)Event is fired when an attribute is selected or unselected.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.ux3.ExactBrowser.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.ExactBrowser with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.ExactBrowser.getMetadata()Returns a metadata object for class sap.ui.ux3.ExactBrowser.
addAttribute(oAttribute)Adds some attribute to the aggregation attributes.
attachAttributeSelected(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the attributeSelected event of this sap.ui.ux3.ExactBrowser.
attachSave(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the save event of this sap.ui.ux3.ExactBrowser.
destroyAttributes()Destroys all the attributes in the aggregation attributes.
destroyOptionsMenu()Destroys the optionsMenu in the aggregation optionsMenu.
detachAttributeSelected(fnFunction, oListener)Detaches event handler fnFunction from the attributeSelected event of this sap.ui.ux3.ExactBrowser.
detachSave(fnFunction, oListener)Detaches event handler fnFunction from the save event of this sap.ui.ux3.ExactBrowser.
fireAttributeSelected(mParameters?)Fires event attributeSelected to attached listeners.
fireSave(mParameters?)Fires event save to attached listeners.
getAttributes()Gets content of aggregation attributes.
getEnableListClose()Gets current value of property enableListClose.
getEnableReset()Gets current value of property enableReset.
getEnableSave()Gets current value of property enableSave.
getFollowUpControl()ID of the element which is the current target of the association followUpControl, or null.
getHeaderTitle()Gets current value of property headerTitle.
getListHeight()Gets current value of property listHeight.
getOptionsMenu()Gets content of aggregation optionsMenu.
getShowHeader()Gets current value of property showHeader.
getShowTopList()Gets current value of property showTopList.
getTitle()Gets current value of property title.
getTopListOrder()Gets current value of property topListOrder.
getTopListWidth()Gets current value of property topListWidth.
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.
reset()Deselects all currently selected attributes and closes all attribute lists.
setEnableListClose(bEnableListClose)Sets a new value for property enableListClose.
setEnableReset(bEnableReset)Sets a new value for property enableReset.
setEnableSave(bEnableSave)Sets a new value for property enableSave.
setFollowUpControl(oFollowUpControl)Sets the associated followUpControl.
setHeaderTitle(sHeaderTitle)Sets a new value for property headerTitle.
setListHeight(iListHeight)Sets a new value for property listHeight.
setOptionsMenu(oOptionsMenu)Sets the aggregated optionsMenu.
setShowHeader(bShowHeader)Sets a new value for property showHeader.
setShowTopList(bShowTopList)Sets a new value for property showTopList.
setTitle(sTitle)Sets a new value for property title.
setTopListOrder(sTopListOrder)Sets a new value for property topListOrder.
setTopListWidth(iTopListWidth)Sets a new value for property topListWidth.
Constructor Detail
new sap.ui.ux3.ExactBrowser(sId?, mSettings?)

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

The supported settings are:

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
attributeSelected(oControlEvent)
Event is fired when an attribute is selected or unselected.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
sap.ui.ux3.ExactAttributeoControlEvent.getParameters.attributeThe attribute which was selected or unselected recently
objectoControlEvent.getParameters.allAttributesArray of all selected ExactAttributes
save(oControlEvent)
Event is fired when an attribute is selected or unselected.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Method Detail
sap.ui.ux3.ExactBrowser.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.ExactBrowser.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.ExactBrowser.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAttribute(oAttribute): sap.ui.ux3.ExactBrowser
Adds some attribute to the aggregation attributes.
Parameters:
sap.ui.ux3.ExactAttributeoAttributethe attribute to add; if empty, nothing is inserted
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
attachAttributeSelected(oData?, fnFunction, oListener?): sap.ui.ux3.ExactBrowser

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.

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.ExactBrowser itself
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
attachSave(oData?, fnFunction, oListener?): sap.ui.ux3.ExactBrowser

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.

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.ExactBrowser itself
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
destroyAttributes(): sap.ui.ux3.ExactBrowser
Destroys all the attributes in the aggregation attributes.
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
destroyOptionsMenu(): sap.ui.ux3.ExactBrowser
Destroys the optionsMenu in the aggregation optionsMenu.
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
detachAttributeSelected(fnFunction, oListener): sap.ui.ux3.ExactBrowser

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.

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.ExactBrowserReference to this in order to allow method chaining
detachSave(fnFunction, oListener): sap.ui.ux3.ExactBrowser

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.

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.ExactBrowserReference to this in order to allow method chaining
fireAttributeSelected(mParameters?): sap.ui.ux3.ExactBrowser
Fires event attributeSelected to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
sap.ui.ux3.ExactAttributemParameters.attribute?The attribute which was selected or unselected recently
objectmParameters.allAttributes?Array of all selected ExactAttributes
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
fireSave(mParameters?): sap.ui.ux3.ExactBrowser
Fires event save to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
getAttributes(): sap.ui.ux3.ExactAttribute[]

Gets content of aggregation attributes.

The attributes which shall be available.

Returns:
sap.ui.ux3.ExactAttribute[]
getEnableListClose(): boolean

Gets current value of property enableListClose.

Enables the close icons of the displayed lists.

Default value is false.

Returns:
booleanValue of property enableListClose
getEnableReset(): boolean

Gets current value of property enableReset.

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

Default value is true.

Returns:
booleanValue of property enableReset
getEnableSave(): boolean

Gets current value of property enableSave.

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

Default value is false.

Returns:
booleanValue of property enableSave
Since:
1.9.2
getFollowUpControl(): sap.ui.core.ID
ID of the element which is the current target of the association followUpControl, or null.
Returns:
sap.ui.core.ID
getHeaderTitle(): string

Gets current value of property headerTitle.

Title text in the header of the Exact Browser.

Returns:
stringValue of property headerTitle
getListHeight(): int

Gets current value of property listHeight.

The height of the list area in px.

Default value is 290.

Returns:
intValue of property listHeight
getOptionsMenu(): sap.ui.commons.Menu

Gets content of aggregation optionsMenu.

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

Returns:
sap.ui.commons.Menu
getShowHeader(): boolean

Gets current value of property showHeader.

Whether the header area of the ExactBrowser should be shown.

Default value is false.

Returns:
booleanValue of property showHeader
getShowTopList(): boolean

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.

Returns:
booleanValue of property showTopList
Since:
1.7.0
getTitle(): string

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.

Returns:
stringValue of property title
getTopListOrder(): sap.ui.ux3.ExactOrder

Gets current value of property topListOrder.

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

Default value is Select.

Returns:
sap.ui.ux3.ExactOrderValue of property topListOrder
Since:
1.7.1
getTopListWidth(): int

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.

Returns:
intValue of property topListWidth
Since:
1.7.0
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.ExactBrowser
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.ExactBrowserReference 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
reset(): void
Deselects all currently selected attributes and closes all attribute lists.
setEnableListClose(bEnableListClose): sap.ui.ux3.ExactBrowser

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.

Parameters:
booleanbEnableListCloseNew value for property enableListClose
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setEnableReset(bEnableReset): sap.ui.ux3.ExactBrowser

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.

Parameters:
booleanbEnableResetNew value for property enableReset
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setEnableSave(bEnableSave): sap.ui.ux3.ExactBrowser

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.

Parameters:
booleanbEnableSaveNew value for property enableSave
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
Since:
1.9.2
setFollowUpControl(oFollowUpControl): sap.ui.ux3.ExactBrowser
Sets the associated followUpControl.
Parameters:
sap.ui.core.ID|sap.ui.core.ControloFollowUpControlID of an element which becomes the new target of this followUpControl association; alternatively, an element instance may be given
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setHeaderTitle(sHeaderTitle): sap.ui.ux3.ExactBrowser

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.

Parameters:
stringsHeaderTitleNew value for property headerTitle
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setListHeight(iListHeight): sap.ui.ux3.ExactBrowser

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.

Parameters:
intiListHeightNew value for property listHeight
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setOptionsMenu(oOptionsMenu): sap.ui.ux3.ExactBrowser
Sets the aggregated optionsMenu.
Parameters:
sap.ui.commons.MenuoOptionsMenuThe optionsMenu to set
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setShowHeader(bShowHeader): sap.ui.ux3.ExactBrowser

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.

Parameters:
booleanbShowHeaderNew value for property showHeader
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setShowTopList(bShowTopList): sap.ui.ux3.ExactBrowser

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.

Parameters:
booleanbShowTopListNew value for property showTopList
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
Since:
1.7.0
setTitle(sTitle): sap.ui.ux3.ExactBrowser

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.

Parameters:
stringsTitleNew value for property title
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
setTopListOrder(sTopListOrder): sap.ui.ux3.ExactBrowser

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.

Parameters:
sap.ui.ux3.ExactOrdersTopListOrderNew value for property topListOrder
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
Since:
1.7.1
setTopListWidth(iTopListWidth): sap.ui.ux3.ExactBrowser

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.

Parameters:
intiTopListWidthNew value for property topListWidth
Returns:
sap.ui.ux3.ExactBrowserReference to this in order to allow method chaining
Since:
1.7.0