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.
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. 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. 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. 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. fireSave(mArguments?)Fires event save to attached listeners. getFollowUpControl()ID of the element which is the current target of the association followUpControl, or null. getTitle()Gets current value of property title. indexOfAttribute(oAttribute)Checks for the provided sap.ui.ux3.ExactAttribute in the aggregation attributes. insertAttribute(oAttribute, iIndex)Inserts a attribute into the aggregation attributes. removeAttribute(vAttribute)Removes a attribute from the aggregation attributes. reset()Deselects all currently selected attributes and closes all attribute lists. setEnableReset(bEnableReset)Sets a new value for property enableReset. setEnableSave(bEnableSave)Sets a new value for property enableSave. setHeaderTitle(sHeaderTitle)Sets a new value for property headerTitle. setListHeight(iListHeight)Sets a new value for property listHeight. 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. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onAfterRendering,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty 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:
- Properties
- Aggregations
- Events
- attributeSelected : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- save : 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:
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.38.
Event Detail
attributeSelected(oControlEvent)
Event is fired when an attribute is selected or unselected.
Parameters:
save(oControlEvent)
Event is fired when an attribute is selected or unselected.
Parameters:
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:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
Returns a metadata object for class sap.ui.ux3.ExactBrowser.
Returns:
Adds some attribute to the aggregation attributes.
Parameters:
Returns:
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:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactBrowser itself |
Returns:
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:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.ux3.ExactBrowser itself |
Returns:
Destroys all the attributes in the aggregation attributes.
Returns:
Destroys the optionsMenu in the aggregation optionsMenu.
Returns:
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:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
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:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event
attributeSelected to attached listeners.
Expects the following event parameters:
attribute of type sap.ui.ux3.ExactAttributeThe attribute which was selected or unselected recentlyallAttributes of type objectArray of all selected ExactAttributes
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event save to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Gets content of aggregation
attributes.
The attributes which shall be available.
Returns:
getEnableListClose(): boolean
Gets current value of property
enableListClose.
Enables the close icons of the displayed lists.
Default value is false.
Returns:
| {boolean} | Value 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:
| {boolean} | Value 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.
- Since:
- 1.9.2
Returns:
| {boolean} | Value of property enableSave |
ID of the element which is the current target of the association followUpControl, or null.
Returns:
getHeaderTitle(): string
Gets current value of property
headerTitle.
Title text in the header of the Exact Browser.
Returns:
| {string} | Value of property headerTitle |
getListHeight(): int
Gets current value of property
listHeight.
The height of the list area in px.
Default value is 290.
Returns:
| {int} | Value of property listHeight |
Gets content of aggregation
optionsMenu.
Menu with options. The menu can not used when the property showTopList is set to false.
Returns:
getShowHeader(): boolean
Gets current value of property
showHeader.
Whether the header area of the ExactBrowser should be shown.
Default value is false.
Returns:
| {boolean} | Value 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.
- Since:
- 1.7.0
Returns:
| {boolean} | Value of property showTopList |
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:
| {string} | Value of property title |
Gets current value of property
topListOrder.
The order how the sublists of the top level list should be displayed.
Default value is Select.
- Since:
- 1.7.1
Returns:
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.
- Since:
- 1.7.0
Returns:
| {int} | Value of property topListWidth |
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:
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a attribute into the aggregation attributes.
Parameters:
| {sap.ui.ux3.ExactAttribute} | oAttribute | the attribute to insert; if empty, nothing is inserted |
| {int} | iIndex | 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 |
Returns:
Removes all the controls from the aggregation
attributes.
Additionally, it unregisters them from the hosting UIArea.
Returns:
Removes a attribute from the aggregation attributes.
Parameters:
Returns:
reset(): void
Deselects all currently selected attributes and closes all attribute lists.
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:
| {boolean} | bEnableListClose | New value for property enableListClose |
Returns:
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:
| {boolean} | bEnableReset | New value for property enableReset |
Returns:
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:
| {boolean} | bEnableSave | New value for property enableSave |
- Since:
- 1.9.2
Returns:
Sets the associated followUpControl.
Parameters:
| {sap.ui.core.Control} | oFollowUpControl | Id of an element which becomes the new target of this followUpControl association; alternatively, an element instance may be given |
Returns:
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:
| {string} | sHeaderTitle | New value for property headerTitle |
Returns:
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:
| {int} | iListHeight | New value for property listHeight |
Returns:
Sets the aggregated optionsMenu.
Parameters:
Returns:
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:
| {boolean} | bShowHeader | New value for property showHeader |
Returns:
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:
| {boolean} | bShowTopList | New value for property showTopList |
- Since:
- 1.7.0
Returns:
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:
| {string} | sTitle | New value for property title |
Returns:
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:
- Since:
- 1.7.1
Returns:
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:
| {int} | iTopListWidth | New value for property topListWidth |
- Since:
- 1.7.0
Returns: