sap.landvisz.LandscapeViewer.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.landvisz.LandscapeViewer 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.LandscapeViewer.
Returns:
Adds some connectionEntity oConnectionEntity to the aggregation named connectionEntities.
Parameters:
Returns:
Adds some connector oConnector to the aggregation named connectors.
Parameters:
Returns:
Adds some solutionOption oSolutionOption to the aggregation named solutionOptions.
Parameters:
Returns:
Adds some system oSystem to the aggregation named systems.
Parameters:
Returns:
appendNavigationPath(sNavigationText): void
Append the text in the navigation path
Parameters:
| {string} | sNavigationText | text to be appended in the navigation path |
Attach event handler
fnFunction to the 'close' event of this
sap.landvisz.LandscapeViewer.
. When called, the context of the event handler (its
this) will be bound to
oListener if specified otherwise to this sap.landvisz.LandscapeViewer.
itself. closes the view
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.LandscapeViewer. itself. |
Returns:
Attach event handler
fnFunction to the 'loadSolutionView' event of this
sap.landvisz.LandscapeViewer.
. When called, the context of the event handler (its
this) will be bound to
oListener if specified otherwise to this sap.landvisz.LandscapeViewer.
itself. load the solution view either deployment or component
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.LandscapeViewer. itself. |
Returns:
Destroys all the connectionEntities in the aggregation named connectionEntities.
Returns:
Destroys all the connectors in the aggregation named connectors.
Returns:
Destroys the plugContent in the aggregation named plugContent.
Returns:
Destroys all the solutionOptions in the aggregation named solutionOptions.
Returns:
Destroys all the systems in the aggregation named systems.
Returns:
Detach event handler
fnFunction from the 'close' event of this
sap.landvisz.LandscapeViewer.
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 'loadSolutionView' event of this
sap.landvisz.LandscapeViewer.
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 close to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
Returns:
Fire event loadSolutionView to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
Returns:
getBoxDependencyLabel(): string
Getter for property
boxDependencyLabel. Label of box view
Default value is Box View
Returns:
| {string} | the value of property boxDependencyLabel |
getBoxDependencyLevels(): string[]
Getter for property
boxDependencyLevels. Levels information in Box dependency view
Default value is empty/undefined
Returns:
| {string[]} | the value of property boxDependencyLevels |
getCloseButtonTooltip(): string
Getter for property
closeButtonTooltip. tooltip for close button
Default value is empty/undefined
Returns:
| {string} | the value of property closeButtonTooltip |
getComponentViewLabel(): string
Getter for property
componentViewLabel. Label for the component view
Default value is Component View
Returns:
| {string} | the value of property componentViewLabel |
getComponentViewTooltip(): string
Getter for property
componentViewTooltip. tooltip for component view button
Default value is empty/undefined
Returns:
| {string} | the value of property componentViewTooltip |
Getter for aggregation connectionEntities.
Optional: connection Entity between two systems.
Returns:
Getter for property
connectionLine. Type of line to be drawn
Default value is sap.landvisz.ConnectionLine.Line
Returns:
Getter for aggregation connectors.
connector contains from and to information
Returns:
getCurrentSolutionView(): string
return the current solution loaded.
Returns:
Getter for property
defaultDependencyView. View type of landscape view
Default value is sap.landvisz.DependencyType.NETWORK_VIEW
Returns:
getDeploymentOptionsLabel(): string
Getter for property
deploymentOptionsLabel. Label for the options
Default value is Deployment Options :
Returns:
| {string} | the value of property deploymentOptionsLabel |
getDeploymentOptionsTooltip(): string
Getter for property
deploymentOptionsTooltip. tooltip of label for the options
Default value is empty/undefined
Returns:
| {string} | the value of property deploymentOptionsTooltip |
getDeploymentViewLabel(): string
Getter for property
deploymentViewLabel. Label for deployment view.
Default value is Deployment View
Returns:
| {string} | the value of property deploymentViewLabel |
getDeploymentViewTooltip(): string
Getter for property
deploymentViewTooltip. tooltip for deployment view button
Default value is empty/undefined
Returns:
| {string} | the value of property deploymentViewTooltip |
getHasParent(): boolean
Getter for property
hasParent. control has to be added in the container or directly in the window.
Default value is true
Returns:
| {boolean} | the value of property hasParent |
getHeight(): int
Getter for property
height. Height of Viewer container
Default value is empty/undefined
Returns:
| {int} | the value of property height |
getNavigationPath(): string
Getter for property
navigationPath. Text displayed in the dependency view
Default value is empty/undefined
Returns:
| {string} | the value of property navigationPath |
getNetworkDependencyLabel(): string
Getter for property
networkDependencyLabel. Label of the network view
Default value is Network View
Returns:
| {string} | the value of property networkDependencyLabel |
Getter for aggregation plugContent.
a control which can be plugged into this control and can be only plugged in top section.
Returns:
getPlugContentHeight(): int
Getter for property
plugContentHeight. Specify the height of plugged content
Default value is 0
Returns:
| {int} | the value of property plugContentHeight |
getSelectedOption(): object
returns an object of the internal connection entity
Returns:
Getter for property
selectionViewPosition. positions for selection view entity
Default value is sap.landvisz.SelectionViewPosition.CENTER
Returns:
getShowClose(): boolean
Getter for property
showClose. close button visibility
Default value is true
Returns:
| {boolean} | the value of property showClose |
getShowDependencyNavigator(): boolean
Getter for property
showDependencyNavigator. Navigator for dependency views
Default value is true
Returns:
| {boolean} | the value of property showDependencyNavigator |
getShowDeploymentTypeSection(): boolean
Getter for property
showDeploymentTypeSection. Deployment type section
Default value is false
Returns:
| {boolean} | the value of property showDeploymentTypeSection |
Getter for aggregation solutionOptions.
Options for the solution
Returns:
Getter for property
solutionOptionType. determines whether the option is rendered on view or entity
Default value is empty/undefined
Returns:
Getter for property
solutionType. Type of solution rendered
Default value is empty/undefined
Returns:
Getter for aggregation systems.
Systems to be rendered in the landscape viewer
Returns:
getTitle(): string
Getter for property
title. Header of the rendered view
Default value is empty/undefined
Returns:
| {string} | the value of property title |
Getter for property
viewType. View type of landscape view
Default value is empty/undefined
Returns:
Getter for property
visibleDependency. Dependency View Visibility
Default value is sap.landvisz.DependencyVisibility.BOTH
Returns:
getWidth(): int
Getter for property
width. width of the Viewer container
Default value is empty/undefined
Returns:
| {int} | the value of property width |
indexOfConnectionEntity(oConnectionEntity): int
Checks for the provided sap.landvisz.ConnectionEntity in the aggregation named connectionEntities 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 |
indexOfConnector(oConnector): int
Checks for the provided sap.landvisz.Connector in the aggregation named connectors 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 |
indexOfSolutionOption(oSolutionOption): int
Checks for the provided sap.landvisz.Option in the aggregation named solutionOptions 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 |
indexOfSystem(oSystem): int
Checks for the provided sap.landvisz.LandscapeEntity in the aggregation named systems 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 connectionEntity into the aggregation named connectionEntities.
Parameters:
| {sap.landvisz.ConnectionEntity} | oConnectionEntity | the connectionEntity to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the connectionEntity should be inserted at; for a negative value of iIndex, the connectionEntity is inserted at position 0; for a value greater than the current size of the aggregation, the connectionEntity is inserted at the last position |
Returns:
Inserts a connector into the aggregation named connectors.
Parameters:
| {sap.landvisz.Connector} | oConnector | the connector to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the connector should be inserted at; for a negative value of iIndex, the connector is inserted at position 0; for a value greater than the current size of the aggregation, the connector is inserted at the last position |
Returns:
Inserts a solutionOption into the aggregation named solutionOptions.
Parameters:
| {sap.landvisz.Option} | oSolutionOption | the solutionOption to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the solutionOption should be inserted at; for a negative value of iIndex, the solutionOption is inserted at position 0; for a value greater than the current size of the aggregation, the solutionOption is inserted at the last position |
Returns:
Inserts a system into the aggregation named systems.
Parameters:
| {sap.landvisz.LandscapeEntity} | oSystem | the system to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the system should be inserted at; for a negative value of iIndex, the system is inserted at position 0; for a value greater than the current size of the aggregation, the system is inserted at the last position |
Returns:
Removes all the controls in the aggregation named connectionEntities.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named connectors.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named solutionOptions.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes all the controls in the aggregation named systems.
Additionally unregisters them from the hosting UIArea.
Returns:
Removes an connectionEntity from the aggregation named connectionEntities.
Parameters:
Returns:
Removes an connector from the aggregation named connectors.
Parameters:
Returns:
Removes an solutionOption from the aggregation named solutionOptions.
Parameters:
| {int|string|sap.landvisz.Option} | vSolutionOption | the solutionOption to remove or its index or id |
Returns:
Removes an system from the aggregation named systems.
Parameters:
Returns:
Setter for property
boxDependencyLabel.
Default value is Box View
Parameters:
| {string} | sBoxDependencyLabel | new value for property boxDependencyLabel |
Returns:
Setter for property
boxDependencyLevels.
Default value is empty/undefined
Parameters:
| {string[]} | aBoxDependencyLevels | new value for property boxDependencyLevels |
Returns:
Setter for property
closeButtonTooltip.
Default value is empty/undefined
Parameters:
| {string} | sCloseButtonTooltip | new value for property closeButtonTooltip |
Returns:
Setter for property
componentViewLabel.
Default value is Component View
Parameters:
| {string} | sComponentViewLabel | new value for property componentViewLabel |
Returns:
Setter for property
componentViewTooltip.
Default value is empty/undefined
Parameters:
| {string} | sComponentViewTooltip | new value for property componentViewTooltip |
Returns:
Setter for property
connectionLine.
Default value is sap.landvisz.ConnectionLine.Line
Parameters:
Returns:
Setter for property
defaultDependencyView.
Default value is sap.landvisz.DependencyType.NETWORK_VIEW
Parameters:
Returns:
Setter for property
deploymentOptionsLabel.
Default value is Deployment Options :
Parameters:
| {string} | sDeploymentOptionsLabel | new value for property deploymentOptionsLabel |
Returns:
Setter for property
deploymentOptionsTooltip.
Default value is empty/undefined
Parameters:
| {string} | sDeploymentOptionsTooltip | new value for property deploymentOptionsTooltip |
Returns:
Setter for property
deploymentViewLabel.
Default value is Deployment View
Parameters:
| {string} | sDeploymentViewLabel | new value for property deploymentViewLabel |
Returns:
Setter for property
deploymentViewTooltip.
Default value is empty/undefined
Parameters:
| {string} | sDeploymentViewTooltip | new value for property deploymentViewTooltip |
Returns:
Setter for property
hasParent.
Default value is true
Parameters:
| {boolean} | bHasParent | new value for property hasParent |
Returns:
Setter for property
height.
Default value is empty/undefined
Parameters:
| {int} | iHeight | new value for property height |
Returns:
Setter for property
navigationPath.
Default value is empty/undefined
Parameters:
| {string} | sNavigationPath | new value for property navigationPath |
Returns:
Setter for property
networkDependencyLabel.
Default value is Network View
Parameters:
| {string} | sNetworkDependencyLabel | new value for property networkDependencyLabel |
Returns:
Setter for the aggregated plugContent.
Parameters:
Returns:
Setter for property
plugContentHeight.
Default value is 0
Parameters:
| {int} | iPlugContentHeight | new value for property plugContentHeight |
Returns:
Setter for property
selectionViewPosition.
Default value is sap.landvisz.SelectionViewPosition.CENTER
Parameters:
Returns:
Setter for property
showClose.
Default value is true
Parameters:
| {boolean} | bShowClose | new value for property showClose |
Returns:
Setter for property
showDependencyNavigator.
Default value is true
Parameters:
| {boolean} | bShowDependencyNavigator | new value for property showDependencyNavigator |
Returns:
Setter for property
showDeploymentTypeSection.
Default value is false
Parameters:
| {boolean} | bShowDeploymentTypeSection | new value for property showDeploymentTypeSection |
Returns:
Setter for property
solutionOptionType.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
solutionType.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
title.
Default value is empty/undefined
Parameters:
| {string} | sTitle | new value for property title |
Returns:
Setter for property
viewType.
Default value is empty/undefined
Parameters:
Returns:
Setter for property
visibleDependency.
Default value is sap.landvisz.DependencyVisibility.BOTH
Parameters:
Returns:
Setter for property
width.
Default value is empty/undefined
Parameters:
| {int} | iWidth | new value for property width |
Returns: