Class sap.ui.vbm.FeatureModule: sap/ui/vbm/Feature

extends Element

The Feature element can be added to the items aggregation of a FeatureCollection. By matching the id it allows to redefine the color of a GeoJSON feature and adds interactivity.

Constructor Summary
new sap.ui.vbm.Feature(sId?, mSettings?)Constructor for a new Feature.
Event Summary
click(oControlEvent)The event is raised when there is a click action on a Feature.
contextMenu(oControlEvent)The event is raised when there is a right click or a tap and hold action on a Feature.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Feature.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Feature with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Feature.getMetadata()Returns a metadata object for class sap.ui.vbm.Feature.
attachClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the click event of this sap.ui.vbm.Feature.
attachContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.Feature.
detachClick(fnFunction, oListener)Detaches event handler fnFunction from the click event of this sap.ui.vbm.Feature.
detachContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.Feature.
fireClick(mArguments?)Fires event click to attached listeners.
fireContextMenu(mArguments?)Fires event contextMenu to attached listeners.
getColor()Gets current value of property color.
getFeatureId()Gets current value of property featureId.
openContextMenu(oMenu)Open the context menu
openDetailWindow(sCaption, sOffsetX, sOffsetY)Open a Detail Window for the Feature at click position
setColor(sColor)Sets a new value for property color.
setFeatureId(sFeatureId)Sets a new value for property featureId.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, 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, rerender, 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, 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.vbm.Feature(sId?, mSettings?)
Constructor for a new Feature.

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
  • Events
    • click : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • contextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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
Event Detail
click(oControlEvent)
The event is raised when there is a click action on a Feature.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
contextMenu(oControlEvent)
The event is raised when there is a right click or a tap and hold action on a Feature.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.unified.Menu}oControlEvent.getParameters.menu Menu object to be used with openContextMenu().
Method Detail
sap.ui.vbm.Feature.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Feature 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.vbm.Feature.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Feature.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
attachClick(oData?, fnFunction, oListener?): sap.ui.vbm.Feature
Attaches event handler fnFunction to the click event of this sap.ui.vbm.Feature.

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.vbm.Feature itself.

The event is raised when there is a click action on a Feature.

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.vbm.Feature itself
Returns:
{sap.ui.vbm.Feature} Reference to this in order to allow method chaining
attachContextMenu(oData?, fnFunction, oListener?): sap.ui.vbm.Feature
Attaches event handler fnFunction to the contextMenu event of this sap.ui.vbm.Feature.

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.vbm.Feature itself.

The event is raised when there is a right click or a tap and hold action on a Feature.

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.vbm.Feature itself
Returns:
{sap.ui.vbm.Feature} Reference to this in order to allow method chaining
detachClick(fnFunction, oListener): sap.ui.vbm.Feature
Detaches event handler fnFunction from the click event of this sap.ui.vbm.Feature.

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.vbm.Feature} Reference to this in order to allow method chaining
detachContextMenu(fnFunction, oListener): sap.ui.vbm.Feature
Detaches event handler fnFunction from the contextMenu event of this sap.ui.vbm.Feature.

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.vbm.Feature} Reference to this in order to allow method chaining
fireClick(mArguments?): sap.ui.vbm.Feature
Fires event click to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.Feature} Reference to this in order to allow method chaining
fireContextMenu(mArguments?): sap.ui.vbm.Feature
Fires event contextMenu to attached listeners.

Expects the following event parameters:

  • menu of type sap.ui.unified.MenuMenu object to be used with openContextMenu().
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.Feature} Reference to this in order to allow method chaining
getColor(): sap.ui.core.CSSColor
Gets current value of property color.

The color, this should be provided in the rgba(r,g,b,a) format.

Returns:
{sap.ui.core.CSSColor} Value of property color
getFeatureId(): string
Gets current value of property featureId.

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

Returns:
{string} Value of property featureId
openContextMenu(oMenu): void
Open the context menu
Parameters:
{object}oMenu the context menu to be opened
openDetailWindow(sCaption, sOffsetX, sOffsetY): void
Open a Detail Window for the Feature at click position
Parameters:
{string}sCaption caption of detail window
{string}sOffsetX position offset in x-direction from the anchor point
{string}sOffsetY position offset in y-direction from the anchor point
setColor(sColor): sap.ui.vbm.Feature
Sets a new value for property color.

The color, this should be provided in the rgba(r,g,b,a) format.

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

Parameters:
{sap.ui.core.CSSColor}sColor New value for property color
Returns:
{sap.ui.vbm.Feature} Reference to this in order to allow method chaining
setFeatureId(sFeatureId): sap.ui.vbm.Feature
Sets a new value for property featureId.

The Feature ID. Used to match with the feature in the GeoJSON given to the parent (FeatureCollection).

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

Parameters:
{string}sFeatureId New value for property featureId
Returns:
{sap.ui.vbm.Feature} Reference to this in order to allow method chaining