Class sap.ca.ui.ZoomableScrollContainerModule: sap/ca/ui/ZoomableScrollContainer


Based on a ScrollContainer, it allows you to pinch and zoom on mobile devices

Deprecated API:Since version 1.22.

ZoomableScrollContainer is used in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.

Constructor Summary
new sap.ca.ui.ZoomableScrollContainer(sId?, mSettings?)Constructor for a new ZoomableScrollContainer.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ca.ui.ZoomableScrollContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ca.ui.ZoomableScrollContainer with name sClassName and enriches it with the information contained in oClassInfo.
sap.ca.ui.ZoomableScrollContainer.getMetadata()Returns a metadata object for class sap.ca.ui.ZoomableScrollContainer.
getInitialScale()Getter for property initialScale.
getMaxScale()Getter for property maxScale.
getMinScale()Getter for property minScale.
getZoomable()Getter for property zoomable.
setInitialScale(fInitialScale)Setter for property initialScale.
setMaxScale(fMaxScale)Setter for property maxScale.
setMinScale(fMinScale)Setter for property minScale.
setZoomable(bZoomable)Setter for property zoomable.
Constructor Detail
new sap.ca.ui.ZoomableScrollContainer(sId?, mSettings?)
Constructor for a new ZoomableScrollContainer.

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:

In addition, all settings applicable to the base type sap.m.ScrollContainer 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
Deprecated:
Since version 1.22.

ZoomableScrollContainer is used in PictureViewer control and is not meant to be consumed outside of PictureViewer usage. PictureViewer was replacing the Carousel as it wasn't supporting some versions of MS Internet Explorer. Now, the sap.m.Carousel is fully functional, please use sap.m.Carousel instead. This control will not be supported anymore.

Method Detail
sap.ca.ui.ZoomableScrollContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ca.ui.ZoomableScrollContainer 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.ca.ui.ZoomableScrollContainer.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ca.ui.ZoomableScrollContainer.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getInitialScale(): float
Getter for property initialScale. Initial scaling factor

Default value is 1

Returns:
{float} the value of property initialScale
getMaxScale(): float
Getter for property maxScale. Highest scaling factor allowed

Default value is 4

Returns:
{float} the value of property maxScale
getMinScale(): float
Getter for property minScale. Lowest scaling factor allowed

Default value is 1

Returns:
{float} the value of property minScale
getZoomable(): boolean
Getter for property zoomable. Activate or not the zooming functionality. If FALSE, it acts exactly as a basic ScrollContainer.

Default value is true

Returns:
{boolean} the value of property zoomable
setInitialScale(fInitialScale): sap.ca.ui.ZoomableScrollContainer
Setter for property initialScale.

Default value is 1

Parameters:
{float}fInitialScale new value for property initialScale
Returns:
{sap.ca.ui.ZoomableScrollContainer}this to allow method chaining
setMaxScale(fMaxScale): sap.ca.ui.ZoomableScrollContainer
Setter for property maxScale.

Default value is 4

Parameters:
{float}fMaxScale new value for property maxScale
Returns:
{sap.ca.ui.ZoomableScrollContainer}this to allow method chaining
setMinScale(fMinScale): sap.ca.ui.ZoomableScrollContainer
Setter for property minScale.

Default value is 1

Parameters:
{float}fMinScale new value for property minScale
Returns:
{sap.ca.ui.ZoomableScrollContainer}this to allow method chaining
setZoomable(bZoomable): sap.ca.ui.ZoomableScrollContainer
Setter for property zoomable.

Default value is true

Parameters:
{boolean}bZoomable new value for property zoomable
Returns:
{sap.ca.ui.ZoomableScrollContainer}this to allow method chaining