An element for defining attributes and sub-attributes used within the Exact pattern.
Constructor for a new ExactAttribute.
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.ExactAttribute(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 |
---|---|---|---|
additionalData | object | An example for additional data are database keys Visibility: public |
|
autoActivateSupply | boolean | false | If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically set to true on every unselect. Visibility: public |
listOrder | sap.ui.ux3.ExactOrder | Select | The order how the sublists of this attribute should be displayed. |
selected | boolean | Specifies whether the attribute shall be selected Visibility: public |
|
showSubAttributesIndicator | boolean | true | Specifies whether the attribute shall have sub values for visual purposes. The indicator which is a little arrow beside an attribute in the list is computed automatically (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute). In the case that a supply function is attached, and the supplyActive attribute has value 'true', then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is considered then and has to be maintained. If the back-end does not support count-calls, for example, showSubAttributesIndicator should be set to true. Visibility: public |
supplyActive | boolean | true | The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false. The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true. Visibility: public |
text | string | The attribute name Visibility: public |
|
width | int | 168 | Specifies the width of the corresponding list in pixels. The value must be between 70 and 500. |
Default Aggregation: attributes
Name | Cardinality | Type | Description |
---|---|---|---|
attributes (default) | 0..n | sap.ui.ux3.ExactAttribute |
Values (sub attributes) of this attribute |
Event | Description |
---|---|
supplyAttributes |
A supply function is a handler which is attached to the supplyAttributes event. The event is fired when the corresponding ExactAttribute is selected, it was already selected when a handler is attached or function getAttributes() is called. |
A supply function is a handler which is attached to the supplyAttributes event. The event is fired when the corresponding ExactAttribute is selected, it was already selected when a handler is attached or function getAttributes() is called.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
attribute | sap.ui.ux3.ExactAttribute |
The ExactAttribute |
Method | Description |
---|---|
addAttribute |
Adds some attribute to the aggregation attributes. |
attachSupplyAttributes |
Attaches event handler When called, the context of the event handler (its A supply function is a handler which is attached to the supplyAttributes event. The event is fired when the corresponding ExactAttribute is selected, it was already selected when a handler is attached or function getAttributes() is called. |
destroyAttributes |
Destroys all the attributes in the aggregation attributes. |
detachSupplyAttributes |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.ux3.ExactAttribute.extend |
Creates a new subclass of class sap.ui.ux3.ExactAttribute with name
|
fireSupplyAttributes |
Fires event supplyAttributes to attached listeners. |
getAdditionalData |
Gets current value of property additionalData. An example for additional data are database keys |
getAttributes |
Gets content of aggregation attributes. Values (sub attributes) of this attribute |
getAutoActivateSupply |
Gets current value of property autoActivateSupply. If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically set to true on every unselect. Default value is |
getListOrder |
Gets current value of property listOrder. The order how the sublists of this attribute should be displayed. Default value is |
sap.ui.ux3.ExactAttribute.getMetadata |
Returns a metadata object for class sap.ui.ux3.ExactAttribute. |
getSelected |
Gets current value of property selected. Specifies whether the attribute shall be selected |
getShowSubAttributesIndicator |
Gets current value of property showSubAttributesIndicator. Specifies whether the attribute shall have sub values for visual purposes. The indicator which is a little arrow beside an attribute in the list is computed automatically (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute). In the case that a supply function is attached, and the supplyActive attribute has value 'true', then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is considered then and has to be maintained. If the back-end does not support count-calls, for example, showSubAttributesIndicator should be set to true. Default value is |
getShowSubAttributesIndicator_Computed |
See attribute showSubAttributesIndicator |
getSupplyActive |
Gets current value of property supplyActive. The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false. The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true. Default value is |
getText |
Gets current value of property text. The attribute name |
getWidth |
Gets current value of property width. Specifies the width of the corresponding list in pixels. The value must be between 70 and 500. Default value is |
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. |
scrollTo |
Scrolls the corresponding list of this attribute until the given direct child attribute is visible. If the corresponding list is not yet visible the call is buffered until the list is available. |
setAdditionalData |
Sets a new value for property additionalData. An example for additional data are database keys When called with a value of |
setAutoActivateSupply |
Sets a new value for property autoActivateSupply. If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically set to true on every unselect. When called with a value of Default value is |
setListOrder |
Sets a new value for property listOrder. The order how the sublists of this attribute should be displayed. When called with a value of Default value is |
setProperty |
References:
|
setSelected |
Sets a new value for property selected. Specifies whether the attribute shall be selected When called with a value of |
setShowSubAttributesIndicator |
Sets a new value for property showSubAttributesIndicator. Specifies whether the attribute shall have sub values for visual purposes. The indicator which is a little arrow beside an attribute in the list is computed automatically (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute). In the case that a supply function is attached, and the supplyActive attribute has value 'true', then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is considered then and has to be maintained. If the back-end does not support count-calls, for example, showSubAttributesIndicator should be set to true. When called with a value of Default value is |
setSupplyActive |
Sets a new value for property supplyActive. The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false. The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true. When called with a value of Default value is |
setText |
Sets a new value for property text. The attribute name When called with a value of |
setTooltip |
References:
|
setWidth |
Sets a new value for property width. Specifies the width of the corresponding list in pixels. The value must be between 70 and 500. When called with a value of Default value is |
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 supplyAttributes event of this sap.ui.ux3.ExactAttribute
.
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.ExactAttribute
itself.
A supply function is a handler which is attached to the supplyAttributes event. The event is fired when the corresponding ExactAttribute is selected, it was already selected when a handler is attached or function getAttributes() is called.
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 supplyAttributes event of this sap.ui.ux3.ExactAttribute
.
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.ExactAttribute 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.Element.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 supplyAttributes to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
attribute | sap.ui.ux3.ExactAttribute |
The ExactAttribute |
Gets current value of property additionalData.
An example for additional data are database keys
Gets current value of property autoActivateSupply.
If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically set to true on every unselect.
Default value is false
.
Gets current value of property listOrder.
The order how the sublists of this attribute should be displayed.
Default value is Select
.
Returns a metadata object for class sap.ui.ux3.ExactAttribute.
Gets current value of property selected.
Specifies whether the attribute shall be selected
Gets current value of property showSubAttributesIndicator.
Specifies whether the attribute shall have sub values for visual purposes. The indicator which is a little arrow beside an attribute in the list is computed automatically (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute). In the case that a supply function is attached, and the supplyActive attribute has value 'true', then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is considered then and has to be maintained. If the back-end does not support count-calls, for example, showSubAttributesIndicator should be set to true.
Default value is true
.
Gets current value of property supplyActive.
The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false. The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true.
Default value is true
.
Gets current value of property width.
Specifies the width of the corresponding list in pixels. The value must be between 70 and 500.
Default value is 168
.
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 |
Scrolls the corresponding list of this attribute until the given direct child attribute is visible. If the corresponding list is not yet visible the call is buffered until the list is available.
Param | Type | DefaultValue | Description |
---|---|---|---|
oOAttribute | sap.ui.ux3.ExactAttribute |
The direct child attribute |
Sets a new value for property additionalData.
An example for additional data are database keys
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
oAdditionalData | object |
New value for property |
Sets a new value for property autoActivateSupply.
If you want the supply function to be called on every select, you can set the autoActivateSupply attribute to true. In this case, supplyActive is automatically set to true on every unselect.
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 |
---|---|---|---|
bAutoActivateSupply | boolean | false |
New value for property |
Sets a new value for property listOrder.
The order how the sublists of this attribute 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 |
---|---|---|---|
sListOrder | sap.ui.ux3.ExactOrder | Select |
New value for property |
References:
Param | Type | DefaultValue | Description |
---|---|---|---|
sPropertyName | string | ||
oValue | object | ||
bSuppressRerendering | boolean |
Sets a new value for property selected.
Specifies whether the attribute shall be selected
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
bSelected | boolean |
New value for property |
Sets a new value for property showSubAttributesIndicator.
Specifies whether the attribute shall have sub values for visual purposes. The indicator which is a little arrow beside an attribute in the list is computed automatically (getShowSubAttributesIndicator_Computed() of sap.ui.ux3.ExactAttribute). In the case that a supply function is attached, and the supplyActive attribute has value 'true', then the Exact pattern needs a hint if sub attributes are available. The showSubAttributesIndicator attribute is considered then and has to be maintained. If the back-end does not support count-calls, for example, showSubAttributesIndicator should be set to true.
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 |
---|---|---|---|
bShowSubAttributesIndicator | boolean | true |
New value for property |
Sets a new value for property supplyActive.
The supplyAttributes event is only fired if supplyActive has value true which is the default. After firing the event, the attribute is automatically set to false. The idea is that a supply function is called only once when the data is requested. To enable the event again it is possible to manually set the attribute back to true.
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 |
---|---|---|---|
bSupplyActive | boolean | true |
New value for property |
Sets a new value for property text.
The attribute name
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string |
New value for property |
References:
Param | Type | DefaultValue | Description |
---|---|---|---|
oTooltip | string sap.ui.core.TooltipBase |
Sets a new value for property width.
Specifies the width of the corresponding 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 |
---|---|---|---|
iWidth | int | 168 |
New value for property |