Class sap.ui.vbm.AreasModule: sap/ui/vbm/Areas

extends VoAggregation

Type specific Visual Object aggregation for Area instances.

Constructor Summary
new sap.ui.vbm.Areas(sId?, mSettings?)Constructor for a new Areas.
Event Summary
edgeClick(oControlEvent)This event is raised when the edge of an Area is clicked.
edgeContextMenu(oControlEvent)This event is raised when the edge of an Area is right clicked.
Events borrowed from class sap.ui.vbm.VoAggregation
click, contextMenu, deselect, drop, handleClick, handleContextMenu, handleMoved, select
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Areas.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Areas with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Areas.getMetadata()Returns a metadata object for class sap.ui.vbm.Areas.
addItem(oItem)Adds some item to the aggregation items.
attachEdgeClick(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the edgeClick event of this sap.ui.vbm.Areas.
attachEdgeContextMenu(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the edgeContextMenu event of this sap.ui.vbm.Areas.
destroyItems()Destroys all the items in the aggregation items.
detachEdgeClick(fnFunction, oListener)Detaches event handler fnFunction from the edgeClick event of this sap.ui.vbm.Areas.
detachEdgeContextMenu(fnFunction, oListener)Detaches event handler fnFunction from the edgeContextMenu event of this sap.ui.vbm.Areas.
fireEdgeClick(mArguments?)Fires event edgeClick to attached listeners.
fireEdgeContextMenu(mArguments?)Fires event edgeContextMenu to attached listeners.
getItems()Gets content of aggregation items.
getPosChangeable()Gets current value of property posChangeable.
indexOfItem(oItem)Checks for the provided sap.ui.vbm.Area in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setPosChangeable(bPosChangeable)Sets a new value for property posChangeable.
Methods borrowed from class sap.ui.vbm.VoAggregation
attachClick, attachContextMenu, attachDeselect, attachDrop, attachHandleClick, attachHandleContextMenu, attachHandleMoved, attachSelect, detachClick, detachContextMenu, detachDeselect, detachDrop, detachHandleClick, detachHandleContextMenu, detachHandleMoved, detachSelect, fireClick, fireContextMenu, fireDeselect, fireDrop, fireHandleClick, fireHandleContextMenu, fireHandleMoved, fireSelect, getCustomProperties, getMaxSel, getMinSel, openDetailWindow, setCustomProperties, setMaxSel, setMinSel
Methods borrowed from class sap.ui.vbm.VoAbstract
openContextMenu
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.Areas(sId?, mSettings?)
Constructor for a new Areas.

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
    • items : sap.ui.vbm.Area[] (default)
  • Events
    • edgeClick : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • edgeContextMenu : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.vbm.VoAggregation 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
edgeClick(oControlEvent)
This event is raised when the edge of an Area is clicked.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.vbm.Area}oControlEvent.getParameters.instance Clicked instance
{int}oControlEvent.getParameters.edge The number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0
edgeContextMenu(oControlEvent)
This event is raised when the edge of an Area is right clicked.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{sap.ui.vbm.Area}oControlEvent.getParameters.instance Clicked instance
{int}oControlEvent.getParameters.edge The number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0
Method Detail
sap.ui.vbm.Areas.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Areas 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.vbm.VoAggregation.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.Areas.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Areas.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.vbm.Areas
Adds some item to the aggregation items.
Parameters:
{sap.ui.vbm.Area}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining
attachEdgeClick(oData?, fnFunction, oListener?): sap.ui.vbm.Areas
Attaches event handler fnFunction to the edgeClick event of this sap.ui.vbm.Areas.

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.Areas itself.

This event is raised when the edge of an Area is clicked.

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

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.Areas itself.

This event is raised when the edge of an Area is right clicked.

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.Areas itself
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining
destroyItems(): sap.ui.vbm.Areas
Destroys all the items in the aggregation items.
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining
detachEdgeClick(fnFunction, oListener): sap.ui.vbm.Areas
Detaches event handler fnFunction from the edgeClick event of this sap.ui.vbm.Areas.

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

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.Areas} Reference to this in order to allow method chaining
fireEdgeClick(mArguments?): sap.ui.vbm.Areas
Fires event edgeClick to attached listeners.

Expects the following event parameters:

  • instance of type sap.ui.vbm.AreaClicked instance
  • edge of type intThe number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining
fireEdgeContextMenu(mArguments?): sap.ui.vbm.Areas
Fires event edgeContextMenu to attached listeners.

Expects the following event parameters:

  • instance of type sap.ui.vbm.AreaClicked instance
  • edge of type intThe number of the edge where the click occured. Edges are numbered zero based: e.g. edge from point 1 to point 2 has number 0
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining
getItems(): sap.ui.vbm.Area[]
Gets content of aggregation items.

Area object aggregation

Returns:
{sap.ui.vbm.Area[]}
getPosChangeable(): boolean
Gets current value of property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

Returns:
{boolean} Value of property posChangeable
indexOfItem(oItem): int
Checks for the provided sap.ui.vbm.Area in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.Area}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.vbm.Areas
Inserts a item into the aggregation items.
Parameters:
{sap.ui.vbm.Area}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.vbm.Area[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.Area[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.vbm.Area
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.vbm.Area}vItem The itemto remove or its index or id
Returns:
{sap.ui.vbm.Area} The removed item or null
setPosChangeable(bPosChangeable): sap.ui.vbm.Areas
Sets a new value for property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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

Default value is true.

Parameters:
{boolean}bPosChangeable New value for property posChangeable
Returns:
{sap.ui.vbm.Areas} Reference to this in order to allow method chaining