A control to render the system
Event Summary
mouseOverIdenIcon(oControlEvent)fires an event on hovering over identification system icon statusSelect(oControlEvent)fires an event on clicking the modelling status trackInfoPress(oControlEvent)Fired when info Icon of track entity clicked Method Summary
sap.landvisz.LandscapeEntity.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.LandscapeEntity with name sClassName
and enriches it with the information contained in oClassInfo
. addActionBar(oActionBar)Adds some actionBar oActionBar
to the aggregation named actionBar
. addDataContainer(oDataContainer)Adds some dataContainer oDataContainer
to the aggregation named dataContainers
. attachMouseOverIdenIcon(oData?, fnFunction, oListener?)Attach event handler fnFunction
to the 'mouseOverIdenIcon' event of this sap.landvisz.LandscapeEntity
. attachStatusSelect(oData?, fnFunction, oListener?)Attach event handler fnFunction
to the 'statusSelect' event of this sap.landvisz.LandscapeEntity
. attachTrackInfoPress(oData?, fnFunction, oListener?)Attach event handler fnFunction
to the 'trackInfoPress' event of this sap.landvisz.LandscapeEntity
. destroyActionBar()Destroys all the actionBar in the aggregation named actionBar
. detachMouseOverIdenIcon(fnFunction, oListener)Detach event handler fnFunction
from the 'mouseOverIdenIcon' event of this sap.landvisz.LandscapeEntity
. detachStatusSelect(fnFunction, oListener)Detach event handler fnFunction
from the 'statusSelect' event of this sap.landvisz.LandscapeEntity
. detachTrackInfoPress(fnFunction, oListener)Detach event handler fnFunction
from the 'trackInfoPress' event of this sap.landvisz.LandscapeEntity
. indexOfActionBar(oActionBar)Checks for the provided sap.landvisz.internal.ActionBar
in the aggregation named actionBar
and returns its index if found or -1 otherwise. indexOfDataContainer(oDataContainer)Checks for the provided sap.landvisz.internal.DataContainer
in the aggregation named dataContainers
and returns its index if found or -1 otherwise. insertActionBar(oActionBar, iIndex)Inserts a actionBar into the aggregation named actionBar
. insertDataContainer(oDataContainer, iIndex)Inserts a dataContainer into the aggregation named dataContainers
. removeActionBar(vActionBar)Removes an actionBar from the aggregation named actionBar
. removeDataContainer(vDataContainer)Removes an dataContainer from the aggregation named dataContainers
. setType(oType)Setter for property type
. 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 $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
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,
setLayoutData,
setTooltip,
toString,
unbindElement 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 Constructor Detail
new sap.landvisz.LandscapeEntity(sId?, mSettings?)
Constructor for a new LandscapeEntity.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers.
If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).
The supported settings are:
- Properties
- Aggregations
- Associations
- Events
- mouseOverIdenIcon : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- statusSelect : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- trackInfoPress : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
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
mouseOverIdenIcon(oControlEvent)
fires an event on hovering over identification system icon
Parameters:
statusSelect(oControlEvent)
fires an event on clicking the modelling status
Parameters:
trackInfoPress(oControlEvent)
Fired when info Icon of track entity clicked
Parameters:
Method Detail
sap.landvisz.LandscapeEntity.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.landvisz.LandscapeEntity with name
sClassName
and enriches it with the information contained in
oClassInfo
.
oClassInfo
might contain the same kind of informations as described in Element.extend.
Parameters:
{string} | sClassName | name of the class to be created |
{object} | oClassInfo? | object literal with informations about the class |
{function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
Returns:
{function} | the created class / constructor function |
Returns a metadata object for class sap.landvisz.LandscapeEntity.
Returns:
Adds some actionBar oActionBar
to the aggregation named actionBar
.
Parameters:
Returns:
Adds some dataContainer oDataContainer
to the aggregation named dataContainers
.
Parameters:
Returns:
Attach event handler
fnFunction
to the 'mouseOverIdenIcon' event of this
sap.landvisz.LandscapeEntity
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.landvisz.LandscapeEntity
.
itself. fires an event on hovering over identification system icon
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.landvisz.LandscapeEntity . itself. |
Returns:
Attach event handler
fnFunction
to the 'statusSelect' event of this
sap.landvisz.LandscapeEntity
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.landvisz.LandscapeEntity
.
itself. fires an event on clicking the modelling status
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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.landvisz.LandscapeEntity . itself. |
Returns:
Attach event handler
fnFunction
to the 'trackInfoPress' event of this
sap.landvisz.LandscapeEntity
.
. When called, the context of the event handler (its
this
) will be bound to
oListener if specified otherwise to this sap.landvisz.LandscapeEntity
.
itself. Fired when info Icon of track entity 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 call, when the event occurs. |
{object} | oListener? | Context object to call the event handler with. Defaults to this sap.landvisz.LandscapeEntity . itself. |
Returns:
Destroys all the actionBar in the aggregation named actionBar
.
Returns:
Destroys all the dataContainers in the aggregation named dataContainers
.
Returns:
Destroys the entityStatus in the aggregation named entityStatus
.
Returns:
Detach event handler
fnFunction
from the 'mouseOverIdenIcon' event of this
sap.landvisz.LandscapeEntity
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'statusSelect' event of this
sap.landvisz.LandscapeEntity
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Detach event handler
fnFunction
from the 'trackInfoPress' event of this
sap.landvisz.LandscapeEntity
.
The passed function and listener object must match the ones used for event registration.
Parameters:
{function} | fnFunction | The function to call, when the event occurs. |
{object} | oListener | Context object on which the given function had to be called. |
Returns:
Fire event mouseOverIdenIcon to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event statusSelect to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event trackInfoPress to attached listeners.
Parameters:
{Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Getter for aggregation actionBar
.
aggregation on action bar control
Returns:
getActions(): object
Getter for property
actions
. actions of entity
Default value is empty/undefined
Returns:
{object} | the value of property actions |
Getter for property
componentType
. Type of a soution component/deployment type entity
Default value is empty/undefined
Returns:
getComponentTypeTooltip(): string
Getter for property
componentTypeTooltip
. Tooltip for component type
Default value is empty/undefined
Returns:
{string} | the value of property componentTypeTooltip |
Getter for aggregation dataContainers
.
aggregations for data container
Returns:
getDefaultState(): string
Getter for property
defaultState
. default state of the system
Default value is empty/undefined
Returns:
{string} | the value of property defaultState |
getDescription(): string
Getter for property
description
. description of the identification region
Default value is empty/undefined
Returns:
{string} | the value of property description |
Getter for aggregation entityStatus
.
Modeling status icon
Returns:
Getter for property
explodeViewHeight
. Height of the show all view
Default value is empty/undefined
Returns:
Getter for property
explodeViewWidth
. Width of the show all view
Default value is empty/undefined
Returns:
getQualifierText(): string
Getter for property
qualifierText
. text of qualifier icon
Default value is empty/undefined
Returns:
{string} | the value of property qualifierText |
getQualifierTooltip(): string
Getter for property
qualifierTooltip
. tooltip for qualifier icon
Default value is empty/undefined
Returns:
{string} | the value of property qualifierTooltip |
getQualifierType(): string
Getter for property
qualifierType
. text of the qualifier that specifies the server
Default value is empty/undefined
Returns:
{string} | the value of property qualifierType |
Getter for property
renderingSize
. rendering size of a system
Default value is sap.landvisz.EntityCSSSize.Regular
Returns:
getShowCustomActions(): boolean
Getter for property
showCustomActions
. determines the visiblity of custom actions
Default value is true
Returns:
{boolean} | the value of property showCustomActions |
getShowEntityActions(): boolean
Getter for property
showEntityActions
. determines the visiblity of entityactions
Default value is true
Returns:
{boolean} | the value of property showEntityActions |
getStateIconSrc(): string
Getter for property
stateIconSrc
. Icon source of the state of entity
Default value is empty/undefined
Returns:
{string} | the value of property stateIconSrc |
getStateIconTooltip(): string
Getter for property
stateIconTooltip
. tooltip of modelling status icon
Default value is empty/undefined
Returns:
{string} | the value of property stateIconTooltip |
getStatusTooltip(): string
Getter for property
statusTooltip
. tooltip for modelling status
Default value is empty/undefined
Returns:
{string} | the value of property statusTooltip |
getSystemId(): string
Getter for property
systemId
. System entity ID
Default value is empty/undefined
Returns:
{string} | the value of property systemId |
getSystemName(): string
Getter for property
systemName
. name of the system
Default value is empty/undefined
Returns:
{string} | the value of property systemName |
Getter for property
systemStatus
. Modeling status of the entity
Default value is sap.landvisz.ModelingStatus.NORMAL
Returns:
getTrackSystemCount(): string
Getter for property
trackSystemCount
. Systems count in the track
Default value is empty/undefined
Returns:
{string} | the value of property trackSystemCount |
Getter for property
type
. type of the system rendered
Default value is empty/undefined
Returns:
indexOfActionBar(oActionBar): int
Checks for the provided sap.landvisz.internal.ActionBar
in the aggregation named actionBar
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
indexOfDataContainer(oDataContainer): int
Checks for the provided sap.landvisz.internal.DataContainer
in the aggregation named dataContainers
and returns its index if found or -1 otherwise.
Parameters:
Returns:
{int} | the index of the provided control in the aggregation if found, or -1 otherwise |
Inserts a actionBar into the aggregation named actionBar
.
Parameters:
{sap.landvisz.internal.ActionBar} | oActionBar | the actionBar to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the actionBar should be inserted at; for a negative value of iIndex , the actionBar is inserted at position 0; for a value greater than the current size of the aggregation, the actionBar is inserted at the last position |
Returns:
Inserts a dataContainer into the aggregation named dataContainers
.
Parameters:
{sap.landvisz.internal.DataContainer} | oDataContainer | the dataContainer to insert; if empty, nothing is inserted |
{int} | iIndex | the 0 -based index the dataContainer should be inserted at; for a negative value of iIndex , the dataContainer is inserted at position 0; for a value greater than the current size of the aggregation, the dataContainer is inserted at the last position |
Returns:
Removes an actionBar from the aggregation named actionBar
.
Parameters:
Returns:
Removes all the controls in the aggregation named actionBar
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named dataContainers
.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes an dataContainer from the aggregation named dataContainers
.
Parameters:
Returns:
Setter for property
actions
.
Default value is empty/undefined
Parameters:
{object} | oActions | new value for property actions |
Returns:
Setter for property
componentType
.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
componentTypeTooltip
.
Default value is empty/undefined
Parameters:
{string} | sComponentTypeTooltip | new value for property componentTypeTooltip |
Returns:
Setter for property
defaultState
.
Default value is empty/undefined
Parameters:
{string} | sDefaultState | new value for property defaultState |
Returns:
Setter for property
description
.
Default value is empty/undefined
Parameters:
{string} | sDescription | new value for property description |
Returns:
Setter for the aggregated entityStatus
.
Parameters:
Returns:
Setter for property
explodeViewHeight
.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
explodeViewWidth
.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
qualifierText
.
Default value is empty/undefined
Parameters:
{string} | sQualifierText | new value for property qualifierText |
Returns:
Setter for property
qualifierTooltip
.
Default value is empty/undefined
Parameters:
{string} | sQualifierTooltip | new value for property qualifierTooltip |
Returns:
Setter for property
qualifierType
.
Default value is empty/undefined
Parameters:
{string} | sQualifierType | new value for property qualifierType |
Returns:
Setter for property
renderingSize
.
Default value is sap.landvisz.EntityCSSSize.Regular
Parameters:
Returns:
Setter for property
showCustomActions
.
Default value is true
Parameters:
{boolean} | bShowCustomActions | new value for property showCustomActions |
Returns:
Setter for property
showEntityActions
.
Default value is true
Parameters:
{boolean} | bShowEntityActions | new value for property showEntityActions |
Returns:
Setter for property
stateIconSrc
.
Default value is empty/undefined
Parameters:
{string} | sStateIconSrc | new value for property stateIconSrc |
Returns:
Setter for property
stateIconTooltip
.
Default value is empty/undefined
Parameters:
{string} | sStateIconTooltip | new value for property stateIconTooltip |
Returns:
Setter for property
statusTooltip
.
Default value is empty/undefined
Parameters:
{string} | sStatusTooltip | new value for property statusTooltip |
Returns:
Setter for property
systemId
.
Default value is empty/undefined
Parameters:
{string} | sSystemId | new value for property systemId |
Returns:
Setter for property
systemName
.
Default value is empty/undefined
Parameters:
{string} | sSystemName | new value for property systemName |
Returns:
Setter for property
systemStatus
.
Default value is sap.landvisz.ModelingStatus.NORMAL
Parameters:
Returns:
Setter for property
trackSystemCount
.
Default value is empty/undefined
Parameters:
{string} | sTrackSystemCount | new value for property trackSystemCount |
Returns:
Setter for property
type
.
Default value is empty/undefined
Parameters:
Returns: