Class sap.ui.test.matchers.AggregationContainsPropertyEqualModule: sap/ui/test/matchers/AggregationContainsPropertyEqual

extends Matcher

AggregationContainsPropertyEqual - checks if an aggregation contains at least one item that has a Property set to a certain value


Since: 1.23.
Constructor Summary
new sap.ui.test.matchers.AggregationContainsPropertyEqual(mSettings?)AggregationContainsPropertyEqual - checks if an aggregation contains at least one item that has a Property set to a certain value.
Method Summary
sap.ui.test.matchers.AggregationContainsPropertyEqual.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.test.matchers.AggregationContainsPropertyEqual with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.test.matchers.AggregationContainsPropertyEqual.getMetadata()Returns a metadata object for class sap.ui.test.matchers.AggregationContainsPropertyEqual.
getAggregationName()Gets current value of property aggregationName.
getPropertyName()Gets current value of property propertyName.
getPropertyValue()Gets current value of property propertyValue.
isMatching(oControl)Checks if the control has a filled aggregation with at least one control that have a property equaling propertyName/Value.
setAggregationName(sAggregationName)Sets a new value for property aggregationName.
setPropertyName(sPropertyName)Sets a new value for property propertyName.
setPropertyValue(oPropertyValue)Sets a new value for property propertyValue.
Methods borrowed from class sap.ui.base.Object
Constructor Detail
new sap.ui.test.matchers.AggregationContainsPropertyEqual(mSettings?)
AggregationContainsPropertyEqual - checks if an aggregation contains at least one item that has a Property set to a certain value.

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.test.matchers.Matcher can be used as well.

Parameters:
{object}mSettings? optional map/JSON-object with initial settings for the new AggregationContainsPropertyEqualMatcher
Method Detail
sap.ui.test.matchers.AggregationContainsPropertyEqual.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.test.matchers.AggregationContainsPropertyEqual 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.test.matchers.Matcher.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
sap.ui.test.matchers.AggregationContainsPropertyEqual.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.test.matchers.AggregationContainsPropertyEqual.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getAggregationName(): string
Gets current value of property aggregationName.

The Name of the aggregation that is used for matching.

Returns:
{string} Value of property aggregationName
getPropertyName(): string
Gets current value of property propertyName.

The Name of the property that is used for matching.

Returns:
{string} Value of property propertyName
getPropertyValue(): any
Gets current value of property propertyValue.

The value of the Property that is used for matching.

Returns:
{any} Value of property propertyValue
isMatching(oControl): boolean
Checks if the control has a filled aggregation with at least one control that have a property equaling propertyName/Value.
Parameters:
{sap.ui.core.Control}oControl the control that is checked by the matcher
Returns:
{boolean} true if the Aggregation set in the property aggregationName is filled, false if it is not.
setAggregationName(sAggregationName): sap.ui.test.matchers.AggregationContainsPropertyEqual
Sets a new value for property aggregationName.

The Name of the aggregation that is used for matching.

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

Parameters:
{string}sAggregationName New value for property aggregationName
Returns:
{sap.ui.test.matchers.AggregationContainsPropertyEqual} Reference to this in order to allow method chaining
Sets a new value for property propertyName.

The Name of the property that is used for matching.

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

Parameters:
{string}sPropertyName New value for property propertyName
Returns:
{sap.ui.test.matchers.AggregationContainsPropertyEqual} Reference to this in order to allow method chaining
Sets a new value for property propertyValue.

The value of the Property that is used for matching.

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

Parameters:
{any}oPropertyValue New value for property propertyValue
Returns:
{sap.ui.test.matchers.AggregationContainsPropertyEqual} Reference to this in order to allow method chaining