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
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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(mArguments?)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.
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, 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, 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.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:
{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.38.
Event Detail
press(oControlEvent)
Event for the areas that can be clicked in an ImageMap
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{string}oControlEvent.getParameters.areaId Id 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:
{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.commons.ImageMap.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.ImageMap.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addArea(oArea): sap.ui.commons.ImageMap
Adds some area to the aggregation areas.
Parameters:
{sap.ui.commons.Area}oArea the area to add; if empty, nothing is inserted
Returns:
{sap.ui.commons.ImageMap} Reference 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:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.commons.ImageMap itself
Returns:
{sap.ui.commons.ImageMap} Reference 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:
{any}content Area content to add
Returns:
{sap.ui.commons.ImageMap}this to allow method chaining
destroyAreas(): sap.ui.commons.ImageMap
Destroys all the areas in the aggregation areas.
Returns:
{sap.ui.commons.ImageMap} Reference 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:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.commons.ImageMap} Reference to this in order to allow method chaining
firePress(mArguments?): sap.ui.commons.ImageMap
Fires event press to attached listeners.

Expects the following event parameters:

  • areaId of type stringId of clicked Area.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.commons.ImageMap} Reference 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:
{string} Value 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.Area}oArea The area whose index is looked for
Returns:
{int} The 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.Area}oArea the area to insert; if empty, nothing is inserted
{int}iIndex the 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.ImageMap} Reference 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.Area}vArea The areato remove or its index or id
Returns:
{sap.ui.commons.Area} The 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:
{string}sName New value for property name
Returns:
{sap.ui.commons.ImageMap} Reference to this in order to allow method chaining