Internal sub-control of the ExactBrowser. The control is not intended to be used stand alone. For this purpose, the ExactBrowser control can be used.
Constructor for a new ExactList.
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.ExactList(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 |
Name | Type | Default Value | Description |
---|---|---|---|
showClose | boolean | false | Defines whether the close icon shall be displayed in the header. Visibility: public |
topHeight | int | 290 | The height in px if this list is the top of the list hierarchy. Visibility: public |
topTitle | string | The title of this list is the top of the list hierarchy. Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
controls | 0..n | sap.ui.commons.ListBox |
Hidden aggregation for internal Listbox |
subLists | 0..n | sap.ui.ux3.ExactList |
The sub-ExactLists of this list. This aggregation must not be maintained from outside. The control automatically takes care to fill this aggregation according to the given ExactAttribute. |
Name | Cardinality | Type | Description |
---|---|---|---|
data | 0..1 | sap.ui.ux3.ExactAttribute |
The associated ExactAttribute |
Event | Description |
---|---|
attributeSelected |
Event which is fired when an attribute is selected/unselected |
Event which is fired when an attribute is selected/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/unselected recently |
allAttributes | object |
Array of all ExactAttributes |
Method | Description |
---|---|
addSubList |
Adds some subList to the aggregation subLists. |
attachAttributeSelected |
Attaches event handler When called, the context of the event handler (its Event which is fired when an attribute is selected/unselected |
destroySubLists |
Destroys all the subLists in the aggregation subLists. |
detachAttributeSelected |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.ux3.ExactList.extend |
Creates a new subclass of class sap.ui.ux3.ExactList with name
|
fireAttributeSelected |
Fires event attributeSelected to attached listeners. |
getData |
ID of the element which is the current target of the association data, or |
sap.ui.ux3.ExactList.getMetadata |
Returns a metadata object for class sap.ui.ux3.ExactList. |
getShowClose |
Gets current value of property showClose. Defines whether the close icon shall be displayed in the header. Default value is |
getSubLists |
Gets content of aggregation subLists. The sub-ExactLists of this list. This aggregation must not be maintained from outside. The control automatically takes care to fill this aggregation according to the given ExactAttribute. |
getTopHeight |
Gets current value of property topHeight. The height in px if this list is the top of the list hierarchy. Default value is |
getTopTitle |
Gets current value of property topTitle. The title of this list is the top of the list hierarchy. |
indexOfSubList |
Checks for the provided |
insertSubList |
Inserts a subList into the aggregation subLists. |
removeAllSubLists |
Removes all the controls from the aggregation subLists. Additionally, it unregisters them from the hosting UIArea. |
removeSubList |
Removes a subList from the aggregation subLists. |
setData |
Sets the associated data. |
setShowClose |
Sets a new value for property showClose. Defines whether the close icon shall be displayed in the header. When called with a value of Default value is |
setTopHeight |
Sets a new value for property topHeight. The height in px if this list is the top of the list hierarchy. When called with a value of Default value is |
setTopTitle |
Sets a new value for property topTitle. The title of this list is the top of the list hierarchy. When called with a value of |
Adds some subList to the aggregation subLists.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubList | sap.ui.ux3.ExactList |
The subList to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the attributeSelected event of this sap.ui.ux3.ExactList
.
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.ExactList
itself.
Event which is fired when an attribute is selected/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 |
Detaches event handler fnFunction
from the attributeSelected event of this sap.ui.ux3.ExactList
.
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.ExactList 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 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/unselected recently |
|
allAttributes | object |
Array of all ExactAttributes |
Gets current value of property showClose.
Defines whether the close icon shall be displayed in the header.
Default value is false
.
Gets content of aggregation subLists.
The sub-ExactLists of this list. This aggregation must not be maintained from outside. The control automatically takes care to fill this aggregation according to the given ExactAttribute.
Gets current value of property topHeight.
The height in px if this list is the top of the list hierarchy.
Default value is 290
.
Gets current value of property topTitle.
The title of this list is the top of the list hierarchy.
Checks for the provided sap.ui.ux3.ExactList
in the aggregation subLists. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubList | sap.ui.ux3.ExactList |
The subList whose index is looked for |
Inserts a subList into the aggregation subLists.
Param | Type | DefaultValue | Description |
---|---|---|---|
oSubList | sap.ui.ux3.ExactList |
The subList to insert; if empty, nothing is inserted |
|
iIndex | int |
The |
Removes all the controls from the aggregation subLists.
Additionally, it unregisters them from the hosting UIArea.
Removes a subList from the aggregation subLists.
Param | Type | DefaultValue | Description |
---|---|---|---|
vSubList | int string sap.ui.ux3.ExactList |
The subList to remove or its index or id |
Sets the associated data.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | sap.ui.core.ID sap.ui.ux3.ExactAttribute |
ID of an element which becomes the new target of this data association; alternatively, an element instance may be given |
Sets a new value for property showClose.
Defines whether the close icon shall be displayed in the header.
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 |
---|---|---|---|
bShowClose | boolean | false |
New value for property |
Sets a new value for property topHeight.
The height in px if this list is the top of the list hierarchy.
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 |
---|---|---|---|
iTopHeight | int | 290 |
New value for property |
Sets a new value for property topTitle.
The title of this list is the top of the list hierarchy.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTopTitle | string |
New value for property |