Class sap.suite.ui.commons.RepeaterViewConfigurationModule: sap/suite/ui/commons/RepeaterViewConfiguration

extends Control

A configuration control defining how the content of the sap.suite.ui.commons.ViewRepeater control is displayed and what data is bound.

Deprecated API:Since version 1.32. Deprecated. Standard Fiori technology should be used.

Constructor Summary
new sap.suite.ui.commons.RepeaterViewConfiguration(sId?, mSettings?)Constructor for a new RepeaterViewConfiguration.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.suite.ui.commons.RepeaterViewConfiguration.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.suite.ui.commons.RepeaterViewConfiguration with name sClassName and enriches it with the information contained in oClassInfo.
sap.suite.ui.commons.RepeaterViewConfiguration.getMetadata()Returns a metadata object for class sap.suite.ui.commons.RepeaterViewConfiguration.
destroyExternalRepresentation()Destroys the externalRepresentation in the aggregation named externalRepresentation.
destroyTemplate()Destroys the template in the aggregation named template.
getExternal()Getter for property external.
getExternalRepresentation()Getter for aggregation externalRepresentation.
getIcon()Getter for property icon.
getIconHovered()Getter for property iconHovered.
getIconSelected()Getter for property iconSelected.
getItemHeight()Getter for property itemHeight.
getItemMinWidth()Getter for property itemMinWidth.
getNumberOfTiles()Getter for property numberOfTiles.
getPath()Getter for property path.
getResponsive()Getter for property responsive.
getTemplate()Getter for aggregation template.
getTitle()Getter for property title.
setExternal(bExternal)Setter for property external.
setExternalRepresentation(oExternalRepresentation)Setter for the aggregated externalRepresentation.
setIcon(sIcon)Setter for property icon.
setIconHovered(sIconHovered)Setter for property iconHovered.
setIconSelected(sIconSelected)Setter for property iconSelected.
setItemHeight(iItemHeight)Setter for property itemHeight.
setItemMinWidth(iItemMinWidth)Setter for property itemMinWidth.
setNumberOfTiles(iNumberOfTiles)Setter for property numberOfTiles.
setPath(sPath)Setter for property path.
setResponsive(oResponsive)Setter for property responsive.
setTemplate(oTemplate)Setter for the aggregated template.
setTitle(sTitle)Setter for property title.
Methods borrowed from class sap.ui.core.Control
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
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
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, 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.suite.ui.commons.RepeaterViewConfiguration(sId?, mSettings?)
Constructor for a new RepeaterViewConfiguration.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.

If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).

The supported settings are:

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.32. Deprecated. Standard Fiori technology should be used.
Method Detail
sap.suite.ui.commons.RepeaterViewConfiguration.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.suite.ui.commons.RepeaterViewConfiguration with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of informations as described in Element.extend.

Parameters:
{string}sClassName name of the class to be created
{object}oClassInfo? object literal with informations about the class
{function}FNMetaImpl? constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
Returns:
{function} the created class / constructor function
sap.suite.ui.commons.RepeaterViewConfiguration.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.suite.ui.commons.RepeaterViewConfiguration.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyExternalRepresentation(): sap.suite.ui.commons.RepeaterViewConfiguration
Destroys the externalRepresentation in the aggregation named externalRepresentation.
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
destroyTemplate(): sap.suite.ui.commons.RepeaterViewConfiguration
Destroys the template in the aggregation named template.
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
getExternal(): boolean
Getter for property external. Indicates if the external representation of this view is rendered instead of the row repeater's own content.

Default value is false

Returns:
{boolean} the value of property external
getExternalRepresentation(): sap.ui.core.Control
Getter for aggregation externalRepresentation.
The control to be rendered instead of sap.suite.ui.commons.ViewRepeater's own content. Only used if the "external" property is set to true. This allows you to create custom views, for example, Table views. The sap.suite.ui.commons.ViewRepeater control will share its model with this control if the control does not have its own model.
Returns:
{sap.ui.core.Control}
getIcon(): sap.ui.core.URI
Getter for property icon. A path to the icon representing this view in sap.suite.ui.commons.ViewRepeater view selector.

Default value is empty/undefined

Returns:
{sap.ui.core.URI} the value of property icon
getIconHovered(): sap.ui.core.URI
Getter for property iconHovered. A path to the icon representing this view in sap.suite.ui.commons.ViewRepeater view selector when the regular icon is hovered.

Default value is empty/undefined

Returns:
{sap.ui.core.URI} the value of property iconHovered
getIconSelected(): sap.ui.core.URI
Getter for property iconSelected. A path to the icon representing this view in sap.suite.ui.commons.ViewRepeater view selector when the regular icon is selected.

Default value is empty/undefined

Returns:
{sap.ui.core.URI} the value of property iconSelected
getItemHeight(): int
Getter for property itemHeight. The height of the tile in this view in pixels. Only applicable if the responsive property is set to true. This value is used for calculating the number of tile rows.

Default value is empty/undefined

Returns:
{int} the value of property itemHeight
getItemMinWidth(): int
Getter for property itemMinWidth. The minimal width of the tile in this view. Only applicable if "responsive" property is set to true.

Default value is -1

Returns:
{int} the value of property itemMinWidth
getNumberOfTiles(): int
Getter for property numberOfTiles. The number of tiles/rows that will be shown on a single page in this view.

Default value is -1

Returns:
{int} the value of property numberOfTiles
getPath(): string
Getter for property path. A path used for rows/titles data binding.

Default value is empty/undefined

Returns:
{string} the value of property path
getResponsive(): any
Getter for property responsive. This parameter indicates whether the content is shown in rows or tiles. If false, the content is shown in rows just like in core sap.ui.commons.RowRepeater. If true, the content is shown in tiles (similar to sap.ui.ux3.DataSet control) that have minimal width defined by the "itemMinWidth" property. The number of columns depends on the parent control's width. If you resize the control, the number of columns may change respectively so that the content tiles can fill the entire space of a row.

Default value is false

Returns:
{any} the value of property responsive
getTemplate(): sap.ui.core.Control
Getter for aggregation template.
The control used as a template while displaying rows/tiles in this view. It should not have fixed width wider than defined by the "itemMinWidth" property, otherwise some content may appear cropped.
Returns:
{sap.ui.core.Control}
getTitle(): string
Getter for property title. The title of the view to be displayed in sap.suite.ui.commons.ViewRepeater view selector. If neither this nor "icon" property are defined, the default title "View ##" will be shown, where ## is an index number of the view in View Repeater starting from 1.

Default value is empty/undefined

Returns:
{string} the value of property title
setExternal(bExternal): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property external.

Default value is false

Parameters:
{boolean}bExternal new value for property external
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setExternalRepresentation(oExternalRepresentation): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for the aggregated externalRepresentation.
Parameters:
{sap.ui.core.Control}oExternalRepresentation
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setIcon(sIcon): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property icon.

Default value is empty/undefined

Parameters:
{sap.ui.core.URI}sIcon new value for property icon
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setIconHovered(sIconHovered): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property iconHovered.

Default value is empty/undefined

Parameters:
{sap.ui.core.URI}sIconHovered new value for property iconHovered
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setIconSelected(sIconSelected): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property iconSelected.

Default value is empty/undefined

Parameters:
{sap.ui.core.URI}sIconSelected new value for property iconSelected
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setItemHeight(iItemHeight): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property itemHeight.

Default value is empty/undefined

Parameters:
{int}iItemHeight new value for property itemHeight
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setItemMinWidth(iItemMinWidth): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property itemMinWidth.

Default value is -1

Parameters:
{int}iItemMinWidth new value for property itemMinWidth
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setNumberOfTiles(iNumberOfTiles): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property numberOfTiles.

Default value is -1

Parameters:
{int}iNumberOfTiles new value for property numberOfTiles
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setPath(sPath): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property path.

Default value is empty/undefined

Parameters:
{string}sPath new value for property path
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setResponsive(oResponsive): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property responsive.

Default value is false

Parameters:
{any}oResponsive new value for property responsive
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setTemplate(oTemplate): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for the aggregated template.
Parameters:
{sap.ui.core.Control}oTemplate
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining
setTitle(sTitle): sap.suite.ui.commons.RepeaterViewConfiguration
Setter for property title.

Default value is empty/undefined

Parameters:
{string}sTitle new value for property title
Returns:
{sap.suite.ui.commons.RepeaterViewConfiguration}this to allow method chaining