Area

extends Element

Used for defining areas in an image map. At runtime, the user can trigger an action, or start a URL, from the single image areas.

Deprecated API:Since version 1.38.

Constructor Summary

new sap.ui.commons.Area(sId?, mSettings?)Constructor for a new Area.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

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

sap.ui.commons.Area.getMetadata()Returns a metadata object for class sap.ui.commons.Area.

getAlt()Gets current value of property alt.

getCoords()Gets current value of property coords.

getHref()Gets current value of property href.

getShape()Gets current value of property shape.

setAlt(sAlt)Sets a new value for property alt.

setCoords(sCoords)Sets a new value for property coords.

setHref(sHref)Sets a new value for property href.

setShape(sShape)Sets a new value for property shape.

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.ui.commons.Area(sId?, mSettings?)

Constructor for a new Area.

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
- shape : string
- coords : string
- href : sap.ui.core.URI
- alt : string

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

Deprecated:
Since version 1.38.

Method Detail

sap.ui.commons.Area.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.Area 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.ui.commons.Area.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.commons.Area.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getAlt(): string

Gets current value of property alt.

Alternative text that is displayed in the case the image is not available

Returns:

{string} Value of property alt

getCoords(): string

Gets current value of property coords.

Coordinates of the area

Returns:

{string} Value of property coords

getHref(): sap.ui.core.URI

Gets current value of property href.

Hyper link that is executed when the area is clicked

Returns:

{sap.ui.core.URI} Value of property href

getShape(): string

Gets current value of property shape.

The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default.

Returns:

{string} Value of property shape

setAlt(sAlt): sap.ui.commons.Area

Sets a new value for property alt.

Alternative text that is displayed in the case the image is not available

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

Parameters:

{string} sAlt New value for property alt

Returns:

{sap.ui.commons.Area} Reference to this in order to allow method chaining

setCoords(sCoords): sap.ui.commons.Area

Sets a new value for property coords.

Coordinates of the area

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

Parameters:

{string} sCoords New value for property coords

Returns:

{sap.ui.commons.Area} Reference to this in order to allow method chaining

setHref(sHref): sap.ui.commons.Area

Sets a new value for property href.

Hyper link that is executed when the area is clicked

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

Parameters:

{sap.ui.core.URI} sHref New value for property href

Returns:

{sap.ui.commons.Area} Reference to this in order to allow method chaining

setShape(sShape): sap.ui.commons.Area

Sets a new value for property shape.

The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default.

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

Parameters:

{string} sShape New value for property shape

Returns:

{sap.ui.commons.Area} Reference to this in order to allow method chaining