Class sap.ui.commons.ImageMapModule: sap/ui/commons/ImageMap

extends Control

Combination of image areas where at runtime these areas are starting points for hyperlinks or actions
Deprecated API:
Since version 1.38.
Constructor Summary
new sap.ui.commons.ImageMap(sId?, mSettings?)Constructor for a new ImageMap.
Event Summary
press(oControlEvent)Event for the areas that can be clicked in an ImageMap
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.ImageMap.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.ImageMap with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.ImageMap.getMetadata()Returns a metadata object for class sap.ui.commons.ImageMap.
addArea(oArea)Adds some area to the aggregation areas.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.ui.commons.ImageMap.
createArea(content)Adds areas to the Image Map.
destroyAreas()Destroys all the areas in the aggregation areas.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.ui.commons.ImageMap.
firePress(mParameters?)Fires event press to attached listeners.
getAreas()Gets content of aggregation areas.
getName()Gets current value of property name.
indexOfArea(oArea)Checks for the provided sap.ui.commons.Area in the aggregation areas.
insertArea(oArea, iIndex)Inserts a area into the aggregation areas.
removeAllAreas()Removes all the controls from the aggregation areas.
removeArea(vArea)Removes a area from the aggregation areas.
setName(sName)Sets a new value for property name.
Constructor Detail
new sap.ui.commons.ImageMap(sId?, mSettings?)

Constructor for a new ImageMap.

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

  • Aggregations

    • areas : sap.ui.commons.Area[]

  • Events

    • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
press(oControlEvent)
Event for the areas that can be clicked in an ImageMap
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.areaIdId of clicked Area.
Method Detail
sap.ui.commons.ImageMap.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.ImageMap 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.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.ImageMap.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.ImageMap.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addArea(oArea): sap.ui.commons.ImageMap
Adds some area to the aggregation areas.
Parameters:
sap.ui.commons.AreaoAreathe area to add; if empty, nothing is inserted
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining
attachPress(oData?, fnFunction, oListener?): sap.ui.commons.ImageMap

Attaches event handler fnFunction to the press event of this sap.ui.commons.ImageMap.

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.commons.ImageMap itself.

Event for the areas that can be clicked in an ImageMap

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.commons.ImageMap itself
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining
createArea(content): sap.ui.commons.ImageMap

Adds areas to the Image Map.

Each argument must be either a JSon object or a list of objects or the area element or elements.

Parameters:
anycontentArea content to add
Returns:
sap.ui.commons.ImageMapthis to allow method chaining
destroyAreas(): sap.ui.commons.ImageMap
Destroys all the areas in the aggregation areas.
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.ui.commons.ImageMap

Detaches event handler fnFunction from the press event of this sap.ui.commons.ImageMap.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining
firePress(mParameters?): sap.ui.commons.ImageMap
Fires event press to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.areaId?Id of clicked Area.
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining
getAreas(): sap.ui.commons.Area[]

Gets content of aggregation areas.

Area representing the reference to the target location

Returns:
sap.ui.commons.Area[]
getName(): string

Gets current value of property name.

Name for the image that serves as reference

Returns:
stringValue of property name
indexOfArea(oArea): int
Checks for the provided sap.ui.commons.Area in the aggregation areas. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.commons.AreaoAreaThe area whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertArea(oArea, iIndex): sap.ui.commons.ImageMap
Inserts a area into the aggregation areas.
Parameters:
sap.ui.commons.AreaoAreathe area to insert; if empty, nothing is inserted
intiIndexthe 0-based index the area should be inserted at; for a negative value of iIndex, the area is inserted at position 0; for a value greater than the current size of the aggregation, the area is inserted at the last position
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining
removeAllAreas(): sap.ui.commons.Area[]

Removes all the controls from the aggregation areas.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.commons.Area[]An array of the removed elements (might be empty)
removeArea(vArea): sap.ui.commons.Area
Removes a area from the aggregation areas.
Parameters:
int|string|sap.ui.commons.AreavAreaThe area to remove or its index or id
Returns:
sap.ui.commons.AreaThe removed area or null
setName(sName): sap.ui.commons.ImageMap

Sets a new value for property name.

Name for the image that serves as reference

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

Parameters:
stringsNameNew value for property name
Returns:
sap.ui.commons.ImageMapReference to this in order to allow method chaining