QuickViewGroupElement

QuickViewGroupElement is a combination of one label and another control (Link or Text) associated to this label.

Since: 1.28.11.

Constructor Summary

new sap.m.QuickViewGroupElement(sId?, mSettings?)Constructor for a new QuickViewGroupElement.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.m.QuickViewGroupElement.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.QuickViewGroupElement with name sClassName and enriches it with the information contained in oClassInfo.

sap.m.QuickViewGroupElement.getMetadata()Returns a metadata object for class sap.m.QuickViewGroupElement.

getEmailSubject()Gets current value of property emailSubject.

getLabel()Gets current value of property label.

getPageLinkId()Gets current value of property pageLinkId.

getTarget()Gets current value of property target.

getType()Gets current value of property type.

getUrl()Gets current value of property url.

getValue()Gets current value of property value.

getVisible()Gets current value of property visible.

setEmailSubject(sEmailSubject)Sets a new value for property emailSubject.

setLabel(sLabel)Sets a new value for property label.

setPageLinkId(sPageLinkId)Sets a new value for property pageLinkId.

setTarget(sTarget)Sets a new value for property target.

setType(sType)Sets a new value for property type.

setUrl(sUrl)Sets a new value for property url.

setValue(sValue)Sets a new value for property value.

setVisible(bVisible)Sets a new value for property visible.

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

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, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.m.QuickViewGroupElement(sId?, mSettings?)

Constructor for a new QuickViewGroupElement.

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
- visible : boolean (default: true)
- label : string (default: )
- value : string (default: )
- url : string (default: )
- target : string (default: _blank)
- type : sap.m.QuickViewGroupElementType (default: GroupElementType.text)
- pageLinkId : string (default: )
- emailSubject : string (default: )

In addition, all settings applicable to the base type sap.ui.core.Element 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

Method Detail

sap.m.QuickViewGroupElement.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.m.QuickViewGroupElement 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.

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.m.QuickViewGroupElement.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.m.QuickViewGroupElement.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getEmailSubject(): string

Gets current value of property emailSubject.

The subject of the email. Works only with QuickViewGroupElement of type email.

Default value is .

Returns:

{string} Value of property emailSubject

getLabel(): string

Gets current value of property label.

Specifies the text displayed below the associated label.

Default value is .

Returns:

{string} Value of property label

getPageLinkId(): string

Gets current value of property pageLinkId.

Specifies the ID of the QuickViewPage, which is opened from the link in the QuickViewGroupElement. Works only with QuickViewGroupElement of type pageLink.

Default value is .

Returns:

{string} Value of property pageLinkId

getTarget(): string

Gets current value of property target.

Specifies the target of the link – it works like the target property of the HTML tag. Works only with QuickViewGroupElement of type link.

Default value is _blank.

Returns:

{string} Value of property target

getType(): sap.m.QuickViewGroupElementType

Gets current value of property type.

Specifies the type of the displayed information – phone number, mobile number, e-mail, link, text or a link to another QuickViewPage. Default value is ‘text’.

Default value is GroupElementType.text.

Returns:

{sap.m.QuickViewGroupElementType} Value of property type

getUrl(): string

Gets current value of property url.

Specifies the address of the QuickViewGroupElement link. Works only with QuickViewGroupElement of type link.

Default value is .

Returns:

{string} Value of property url

getValue(): string

Gets current value of property value.

Specifies the text of the control that associates with the label.

Default value is .

Returns:

{string} Value of property value

getVisible(): boolean

Gets current value of property visible.

Determines whether the element should be visible on the screen.

Default value is true.

Returns:

{boolean} Value of property visible

setEmailSubject(sEmailSubject): sap.m.QuickViewGroupElement

Sets a new value for property emailSubject.

The subject of the email. Works only with QuickViewGroupElement of type email.

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

Default value is .

Parameters:

{string} sEmailSubject New value for property emailSubject

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setLabel(sLabel): sap.m.QuickViewGroupElement

Sets a new value for property label.

Specifies the text displayed below the associated label.

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

Default value is .

Parameters:

{string} sLabel New value for property label

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setPageLinkId(sPageLinkId): sap.m.QuickViewGroupElement

Sets a new value for property pageLinkId.

Specifies the ID of the QuickViewPage, which is opened from the link in the QuickViewGroupElement. Works only with QuickViewGroupElement of type pageLink.

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

Default value is .

Parameters:

{string} sPageLinkId New value for property pageLinkId

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setTarget(sTarget): sap.m.QuickViewGroupElement

Sets a new value for property target.

Specifies the target of the link – it works like the target property of the HTML tag. Works only with QuickViewGroupElement of type link.

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

Default value is _blank.

Parameters:

{string} sTarget New value for property target

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setType(sType): sap.m.QuickViewGroupElement

Sets a new value for property type.

Specifies the type of the displayed information – phone number, mobile number, e-mail, link, text or a link to another QuickViewPage. Default value is ‘text’.

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

Default value is GroupElementType.text.

Parameters:

{sap.m.QuickViewGroupElementType} sType New value for property type

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setUrl(sUrl): sap.m.QuickViewGroupElement

Sets a new value for property url.

Specifies the address of the QuickViewGroupElement link. Works only with QuickViewGroupElement of type link.

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

Default value is .

Parameters:

{string} sUrl New value for property url

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setValue(sValue): sap.m.QuickViewGroupElement

Sets a new value for property value.

Specifies the text of the control that associates with the label.

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

Default value is .

Parameters:

{string} sValue New value for property value

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining

setVisible(bVisible): sap.m.QuickViewGroupElement

Sets a new value for property visible.

Determines whether the element should be visible on the screen.

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

Default value is true.

Parameters:

{boolean} bVisible New value for property visible

Returns:

{sap.m.QuickViewGroupElement} Reference to this in order to allow method chaining