Class sap.ui.vbm.BoxModule: sap/ui/vbm/Box

extends VoBase

Specific Visual Object element for a Box. A Box is a rectangle, which is positioned with its centerpoint at the given position. The ratio between width and height can be controlled with property scale. Depending on the property fxsize a box has an absolute or relative size.
Since the actual size of a box may depend on the zoom level it might be only partly visible. Thus detail windows will open at the click position.

Constructor Summary
new sap.ui.vbm.Box(sId?, mSettings?)Constructor for a new Box.
Events borrowed from class sap.ui.vbm.VoBase
click, contextMenu, drop, handleClick, handleContextMenu, handleMoved
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Box.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Box with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Box.getMetadata()Returns a metadata object for class sap.ui.vbm.Box.
getColor()Gets current value of property color.
getColorBorder()Gets current value of property colorBorder.
getPosition()Gets current value of property position.
getScale()Gets current value of property scale.
setColor(sColor)Sets a new value for property color.
setColorBorder(sColorBorder)Sets a new value for property colorBorder.
setPosition(sPosition)Sets a new value for property position.
setScale(sScale)Sets a new value for property scale.
Methods borrowed from class sap.ui.vbm.VoBase
attachClick, attachContextMenu, attachDrop, attachHandleClick, attachHandleContextMenu, attachHandleMoved, detachClick, detachContextMenu, detachDrop, detachHandleClick, detachHandleContextMenu, detachHandleMoved, fireClick, fireContextMenu, fireDrop, fireHandleClick, fireHandleContextMenu, fireHandleMoved, getChangeable, getDragData, getEntity, getFxdir, getFxsize, getHotDeltaColor, getHotScale, getKey, getLabelArrow, getLabelBgColor, getLabelBorderColor, getLabelPos, getLabelText, getLabelType, getSelect, getSelectColor, openContextMenu, openDetailWindow, setChangeable, setDragData, setEntity, setFxdir, setFxsize, setHotDeltaColor, setHotScale, setKey, setLabelArrow, setLabelBgColor, setLabelBorderColor, setLabelPos, setLabelText, setLabelType, setSelect, setSelectColor
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.Box(sId?, mSettings?)
Constructor for a new Box.

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
    • position : string (default: 0;0;0)
    • scale : string (default: 1;1;1)
    • color : string (default: RGB(255;0;0))
    • colorBorder : string (default: RGB(255;0;0))

In addition, all settings applicable to the base type sap.ui.vbm.VoBase 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
Method Detail
sap.ui.vbm.Box.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Box 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.VoBase.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.Box.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Box.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getColor(): string
Gets current value of property color.

The color of the box.

Default value is RGB(255;0;0).

Returns:
{string} Value of property color
getColorBorder(): string
Gets current value of property colorBorder.

The border color of the box.

Default value is RGB(255;0;0).

Returns:
{string} Value of property colorBorder
getPosition(): string
Gets current value of property position.

The position of the Box. The format is "lon;lat;0".

Default value is 0;0;0.

Returns:
{string} Value of property position
getScale(): string
Gets current value of property scale.

The scale of the box. The format is "x-Scale;y-Scale;z-Scale" whereas z-Scale is currently ignored.

Default value is 1;1;1.

Returns:
{string} Value of property scale
setColor(sColor): sap.ui.vbm.Box
Sets a new value for property color.

The color of the box.

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

Default value is RGB(255;0;0).

Parameters:
{string}sColor New value for property color
Returns:
{sap.ui.vbm.Box} Reference to this in order to allow method chaining
setColorBorder(sColorBorder): sap.ui.vbm.Box
Sets a new value for property colorBorder.

The border color of the box.

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

Default value is RGB(255;0;0).

Parameters:
{string}sColorBorder New value for property colorBorder
Returns:
{sap.ui.vbm.Box} Reference to this in order to allow method chaining
setPosition(sPosition): sap.ui.vbm.Box
Sets a new value for property position.

The position of the Box. The format is "lon;lat;0".

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

Default value is 0;0;0.

Parameters:
{string}sPosition New value for property position
Returns:
{sap.ui.vbm.Box} Reference to this in order to allow method chaining
setScale(sScale): sap.ui.vbm.Box
Sets a new value for property scale.

The scale of the box. The format is "x-Scale;y-Scale;z-Scale" whereas z-Scale is currently ignored.

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

Default value is 1;1;1.

Parameters:
{string}sScale New value for property scale
Returns:
{sap.ui.vbm.Box} Reference to this in order to allow method chaining