{ "Interfaces": { "sap.watt.common.outlinepane.Outline": { "kind": "interface", "name": "Interfaces.sap.watt.common.outlinepane.Outline", "basename": "sap.watt.common.outlinepane.Outline", "visibility": "internal", "description": "The Outline abstract interface. Extends: sap.watt.common.service.ui.Part", "component": "CA-WDE-EDT-OUT", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.common.plugin.multieditor.service.MultiEditor": { "kind": "interface", "name": "Interfaces.sap.watt.common.plugin.multieditor.service.MultiEditor", "basename": "sap.watt.common.plugin.multieditor.service.MultiEditor", "visibility": "internal", "description": "The Multi Editor interface. When enabled, holds several editors in the same content tab.", "component": "CA-WDE-EDT", "events": {}, "methods": { "containsEditor": { "description": "This method returns whether the multi-editor contains a certain editor.", "params": [ { "name": "oEditor", "type": "sap.watt.common.service.editor.Editor", "description": "The editor to check." } ], "returns": { "type": "boolean", "description": "Returns True if the multi editor contains the Editor service." }, "visibility": "internal" }, "getActiveEditor": { "description": "This method returns the active editor.", "returns": { "type": "sap.watt.common.service.editor.Editor", "description": "Returns the active editor." }, "visibility": "internal" }, "getAllEditors": { "description": "Returns all editors.", "returns": { "type": "[sap.watt.common.service.editor.Editor]", "description": "Returns an array that contains all the editors." }, "visibility": "internal" }, "hasDocument": { "description": "Returns whether the document exists.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The document to check." } ], "returns": { "type": "boolean", "description": "Returns True if the document exists." }, "visibility": "internal" }, "hasDocuments": { "description": "Returns whether the multi-editor has documents.", "returns": { "type": "boolean", "description": "Return True if any document exists." }, "visibility": "internal" } }, "configurationProperties": { "editors": { "description": "For configuring the editors to be used.", "type": [ { "name": { "type": "string", "description": "The editor command name." }, "service": { "type": "sap.watt.common.service.editor.Editor", "description": "The editor service to be provided." }, "defaultName": { "type": "string", "description": "The editor default name." } } ], "visibility": "internal", "multiple": false }, "doNotLoadDefaultCss": { "description": "For loading custom CSS definitions.", "type": "boolean", "multiple": false, "visibility": "internal" }, "saveLastTab": { "description": "Saves the last tab that the user selects.", "type": "boolean", "multiple": false, "visibility": "internal" } } }, "sap.watt.common.plugin.run.service.runner": { "kind": "interface", "name": "Interfaces.sap.watt.common.plugin.run.service.runner", "basename": "sap.watt.common.plugin.run.service.runner", "visibility": "internal", "description": "The runner service implements an interface that handles the concrete behavior required for running an app.", "component": "CA-WDE-RUN", "events": {}, "methods": { "createDefaultConfiguration": { "description": "Creates the default run configuration.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The file to run." }, { "name": "isValidRunConfigurationFlow", "type": "boolean", "description": "When set to true, indicates a case that the runner does not support." }, { "name": "sWindowId", "type": "string", "description": "The ID of the tab in which the app will be opened." } ], "returns": { "type": "object", "description": "The contextual configuration to run or set in the configuration UI." }, "visibility": "internal" }, "run": { "description": "Runs the configurations.", "params": [ { "name": "value", "type": "object", "description": "The runner value." }, { "name": "oWindow", "type": "object", "description": "Refers to the newly created window." }, { "name": "aData", "type": "[object]", "description": "An array of runner data." }, { "name": "oConfigParameters", "type": "object", "description": "Configuration parameters." }, { "name": "oRunnableDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The file to run." } ], "visibility": "internal" }, "getApplicationUrl": { "description": "Optional. Returns the application URL.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The file to run." }, { "name": "oConfiguration", "type": "object", "description": "Run configuration parameters." } ], "returns": { "type": "string", "description": "The application URL. If no url received, return value is null" }, "visibility": "internal" }, "getConfigurationUi": { "description": "Optional. Shows a configuration view in the run configuration screen.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The file to run." } ], "returns": { "type": "object", "description": "Members of the returned object: getContent(oDocument) - returns the UI element to display in the configuration, setConfiguarion (configuration) - sets the data in configuration object in the UI, getConfiguration() - returns the data the user entered in the configuration." }, "visibility": "internal" }, "isConfigurationValid": { "description": "Validates the run configuration.", "params": [ { "name": "oConfiguration", "type": "object", "description": "Configuration parameters." }, { "name": "oDocumnet", "type": "[sap.watt.common.plugin.document.Document]", "description": "The file to run." } ], "returns": { "type": "boolean", "default": true, "description": "Returns true if a configuration is valid, otherwise returns false." }, "visibility": "internal" }, "updateConfiguration": { "description": "Optional. Updates a configuration with new parameters.", "params": [ { "name": "oConfiguration", "type": "object", "description": "Configuration parameters." }, { "name": "oParams", "type": "object", "description": "Configuration from the runner UI." } ], "returns": { "type": "object", "description": "Updated configuration." }, "visibility": "internal" }, "getAppRunnableFileRelativePath": { "description": "Optional. Returns the file path of the project's runnable file in the run console, relative to the resources folder.", "params": [ { "name": "oConfiguration", "type": "object", "description": "Configuration parameters." } ], "returns": { "type": "string", "description": "File path of the runnable file." }, "visibility": "internal" }, "isAppUrlRelevant": { "description": "Optional. Returns the runner states if displaying the URL in the run console relevant; i.e., if the default return value is true.", "params": [ { "name": "sProjectPath", "type": "object", "description": "The path to the project." } ], "returns": { "type": "boolean", "description": "Returns true if the URL is relevant." }, "visibility": "internal" }, "getConfigurationName": { "description": "Optional. Returns the default name for a newly created configuration of the runner.", "params": [ { "name": "oConfiguration", "type": "object", "description": "The default configuration" } ], "returns": { "type": "string", "description": "Returns the configuration name in a string" }, "visibility": "internal" } }, "configurationProperties": { "runners": { "description": "The runner configuration property.", "type": { "id": { "type": "string", "description": "The runner unique ID to be used for identifying a runner." }, "service": { "type": "object", "description": "The name of the service which will be attached to the runner ID." }, "displayName": { "type": "string", "description": "The string that will be displayed as the runner in the UI." }, "projectTypesIds": { "type": "[string]", "description": "An array of project types in which the runner will be displayed." }, "doNotOpenNewWindow": { "type": "boolean", "description": "When the value is set to true, indicates that a new window will not be opened." }, "fileTypes": { "type": "[string]", "description": "Determines which file types the runner will run." } }, "multiple": true, "visibility": "internal" } } }, "sap.watt.common.plugin.runregistry.service.RunRegistry": { "kind": "interface", "name": "Interfaces.sap.watt.common.plugin.runregistry.service.RunRegistry", "basename": "sap.watt.common.plugin.runregistry.service.RunRegistry", "visibility": "internal", "description": "The interface for run provider. Runs register themselves by configuring themselves with this service.", "component": "CA-WDE-RUN", "events": {}, "methods": { "run": { "visibility": "internal", "description": "Runs the project", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document" }, { "name": "oRunBody", "type": "object" } ] }, "stop": { "visibility": "internal", "description": "Stops the application", "params": [ { "name": "sRunId", "type": "string" }, { "name": "sProjectId", "type": "string" } ] }, "getProcesses": { "visibility": "internal", "description": "Get run processes on workspace", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document" } ] }, "refresh": { "visibility": "internal", "description": "Rerun specifc runner process", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document" }, { "name": "oRefreshBody", "type": "object" } ] } }, "configurationProperties": { "setRun": { "type": { "service": "sap.watt.common.service.remote.Run" }, "multiple": true, "visibility": "internal" } } }, "sap.watt.ideplatform.languageserverprotocol.service.LSPCodeCompletion": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.languageserverprotocol.service.LSPCodeCompletion", "basename": "sap.watt.ideplatform.languageserverprotocol.service.LSPCodeCompletion", "visibility": "internal", "description": "An extended CodeCompletion interface. Handles code completion for editors. Supports strict code completion.", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.ideplatform.test.testresult.service.TestResultProvider": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.test.testresult.service.TestResultProvider", "basename": "sap.watt.ideplatform.test.testresult.service.TestResultProvider", "visibility": "internal", "description": "Provides test result list, export and clear history functions for test view. Service object will be injected as context.service and is accessible via this.context.service.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "getCapabilities": { "description": "Returns string array with capabilities", "visibility": "internal", "returns": { "type": "array", "description": "All capabilities", "items": { "type": "string" } } }, "getTestResults": { "description": "Returns the test results", "visibility": "internal", "params": [ { "name": "projectPath", "type": "string", "description": "The project path" } ], "returns": { "type": "object", "description": "Provide the test result file names as indexed object, id as key" } }, "deleteTestResults": { "description": "Deletes all test result/coverage on the server. Button will be disabled if method is not implemented", "visibility": "internal", "params": [ { "name": "projectPath", "type": "string", "description": "The project path" } ], "returns": {} }, "getExportUrls": { "description": "Get list of export urls. Button will be disabled if method is not implemented", "visibility": "internal", "params": [ { "name": "projectPath", "type": "string", "description": "The project path" } ], "returns": { "type": "array", "description": "All export urls as array", "items": { "type": "string" } } }, "getTestReport": { "description": "Gets the test report with given id, or null/undefined if none exists", "visibility": "internal", "params": [ { "name": "testRun", "type": "object", "description": "The current test run object retrieved by getTestResults" } ], "returns": { "type": "string", "description": "The content" } }, "getTestCoverage": { "description": "Optional, gets the test coverage with given id, or null/undefined if none exists. Might be not implemented if coverage is not supported", "visibility": "internal", "params": [ { "name": "testRun", "type": "object", "description": "The current test run object retrieved by getTestResults" } ], "returns": { "type": "string", "description": "The content" } } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.DebugPlatform": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.DebugPlatform", "basename": "sap.watt.ideplatform.debug.core.service.DebugPlatform", "visibility": "internal", "description": "Debug platform related services", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.DebugClient": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.DebugClient", "basename": "sap.watt.ideplatform.debug.core.service.DebugClient", "visibility": "internal", "description": "The debugger framework", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.BreakpointManager": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.BreakpointManager", "basename": "sap.watt.ideplatform.debug.core.service.BreakpointManager", "visibility": "internal", "description": "The breakpoint manager manages the collection of breakpoints. It keeps track of all of the breakpoints in the workspace. The kinds of breakpoints supported by each debugger domain and the information required to create those breakpoints is defined by the domain. Breakpoint creation is a client responsibility. Clients may register for change notifications - see breakpointsChanged and breakpointManagerEnablementChanged events.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.WatchExpressionManager": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.WatchExpressionManager", "basename": "sap.watt.ideplatform.debug.core.service.WatchExpressionManager", "visibility": "internal", "description": "The watch expression manager manages the collection of registered watch expressions. It keeps track of all of the watch expressions in the workspace. A watch expression is a snippet of code that can be evaluated to produce a value. Watch expression creation and evaluation are client responsibilities. Clients may register for watch expression change notifications - see expressionsChanged event", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.DebugSessionManager": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.DebugSessionManager", "basename": "sap.watt.ideplatform.debug.core.service.DebugSessionManager", "visibility": "internal", "description": "Interface for managing debug sessions", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.DebugSuspendProcessor": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.DebugSuspendProcessor", "basename": "sap.watt.ideplatform.debug.core.service.extension.DebugSuspendProcessor", "visibility": "internal", "description": "A debug suspend processor interface provides access to resume/suspend functionality.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "suspend": { "description": "Stops on the next statement.", "visibility": "internal" }, "resume": { "description": "Resumes execution.", "visibility": "internal" }, "canResume": { "description": "Distinguishes whether resume can be processed.", "visibility": "internal", "returns": { "type": "boolean", "description": "True if resume can be processed, false otherwise." } }, "canSuspend": { "description": "Distinguishes whether suspend can be processed.", "visibility": "internal", "returns": { "type": "boolean", "description": "True if suspend can be processed, false otherwise." } } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.DebugStepProcessor": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.DebugStepProcessor", "basename": "sap.watt.ideplatform.debug.core.service.extension.DebugStepProcessor", "visibility": "internal", "description": "A debug step processor interface provides access to single-step functionality.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "stepOver": { "description": "Steps over the statement.", "visibility": "internal" }, "stepInto": { "description": "Steps into the function call.", "visibility": "internal" }, "stepOut": { "description": "Steps out of the function call.", "visibility": "internal" }, "canStepOver": { "description": "Distinguishes whether step over can be processed.", "visibility": "internal", "returns": { "type": "boolean", "description": "True if step over can be processed, false otherwise." } }, "canStepInto": { "description": "Distinguishes whether step into can be processed.", "visibility": "internal", "returns": { "type": "boolean", "description": "True if step into can be processed, false otherwise." } }, "canStepOut": { "description": "Distinguishes whether step out can be processed.", "visibility": "internal", "returns": { "type": "boolean", "description": "True if step out can be processed, false otherwise." } } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.VariableProvider": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.VariableProvider", "basename": "sap.watt.ideplatform.debug.core.service.extension.VariableProvider", "visibility": "internal", "description": "A variable provider reads the child variables from the debuggee for a given parent variable.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "readVariables": { "description": "Reads the child variables from the debuggee for the given parent variable asynchronously. The result will be stored in the variables reference the given variable, its allocated state will be set to true. If the allocated state of the given variable is true, no read operation will be executed.", "visibility": "internal", "params": [ { "name": "variable", "type": "sap.watt.ideplatform.debug.core.model.Variable", "description": "The variable for which the child variables are read." } ] } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.ExpressionEvaluator": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.ExpressionEvaluator", "basename": "sap.watt.ideplatform.debug.core.service.extension.ExpressionEvaluator", "visibility": "internal", "description": "Evaluates the given expression using the provided context object.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "evaluateExpression": { "description": "Evaluates the given expression in the given context asynchronously. The result is stored in the expression's variable reference, the allocated state will be set to true. If the allocated state of the given expression is true no evaluation needs to be performed.", "visibility": "internal", "params": [ { "name": "expression", "type": "sap.watt.ideplatform.debug.core.model.Expression", "description": "The expression that should be evaluated." }, { "name": "context", "type": "sap.watt.ideplatform.debug.core.model.StackFrame", "optional": true, "description": "The context for the evaluation." } ] } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.WatchExpressionEvaluator": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.WatchExpressionEvaluator", "basename": "sap.watt.ideplatform.debug.core.service.extension.WatchExpressionEvaluator", "visibility": "internal", "description": "Evaluates the given watch expressions based on their context object asynchronously.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "evaluateWatchExpressions": { "description": "Evaluates the given watch expressions asynchronously. The result is stored in the watch expression's variable reference, the allocated state will be set to true. If the allocated state of a given watch expression is false no evaluation is performed.", "visibility": "internal", "params": [ { "name": "watchExpressions", "type": "array", "items": { "type": "sap.watt.ideplatform.debug.core.model.WatchExpression" }, "description": "The watch expressions to be evaluated." } ] } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.BreakpointLifecycleParticipant": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.BreakpointLifecycleParticipant", "basename": "sap.watt.ideplatform.debug.core.service.extension.BreakpointLifecycleParticipant", "visibility": "internal", "description": "The breakpoint lifecylce participant is responsible for saving/restoring breakpoints in the IDEs preferences and for creating breakpoints based on the editor's file location information.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "create": { "description": "Creates a new breakpoint from the state captured by the given JSON representation. Clients must check for existence of properties.", "visibility": "internal", "params": [ { "name": "breakpointSettings", "type": "object", "description": "Breakpoint settings, e.g. as defined by 'sap.watt.ideplatform.debug.core.model.Breakpoint' ('debugModelId', 'location') or 'sap.watt.ideplatform.debug.core.model.LineBreakpoint' ('debugModelId', 'location', 'statement')" } ], "returns": { "type": "sap.watt.ideplatform.debug.core.model.Breakpoint", "description": "The newly created breakpoint instance" } }, "restore": { "description": "Re-creates and returns the breakpoint from the state captured by the given JSON representation.

This method is called by the debug framework as part of the breakpoint manager bootstrap sequence. No debug session exists at this point in time.", "visibility": "internal", "params": [ { "name": "breakpointSettings", "type": "object", "description": "Breakpoint settings, e.g. as defined by 'sap.watt.ideplatform.debug.core.model.Breakpoint' ('debugModelId', 'location') or 'sap.watt.ideplatform.debug.core.model.LineBreakpoint' ('debugModelId', 'location', 'statement')" } ], "returns": { "type": "sap.watt.ideplatform.debug.core.model.Breakpoint", "description": "The breakpoint object or 'undefined' if it could not be created" } }, "save": { "description": "Saves the state of the given breakpoint.

This method is called by the debug framework on every 'breakpointsChanged' or 'breakpointManagerEnablementChanged' event.", "visibility": "internal", "params": [ { "name": "breakpoint", "type": "sap.watt.ideplatform.debug.core.model.Breakpoint", "description": "The breakpoint object" } ], "returns": { "type": "object", "description": "The JSON representation of the given breakpoint to persist." } } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.WatchExpressionLifecycleParticipant": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.WatchExpressionLifecycleParticipant", "basename": "sap.watt.ideplatform.debug.core.service.extension.WatchExpressionLifecycleParticipant", "visibility": "internal", "description": "The watch expression lifecylce participant is responsible for saving/restoring watch expressions in the IDEs preferences and for creating new watch expressions based on the user provided information.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "create": { "description": "Creates a new watch expression from the state captured by the given JSON representation. Clients must check for existence of properties.", "visibility": "internal", "params": [ { "name": "settings", "type": "object", "description": "WatchExpression settings, e.g. as defined by 'sap.watt.ideplatform.debug.core.model.WatchExpression' ('debugModelId', 'enabled', 'expressionText')" } ], "returns": { "type": "sap.watt.ideplatform.debug.core.model.WatchExpression", "description": "The newly created watch expression instance" } }, "restore": { "description": "Re-creates and returns the watch expression from the state captured by the given JSON representation.

This method is called by the debug framework as part of the expression manager bootstrap sequence. No debug session exists at this point in time.", "visibility": "internal", "params": [ { "name": "settings", "type": "object", "description": "WatchExpression settings, e.g. as defined by 'sap.watt.ideplatform.debug.core.model.WatchExpression' ('debugModelId', 'enabled', 'expressionText')" } ], "returns": { "type": "sap.watt.ideplatform.debug.core.model.WatchExpression", "description": "The watch expression object or 'undefined' if it could not be created" } }, "save": { "description": "Saves the state of the given watch expression.

This method is called by the debug framework on every 'expressionsChanged' event.", "visibility": "internal", "params": [ { "name": "expression", "type": "sap.watt.ideplatform.debug.core.model.WatchExpression", "description": "The watch expression object" } ], "returns": { "type": "object", "description": "The JSON representation of the given watch expression to persist." } } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.DebugEngine": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.DebugEngine", "basename": "sap.watt.ideplatform.debug.core.service.extension.DebugEngine", "visibility": "internal", "description": "A debug engine provides debugging services such as execution control, breakpoints, and expression evaluation. The debug engine is responsible for monitoring the state of a program being debugged.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "createDebugSession": { "description": "Creates a debug session based on the given launch configuration and adds it to the collection of registered debug sessions.", "visibility": "internal", "params": [ { "name": "launchConfiguration", "type": "sap.watt.ideplatform.debug.core.model.LaunchConfiguration", "description": "The configuration used to setup the debug session" } ], "returns": { "type": "sap.watt.ideplatform.debug.core.model.DebugSession", "description": "Returns the new debug session connected to the debug taget runtime." } }, "disconnectDebugSession": { "description": "Removes the given debug session from the collection of registered debug sessions and disconnects it from the debugee.", "visibility": "internal", "params": [ { "name": "debugSession", "type": "sap.watt.ideplatform.debug.core.model.DebugSession", "description": "The debug session to add." } ] } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.DebugView": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.DebugView", "basename": "sap.watt.ideplatform.debug.core.service.extension.DebugView", "visibility": "internal", "description": "DebugView service providing UI related artefacts like sorters, labels, images or editors associated with debug elements in a specific debug model.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "getVariableComparator": { "description": "Returns a compare function used for domain specific variable sorting. Variables are not sorted by default. The comparator is cached by the debug framework.", "visibility": "internal", "returns": { "type": "sap.ui.model.Sorter", "description": "The variable compare function." } }, "getDebugConsoleControl": { "description": "Returns a UI fragment that will be embedded in the debug console panel. The UI control is cached by the debug framework.", "visibility": "internal", "returns": { "type": "sap.ui.core.Fragment", "description": "The fragment providing evaluate expression support." } } }, "configurationProperties": {} }, "sap.watt.ideplatform.debug.core.service.extension.LaunchConfigurationProvider": { "kind": "interface", "name": "Interfaces.sap.watt.ideplatform.debug.core.service.extension.LaunchConfigurationProvider", "basename": "sap.watt.ideplatform.debug.core.service.extension.LaunchConfigurationProvider", "visibility": "internal", "description": "A debug launch configuration provider implementation returns a list of debugger specific launch configuration objects that are available in the given MTA scope. Debug launch configuration objects provide information required by the concrete debugger to be attached to a running process.", "component": "HAN-WDE-EDT-NJS", "events": {}, "methods": { "getLaunchConfigurations": { "description": "Returns list of debug configurations available in the given MTA project scope for which the debugger could be attached to. Note: The implementation must not return launch configurations for which a debug session already exists.", "visibility": "internal", "params": [ { "name": "mtaDocument", "type": "object", "optional": true, "description": "The MTA document object that has been selected in the workspace - might be undefined." } ], "returns": { "type": "sap.watt.ideplatform.debug.core.model.LaunchConfiguration", "description": "The launch configuration object holding data required by a debugger to a attach to a running process." } } }, "configurationProperties": {} }, "sap.watt.common.plugin.document.Document": { "kind": "interface", "name": "Interfaces.sap.watt.common.plugin.document.Document", "basename": "sap.watt.common.plugin.document.Document", "visibility": "internal", "description": "The base interface for all documents", "component": "CA-WDE-WRK", "events": {}, "methods": { "getName": { "visibility": "internal", "description": "Gets the document name.", "returns": { "type": "string", "description": "The document's name." } } }, "configurationProperties": {} }, "sap.watt.common.service.editor.CodeCompletion": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.editor.CodeCompletion", "basename": "sap.watt.common.service.editor.CodeCompletion", "visibility": "internal", "description": "The CodeCompletion interface. Handles code completion for editors.", "component": "CA-WDE-EDT-COC", "events": {}, "methods": { "getWordSuggestions": { "params": [ { "name": "oContentStatus", "type": "object", "description": "The content status, including the content buffer, the current offset, and other information." } ], "visibility": "internal", "returns": { "type": "object" } }, "enrichCompletionProposal": { "description": "Completion proposal enrichment upon active item (resolve)", "params": [ { "name": "oProposal", "type": "object", "description": "The proposal enrichment, including the proposal, the description, the category, and other information." } ], "returns": { "type": "boolean", "default": false, "description": "Returns True if the proposal is enriched." }, "visibility": "internal" }, "isAvailable": { "description": "Checks if code completion is available", "params": [ { "name": "oDocument", "type": "object", "description": "Current document." } ], "returns": { "type": "boolean", "default": true, "description": "Returns True if code completion is available." }, "visibility": "internal" }, "getTriggerCharacters": { "description": "Get a list of code completion trigger characters if any", "params": [ { "name": "oDocument", "type": "object", "description": "Current document." } ], "returns": { "type": "[string]", "default": null, "description": "Returns list of trigger characters if any." }, "visibility": "internal" } }, "configurationProperties": {} }, "sap.watt.common.service.editor.Editor": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.editor.Editor", "basename": "sap.watt.common.service.editor.Editor", "visibility": "internal", "description": "The editor interface, which is the base interface for all editors.", "events": { "opened": { "description": "Fired after a document is opened if the control contains the document content.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The open document." } ], "visibility": "internal" }, "closed": { "description": "Fired after a document is closed.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The open document." } ], "visibility": "internal" } }, "methods": { "open": { "description": "Calls the open method in order to open a document in the editor.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The document to open." } ], "visibility": "internal" }, "getState": { "description": "Returns the current state of editor. null or undefined means that the status is ok.", "returns": { "type": "string", "description": "The current state of editor." }, "visibility": "internal" }, "isRestorable": { "description": "Returns True if the editor should be restored at startup.", "returns": { "type": "boolean", "description": "Is the the editor should be restored at startup." }, "visibility": "internal" }, "isAvailable": { "description": "Returns whether the editor is available in the current system.", "returns": { "type": "boolean", "default": true, "description": "Returns True if the editor available in the current system." }, "visibility": "internal" }, "flush": { "description": "Writes the editor content into the document.", "visibility": "internal" }, "close": { "description": "Calls the close method in order to close a document in the editor.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The document to close." } ], "visibility": "internal" }, "getTitleForDocument": { "description": "Calls the getTitleForDocument method in order to get the display title for document.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The document to display his title." } ], "returns": { "type": "string" }, "visibility": "internal" }, "getTooltipForDocument": { "description": "Calls the getTooltipForDocument method in order to get the display tooltip for the document.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The document to display his tooltip." } ], "returns": { "type": "string" }, "visibility": "internal" } }, "configurationProperties": {} }, "sap.watt.common.service.editor.UndoRedo": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.editor.UndoRedo", "basename": "sap.watt.common.service.editor.UndoRedo", "visibility": "internal", "description": "The undo / redo interface. Handles the undo and redo operations for editors.", "events": {}, "methods": { "undo": { "description": "Performs an undo operation, reverting the last change.", "visibility": "internal" }, "redo": { "description": "Performs an redo operation, reverting the last change.", "visibility": "internal" }, "hasUndo": { "description": "Gets whether an undo operation is available.", "returns": { "type": "boolean", "description": "Returns whether an undo is available." }, "visibility": "internal" }, "hasRedo": { "description": "Gets whether a redo operation is available", "returns": { "type": "boolean", "description": "Returns whether a redo is available." }, "visibility": "internal" }, "markClean": { "description": "If the session has been saved or newly opened, marks the current edit session as clean from changes.", "visibility": "internal" }, "isClean": { "description": "Gets whether the current edit session has been modified since the last save.", "returns": { "type": "boolean", "description": "Returns whether the current edit session is clean." }, "visibility": "internal" } }, "configurationProperties": {} }, "sap.watt.common.service.editor.Validator": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.editor.Validator", "basename": "sap.watt.common.service.editor.Validator", "visibility": "internal", "description": "Each validator implements this interface, which handles concrete behavior of the validator.", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.common.service.ide.Command": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ide.Command", "basename": "sap.watt.common.service.ide.Command", "visibility": "public", "description": "Each command service implements this interface, which handles concrete behavior independently of its UI representation, such as Delete or Copy.", "component": "CA-WDE-MNU", "events": {}, "methods": { "execute": { "description": "Executes the command instance.", "params": [ { "name": "vValue", "type": "object", "optional": true, "description": "The value that is passed from the service that calls the execute method." }, { "name": "oWindow", "type": "object", "optional": true, "description": "Undefined value or window object returned by the window.open method , when the windowTarget property is set." } ], "visibility": "public" }, "isEnabled": { "description": "Determines whether a command is enabled. A UI uses this state to enable or disable a menu item. Example: A file deletion command returns true when a file is selected. Alternatively, you can declare this enablement as part of the command declaration in the plugin.json file using the enabled property.", "params": [ { "name": "vValue", "type": "object", "optional": true, "description": "The value that is passed from the service that calls the isEnabled method." } ], "visibility": "public" }, "isAvailable": { "description": "Determines whether a command is available. A UI would use this state to show or hide a menu item. Example: A debug command returns false if no debugging is performed at all. Note that the availability may alternatively be declared as part of the command declaration in the plugin.json file using the available property.", "params": [ { "name": "vValue", "type": "object", "optional": true, "description": "The value that is passed from the service that calls the isAvailable method." } ], "visibility": "public" } }, "configurationProperties": {} }, "sap.watt.common.service.ide.CommandGroupItemProvider": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ide.CommandGroupItemProvider", "basename": "sap.watt.common.service.ide.CommandGroupItemProvider", "visibility": "public", "description": "When it is not possible to statically configure the items of a group, the CommandGroupItemProvider interface allows you to implement a service that returns items dynamically", "events": {}, "methods": { "getItems": { "visibility": "public", "description": "Returns an array of ActionItem elements that connect to the CommandGroup." } }, "configurationProperties": {} }, "sap.watt.common.service.ide.Log": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ide.Log", "basename": "sap.watt.common.service.ide.Log", "visibility": "internal", "description": "Implement this interface when you want to add a log target to the log service by configuring the targets configuration property. A default implementation of this interface is the \"sap.watt.platform.log/service/Log\" module.", "events": {}, "methods": {}, "configurationProperties": { "name": { "name": "sName", "type": "string", "description": "name of the log target", "visibility": "internal" }, "bufferSize": { "name": "size", "type": "number", "description": "The size of the text buffer in number of lines", "visibility": "internal" }, "logLevel": { "name": "sLevel", "type": "string", "description": "The default log level. Only messages with greater or equal level will be notified to clients. Order: debug < info < warn < error", "visibility": "internal" } } }, "sap.watt.common.service.platform.DocumentProvider": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.platform.DocumentProvider", "basename": "sap.watt.common.service.platform.DocumentProvider", "visibility": "internal", "description": "The interface for the document provider.", "component": "CA-WDE-WRK", "events": {}, "methods": { "getDocumentByKeyString": { "deprecated": { "since": "1.7.0", "until": "2.0.0", "description": "Use context.service.document.getDocumentByKeyString() instead." }, "description": "Gets a document according to its key string.", "params": [ { "name": "sKeyString", "type": "string", "description": "Key string." } ], "returns": { "type": "sap.watt.common.plugin.document.Document", "description": "The document that is found." }, "visibility": "internal" }, "createDocumentInternally": { "description": "Creates a document instance based on the entity. Make sure that it doesn't create the instance in the back end. To create a document in the back end, get a document and create a child document from it (for example: folder.createFile()).", "params": [ { "name": "oEntity", "type": "object", "description": "The entity that contains the basic information for creating a document." }, { "name": "oEventEmitter", "type": "object", "description": "The event emitter context of the document service." } ], "returns": { "type": "sap.watt.common.plugin.document.Document", "description": "The newly created document instance that contains the specific methods of the type adaptor." }, "visibility": "internal" } }, "configurationProperties": {} }, "sap.watt.common.service.remote.Run": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.remote.Run", "basename": "sap.watt.common.service.remote.Run", "visibility": "internal", "description": "Interface for remote run", "component": "CA-WDE-RUN", "events": { "runProgress": { "params": [ { "name": "oResponse", "type": "object", "description": "Includes the processId, status, and project parameters." } ], "description": "This event is fired when the server reports progress on the run process.", "visibility": "internal" } }, "methods": { "run": { "visibility": "internal", "params": [ { "name": "oProjectDocument", "type": "sap.watt.common.plugin.document.Document", "description": "Project to run." } ], "returns": { "type": "string", "description": "The application URL." }, "description": "Runs a generic runner on a remote server." }, "stop": { "visibility": "internal", "params": [ { "name": "sRunId", "type": "string", "description": "ID of runner to stop." }, { "name": "sProjectId", "type": "string", "description": "Project to stop." } ] }, "getProcesses": { "visibility": "internal", "params": [ { "name": "oProjectDocument", "type": "sap.watt.common.plugin.document.Document", "description": "Project to get processes for." } ], "returns": { "type": "object", "description": "The project processes array." }, "description": "Gets processes of specific project." }, "refresh": { "visibility": "internal", "params": [ { "name": "oProjectDocument", "type": "sap.watt.common.plugin.document.Document", "description": "Project to get processes for." }, { "name": "oRefreshBody", "type": "object", "description": "Refresh request body." } ], "returns": { "type": "string", "description": "The application URL." }, "description": "Restart specific runner process." } }, "configurationProperties": {} }, "sap.watt.common.service.selection.Provider": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.selection.Provider", "basename": "sap.watt.common.service.selection.Provider", "visibility": "internal", "description": "The selection provider interface. Base interface for all selectable ui parts. UI parts which implement this interface will have their selection returned from the selection service while in focus.", "component": "CA-WDE-SEL", "events": { "selectionChanged": { "description": "Fired when the selection of the selection provider changes.", "visibility": "internal" } }, "methods": { "getSelection": { "description": "Returns the selected object", "returns": { "type": "object", "description": "The currently selected object of the selection provider. The selection may be an array." }, "visibility": "internal" } }, "configurationProperties": {} }, "sap.watt.common.service.template.Template": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.template.Template", "basename": "sap.watt.common.service.template.Template", "visibility": "public", "description": "The template interface. A template must provide a template module (a JavaScript file referenced from the template property of the template configuration), implementing these interface methods, which can be used as extension points for the generation process and behavior of the template's generation wizard.", "events": {}, "methods": { "onBeforeTemplateGenerate": { "description": "Applies the template logic before generating the template resources into the provided .zip file. It is executed before passing the model to the template resources, and is therefore ideal for model manipulations.", "visibility": "public", "params": [ { "name": "templateZip", "type": "object", "description": "A JSZip object containing the generated project resources that are generated according to the template resources." }, { "name": "model", "type": "object", "description": "JSON object that includes the data provided by all the wizard steps that are used for generating the template." } ], "example": "return oTemplate.onBeforeTemplateGenerate(templateZip, oModel).then(function (aResults) {\n});" }, "onAfterGenerate": { "description": "This method is executed after generating the new project's .zip file, but before extracting its files to the SAP Web IDE workspace. Therefore, this method is ideal for manipulating the generated project files, for example: renaming files according to the template model.", "visibility": "public", "params": [ { "name": "projectZip", "type": "object", "description": "a JSZip object containing the generated project resources after applying the model parameters on the template resources." }, { "name": "model", "type": "object", "description": "JSON object that includes the data provided by all the wizard steps used for generating the template." } ], "example": "return oTemplate.onAfterGenerate(projectZip, oModel).then(function (aResults) {\n});" }, "customValidation": { "description": "The current validation infrastructure checks whether the template can be selected in the wizard within the context of the user selections (using project type validation). This is used for preventing the user from selecting a template when it is not appropriate according to previous selections in the generation wizard or workspace. Use this method to add more validations, if needed.", "visibility": "public", "params": [ { "name": "model", "type": "object", "description": "The template model that is created in the generation wizard based on user selections." } ], "returns": { "type": "boolean", "default": true, "description": "Returns true if validation succeeds, or false if validation fails." }, "example": "return oTemplate.customValidation(oModel).then(function (bResult) {\n});" }, "onBeforeTemplateCustomizationLoaded": { "visibility": "public", "description": "In this method, the template developer can configure the template model and wizard model before the template customization step loads the UI; for example, when a user wants to set one of the template model parameters as the component path.", "params": [ { "name": "wizardModel", "type": "object", "description": "The model that contains the wizard parameters and values set by the previous wizard steps." }, { "name": "templateModel", "type": "object", "description": "The model representing the model.json of the template." } ], "returns": { "type": "[object]", "description": "An array of models, including the wizard and template models." }, "example": "return oTemplate.onBeforeTemplateCustomizationLoaded(oWizardModel, oTemplateModel).then(function(aResults) {\n});" }, "configWizardSteps": { "description": "Configures the wizard steps that appear after the template is selected in the wizard. The method arguments are the wizard step objects that appear after selecting the template. This method is used to set up step parameters and event handlers that define appropriate relations between steps; for example, defining how step 2 handles changes that occur in step 1.", "visibility": "public", "params": [ { "name": "wizardStep", "type": "object", "description": "The wizard steps that appear after the template is selected in the wizard." } ], "returns": { "type": "[object]", "description": "An array of wizard step objects." }, "example": "return oTemplate.configWizardSteps().then(function (aSteps) {\n});" } }, "configurationProperties": {} }, "sap.watt.common.service.htmlproducer.HtmlProducer": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.htmlproducer.HtmlProducer", "basename": "sap.watt.common.service.htmlproducer.HtmlProducer", "visibility": "internal", "description": "Used for injecting JavaScript code into the HTML file that is used for previewing with SAP Web IDE.", "component": "CA-WDE-RUN-UI", "events": {}, "methods": { "extendRunnableHtml": { "params": [ { "name": "oConfiguration", "type": "object" } ], "returns": { "type": "object" }, "visibility": "internal", "description": "Extends the content of the runnable HTML file." } }, "configurationProperties": {} }, "sap.watt.common.service.ui.Part": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ui.Part", "basename": "sap.watt.common.service.ui.Part", "visibility": "public", "description": "The UI part interface, which is the base interface for all visual components.", "component": "CA-WDE-MNU", "events": { "visibilityChanged": { "description": "Fired when the visibility of the part interface is changed.", "params": [ { "name": "visible", "type": "boolean", "description": "The target visibility state of the part instance." } ], "visibility": "public" } }, "methods": { "getContent": { "description": "Calls the getContent method whenever the part instance content is required.", "returns": { "type": "object", "description": "The UI component of the part instance." }, "visibility": "public" }, "getFocusElement": { "description": "Returns the UI element which can receive the focus in the UI component of the part instance.", "returns": { "type": "object", "description": "The UI element which can receive the focus." }, "visibility": "internal" }, "setVisible": { "description": "Changes the visibility state of the part instance.", "params": [ { "name": "bVisible", "type": "boolean", "description": "The target visibility state of the part instance." } ], "visibility": "internal" }, "isVisible": { "description": "The visibility state of the part instance.", "returns": { "type": "boolean", "description": "Returns the visibility state of the part instance." }, "visibility": "public" } }, "configurationProperties": { "styles": { "description": "Allows loading a CSS file from a provided URI.", "type": [ { "uri": "string", "type": "string" } ], "multiple": false, "visibility": "public" } } }, "sap.watt.common.service.ui.ProjectSettingConfig": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ui.ProjectSettingConfig", "basename": "sap.watt.common.service.ui.ProjectSettingConfig", "visibility": "public", "description": "The ProjectSettingConfig interface. Base interface for project settings configuration.", "events": { "changed": { "description": "Fires when changes are made to the project settings.", "params": [ { "name": "service", "type": "object" } ], "visibility": "public" } }, "methods": { "getContent": { "description": "Gets the project settings of the given project path from the ProjectSettingConfig instance.", "params": [ { "name": "sProjectPath", "type": "string", "optional": true, "description": "The project path. If not defined, the actual selection is used." } ], "returns": { "type": "object" }, "visibility": "public" }, "save": { "description": "Saves the project settings in the ProjectSettingConfig instance for the given project path.", "params": [ { "name": "sProjectPath", "type": "string", "optional": true, "description": "The project path. If not defined, the actual selection is used." } ], "returns": { "type": "object" }, "visibility": "public" }, "isAvailable": { "description": "Shows or hides the configuration pane you added to the project settings area of SAP Web IDE.", "params": [ { "name": "oProjectDocument", "type": "sap.watt.common.document.Document", "description": "Project document data." } ], "returns": { "type": "boolean", "default": true }, "visibility": "public" }, "getContentMessageStrip": { "description": "Gets the message strip control according from the project path from the ProjectSettingConfig instance.", "params": [ { "name": "sProjectPath", "type": "string", "optional": true, "description": "The project path. If not defined, the actual selection is used." } ], "returns": { "type": "sap.watt.ui.control.MessageStrip" }, "visibility": "public" }, "getContentPreview": { "description": "Gets the project settings preview pane according from the project path from the ProjectSettingConfig instance.", "params": [ { "name": "sProjectPath", "type": "string", "optional": true, "description": "The project path. If not defined, the actual selection is used." } ], "returns": { "type": "sap.ui.core.Control" }, "visibility": "public" } }, "configurationProperties": {} }, "sap.watt.common.service.ui.UserPreferenceConfig": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ui.UserPreferenceConfig", "basename": "sap.watt.common.service.ui.UserPreferenceConfig", "visibility": "public", "description": "The UserPreferenceConfig interface. Base interface for user preference configuration.", "events": { "changed": { "description": "Fires when changes are made to the user preferences.", "params": [ { "name": "service", "type": "object" } ], "visibility": "public" } }, "methods": { "getContent": { "description": "Gets the user preferences from the UserPreferenceConfig instance.", "params": [], "returns": { "type": "object" }, "visibility": "public" }, "save": { "description": "Saves the user preferences in the UserPreferenceConfig instance.", "params": [], "returns": { "type": "object" }, "visibility": "public" }, "isAvailable": { "description": "Shows or hides the configuration pane you added to the Preferences perspective of SAP Web IDE.", "params": [], "returns": { "type": "boolean", "default": true }, "visibility": "public" }, "getContentMessageStrip": { "description": "Gets the message strip control as part of the user preference content from the UserPreferenceConfig instance.", "returns": { "type": "sap.watt.ui.control.MessageStrip" }, "visibility": "public" }, "getContentPreview": { "description": "Gets the preview pane of the user preference content from the UserPreferenceConfig instance.", "returns": { "type": "sap.ui.core.Control" }, "visibility": "public" } }, "configurationProperties": {} }, "sap.watt.common.service.ui.WizardPart": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ui.WizardPart", "basename": "sap.watt.common.service.ui.WizardPart", "visibility": "public", "description": "The WizardPart interface is a base interface for all the visual wizard components, such as wizard steps.", "events": {}, "methods": { "getContent": { "description": "Creates and returns the SAPUI5 control displaying the relevant wizard part (as sap.watt.uitools.plugin.template.ui.wizard.WizardStep).", "visibility": "public", "returns": { "type": "object", "description": "An SAPUI5 control that displays a relevant wizard part, such as sap.watt.uitools.plugin.template.ui.wizard.WizardStep." }, "example": "return oAppDescriptorService.getContent().then(function(oAppDescriptorStep) {\n});" } }, "configurationProperties": { "styles": { "description": "The styles configuration object is used for adding a style sheet to a wizard part.", "visibility": "public", "type": [ { "uri": "string", "type": "string" } ], "multiple": false } } }, "sap.watt.common.service.ui.WizardStep": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ui.WizardStep", "basename": "sap.watt.common.service.ui.WizardStep", "visibility": "public", "description": "The wizard step interface. Any wizard step that is intended to be available in the template creation wizards is a UI wizard part whose getContent method initiates the step UI (extending sap.watt.uitools.plugin.template.ui.wizard.WizardStepContent) with the this.context property, and returns the result of the getWizardStep method of the wizard service with the step content object, the step title, and description.", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.common.service.ui.WizardFinishStep": { "kind": "interface", "name": "Interfaces.sap.watt.common.service.ui.WizardFinishStep", "basename": "sap.watt.common.service.ui.WizardFinishStep", "visibility": "public", "description": "The interface for the last step of a wizard. Any wizard final step is a WizardPart interface whose getContent method initiates the step UI (extending the sap.watt.uitools.plugin.template.ui.wizard.WizardStepContent parameter) with the this.context property. The getContent method then returns the result of the getWizardStep method of the wizard service with the WizardStep interface content object.", "events": {}, "methods": {}, "configurationProperties": {} }, "sap.watt.saptoolsets.mta.common.mtaproject.MTAProjectSpaceProvider": { "kind": "interface", "name": "Interfaces.sap.watt.saptoolsets.mta.common.mtaproject.MTAProjectSpaceProvider", "basename": "sap.watt.saptoolsets.mta.common.mtaproject.MTAProjectSpaceProvider", "visibility": "internal", "description": "The interface for MTAProjectSpace provider. MTAProjectSpace services register themselves by configuring this service", "component": "CA-WDE-BLD", "events": {}, "methods": { "getProjectSpace": { "visibility": "internal", "params": [ { "name": "sProjectName", "type": "string", "description": "Project Name for which to return the space" } ], "returns": { "type": "object", "description": "The Project Space (name and guid) as configured on server" } }, "getActiveProjectSpace": { "visibility": "internal", "params": [ { "name": "sProjectName", "type": "string", "description": "Project Name for which to return the space" } ], "returns": { "type": "object", "description": "The Active Project Space (user preferences or project settings) as configured on server" } } }, "configurationProperties": {} } }, "Services": { "annotations": { "kind": "service", "name": "Services.annotations", "basename": "annotations", "visibility": "public", "description": "The annotations service manages functionality related to the OData service annotations.", "component": "CA-WDE-TPL", "events": {}, "methods": { "getAnnotationsUrls": { "name": "getAnnotationsUrls", "visibility": "internal", "static": true, "description": "Returns an array of Annotations file URLs for a specific service and destination.", "params": [ { "name": "oDestination", "type": "object", "optional": "false", "description": "The destination object." }, { "name": "sServiceUri", "type": "string", "optional": "false", "description": "The service URI." } ], "returns": { "type": "Array", "description": "An array of annotations urls." } }, "getAnnotationXML": { "name": "getAnnotationXML", "visibility": "internal", "static": true, "description": "Gets the annotation file content as an XML code.", "params": [ { "name": "oDestination", "type": "object", "optional": "false", "description": "An object which consists of the following objects: description, name, path, url, and wattUsage," }, { "name": "sAnnotationsRelativeUrl", "type": "string", "optional": "false", "description": "The relative URL of the annotation." } ], "returns": { "type": "string", "description": "The XML content as a string." } }, "getMetaModel": { "name": "getMetaModel", "visibility": "internal", "static": true, "description": "Creates and return MetaModel parameter based on the service and list of annotation files.", "params": [ { "name": "sServiceUri", "type": "string", "optional": "false", "description": "The service URI." }, { "name": "aAnnotations", "type": "Array", "optional": "false", "description": "An Array of annotations." }, { "name": "sMetadataContent", "type": "string", "optional": "false", "description": "The metadata object content." } ], "returns": { "type": "object", "description": "The MetaModel object based on the service and list of annotation files." } }, "isMetaDataContainsAnnotions": { "name": "isMetaDataContainsAnnotions", "visibility": "public", "static": true, "description": "Checks if the metadata object contains annotations.", "params": [ { "name": "oMetaDataContent", "type": "object", "optional": "false", "description": "The metadata object content." } ], "returns": { "type": "boolean", "description": "true if the given metadata object contains annotations." }, "example": "return oAnnotationService.isMetaDataContainsAnnotions(_sMetadataWithannotations).then(function(res){\n});" }, "mockFiles": { "name": "mockFiles", "visibility": "internal", "static": true, "description": "Mocks files for creating a MetaModel object.", "params": [ { "name": "sServiceURL", "type": "string", "optional": "false", "description": "The service URL or null if it needs to be mocked." }, { "name": "sMetadataContent", "type": "string", "optional": "false", "description": "The Metadata object content to be returned by the mock function." }, { "name": "aAnnotations", "type": "Array", "optional": "false", "description": "The array of annotations files to be mocked." } ] } }, "configurationProperties": {} }, "basevalidator": { "kind": "service", "name": "Services.basevalidator", "basename": "basevalidator", "visibility": "public", "description": "The basevalidator service enables the registration of code validation services and also is responsible for triggering the validation of common editor events such as changing or saving a document and pushing to Git.", "component": "CA-WDE-EDT-VAL", "events": {}, "methods": { "getCurrentValidatorServiceProxyById": { "name": "getCurrentValidatorServiceProxyById", "visibility": "internal", "static": true, "description": "Returns a proxy for the code validation service according to its serviceID parameter.", "params": [ { "name": "serviceID", "type": "String", "optional": "false", "description": "Is the serviceID parameter of the code validation service." } ], "returns": { "type": "Object", "description": "oServiceProxy - A proxy for the validator service." } } }, "configurationProperties": { "validator": { "name": "validator", "type": "Object[]", "description": "Configures a code validator.", "params": [ { "name": "validatorName", "type": "string", "description": "Unique name for the code validator." }, { "name": "fileExtension", "type": "string[]", "description": "File extensions supported by the code validator." }, { "name": "syncExec", "type": "boolean", "description": "Determines whether to execute a validation synchronously." }, { "name": "service", "type": "sap.watt.common.service.editor.Validator", "description": "Code validator implementation service." }, { "name": "configurationService", "type": "sap.watt.common.service.editor.ValidatorConfiguration", "description": "Optional service for handling the validator configuration." }, { "name": "displayConfigurationService", "type": "sap.watt.common.service.editor.DisplayValidatorConfiguration", "description": "Optional service for handling the validator configuration conversion to the display format of the project settings." } ], "visibility": "public", "example": "{\n \"name\": \"sampleValidator\",\n \"description\": \"sample validator service\",\n\n \"requires\": {\n \"services\": [\n \"basevalidator\"\n ]\n },\n \"provides\": {\n \"services\" : {\n \"sampleValidator\" :{\n \"module\" : \"tokyo/ideplatform/plugin/baseValidator/mocks/forSDK/sampleValidator\"\n }\n }\n },\n \"configures\":{\n \"services\":{\n \"basevalidator:validator\" : [\n {\n \"validatorName\": \"sample Validator\",\n \"fileExtension\": [\"abc\"],\n \"service\": \"@sampleValidator\"\n }\n ]\n }\n }\n}" } } }, "beautifierProcessor": { "kind": "service", "name": "Services.beautifierProcessor", "basename": "beautifierProcessor", "visibility": "internal", "description": "The beautifierProcessor service allows plugins to perform beautify operations on text files such as Java or JavaScript.", "component": "CA-WDE-EDT-FMT", "events": {}, "methods": { "beautify": { "name": "beautify", "visibility": "internal", "static": true, "description": "Execution of beautifier on string content", "params": [ { "name": "sContent", "type": "string", "optional": "false", "description": "The content to beautify." }, { "name": "sFileExtension", "type": "string", "optional": "false", "description": "The file extension for the content." }, { "name": "aContentTypes-", "type": "Object[]", "optional": "false", "description": "Optional: Content types to use for searching beautifier." }, { "name": "oSettings", "type": "object", "optional": "false", "description": "Optional: If not supplied, default settings are applied." } ], "returns": { "type": "Promise.", "description": "- The beautified content." } }, "beautifyDocument": { "name": "beautifyDocument", "visibility": "internal", "static": true, "description": "Execution of beautifier on document content.", "params": [ { "name": "oDoc", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The document to beautify." }, { "name": "oSettings", "type": "object", "optional": "false", "description": "Optional: If not supplied, default settings are applied." } ], "returns": { "type": "Promise.", "description": "- The beautified content." } }, "getBeautifiedExtensions": { "name": "getBeautifiedExtensions", "visibility": "internal", "static": true, "description": "Gets the file extensions that were configured for beautification.", "returns": { "type": "string[]", "description": "- An array that is populated with the file extensions that were configured." } }, "hasBeautifierForDocument": { "name": "hasBeautifierForDocument", "visibility": "internal", "static": true, "description": "Checks if a document has beautifier", "params": [ { "name": "oDoc", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The document object." } ], "returns": { "type": "Promise.", "description": "- True or False if there is a beautifier or not for the specific file extension." } } }, "configurationProperties": {} }, "command": { "kind": "service", "name": "Services.command", "basename": "command", "visibility": "public", "description": "The command service allows plugins to add commands to SAP Web IDE that enable certain actions for the application developer, such as beautify, deploy, and Git commit. A command is rendered in the UI as part of a command group. The command service implements the command pattern, and when it is triggered by a UI interaction, such as a mouse click or keyboard shortcut, it invokes the execute method.", "component": "CA-WDE-MNU", "events": {}, "methods": { "getCommand": { "name": "getCommand", "visibility": "internal", "static": true, "description": "Get a specific command by ID.", "params": [ { "name": "sCommandId", "type": "string", "optional": "false", "description": "Command ID used for identifying a command in SAP Cloud IDE." } ], "returns": { "type": "Promise.", "description": "An object representing the command. If the command is not found, an Error is thrown." }, "example": "return oCommandService.getCommand(\"test.sample.Command.id\").then(function(oCommand) {\n console.log(oCommand);\n // {\n //\t\"id\" : \"test.sample.Command.id\",\n //\t\"label\": \"Run\",\n //\t\"icon\": \"run\",\n //\"service\": \"core.platform2.platform.plugin.command.SampleCommand\",\n //\t\"keyBinding\": \"mod+y\"\n //}\t\n return oCommand;\n});" }, "invalidateAll": { "name": "invalidateAll", "visibility": "internal", "static": true, "description": "Fires an invalidation event for all commands, to allow listeners of this event handle changes in the command states.", "returns": { "type": "Promise.", "description": "A promise which is resolved immediately, without waiting for command invalidation handlers." } } }, "configurationProperties": { "commands": { "name": "commands", "type": "Object[]", "description": "The command configuration object is used for creating a command in SAP Web IDE.", "params": [ { "name": "id", "type": "string", "description": "The command ID is used for identifying a command on the Cloud IDE platform." }, { "name": "service", "type": "sap.watt.common.service.ide.Command", "description": "Located in the command folder, each command has a service that implements the logic of the 'execute' method and additional related logic." }, { "name": "keyBinding", "type": "string", "description": "Specifies keyboard shortcuts for the command." }, { "name": "label", "type": "string", "description": "Specifies a label for the command; for example, a label on the Menu bar." }, { "name": "icon", "type": "string", "description": "Specifies an icon for the command." }, { "name": "iconLabel", "type": "string", "description": "Specifies an icon label for the command. The icon label is displayed next to the icon." }, { "name": "available", "type": "boolean", "description": "Determines whether a command is available. Only available commands appear in the UI. If the available property is explicitly defined, the isAvailable method is not invoked." }, { "name": "enabled", "type": "boolean", "description": "Determines whether a command is enabled. If a command is not enabled, it appears as grayed out in the UI. If the enabled property is explicitly defined, the isEnabled method is not invoked." }, { "name": "windowTarget", "type": "string", "description": "Setting this property opens a window with the provided target name; this is similar to the HTML anchor <a> tag target attribute." } ], "visibility": "public", "example": "{\n \"name\": \"SampleCommandConsumer\",\n \"configures\": {\n \"services\": {\n \"command:commands\": [{\n \"id\": \"test.sample.Command.id\",\n \"label\": \"Run\",\n \"icon\": \"run\",\n \"service\": \"core.platform2.platform.plugin.command.SampleCommand\",\n \"keyBinding\": \"mod+y\"\n }\n ]\n }\n }\n}" } } }, "commandGroup": { "kind": "service", "name": "Services.commandGroup", "basename": "commandGroup", "visibility": "public", "description": "The commandGroup service allows plugins to add new groups to SAP Web IDE. A command group can contain inner command groups or commands.", "component": "CA-WDE-MNU", "events": {}, "methods": {}, "configurationProperties": { "groups": { "name": "groups", "type": "Object[]", "description": "Is used for creating a command group in SAP Web IDE. Groups can be reused in other groups to ensure that menu structures in the entire application are identical.", "params": [ { "name": "id", "type": "string", "description": "Command group ID is used for identifying a command group in the SAP Web IDE." }, { "name": "label", "type": "string", "description": "Specifies a label for a group." }, { "name": "icon", "type": "string", "description": "Specifies an icon for a group." }, { "name": "service", "type": "sap.watt.common.service.ide.CommandGroupItemProvider", "description": "Items can be provided dynamically using a service that implements the CommandGroupItemProvider interface." } ], "visibility": "public", "example": "{\n \"name\" : \"commandGroupConsumer\",\n \"configures\" : {\n\n \"services\" : {\n \"commandGroup:groups\" : [\n {\"id\" : \"commandGroupSample.dummy.action\", \"label\" : \"Dummy Action\"},\n { \"id\" : \"commandGroupSample.dummy.inline\", \"label\": \"Dummy Inline\"},\n ]\n }\t// end of service\n } // end of configure\n}" }, "items": { "name": "items", "type": "Object[]", "description": "Determines the hierarchy of the command groups. Each item object has a parent command group and can reference an existing command or command group.", "params": [ { "name": "id", "type": "string", "description": "Used for identifying an item in SAP Web IDE." }, { "name": "parent", "type": "string", "description": "The direct parent command group ID that holds the item object." }, { "name": "type", "type": "string", "description": "The type property specifies the type of group item. There are several types available for the item property, such as action, menu, inline, and list." }, { "name": "command", "type": "string", "description": "The ID of the associated command." }, { "name": "group", "type": "string", "description": "The ID of the associated commandGroup." }, { "name": "label", "type": "string", "description": "Specifies a label for the group item." }, { "name": "icon", "type": "string", "description": "Specifies an icon for the group item." }, { "name": "default", "type": "string", "description": "Specifies whether the action is the default action. This is relevant for an item in the action type. When two or more action items in a group are set as the default property, the action with the highest priority becomes the default. When the item's type is menu and rendered in the toolbar while one of the action items of the associated group has a default action, the menu is rendered as a split button." }, { "name": "prio", "type": "string", "description": "The item's order priority in the group." } ], "visibility": "public", "example": "{\n \"commandGroup:items\": [\n {\"parent\": \"commandGroupSample.dummy.action\", \"command\": \"commandSample.createFile\", \"prio\": 1},\n {\"parent\": \"commandGroupSample.dummy.inline\", \"group\": \"commandGroupSample.foo.inline\", \"type\": \"inline\", \"prio\": 1}\n ]\n}" }, "itemToPerspectiveMapping": { "name": "itemToPerspectiveMapping", "type": "Object[]", "description": "Determines the perspectives in which an item appears. If no mapping is specified, the item appears in all perspectives.", "params": [ { "name": "id", "type": "string", "description": "The ID of the item." }, { "name": "perspective", "type": "string", "description": "The ID of the perspective." } ], "visibility": "public", "example": "{\n \"commandGroup:itemToPerspectiveMapping\" : [\n { \"id\" : \"commandSample.createFile\", \"perspective\" : \"development\" },\n { \"id\" : \"commandGroupSample.welcome.menu\", \"perspective\" : \"welcome\" }\n ]\n}" } } }, "content": { "kind": "service", "name": "Services.content", "basename": "content", "visibility": "public", "description": "The content service maps a document to an editor, enabling the document to be displayed or edited.", "component": "CA-WDE-EDT", "events": {}, "methods": { "getContextTab": { "name": "getContextTab", "visibility": "internal", "static": true, "examples": [ { "text": "oContentService.getContextTab().then(function(oContextTab) {" } ], "returns": { "type": "Object", "description": "context tab" } }, "getCurrentDocument": { "name": "getCurrentDocument", "visibility": "public", "static": true, "description": "Returns a document object for the file in the active tab, or null if no tabs are open.", "returns": { "type": "sap.watt.common.document.Document", "description": "A document object for the file in the active tab." }, "example": "return oContentService.getCurrentDocument().then(function(oDocument) {\n});" }, "getCurrentEditor": { "name": "getCurrentEditor", "visibility": "internal", "static": true, "description": "Returns editor service of current tab", "examples": [ { "text": "this.getCurrentEditor()" } ], "returns": { "type": "sap.watt.common.service.editor.Editor", "description": "An editor service object of the current tab" } }, "getDocuments": { "name": "getDocuments", "visibility": "internal", "static": true, "examples": [ { "text": "this.getDocuments(true);" } ], "params": [ { "name": "bOnlyTheDirty:", "type": "undefined", "optional": "false", "description": "if undefined or false return all documents, else return only the dirty documents" } ], "returns": { "type": "object[]" } }, "open": { "name": "open", "visibility": "public", "static": true, "description": "Opens a specified document with a specified editor such as the layout editor or compare editor.", "examples": [ { "text": "this.context.service.content.open(oDocument, oEditor).then(function() {;" } ], "params": [ { "name": "oDocument", "type": "sap.watt.common.document.Document", "optional": "false", "description": "The document object." }, { "name": "oEditor", "type": "sap.watt.common.service.editor.Editor", "optional": "false", "description": "The editor service." } ], "example": "return oContentService.open(oFile1Doc, oAceEditorService);" } }, "configurationProperties": {} }, "contextMenu": { "kind": "service", "name": "Services.contextMenu", "basename": "contextMenu", "visibility": "internal", "description": "The contextMenu service opens a context menu associated with a command group.", "component": "CA-WDE-MNU", "events": {}, "methods": { "open": { "name": "open", "visibility": "internal", "static": true, "description": "Opens a context menu with a specific command group at the specified coordinates.", "params": [ { "name": "sGroup", "type": "string", "optional": "false", "description": "The command group that the context menu should display." }, { "name": "iPageX", "type": "number", "optional": "false", "description": "The X coordinate of the context menu." }, { "name": "iPageY", "type": "number", "optional": "false", "description": "The Y coordinate of the context menu." } ] } }, "configurationProperties": {} }, "deployment": { "kind": "service", "name": "Services.deployment", "basename": "deployment", "visibility": "public", "description": "The deployment service manages functionality related to the deployment of applications to SAP Cloud Platform.", "component": "CA-WDE-DPL-HCP", "events": { "deploymentToHCPSuccessfullyFinished": { "name": "deploymentToHCPSuccessfullyFinished", "visibility": "public", "description": "Fired when the deployment to SAP Cloud Platform has successfully finished.", "params": [ { "name": "deployedAppName", "type": "string", "description": "The application name in SAP Cloud Platform." }, { "name": "projectDocument", "type": "Object", "description": "The document object representing the application in SAP Web IDE." }, { "name": "version", "type": "string", "description": "The application version (for example 1.0.2)." }, { "name": "URL", "type": "string", "description": "The URL of the application in SAP Cloud Platform." }, { "name": "bAppIndexMessages", "type": "boolean", "description": "Specify whether the app index replication has returned any messages or not." } ], "example": "\"subscribes\":{\n \"deployment: deploymentToHCPSuccessfullyFinished\" :\"someservice:onHCPDeploy\"\n}" } }, "methods": {}, "configurationProperties": {} }, "document": { "kind": "service", "name": "Services.document", "basename": "document", "visibility": "public", "description": "The document service allows access to all documents that are defined and accessible through document providers. The service also handles document caching.", "component": "CA-WDE-WRK", "events": { "changed": { "name": "changed", "visibility": "internal", "description": "Fired when a property of a document is changed.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The changed document." }, { "name": "changeType", "type": "string", "description": "The type of the change. Possible values are: content, created, renamed, children, hidden, deleted, release." } ], "example": "\"subscribes\":{\n \"document:changed\" :\"myTestDocumentExampleService2:onChange\"\n}" }, "created": { "name": "created", "visibility": "internal", "description": "Fired when a new document is created.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The new document." } ], "example": "\"subscribes\":{\n \"document:created\" :\"myTestDocumentExampleService1:onCreate\"\n}" }, "deleted": { "name": "deleted", "visibility": "internal", "description": "Fired when a document is deleted.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The deleted document." } ], "example": "\"subscribes\":{\n \"document:deleted\" :\"myTestDocumentExampleService4:onDelete\"\n}" }, "saved": { "name": "saved", "visibility": "internal", "description": "Fired when the content of a document is persisted.", "params": [ { "name": "document", "type": "sap.watt.common.plugin.document.Document", "description": "The document whose content is saved." } ], "example": "\"subscribes\":{\n \"document:saved\" :\"myTestDocumentExampleService3:onSave\"\n}" } }, "methods": { "getContainedDocuments": { "name": "getContainedDocuments", "visibility": "public", "static": true, "description": "Gets all known documents for which the passed document's entities contain method returns true.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The containing document." }, { "name": "bOnlyDirectChildren", "type": "boolean", "optional": "false", "description": "true if you want to return only direct child objects." } ], "returns": { "type": "object[]", "description": "An array of documents that are found." }, "example": "return oDocumentService.getContainedDocuments(oDoc, true).then(function(aDocs){\n var nNumberOfContainedDocuments = aDocs.length;\n});" }, "getDocumentByKeyString": { "name": "getDocumentByKeyString", "visibility": "public", "static": true, "description": "Retrieves a document according to a key.", "params": [ { "name": "sKeyString", "type": "string", "optional": "false", "description": "The key that is used to retrieve a document." } ], "returns": { "type": "sap.watt.common.plugin.document.Document", "description": "The document instance. Returns null if the document is not found." }, "example": "return oDocumentService.getDocumentByKeyString(\"file:/\" + sProject1Name + \"/aa\").then(function(oDoc) {\n var sName = oDoc.getName();\n});" } }, "configurationProperties": { "providers": { "name": "providers", "type": "object[]", "description": "An array of document providers.", "visibility": "internal" } } }, "filesystem.documentProvider": { "kind": "service", "name": "Services.filesystem.documentProvider", "basename": "filesystem.documentProvider", "visibility": "public", "description": "The filesystem.documentProvider service is the document provider for workspace files and folders. It also provides direct access to the workspace root.", "component": "CA-WDE-WRK", "events": {}, "methods": { "getRoot": { "name": "getRoot", "visibility": "public", "static": true, "description": "Returns the workspace root.", "returns": { "type": "Promise.", "description": "The workspace root document." }, "example": "var that = this;\nreturn this.context.service.filesystem.documentProvider.getRoot().then(function(oRoot) {\n // Get root content\n return that.context.service.document.getContainedDocuments(oRoot, true).then(function(aContainedDocuments) {\n // Go over the content and search for an existing project with the same name\n for (var index = 0; index < aContainedDocuments.length; ++index) {\n if (aContainedDocuments[index].getName() === sProjectName) {\n // Do something with the project.\n }\n }\n });\n});" } }, "configurationProperties": {} }, "focus": { "kind": "service", "name": "Services.focus", "basename": "focus", "visibility": "internal", "description": "The focus service tracks the currently focused service and notifies listeners when the focus changes. It can also set the focus on a service.", "component": "CA-WDE-SEL", "events": {}, "methods": { "attachFocus": { "name": "attachFocus", "visibility": "internal", "static": true, "description": "Adds a focus listener to the focus element of a service. This method is called automatically for perspective views.", "params": [ { "name": "oService", "type": "sap.watt.common.service.ui.Part", "optional": "false", "description": "The service whose focus should be tracked." } ] }, "detachFocus": { "name": "detachFocus", "visibility": "internal", "static": true, "description": "Removes the focus listener from the focus element of a service.", "params": [ { "name": "oService", "type": "sap.watt.common.service.ui.Part", "optional": "false", "description": "The service whose focus should no longer be tracked." } ] }, "setFocus": { "name": "setFocus", "visibility": "internal", "static": true, "description": "Sets the focus on a service. This method attaches a focus listener to the focus element of the service if necessary.", "params": [ { "name": "oService", "type": "sap.watt.common.service.ui.Part", "optional": "false", "description": "The service that should receive the focus." } ] } }, "configurationProperties": {} }, "generation": { "kind": "service", "name": "Services.generation", "basename": "generation", "visibility": "internal", "description": "The generation service for generating a new project based on a template.", "component": "CA-WDE-TPL", "events": {}, "methods": { "generate": { "name": "generate", "visibility": "internal", "static": true, "description": "Generates a new project or component into an existing folder based on the template and user selections in the wizard.", "params": [ { "name": "path", "type": "String", "optional": "false", "description": "The path where the template files should be generated." }, { "name": "selectedTemplate", "type": "Object", "optional": "false", "description": "The settings of the selected template, as they appear in the plugin.json file of the template plugin." }, { "name": "model", "type": "Object", "optional": "false", "description": "The model of the user selections in the wizard." }, { "name": "bOverwrite", "type": "Boolean", "optional": "false", "description": "States whether the created template files should overwrite an existing project or component." }, { "name": "oTargetDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The document of the newly generated project." } ], "returns": { "type": "Promise.", "description": "A promise which is resolved immediately, without waiting for command invalidation handlers." } }, "generateProject": { "name": "generateProject", "visibility": "internal", "static": true, "description": "Generates a new project based on a template and user selections in the wizard.", "params": [ { "name": "sPath", "type": "String", "optional": "false", "description": "The path where the template files .should be generated." }, { "name": "oSelectedTemplate", "type": "Object", "optional": "false", "description": "The settings of the selected template, as they appear in the plugin.json file of the template plugin." }, { "name": "oModel", "type": "Object", "optional": "false", "description": "The model of the user selections in the wizard." }, { "name": "bOverwrite", "type": "Boolean", "optional": "false", "description": "States whether the created template files should overwrite an existing project or component." }, { "name": "oParentDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The parent document of the template that is passed by the wizard only if there is a subproject module." } ], "returns": { "type": "sap.watt.common.plugin.document.Document", "description": "The newly created project instance." } } }, "configurationProperties": {} }, "heliumwsmapping": { "kind": "service", "name": "Services.heliumwsmapping", "basename": "heliumwsmapping", "visibility": "internal", "description": "The heliumwsmapping service maps a Helium workspace to the development interface (DI).\nThis parameter is used for previewing applications in SAP Web IDE.\nThe mapping is needed for redirecting calls from Helium to Orion to search for the file in DI.", "component": "CA-WDE-COR", "events": {}, "methods": { "getHeliumWorkspaceMapping": { "name": "getHeliumWorkspaceMapping", "visibility": "internal", "static": true, "description": "Returns the Helium workspace mapping string of a document.", "params": [ { "name": "oDocument", "type": "Object", "optional": "false", "description": "The document for which to calculate the path." } ], "returns": { "type": "string", "description": "The Helium workspace mapping string." } } }, "configurationProperties": {} }, "htmlproducer": { "kind": "service", "name": "Services.htmlproducer", "basename": "htmlproducer", "visibility": "internal", "description": "The html producer service allows other plugins to add JS code to the html file that is being used to run the project", "component": "CA-WDE-RUN", "events": {}, "methods": {}, "configurationProperties": { "htmlProducers": { "name": "htmlProducers", "type": "Object[]", "description": "configured properties for an htmlProducer", "params": [ { "name": "id", "type": "string", "description": "the unique ID of the htmlProducer" }, { "name": "htmlProducer", "type": "sap.watt.common.service.htmlproducer.HtmlProducer", "description": "the name of the service which will be attached to the htmlProducer ID." } ], "visibility": "internal" } } }, "keepAlive": { "kind": "service", "name": "Services.keepAlive", "basename": "keepAlive", "visibility": "internal", "description": "The keepAlive service provides information about the state of the connection to the back end.", "component": "CA-WDE-MNU", "events": {}, "methods": { "isAlive": { "name": "isAlive", "visibility": "internal", "static": true, "description": "Checks whether SAP Web IDE is currently connected to the back end.", "returns": { "type": "Promise.", "description": "The check result." } } }, "configurationProperties": {} }, "log": { "kind": "service", "name": "Services.log", "basename": "log", "visibility": "public", "description": "The log service allows plugins to add new messages to the SAP Web IDE log.", "component": "CA-WDE-LOG", "events": {}, "methods": { "debug": { "name": "debug", "visibility": "internal", "static": true, "description": "Logs a debug message.", "params": [ { "name": "sTag", "type": "string", "optional": "false", "description": "A tag for the message, such as the plugin or operation name." }, { "name": "sMessage", "type": "string", "optional": "false", "description": "The message." }, { "name": "aTargets", "type": "Object[]", "optional": "true", "description": "An array of target services that are notified, such as user and system. If not specified, all targets are notified." } ] }, "error": { "name": "error", "visibility": "public", "static": true, "description": "Logs an error message.", "params": [ { "name": "sTag", "type": "string", "optional": "false", "description": "A tag for the message, such as the plugin or operation name." }, { "name": "sMessage", "type": "string", "optional": "false", "description": "The message." }, { "name": "aTargets", "type": "Object[]", "optional": "true", "description": "An array of target services that are notified, such as user and system. If not specified, all targets are notified." } ], "example": "return oLogService.error(\"tag_name\", \"an error message\",[\"user\"]).then(function() {\n});" }, "info": { "name": "info", "visibility": "public", "static": true, "description": "Logs an info message.", "params": [ { "name": "sTag", "type": "string", "optional": "false", "description": "A tag for the message, such as the plugin or operation name." }, { "name": "sMessage", "type": "string", "optional": "false", "description": "The message." }, { "name": "aTargets", "type": "Object[]", "optional": "true", "description": "An array of target services that are notified, such as user and system. If not specified, all targets are notified." } ], "example": "return oLogService.info(\"tag_name\", \"an info message\",[\"user\"]).then(function() {\n});" }, "warn": { "name": "warn", "visibility": "public", "static": true, "description": "Logs a warning message.", "params": [ { "name": "sTag", "type": "string", "optional": "false", "description": "A tag for the message, such as the plugin or operation name." }, { "name": "sMessage", "type": "string", "optional": "false", "description": "The message." }, { "name": "aTargets", "type": "Object[]", "optional": "true", "description": "An array of target services that are notified, such as user and system. If not specified, all targets are notified." } ], "example": "return oLogService.warn(\"tag_name\", \"a warnning message\",[\"user\"]).then(function() {\n});" } }, "configurationProperties": { "targets": { "name": "targets", "type": "object[]", "description": "An array of target services that are notified when messages are logged.", "params": [ { "name": "name", "type": "string", "description": "The name of the target service." }, { "name": "service", "type": "object", "description": "An object that represents the service, including its implementing module and configuration." } ], "visibility": "internal" } } }, "mtafoldertoprojectconvertor.convertor": { "kind": "service", "name": "Services.mtafoldertoprojectconvertor.convertor", "basename": "mtafoldertoprojectconvertor.convertor", "visibility": "internal", "description": "The mtafoldertoprojectconvertor.convertor service converts a folder document to an MTA module.", "component": "CA-WDE-MTA", "events": {}, "methods": { "convertFolderToProject": { "name": "convertFolderToProject", "visibility": "internal", "static": true, "description": "Converts a folder document to an MTA module.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The document to convert." }, { "name": "oProjectData", "type": "Object", "optional": "false", "description": "Project data to set." } ], "returns": { "type": "Promise.", "description": "The convertoed to project folder document." } } }, "configurationProperties": {} }, "mtafoldertoprojectconvertor.validation": { "kind": "service", "name": "Services.mtafoldertoprojectconvertor.validation", "basename": "mtafoldertoprojectconvertor.validation", "visibility": "internal", "description": "The validation service determines if a document can be converted to a multi-target application (MTA) module.", "component": "CA-WDE-WRK", "events": {}, "methods": { "isConvertable": { "name": "isConvertable", "visibility": "internal", "static": true, "description": "Checks if a document can be converted to an MTA module.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The document to check." } ], "returns": { "type": "Promise.", "description": "The check result." } } }, "configurationProperties": {} }, "neoapp": { "kind": "service", "name": "Services.neoapp", "basename": "neoapp", "visibility": "public", "description": "The neoapp service allows plugins to read and write to the neoapp.json file, which consists of multiple configuration keys.", "component": "CA-WDE-TPL", "events": {}, "methods": { "getNeoappDocumentAndContent": { "name": "getNeoappDocumentAndContent", "visibility": "public", "static": true, "description": "Returns the neoapp document and its content in a document in the project.", "params": [ { "name": "oDocument", "type": "Object", "optional": "false", "description": "A document that is selected in the workspace." } ], "returns": { "type": "array", "description": "A neoapp document object and its content." }, "example": "return oNeoappService.getNeoappDocumentAndContent(oTargetDocument).spread(function(oNeoappDocument, oNeoappContent){\n});" } }, "configurationProperties": {} }, "odataDiscovery": { "kind": "service", "name": "Services.odataDiscovery", "basename": "odataDiscovery", "visibility": "public", "description": "The odataDiscovery service handles the discovery information relating to the consumption of OData services in SAPUI5 projects.", "component": "CA-WDE-TPL", "events": {}, "methods": { "getMetadataUri": { "name": "getMetadataUri", "visibility": "public", "static": true, "description": "Returns the local and remote URIs to retrieve the metadata and annotations of an OData service. In SAP Web IDE for HANA, only the local URI is returned.", "params": [ { "name": "sManifestPath", "type": "string", "optional": "false", "description": "The path to the \"manifest.json\" file in a project." }, { "name": "sDataSourceName", "type": "string", "optional": "false", "description": "The name of the data source as it appears in the \"manifest.json\" file." } ], "returns": { "type": "object", "description": "An object with the data source URI information and its annotations information. Each annotation is separate data source entry in the object. Each annotation data source contains a priority property to prioritize it." }, "example": "return oODataDiscoveryService.getMetadataUri(\"/path/to/manifest.json\", \"mainService\")\n .then(function (metadataUris) {\n});" } }, "configurationProperties": {} }, "perspective": { "kind": "service", "name": "Services.perspective", "basename": "perspective", "visibility": "public", "description": "The perspective service allows defining a structured layout with resizable areas.", "component": "CA-WDE-PRS", "events": { "areaSizeChanged": { "name": "areaSizeChanged", "visibility": "internal", "description": "Fired when the size of one or more areas in the perspective changes." }, "perspectiveChanged": { "name": "perspectiveChanged", "visibility": "internal", "description": "Fired when the state of views or areas in the perspective changes or the perspective is switched.\nIn case from and to parameters are the same perspective, it means the visibility of an area or view in that perspective changed.", "params": [ { "name": "from", "type": "string", "description": "The perspective before the event." }, { "name": "to", "type": "string", "description": "The perspective after the event." } ] } }, "methods": { "getAreaForService": { "name": "getAreaForService", "visibility": "internal", "static": true, "description": "Get the name of the area in the current perspective in which a view (or a service associated with a view) is currently displayed.\nIf the view is not displayed in any area, undefined is returned. The area name is returned even if the area is not visible.", "params": [ { "name": "vViewIdOrService", "type": "string", "optional": "false", "description": "The name of the requested view or the service associated with the view." } ], "returns": { "type": "Promise.", "description": "The name of the area that the service is displayed at." } }, "getCurrentPerspective": { "name": "getCurrentPerspective", "visibility": "internal", "static": true, "description": "Return the name of the currently visible perspective.", "returns": { "type": "Promise.", "description": "The name of the current perspective." } }, "isAreaVisible": { "name": "isAreaVisible", "visibility": "internal", "static": true, "description": "Returns an indication of whether an area of the current perspective is visible.", "params": [ { "name": "sAreaId", "type": "string", "optional": "false", "description": "The name of the area." } ], "returns": { "type": "Promise.", "description": "The visibility state of the requested area." } }, "isServiceAvailableInCurrentPerspective": { "name": "isServiceAvailableInCurrentPerspective", "visibility": "internal", "static": true, "description": "Returns whether the given service is available in current visible perspective.", "params": [ { "name": "vViewIdOrService", "type": "object", "optional": "false", "description": "The requested view id or service." } ], "returns": { "type": "Promise.", "description": "Whether the service is available in current perspective." } }, "resetToDefault": { "name": "resetToDefault", "visibility": "internal", "static": true, "description": "Reset the current perspective to its default state. The areas are returned to their configured visibility and size.\nNote: the views displayed in the areas are not changed, except in visible areas which do not currently contain a view, in which case the area will display its default view after the call.", "returns": { "type": "Promise.", "description": "A promise which is resolved after the current perspective was reset to its default state." } }, "switchPerspective": { "name": "switchPerspective", "visibility": "internal", "static": true, "description": "Change the currently visible perspective to a different perspective.", "params": [ { "name": "sPerspective", "type": "string", "optional": "false", "description": "The name of the perspective to switch to." } ], "returns": { "type": "Promise.", "description": "A promise which is resolved after the new perspective is rendered." } } }, "configurationProperties": { "views": { "name": "views", "type": "Object[]", "description": "Determines the service that is mapped to the view ID. A view can be displayed in a perspective.", "params": [ { "name": "id", "type": "string", "description": "Is used for identifying a view in SAP Web IDE." }, { "name": "service", "type": "sap.watt.common.service.ui.Part", "description": "Is displayed in a specific area and should implement the part interface." }, { "name": "area", "type": "string", "description": "The area where the view will be displayed in all perspectives having an area with this name." }, { "name": "cssclass", "type": "string", "description": "The CSS class that is provided for the specific view." }, { "name": "restore", "type": "boolean", "description": "Determines whether a view is rendered on startup if it was opened before SAP Web IDE was closed. The default value of the restore type is true." }, { "name": "persist", "type": "boolean", "description": "Determines whether a view is saved in the user preferences." }, { "name": "alwaysOpenAsDefaultAfterNormalized", "type": "boolean", "description": "Determines whether a service is displayed after the area is minimized, even if it was closed before the area was maximized." } ], "visibility": "public", "example": "{\n \"name\": \"perspectiveExamplesTestConsumer\",\n \"provides\": {\n \"services\": {\n \"perspectiveExamples\": {\n \"implements\": \"sap.watt.common.service.ui.Part\",\n \"module\": \"core/platform2/platform/plugin/perspective/service/perspectiveExamples\"\n }\n }\n },\n \"configures\": {\n \"services\": {\n \"perspective:views\": [\n {\n \"id\": \"perspectiveExamples\",\n \"service\": \"@perspectiveExamples\",\n \"cssclass\": \"example test\"\n }\n ]\n }\n }\n}" }, "viewToAreaMapping": { "name": "viewToAreaMapping", "type": "Object[]", "description": "Determines the placement of a view in each perspective.", "params": [ { "name": "view", "type": "string", "description": "The ID of the view that is displayed." }, { "name": "perspective", "type": "string", "description": "The ID of the perspective in which the view is displayed." }, { "name": "area", "type": "string", "description": "The area where the view is displayed." } ], "visibility": "public", "example": "\"perspective:viewToAreaMapping\": [\n {\n \"view\": \"perspectiveExamples\",\n \"perspective\": \"development\",\n \"area\": \"right\"\n }\n]" } } }, "preferences": { "kind": "service", "name": "Services.preferences", "basename": "preferences", "visibility": "internal", "description": "The preferences service reads and writes user preferences from the backend according to preference key.", "component": "CA-WDE-CPS", "events": {}, "methods": { "get": { "name": "get", "visibility": "internal", "static": true, "description": "Get the value of a user preference.", "params": [ { "name": "sNode", "type": "string", "optional": "false", "description": "The preference key name." } ], "returns": { "type": "Promise.", "description": "The preference value." } }, "isGlobal": { "name": "isGlobal", "visibility": "internal", "static": true, "description": "Checks whether the given key saved in global preferences.", "params": [ { "name": "sNode", "type": "string", "optional": "false", "description": "The preference key." } ], "returns": { "type": "boolean", "description": "true - saved as global, otherwise false." } }, "remove": { "name": "remove", "visibility": "internal", "static": true, "description": "Remove user preferences according to key.\nNote: the actual remove operation to the backend may be delayed to improve performance. This does not affect get operations through the preference service.", "params": [ { "name": "sNode", "type": "string", "optional": "false", "description": "The preference key." }, { "name": "bForceSave", "type": "boolean", "optional": "true", "description": "Immediately perform the remove operation. Default is false. Note: sending true may impact performance." }, { "name": "bGlobal", "type": "boolean", "optional": "true", "description": "The preferences value is removed from all user workspaces. Default is false." } ], "returns": { "type": "Promise.", "description": "A promise which is resolved after the operation is complete. If bForceSave was not set to true, this may be before the preferences are updated in the backend." } }, "set": { "name": "set", "visibility": "internal", "static": true, "description": "Save user preferences according to key.\nNote: the actual set operation to the backend may be delayed to improve performance. This does not affect get operations through the preference service.", "params": [ { "name": "oSettings", "type": "Object", "optional": "false", "description": "The preference value, which is an object that can be serialized to JSON format." }, { "name": "sNode", "type": "string", "optional": "false", "description": "The preference key." }, { "name": "bForceSave", "type": "boolean", "optional": "true", "description": "Immediately save the preferences. Default is false. Note: sending true may impact performance." }, { "name": "bGlobal", "type": "boolean", "optional": "true", "description": "The preferences value is used for all user workspaces. Default is false." } ], "returns": { "type": "Promise.", "description": "A promise which is resolved after the operation is complete. If bForceSave was not set to true, this may be before the preferences are updated in the backend." } } }, "configurationProperties": {} }, "projectsetting": { "kind": "service", "name": "Services.projectsetting", "basename": "projectsetting", "visibility": "public", "description": "The projectsetting service allows plugins to add new project settings to SAP Web IDE.", "component": "CA-WDE-CPS", "events": {}, "methods": { "showPlugin": { "name": "showPlugin", "visibility": "internal", "static": true, "description": "Switches to the Development perspective, selects the provided project settings according to the provided document and displays the plugin according the provided plugin ID.", "params": [ { "name": "oDocument", "type": "Document", "optional": "false", "description": "The document to select." }, { "name": "sPluginId", "type": "string", "optional": "false", "description": "The plugin id to display." } ], "example": "return oProjectSettingService.showPlugin(oDocument, \"projectType\").then(function() {\n});" } }, "configurationProperties": { "plugins": { "name": "plugins", "type": "Object[]", "description": "Used for creating a Project Settings section in SAP Web IDE.", "params": [ { "name": "id", "type": "string", "description": "The ID of the Project Settings section." }, { "name": "group", "type": "string", "description": "The group of the Project Settings section." }, { "name": "name", "type": "string", "description": "The name of the Project Settings section." }, { "name": "title", "type": "string", "description": "The title of the Project Settings section." }, { "name": "description", "type": "string", "description": "The description of the Project Settings section." }, { "name": "configService", "type": "sap.watt.common.service.ui.ProjectSettingConfig", "description": "The configuration service to be used by the User Preferences section." }, { "name": "projectTypes", "type": "string[]", "description": "An array of project types. The settings are only displayed for project types in this list." } ], "visibility": "public", "example": "\"projectsetting:plugins\": [{\n \"id\": \"projectSettingWithConfigService\",\n \"name\": \"projectSettingWithConfigService\",\n \"title\": \"projectSettingWithConfigService\",\n \"configService\": \"@myTestConfigService\"\n}]" } } }, "repositorybrowser": { "kind": "service", "name": "Services.repositorybrowser", "basename": "repositorybrowser", "visibility": "internal", "description": "The repositorybrowser service shows the workspace tree and allows performing actions on workspace projects, folders, and files.", "component": "CA-WDE-WRK", "events": {}, "methods": { "isSingleFolderNotRootSelection": { "name": "isSingleFolderNotRootSelection", "visibility": "internal", "static": true, "description": "Checks whether the selection is a single folder that is not the workspace root.", "returns": { "type": "Promise.", "description": "The check result." } }, "setSelection": { "name": "setSelection", "visibility": "internal", "static": true, "description": "Sets the selection to a specific document in the tree, expanding the parent folders if necessary.", "params": [ { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The document to select." }, { "name": "bExpand", "type": "boolean", "optional": "false", "description": "If true, expands the parent documents of oDocument in the browser tree." }, { "name": "bIncludingMyself", "type": "boolean", "optional": "true", "description": "If true, expands oDocument parameter, making its child parameters visible. The default is false." } ] } }, "configurationProperties": {} }, "resource": { "kind": "service", "name": "Services.resource", "basename": "resource", "visibility": "internal", "description": "The resource service is used for including stylesheets.", "component": "CA-WDE-PRS", "events": {}, "methods": { "includeStyles": { "name": "includeStyles", "visibility": "internal", "static": true, "description": "Include stylesheets.", "params": [ { "name": "aStyles", "type": "Object[]", "optional": "false", "parameterProperties": { "uri": { "name": "uri", "type": "string", "description": "The URL of the stylesheet that should be included." } }, "description": "An array of objects with the URLs of the stylesheets that should be included." } ], "returns": { "type": "Promise.", "description": "A promise which is returned after the stylesheet is included." } } }, "configurationProperties": {} }, "run": { "kind": "service", "name": "Services.run", "basename": "run", "visibility": "public", "description": "The run service enables you to run an application.", "component": "CA-WDE-RUN", "events": {}, "methods": { "getApplicationUrl": { "name": "getApplicationUrl", "visibility": "public", "static": true, "description": "Returns the URL of the application for running it with a specific file.", "params": [ { "name": "fullPath", "type": "string", "optional": "false", "description": "Full path of a runnable file. Full path definition: '/{project folder}/{sub folders}/{runnable file name}' , for example: '/AppName/webapp/index.html' The full path can be retrieved via the document object by calling oDocument.getEntity().getFullPath(). See {@link sap.watt.common.document.Document}" }, { "name": "runConfiguration", "type": "Object", "optional": "true", "description": "The _metadata object contains the following parameters: id, runnerId, displayName, and lastRunTimeStamp." } ], "returns": { "type": "string", "description": "The application URL." }, "example": "var runConfiguration = {\n \"filePath\": \"/ProjectFolder/subFolder/index.html\",\n \"_metadata\": {\n \"id\": 1234567,\n \"runnerId\": \"testRunner\",\n \"displayName\": \"Test configuration\",\n \"lastRunTimeStamp\": 1484570000000\n }\n};\nreturn oRunService.getApplicationUrl(\"/ProjectFolder/subFolder/index.html\", runConfiguration);" }, "getRunConfigurations": { "name": "getRunConfigurations", "visibility": "public", "static": true, "description": "Returns the run configurations of the project.", "params": [ { "name": "fullPath", "type": "string", "optional": "false", "description": "Full path of a file in the project. Full path definition: '/{project folder}/{sub folders}/{runnable file name}' , for example: '/AppName/webapp/index.html' The full path can be retrieved via the document object by calling oDocument.getEntity().getFullPath(). See {@link sap.watt.common.document.Document}" } ], "returns": { "type": "Object[]", "description": "The run configurations of the project." }, "example": "return oRunService.getRunConfigurations(\"/ProjectFolder/subFolder/index.html\");" } }, "configurationProperties": {} }, "runconsole": { "kind": "service", "name": "Services.runconsole", "basename": "runconsole", "visibility": "internal", "description": "The runconsole service allows other runners to display their running statuses in the run console.", "component": "CA-WDE-RUN", "events": {}, "methods": { "getConfigurationsExecuted": { "name": "getConfigurationsExecuted", "visibility": "internal", "static": true, "description": "Gets the object and all its executed configurations in execution per for each project.", "params": [ { "name": "sProjectPath", "type": "string", "optional": "false", "description": "The multi-target application (MTA) document path." } ] }, "getInitialStatus": { "name": "getInitialStatus", "visibility": "internal", "static": true, "description": "Gets the initial status of an application after SAP Web IDE reloads.", "params": [ { "name": "sProjectPath", "type": "string", "optional": "false", "description": "The module path." } ] }, "getRunner": { "name": "getRunner", "visibility": "internal", "static": true, "description": "Gets the runner according to the runner ID.", "params": [ { "name": "sRunnerId", "type": "string", "optional": "false", "description": "The runner ID." } ] }, "openWindow": { "name": "openWindow", "visibility": "internal", "static": true, "description": "Opens a new window and returns the window ID." }, "startRun": { "name": "startRun", "visibility": "internal", "static": true, "description": "Starts running an application from the run console.", "params": [ { "name": "bOpenNewWindow", "type": "boolean", "optional": "false", "description": "Determines whether an application should open in a new window or tab." }, { "name": "sProjectId", "type": "string", "optional": "false", "description": "The project ID." }, { "name": "sRunnerId", "type": "string", "optional": "false", "description": "The runner ID." } ] }, "stopRun": { "name": "stopRun", "visibility": "internal", "static": true, "description": "Stops running the project according to the processId parameter.", "params": [ { "name": "sProcessId", "type": "string", "optional": "false", "description": "The process ID." }, { "name": "sProjectId", "type": "string", "optional": "false", "description": "The project ID." } ] } }, "configurationProperties": { "projectTypes": { "name": "projectTypes", "type": "string[]", "description": "Determines the project types that are displayed in the run console.", "visibility": "internal" }, "setRunprogress": { "name": "setRunprogress", "type": "object[]", "description": "The run service that fires the runProgress event. The run console listens to the event fired by this service.", "visibility": "internal" } } }, "selection": { "kind": "service", "name": "Services.selection", "basename": "selection", "visibility": "public", "description": "The selection service provides the currently focused selection and its owner.", "component": "CA-WDE-SEL", "events": { "changed": { "name": "changed", "visibility": "public", "description": "Fired when the selection changes in the currently focused service and when the currently focused service, which is a selection provider, changes.", "params": [ { "name": "selection", "type": "Object", "description": "The selected object." }, { "name": "owner", "type": "sap.watt.common.service.selection.Provider", "description": "The selection provider that owns the selection." } ], "example": "\"subscribes\":{\n \"selection:changed\" :\"myTestSelectionExampleService:onSelectionChangedEventHandler\"\n}" } }, "methods": { "getOwner": { "name": "getOwner", "visibility": "internal", "static": true, "description": "Get the selection owner by its ID or the currently focused selection provider if an ID is not sent.", "params": [ { "name": "sID", "type": "string", "optional": "true", "description": "The ID of the selection provider. If not sent, the currenly focused selection provider is returned." } ], "returns": { "type": "Promise.", "description": "The selection owner." } }, "getSelection": { "name": "getSelection", "visibility": "public", "static": true, "description": "Get the current selection.", "params": [ { "name": "sID", "type": "string", "optional": "true", "description": "The ID of the selection provider. If not sent, the currently focused service is used." } ], "returns": { "type": "Promise.", "description": "The selection returned from the requested selection owner, or the selection returned from the currently focused service if sID is not sent." }, "example": "return oSelectionService.getSelection().then(function(oSelection) {\n});" }, "isOwner": { "name": "isOwner", "visibility": "internal", "static": true, "description": "Check if a certain service is the owner of the selection.", "params": [ { "name": "oService", "type": "sap.watt.common.service.selection.Provider", "optional": "false", "description": "The service to check." } ], "returns": { "type": "Promise.", "description": "The check result." } } }, "configurationProperties": {} }, "setting.project": { "kind": "service", "name": "Services.setting.project", "basename": "setting.project", "visibility": "internal", "description": "The project service persists and reads settings that are configured in a project.", "component": "CA-WDE-CPS", "events": {}, "methods": { "get": { "name": "get", "visibility": "internal", "static": true, "description": "Gets the value of a project setting.", "params": [ { "name": "oService", "type": "Object", "optional": "false", "description": "The service that sets the setting or the setting name." }, { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The project or a document that is a child of the project." } ], "returns": { "type": "Promise.", "description": "The setting value or null if not found." } }, "set": { "name": "set", "visibility": "internal", "static": true, "description": "Sets the value of a project setting.", "params": [ { "name": "oService", "type": "Object", "optional": "false", "description": "The service that sets the setting or the setting name." }, { "name": "vSettings", "type": "Object", "optional": "false", "description": "The setting to set. The value can be of any type. Complex types must be serializable to JSON format." }, { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The project or a document that is a child of the project." } ] } }, "configurationProperties": {} }, "setting.user": { "kind": "service", "name": "Services.setting.user", "basename": "setting.user", "visibility": "internal", "description": "The user service persists and reads settings that are configured in a project and are specific for the current user.", "component": "CA-WDE-CPS", "events": {}, "methods": { "get": { "name": "get", "visibility": "internal", "static": true, "description": "Gets the value of a project setting for the current user.", "params": [ { "name": "oService", "type": "Object", "optional": "false", "description": "The service that sets the setting or the setting name." }, { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The project or a document that is a child of the project." } ], "returns": { "type": "Promise.", "description": "The setting value or null if not found." } }, "set": { "name": "set", "visibility": "internal", "static": true, "description": "Sets the value of a project setting for the current user.", "params": [ { "name": "oService", "type": "Object", "optional": "false", "description": "The service that sets the setting or the setting name." }, { "name": "vSettings", "type": "Object", "optional": "false", "description": "The setting to set. The value can be of any type. Complex types must be serializable to JSON format." }, { "name": "oDocument", "type": "sap.watt.common.plugin.document.Document", "optional": "false", "description": "The project or a document that is a child of the project." } ] } }, "configurationProperties": {} }, "system": { "kind": "service", "name": "Services.system", "basename": "system", "visibility": "internal", "description": "The system service connects to the SAP Web IDE back end.", "component": "CA-WDE-MNU", "events": { "loggedIn": { "name": "loggedIn", "visibility": "internal", "description": "Fired when the login process has completed successfully." }, "loggedOut": { "name": "loggedOut", "visibility": "internal", "description": "Fired when the user requests to log out from SAP Web IDE." } }, "methods": { "getUserInfo": { "name": "getUserInfo", "visibility": "internal", "static": true, "description": "Returns the user information for the logged-in user.", "returns": { "type": "Promise.", "description": "The user information. The returned properties are: sUsername, sAccount, sEMail, sFirstName, sLastName." } } }, "configurationProperties": {} }, "task": { "kind": "service", "name": "Services.task", "basename": "task", "visibility": "internal", "description": "Use the task service to execute tasks.", "component": "CA-WDE-BLD", "events": {}, "methods": { "execute": { "name": "execute", "visibility": "internal", "static": true, "description": "Execute a task in the Kubernetes workspace.", "params": [ { "name": "task", "type": "object", "optional": "false", "parameterProperties": { "label": { "name": "label", "type": "string", "description": "The task logical type." }, "command": { "name": "command", "type": "string", "description": "The command to execute." }, "options": { "name": "options", "type": "object", "parameterProperties": { "env": { "name": "env", "type": "object", "description": "A map of environment variables available during execution." }, "cwd": { "name": "cwd", "type": "string", "description": "The working directory where the command runs." } }, "description": "Execution options." }, "webideOptions": { "name": "webideOptions", "type": "object", "parameterProperties": { "displayName": { "name": "displayName", "type": "string", "description": "The name of the task to display in the UI." }, "parameters": { "name": "parameters", "type": "object", "description": "A map of placeholders whose values are replaced before the task execution." }, "presentation": { "name": "presentation", "type": "object", "parameterProperties": { "showProgress": { "name": "showProgress", "type": "boolean", "description": "Show the progress of the task in the task bar. Default is true." }, "showOutput": { "name": "showOutput", "type": "boolean", "description": "Show the output (stdout & stderr) of the running command in the SAP Web IDE console. Default is true." }, "showNotification": { "name": "showNotification", "type": "boolean", "description": "Show a lite notification when the task starts and ends. Default is true." }, "notificationSuccessText": { "name": "notificationSuccessText", "type": "string", "description": "The message displayed in the lite notification when the task ends successfully. Default is \"The <task name> process finished\"." }, "notificationFailureText": { "name": "notificationFailureText", "type": "string", "description": "The message displayed in the lite notification when the task ends with an error. Default is \"The <task name> process failed\"." } }, "description": "Presentation options when running the task." }, "targetDocument": { "name": "targetDocument", "type": "sap.watt.common.plugin.document.Document", "description": "The document that is the context of the command execution. Affects placeholder values ${current.project.relpath} and ${current.project.path}." }, "resultMounting": { "name": "resultMounting", "type": "object", "parameterProperties": { "required": { "name": "required", "type": "boolean", "description": "Is result mounting in the DI workspace required?" }, "location": { "name": "location", "type": "string", "description": "The location of the task results in the Kubernetes workspace." }, "mapper": { "name": "mapper", "type": "string", "description": "The mapper in DI which performs the result mounting." }, "force": { "name": "force", "type": "string", "description": "continue to mount result even when command execution returned error code." }, "resultHandler": { "name": "resultHandler", "type": "function", "description": "a callback handler to get notified when mount is done." } }, "description": "Result mounting options." }, "copyBack": { "name": "copyBack", "type": "object", "parameterProperties": { "required": { "name": "required", "type": "boolean", "description": "Is copy back to the DI workspace required?" }, "location": { "name": "location", "type": "string", "description": "The location of the task results in the Kubernetes workspace." }, "mapper": { "name": "mapper", "type": "string", "description": "The mapper in DI which performs the copy back." }, "force": { "name": "force", "type": "string", "description": "continue to copy back even when command execution returned error code." } }, "description": "Copy-back options." }, "cfRequired": { "name": "cfRequired", "type": "boolean", "description": "Does the task access a Cloud Foundry environment?" }, "provisionRequired": { "name": "provisionRequired", "type": "boolean", "description": "Is provision required before the task is executed?" }, "outputHandler": { "name": "outputHandler", "type": "function", "description": "a callback that receives buffer logs from command execution. Overrides the default log that writes to Webide console." } }, "description": "SAP Web IDE specific options." } }, "description": "The task to execute." } ], "returns": { "type": "Promise.", "description": "A promise which is resolved when the execution of the task is completed." }, "example": "var that = this;\nreturn this.context.service.selection.getSelection().then(function (aSelection) {\n if (aSelection && aSelection.length === 1) {\n var targetDocument = aSelection[0].document;\n var oTask = {\n label: \"my_task\",\n command: \"Command to run\",\n options: {\n cwd: \"${current.project.path}\",\n env: {\n \"MY_ENV_VAR\": \"env_var_value\"\n }\n },\n webideOptions: {\n targetDocument: targetDocument,\n resultMounting: {\n required: true,\n location: \"path_to_build_results.zip\",\n mapper: \"mapper_name\"\n },\n displayName: \"Run task on ${doc_name}\",\n parameters: {\n doc_name: targetDocument.getName()\n }\n }\n };\n that.context.service.task.execute(oTask).then(function () {\n // Handle task execution success\n }).fail(function (oError) {\n // Handle task execution failure\n }).done();\n }\n});" } }, "configurationProperties": {} }, "template": { "kind": "service", "name": "Services.template", "basename": "template", "visibility": "public", "description": "The template registry service creates and configures a new template in SAP Web IDE.", "component": "CA-WDE-TPL", "events": {}, "methods": {}, "configurationProperties": { "templates": { "name": "templates", "type": "Object[]", "description": "The templates configuration object is used for creating a new template in SAP Web IDE.", "params": [ { "name": "id", "type": "string", "description": "Identifies a template." }, { "name": "template", "type": "sap.watt.common.service.template.Template", "description": "The path to the [TemplateName].js file, which implements the 'sap.watt.common.service.template.Template' interface for the template." }, { "name": "name", "type": "string", "description": "The name of the template." }, { "name": "description", "type": "string", "description": "The description of the template." }, { "name": "path", "type": "string", "description": "Path to the folder that contains all the template resources, such as the 'resources.zip' file, the template class, the model and preview image files, and so on." }, { "name": "fileName", "type": "string", "description": "The name of the .zip file containing the template resources, such as 'resources.zip'. Configure this property only for a template that provides resources." }, { "name": "requiredTemplates", "type": "Object[]", "description": "An array of the template IDs of all the templates whose resources are included in the template being developed." }, { "name": "modelFileName", "type": "string", "description": "The name of the JSON file, such as 'model.json', that contains the template customization model to be displayed in the 'Template Customization' wizard step. This property must be provided if the templateCustomizationStep property is defined in the wizardSteps configuration of the template." }, { "name": "runConfigurationsFileName", "type": "string", "description": "Path to the JSON file that specifies the run configurations, for example: 'runConfigurationsFileName':'runconfig.json'." }, { "name": "modelRoot", "type": "string", "description": "The name of the main JSON key in the content of the file defined in the modelFileName property. This property must be provided if the templateCustomizationStep step is defined in the wizardSteps configuration of the template." }, { "name": "icon", "type": "string", "description": "The path to the SAPUI5 icon font that is displayed as an icon for this template." }, { "name": "category", "type": "string[]", "description": "The ID of the category to which this template belongs. For more information, see Category Configuration below." }, { "name": "templateType", "type": "string", "description": "The template type, which can be project, module (sub project) or component. According to the type defined in this property, the template will be available for selection and generation in the appropriate wizard." }, { "name": "supportedProjectTypes", "type": "string[]", "description": "The project types that are supported by the template. When using the module or component template types, the supported project types are then used to filter the module and components according to the selected project in the workspace." }, { "name": "targetProjectTypes", "type": "string[]", "description": "The project types of the generated project." }, { "name": "targetEnvironments", "type": "string[]", "description": "The target environment for deploying your projects. The available environments are 'neo', 'abap' and 'cf'." }, { "name": "additionalData", "type": "Object[]", "description": "A generic data object that can be added to a template." }, { "name": "orderPriority", "type": "number", "description": "The priority of the template. Sets the order of displayed templates." }, { "name": "coreTemplate", "type": "boolean", "description": "Determines if the template is a core or external development template." }, { "name": "wizardSteps", "type": "string[]", "description": "An array of the names of the services wrapping the wizard steps (implementing the sap.watt.common.service.ui.WizardStep interface) that appear in the wizard after selecting the template." }, { "name": "requiresNeoApp", "type": "boolean", "description": "A flag stating whether this template requires also generating a neo-app.json file in addition to the template artifact. Note that any project that acts as a standalone application must contain the neo-app.json file in order to be run correctly using SAP Web IDE." }, { "name": "internalOnly", "type": "boolean", "description": "A flag stating whether if this template should be available only for internal stakeholders." }, { "name": "version", "type": "string", "description": "The template version." }, { "name": "versionLabel", "type": "string", "description": "The version description of the template." }, { "name": "previewImage", "type": "string", "description": "The relative path within the template location, as set in the path property, to an image that serves as a static preview of the artifact generated from the template." }, { "name": "requiredModules", "type": "string[]", "description": "A list of SAPUI5 module paths that are loaded prior to generation." }, { "name": "beautifyFiles", "type": "boolean", "description": "Determines whether the resources will be beautified." }, { "name": "UI5Version", "type": "string", "description": "The UI5 Version used in this template's generated application." }, { "name": "selectedDataConnectionName", "type": "string", "description": "The seleced data connection type used in this template's generated application." } ], "visibility": "public", "example": "\"template:templates\": [\n {\n \"id\": \"test.emptyDesktopProject\",\n \"template\": \"sap.watt.saptoolsets.fiori.project.ui5template/emptyDesktopProject/EmptyDesktopProjectTemplate\",\n \"name\": \"SAPUI5 Application\",\n \"description\": \"Creates an SAPUI5 project including an optional view. You can choose one of the following view types: XML, JSON, JavaScript, and HTML.\",\n \"path\": \"ui5template/emptyDesktopProject\",\n \"fileName\": \"EmptyDesktopProjectTemplate.zip\",\n \"requiredTemplates\": [\"ui5template.emptyMobileProject\"],\n \"modelFileName\": \"model.json\",\n \"runConfigurationsFileName\": \"runconfig.json\",\n \"modelRoot\": \"emptyDesktopProject\",\n \"icon\": \"sap-icon://e-learning\",\n \"category\": \"Empty.SAPUI5.Project\",\n \"templateType\": \"project\",\n \"supportedProjectTypes\": [\"sap.html5\", \"com.sap.webide.hybrid.cordova\"],\n \"targetProjectTypes\": [\"sap.html5\", \"sap.watt.uitools.ide.fiori\"],\n \"additionalData\": \"\",\n \"orderPriority\": 2001,\n \"coreTemplate\": true,\n \"wizardSteps\": [\"templateCustomizationStep\"],\n \"requiresNeoApp\": true,\n \"internalOnly\": false,\n \"version\": \"1.0.1\",\n \"versionLabel\": \"SAPUI5 1.34\",\n \"previewImage\": \"image/SAPUI5-Application.png\",\n \"requiredModules\": [\"sap.watt.uitools.ui5template/fioriMasterDetail/MyFieldHelper\"],\n \"beautifyFiles\": true\n }\n]" }, "categories": { "name": "categories", "type": "Object[]", "description": "Defines where the templates are displayed in the template library and relevant wizard step.", "params": [ { "name": "id", "type": "string", "description": "The category unique ID." }, { "name": "name", "type": "string", "description": "The category name." }, { "name": "description", "type": "string", "description": "The category description." } ], "visibility": "public", "example": "\"template:categories\": [\n {\n \"id\": \"Empty.SAPUI5.Project\",\n \"name\": \"Basic SAPUI5 Project\",\n \"description\": \"New SAPUI5 projects for mobile and desktop browsers.\"\n }\n]" } } }, "toprightpane": { "kind": "service", "name": "Services.toprightpane", "basename": "toprightpane", "visibility": "internal", "description": "The toprightpane service displays items on the right side of the SAP Web IDE header.", "component": "CA-WDE-PRS", "events": {}, "methods": {}, "configurationProperties": { "items": { "name": "items", "type": "Object[]", "description": "The items to display on the right side of the SAP Web IDE header. The height of the items is limited by the header size.", "params": [ { "name": "service", "type": "sap.watt.common.service.ui.Part", "description": "The part instance that returns the UI element to display." }, { "name": "prio", "type": "number", "description": "The item priority, which defines the order in which the items are displayed." } ], "visibility": "internal" } } }, "ui5projecthandler": { "kind": "service", "name": "Services.ui5projecthandler", "basename": "ui5projecthandler", "visibility": "internal", "description": "The ui5projecthandler service allows the reading or adding of data from a project. The service locates the file that defines the project's configuration and can handle different types of projects.", "component": "CA-WDE-TPL", "events": {}, "methods": { "addDataSource": { "name": "addDataSource", "visibility": "internal", "static": true, "description": "Adds JSON file content of the data source object under the given data source name in the handler file.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." }, { "name": "sDataSourceName", "type": "string", "optional": "false", "description": "A string that represents the data source name." }, { "name": "oContent", "type": "object", "optional": "false", "description": "A JSON file that contains the data source." }, { "name": "bOverwrite", "type": "boolean", "optional": "false", "description": "The true value causes the existing content to be overwritten." } ], "returns": { "type": "boolean", "description": "Added content successfully." } }, "addModel": { "name": "addModel", "visibility": "internal", "static": true, "description": "Adds JSON file content of new model to the handler file.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." }, { "name": "sModelName", "type": "string", "optional": "false", "description": "Name of the model." }, { "name": "oContent", "type": "object", "optional": "false", "description": "The JSON file content of the model." }, { "name": "bOverwrite", "type": "boolean", "optional": "false", "description": "The true value causes the existing content to be overwritten." } ], "returns": { "type": "boolean", "description": "Added content successfully." } }, "addRoutingAdditionalData": { "name": "addRoutingAdditionalData", "visibility": "internal", "static": true, "description": "Adds Additional Data object under routing in sap.ui5 section.", "params": [ { "name": "oDocument", "type": "object", "optional": "true", "description": "A document file in a project." }, { "name": "sViewName", "type": "string", "optional": "true", "description": "A string representing the view name." }, { "name": "sRouteName", "type": "string", "optional": "true", "description": "A string representing the route name." }, { "name": "sEntitySet", "type": "string", "optional": "true", "description": "A string representing the entity set name." }, { "name": "bOverwrite", "type": "boolean", "optional": "true", "description": "The true value causes the existing content to be overwritten." } ], "returns": { "type": "boolean", "description": "Added content successfully." } }, "getAttribute": { "name": "getAttribute", "visibility": "internal", "static": true, "description": "Returns the JSON file content of the given attribute under the handler document file.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." }, { "name": "sAttributeName", "type": "string", "optional": "false", "description": "A string representing the Attribute name (e.g. \"sap.app\", \"dataSources\")." } ], "returns": { "type": "object", "description": "The JSON file content of the attribute." } }, "getDataSources": { "name": "getDataSources", "visibility": "internal", "static": true, "description": "Returns JSON object of all data source objects under handler file document.", "params": [ { "name": "oDocument", "type": "Object", "optional": "false", "description": "A document file that is in a project." } ] }, "getDataSourcesByType": { "name": "getDataSourcesByType", "visibility": "internal", "static": true, "description": "Returns JSON array of data source object that is equal to the given data source type.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." }, { "name": "sDataSourceType", "type": "string", "optional": "false", "description": "A string representing data source name." } ], "returns": { "type": "Array", "description": "A JSON file that contains the data source." } }, "getDefaultDataSource": { "name": "getDefaultDataSource", "visibility": "internal", "static": true, "description": "Returns JSON file of data source object that is defined under the \"sap.ui5\" - \"models\" section as default one (has '\"\"' as key).", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." } ], "returns": { "type": "object", "description": "A JSON file that contains the data source." } }, "getDependencies": { "name": "getDependencies", "visibility": "internal", "static": true, "description": "Returns JSON object of all dependencies objects under the handler file document.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." } ], "returns": { "type": "object", "description": "The JSON file content of the dependencies." } }, "getHandlerDocument": { "name": "getHandlerDocument", "visibility": "internal", "static": true, "description": "Returns the handler file document.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." } ], "returns": { "type": "object", "description": "Handler file document." } }, "getHandlerFilePath": { "name": "getHandlerFilePath", "visibility": "internal", "static": true, "description": "Returns a string path of the handler file document without the handler file name.", "params": [ { "name": "oDocument", "type": "Object", "optional": "false", "description": "A document file that is in a project." } ] }, "getI18nPath": { "name": "getI18nPath", "visibility": "internal", "static": true, "description": "Returns the i18n path in the handler file document.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." } ], "returns": { "type": "string", "description": "The path to the i18n properties file." } }, "getModels": { "name": "getModels", "visibility": "internal", "static": true, "description": "Returns JSON object of all model objects under handler file document.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "Document file that is in a project." } ], "returns": { "type": "object", "description": "The JSON file content of the models." } }, "getRoutingAdditionalData": { "name": "getRoutingAdditionalData", "visibility": "internal", "static": true, "description": "Returns JSON object of all routing AdditionalData objects under handler file document.", "params": [ { "name": "oDocument", "type": "object", "optional": "true", "description": "A document file in a project." } ], "returns": { "type": "object", "description": "The JSON file content of the targets." } }, "isManifestProjectGuidelinesType": { "name": "isManifestProjectGuidelinesType", "visibility": "internal", "static": true, "description": "Checks if project is using the app descriptor manifest.json file guidelines.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." } ], "returns": { "type": "boolean", "description": "Returns true if project has manifest guidelines." } }, "removeDataSource": { "name": "removeDataSource", "visibility": "internal", "static": true, "description": "Removes the JSON file content of the data source object that is equal to the given data source name.\nDisclaimer! Does not remove references to the data source object in the descriptor file.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." }, { "name": "sDataSourceName", "type": "string", "optional": "false", "description": "A string that represents the data source name." } ], "returns": { "type": "boolean", "description": "Removed content successfully." } }, "removeDataSourceAnnotation": { "name": "removeDataSourceAnnotation", "visibility": "internal", "static": true, "description": "Removes annotation reference name from the 'annotations' section under the given data source name.\nDisclaimer! Does not remove the annotation data source itself.", "params": [ { "name": "oDocument", "type": "object", "optional": "false", "description": "A document file that is in a project." }, { "name": "sDataSourceName", "type": "string", "optional": "false", "description": "A string that represents the data source name." }, { "name": "sAnnotationName", "type": "string", "optional": "false", "description": "A string that represents the annotation name." } ], "returns": { "type": "boolean", "description": "Removed content successfully." } }, "removeRoutingAdditionalData": { "name": "removeRoutingAdditionalData", "visibility": "internal", "static": true, "description": "Removes the Additional Data of the route view under handler file document.", "params": [ { "name": "oDocument", "type": "object", "optional": "true", "description": "A document file in a project." }, { "name": "sViewFullQualifiedName", "type": "string", "optional": "true", "description": "A string representing the full qualified view name." } ], "returns": { "type": "boolean", "description": "Removed content successfully." } } }, "configurationProperties": {} }, "usageMonitoring": { "kind": "service", "name": "Services.usageMonitoring", "basename": "usageMonitoring", "visibility": "internal", "description": "The usageMonitoring service reports usage statistics for Web IDE components.", "component": "CA-WDE-FPM", "events": {}, "methods": { "report": { "name": "report", "visibility": "internal", "static": true, "description": "Report an event.", "params": [ { "name": "sEventComponent", "type": "string", "optional": "false", "description": "The event component. (e.g. W5G, TEMPLATE, EDITOR)." }, { "name": "sEventType", "type": "string", "optional": "false", "description": "The type of the event. (e.g. search)." }, { "name": "sEventValue", "type": "string", "optional": "false", "description": "The value of the event. (e.g. project name)." } ], "returns": { "type": "Promise.", "description": "A promise which is resolved after the usage report was sent." } } }, "configurationProperties": { "reportParams": { "name": "reportParams", "type": "Object[]", "description": "Configuration for new events to report.", "params": [ { "name": "components", "type": "string[]", "description": "Components that report events." }, { "name": "eventTypes", "type": "string[]", "description": "Event types to report." } ], "visibility": "internal" } } }, "usernotification": { "kind": "service", "name": "Services.usernotification", "basename": "usernotification", "visibility": "public", "description": "The userNotification service provides a unified messageBox control that can display the following notification message types: confirm, error, or lite notifications. These notification messages are briefly visible and are not obtrusive. Lite notifications appear in the user notification bar of SAP Web IDE.", "component": "CA-WDE-LOG", "events": {}, "methods": { "alert": { "name": "alert", "visibility": "public", "static": true, "description": "Displays an error-type messageBox control with a Close button.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the contents of the messageBox control." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sCustomAction", "type": "string", "optional": "true", "description": "Contains alternative text for the messageBox control Close button." }, { "name": "sInitialFocus", "type": "string", "optional": "true", "description": "Sets the initial focus on a button when the messageBox is opened." }, { "name": "sDetails", "type": "string", "optional": "true", "description": "If the sDetails parameter is set in the messageBox control, a Show Details link is added, and on click opens the sDetails content." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." }, "example": "oUserNotification.alert(\"alert example\").done();" }, "confirm": { "name": "confirm", "visibility": "public", "static": true, "description": "Displays a confirmation-type messageBox control with OK and Cancel buttons.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the content of the messageBox control." }, { "name": "bCancleable", "type": "boolean", "optional": "true", "description": "If the bCancelable parameter is set to true then the Yes, No, and Cancel buttons are displayed." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sCustomConfirmation", "type": "string", "optional": "true", "description": "Contains alternative text for the OK button of the messageBox control." }, { "name": "sCustomRejection", "type": "string", "optional": "true", "description": "Contains alternative text for the Cancel button of the messageBox control." }, { "name": "sInitialFocus", "type": "string", "optional": "true", "description": "Sets the initial focus on a button when the messageBox is opened." }, { "name": "sDetails", "type": "string", "optional": "true", "description": "If the sDetails parameter is set in the messageBox control, a Show Details link is added, and on click opens the sDetails content." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both of the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." }, "example": "oUserNotification.confirm(\"Confirmation\", true).done();" }, "confirmYesNo": { "name": "confirmYesNo", "visibility": "public", "static": true, "description": "Displays a confirmation-type messageBox control with Yes and No buttons.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the content of the messageBox control." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both of the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." }, "example": "oUserNotification.confirmYesNo(\"Confirmation Message\", \"Notification Title\").done();" }, "info": { "name": "info", "visibility": "public", "static": true, "description": "Displays an info-type messageBox control with an OK button.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the content of the messageBox control." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sDetails", "type": "string", "optional": "true", "description": "If the sDetails parameter is set in the messageBox control, a Show Details link is added, and on click opens the sDetails content." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both of the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." }, "example": "oUserNotification.info(\"info example\").done();" }, "liteNotificationFailure": { "name": "liteNotificationFailure", "visibility": "public", "static": true, "description": "Displays a failure-type lite notification in the user notification bar for 16 seconds.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the message to display in the user notification bar." }, { "name": "sCommandId", "type": "string", "optional": "true", "description": "The ID of the command to display in the user notification as possible action." }, { "name": "oCommandExecuteValue", "type": "object", "optional": "true", "description": "The value to pass to the execute method of the command." }, { "name": "bAutoDisappear", "type": "boolean", "optional": "true", "description": "The bAutoDisappear property is set to true by default, causing the notification to disappear automatically after a short time. If set to false, the notification disappears only when the user closes the dialog box." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "example": "oUserNotification.liteNotificationFailure(\"lite failure example\", \"test.SampleCommandForLiteNotification.id\").done();" }, "liteNotificationInfo": { "name": "liteNotificationInfo", "visibility": "public", "static": true, "description": "Displays a lite notification in the user notification bar for four seconds.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the message to display in the user notification bar." }, { "name": "sCommandId", "type": "string", "optional": "true", "description": "The ID of the command to display in the user notification as possible action." }, { "name": "oCommandExecuteValue", "type": "object", "optional": "true", "description": "The value to pass to the execute method of the command." }, { "name": "bAutoDisappear", "type": "boolean", "optional": "true", "description": "The bAutoDisappear property is set to true by default, causing the notification to disappear automatically after a short time. If set to false, the notification disappears only when the user closes the dialog box." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "example": "oUserNotification.liteNotificationInfo(\"lite info example\", \"test.SampleCommandForLiteNotification.id\").done();" }, "liteNotificationSuccess": { "name": "liteNotificationSuccess", "visibility": "public", "static": true, "description": "Displays a success-type lite notification in the user notification bar for eight seconds.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the message to display in the user notification bar." }, { "name": "sCommandId", "type": "string", "optional": "true", "description": "The ID of the command to display in the user notification as possible action." }, { "name": "oCommandExecuteValue", "type": "object", "optional": "true", "description": "The value to pass to the execute method of the command." }, { "name": "bAutoDisappear", "type": "boolean", "optional": "true", "description": "The bAutoDisappear property is set to true by default, causing the notification to disappear automatically after a short time. If set to false, the notification disappears only when the user closes the dialog box." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "example": "oUserNotification.liteNotificationSuccess(\"lite success example\", \"test.SampleCommandForLiteNotification.id\").done();" }, "notification": { "name": "notification", "visibility": "internal", "static": true, "description": "Displays a alert-type messageBox control with an OK button.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the contents of the messageBox control." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sDetails", "type": "string", "optional": "true", "description": "If the sDetails parameter is set in the messageBox control, a Show Details link is added, and on click opens the sDetails content." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." } }, "success": { "name": "success", "visibility": "internal", "static": true, "description": "Displays a success-type messageBox control with an OK button.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the contents of the messageBox control." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sDetails", "type": "string", "optional": "true", "description": "If the sDetails parameter is set in the messageBox control, a Show Details link is added, and on click opens the sDetails content." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." } }, "warning": { "name": "warning", "visibility": "public", "static": true, "description": "Displays a warning-type messageBox control with an Close button.", "params": [ { "name": "sMessage", "type": "string", "optional": "false", "description": "Contains the content of the messageBox control." }, { "name": "sTitle", "type": "string", "optional": "true", "description": "Contains the title of the messageBox control." }, { "name": "sCustomAction", "type": "string", "optional": "true", "description": "Contains alternative text for the messageBox control button." }, { "name": "sCustomCancel", "type": "string", "optional": "true", "description": "Contains alternative text for the messageBox control cancel button." }, { "name": "sInitialFocus", "type": "string", "optional": "true", "description": "Sets the initial focus on a button when the messageBox is opened." }, { "name": "sDetails", "type": "string", "optional": "true", "description": "If the sDetails parameter is set in the messageBox control, a Show Details link is added, and on click opens the sDetails content." }, { "name": "sSourceService", "type": "string", "optional": "true", "description": "The name of the source service for usage monitoring purposes." } ], "returns": { "type": "Object", "description": "Returns both of the following properties: sResult and bResult. sResult is the string value of the clicked button in the messageBox control. bResult is the Boolean state of the messageBox control." }, "example": "oUserNotification.warning(\"warning example\").done();" } }, "configurationProperties": {} }, "userpreference": { "kind": "service", "name": "Services.userpreference", "basename": "userpreference", "visibility": "public", "description": "The userpreference service allows plugins to add new user preferences to the SAP Web IDE Preferences perspective.", "component": "CA-WDE-CPS", "events": {}, "methods": { "showPlugin": { "name": "showPlugin", "visibility": "internal", "static": true, "description": "Switches to the Preferences perspective and displays the plugin according to the provided plugin ID.", "params": [ { "name": "sPluginId", "type": "string", "optional": "false", "description": "The plugin ID to display." } ], "example": "return oUserPreferenceService.showPlugin(\"editor\").then(function() {\n});" } }, "configurationProperties": { "plugins": { "name": "plugins", "type": "Object[]", "description": "Defines a User Preferences section in the SAP Web IDE User Preferences perspective.", "params": [ { "name": "id", "type": "string", "description": "The ID of the User Preferences section." }, { "name": "isSystemPreference", "type": "boolean", "description": "true for global preferences, false for workspace-level preferences. This parameter is set to false by default." }, { "name": "name", "type": "string", "description": "The name of the User Preferences section." }, { "name": "title", "type": "string", "description": "The title of the User Preferences section." }, { "name": "description", "type": "string", "description": "The description of the User Preferences section." }, { "name": "configService", "type": "sap.watt.common.service.ui.UserPreferenceConfig", "description": "The configuration service to be used by the User Preferences section." } ], "visibility": "public", "example": "\"userpreference:plugins\": [{\n \"id\": \"userPreferenceWithConfigServiceTest\",\n \"name\": \"userPreferenceWithConfigServiceTest\",\n \"title\": \"userPreferenceWithConfigServiceTest\",\n \"configService\": \"@myTestConfigService\"\n}]" } } }, "wizard": { "kind": "service", "name": "Services.wizard", "basename": "wizard", "visibility": "public", "description": "The wizard service serves as a factory for creating wizard and wizard step SAPUI5 controls.", "component": "CA-WDE-TPL", "events": {}, "methods": { "createWizard": { "name": "createWizard", "visibility": "public", "static": true, "description": "Creates a new wizard control object with the provided title, description, summary text, finish handler method and array of wizardStep objects to display in the wizard.", "params": [ { "name": "sId", "type": "string", "optional": "false", "description": "Wizard control unique identifier." }, { "name": "sTitle", "type": "string", "optional": "false", "description": "Wizard title text." }, { "name": "sDescription", "type": "string", "optional": "false", "description": "Wizard description text." }, { "name": "aSteps", "type": "Object[]", "optional": "false", "description": "Array of sap.watt.ideplatform.plugin.template.ui.wizard.WizardStep controls." }, { "name": "aFinishStepConfig", "type": "Object", "optional": "false", "description": "Allows customizing the UI of a wizard's Finish step. Can be one of two possible types: A. A configuration object with the following optional properties: summaryText - holds the description of the default summary text to be displayed as the Confirm step description (this can be changed later by using the setSummary method). finishStepContent - holds a control extending the WizardStepContent method which implements the Confirm step UI and logic. B. A string value with the same value as the summaryText property in option A." }, { "name": "fnFinishHandler", "type": "function", "optional": "false", "description": "Handler method to be executed when finishing the wizard. Gets no parameters. Must return a Q-promise." }, { "name": "fnAfterCloseHandler", "type": "function", "optional": "true", "description": "Optional handler method to be executed after closing the wizard. Gets the close event." }, { "name": "sExitMessage", "type": "string", "optional": "true", "description": "Optional custom text to display when closing the wizard before finish." }, { "name": "bEnableDynamicFinish", "type": "boolean", "optional": "true", "description": "Optional parameter to enable the dynamic finish behaviour in the wizard. false by default." } ], "returns": { "type": "Object", "description": "A wizard control object." }, "example": "return oWizardService.createWizard(sId, sTitle, sDescription, [oWizardStep], sSummary, fnFinishHandler, fnAfterCloseHandler, sExitMessage, false).then(function(oWizard){\n});" }, "createWizardStep": { "name": "createWizardStep", "visibility": "public", "static": true, "description": "Creates a new wizard step control object with the provided title, description and wizardStepContent control object.", "params": [ { "name": "oWizardStepContent", "type": "Object", "optional": "false", "description": "An object extending the sap.watt.ideplatform.plugin.template.ui.wizard.WizardStepContent control, displaying the step content." }, { "name": "sTitle", "type": "string", "optional": "false", "description": "Wizard step title text." }, { "name": "sDescription", "type": "string", "optional": "false", "description": "Wizard step description text." } ], "returns": { "type": "Object", "description": "A WizardStep control object." }, "example": "return oWizardService.createWizardStep(oWizardStepContent, title, description).then(function(oWizardStep){\n});" } }, "configurationProperties": { "styles": { "name": "styles", "type": "Object[]", "description": "The styles configuration object is used for adding a style sheet to the wizard.", "params": [ { "name": "uri", "type": "string", "description": "The URL to the CSS file." } ], "visibility": "public", "example": "{\n \"wizard:styles\": [\n {\n \"uri\" : \"sap.watt.ideplatform.template/css/wizard.css\"\n },\n {\n \"uri\" : \"sap.watt.ideplatform.template/css/templateWizard.css\"\n }\n ]\n};" } } } }, "Classes": { "sap.watt.common.document.Document": { "kind": "class", "name": "Classes.sap.watt.common.document.Document", "basename": "sap.watt.common.document.Document", "visibility": "public", "description": "Represents a file system object in the workspace.\nIt can be a folder that is represented by the FolderDocument class, or a file represented by the FileDocument class, or a project represented by the ProjectDocument class.", "component": "CA-WDE-WRK", "events": {}, "methods": { "getName": { "name": "getName", "visibility": "public", "description": "Gets the document name, which is the same name as the file or folder on the disk.", "examples": [ { "text": "return oDocument.getName();" } ], "returns": { "type": "string", "description": "The document name." }, "example": "return oDocument.getName();" } } }, "sap.watt.common.perspective.command.AbstractUIPartToggler": { "kind": "class", "name": "Classes.sap.watt.common.perspective.command.AbstractUIPartToggler", "basename": "sap.watt.common.perspective.command.AbstractUIPartToggler", "visibility": "public", "description": "The AbstractUIPartToggler class is an implementation that allows the creation of a service.\nIt is mainly used for toggling specific views when the related command is executed.\nThe AbstractUIPartToggler class is managed by the framework.", "component": "CA-WDE-PRS", "events": {}, "methods": { "execute": { "name": "execute", "visibility": "public", "description": "Executes the command instance. Toggles the corresponding view visibility.", "returns": { "type": "Promise.", "description": "Promise that is resolved when the target view rendering is finished." } }, "isActive": { "name": "isActive", "visibility": "public", "description": "Determines whether a command is active.\nA command is active only if it is set to be both available and enabled while the configured service is set to visible.", "returns": { "type": "Promise." } }, "isAvailable": { "name": "isAvailable", "visibility": "public", "description": "Determines whether a command is available.
\nA command is available only in the following scenarios:
\n
    \n
  • If the configured perspective property for the AbstractUIPartToggler instance matches the current perspective.
    • \n
  • If the perspective property is not configured and the service property represents a view that is mapped to the current perspective.
    • \n
", "returns": { "type": "Promise." } }, "isEnabled": { "name": "isEnabled", "visibility": "public", "description": "Determines whether a command is enabled.
\nA command is enabled only in the following scenarios:
\n
    \n
  • If the configured perspective property for the AbstractUIPartToggler instance matches the current perspective.
    • \n
  • If the perspective property is not configured and the service property represents a view that is mapped to the current perspective.
    • \n
", "returns": { "type": "Promise." } } } }, "sap.watt.common.platform.service.ui.AbstractPart": { "kind": "class", "name": "Classes.sap.watt.common.platform.service.ui.AbstractPart", "basename": "sap.watt.common.platform.service.ui.AbstractPart", "visibility": "public", "description": "The AbstractPart class is an abstract implementation for the part interface. \nIt can be extended by services that represent visual components such as the search pane.", "component": "CA-WDE-MNU", "events": {}, "methods": { "configure": { "name": "configure", "visibility": "internal", "description": "Save the configuration properties of the part instance as members, so they can be used in other methods.\nCall this method from a service's configure method to handle the styles configuration property.", "returns": { "type": "Promise.", "description": "Promise which is resolved once the configuration properties are saved on the part instance." } }, "getContent": { "name": "getContent", "visibility": "public", "description": "Calls the includeStyles method with a configured CSS URL file. As a result, the CSS file is included and affects the DOM.", "returns": { "type": "Promise." } }, "getFocusElement": { "name": "getFocusElement", "visibility": "internal", "description": "Returns the element which receives the focus in this part instance. The returned element is the same element returned\nfrom method getContent. Override this method to let a different element receive the focus.", "returns": { "type": "Promise.", "description": "Promise which is resolved with the focus element of the part instance." } }, "isVisible": { "name": "isVisible", "visibility": "public", "description": "Gets the visibility state of the part instance.", "returns": { "type": "boolean" } }, "setVisible": { "name": "setVisible", "visibility": "internal", "description": "Changes the visibility state of the part instance. If the visibility target state is different from current visibility state,\nthe visibilityChanged event is fired and the current state is updated accordingly.", "params": [ { "name": "bVisible", "type": "boolean", "optional": "false", "description": "The new visibility state of the part instance." } ], "returns": { "type": "Promise.", "description": "Promise which is resolved when the visibility state is changed and all listeners finished responding to it." } } } }, "sap.watt.common.platform.service.ui.AbstractProjectSettingConfig": { "kind": "class", "name": "Classes.sap.watt.common.platform.service.ui.AbstractProjectSettingConfig", "basename": "sap.watt.common.platform.service.ui.AbstractProjectSettingConfig", "visibility": "public", "description": "The AbstractProjectSettingConfig class is an abstract implementation for the ProjectSettingConfig interface. It can be extended to a service that can then be passed as a parameter to the plugins configuration property of the projectsetting service.", "events": {}, "methods": { "getContent": { "name": "getContent", "visibility": "public", "description": "Gets the project settings of the given project path from the ProjectSettingConfig instance.", "returns": { "type": "Promise.", "description": "The extending class should override this method and return the UI object of the project settings." } }, "getContentMessageStrip": { "name": "getContentMessageStrip", "visibility": "public", "description": "Gets the message strip control according from the project path from the ProjectSettingConfig instance.", "returns": { "type": "Promise.", "description": "The extending class should override this method and return the UI object of the project settings." } }, "getContentPreview": { "name": "getContentPreview", "visibility": "public", "description": "Gets the project settings preview pane according from the project path from the ProjectSettingConfig instance.", "returns": { "type": "Promise.", "description": "The extending class should override this method and return the UI object of the project settings." } }, "isAvailable": { "name": "isAvailable", "visibility": "public", "description": "Shows or hides the configuration pane you added to the project settings area of SAP Web IDE.", "returns": { "type": "Promise.", "description": "The extending class may override this method if the pane is not always visible. The return value is a promise that is resolved to a Boolean value." } }, "save": { "name": "save", "visibility": "public", "description": "Saves the project settings in the ProjectSettingConfig instance for the given project path.", "returns": { "type": "Promise.", "description": "n/a" } } } }, "sap.watt.common.platform.service.ui.AbstractUserPreferenceConfig": { "kind": "class", "name": "Classes.sap.watt.common.platform.service.ui.AbstractUserPreferenceConfig", "basename": "sap.watt.common.platform.service.ui.AbstractUserPreferenceConfig", "visibility": "public", "description": "The AbstractUserPreferenceConfig class is an abstract implementation for the UserPreferenceConfig interface. It can be extended to a service that can then be passed as a parameter to the plugins configuration property of the userpreference service.", "events": {}, "methods": { "getContent": { "name": "getContent", "visibility": "public", "description": "Gets the user preferences from the UserPreferenceConfig instance.", "returns": { "type": "Promise.", "description": "The extending class should override this method and return the UI object of the user preferences." } }, "getContentMessageStrip": { "name": "getContentMessageStrip", "visibility": "public", "description": "Gets the message strip control as part of the user preference content from the UserPreferenceConfig instance.", "returns": { "type": "Promise.", "description": "The extending class should override this method and return the UI object of the user preferences." } }, "getContentPreview": { "name": "getContentPreview", "visibility": "public", "description": "Gets the preview pane of the user preference content from the UserPreferenceConfig instance.", "returns": { "type": "Promise.", "description": "The extending class should override this method and return the UI object of the user preferences." } }, "isAvailable": { "name": "isAvailable", "visibility": "public", "description": "Shows or hides the configuration pane you added to the Preferences perspective of SAP Web IDE.", "returns": { "type": "Promise.", "description": "The extending class may override this method if the pane is not always visible. The return value is a promise that is resolved to a Boolean value." } }, "save": { "name": "save", "visibility": "public", "description": "Saves the user preferences in the UserPreferenceConfig instance.", "returns": { "type": "Promise.", "description": "n/a" } } } }, "sap.watt.platform.filesystem.document.FileDocument": { "kind": "class", "name": "Classes.sap.watt.platform.filesystem.document.FileDocument", "basename": "sap.watt.platform.filesystem.document.FileDocument", "visibility": "public", "description": "The FileDocument class represents a file in the workspace.", "component": "CA-WDE-WRK", "events": {}, "methods": { "getContent": { "name": "getContent", "visibility": "public", "description": "Returns the content of the file document.", "examples": [ { "text": "oDocument.getContent().then(function(sContent) {\n});" } ], "returns": { "type": "string", "description": "The file content." }, "example": "oDocument.getContent().then(function(sContent) {\n});" }, "setContent": { "name": "setContent", "visibility": "public", "description": "Sets the content of the file document, replacing all previous content. Note that the content is set in the Document object but it is not permanently saved in the workspace.", "examples": [ { "text": "return oDocument.setContent(sNewContent);" } ], "params": [ { "name": "sContent", "type": "string", "optional": "false", "description": "The new file content." }, { "name": "oService", "type": "object", "optional": "true", "description": "A service for editing content." } ], "example": "return oDocument.setContent(sNewContent);" } } } }, "Controls": { "sap.watt.ui.control.dialog.ActionDialog": { "kind": "control", "name": "Controls.sap.watt.ui.control.dialog.ActionDialog", "basename": "sap.watt.ui.control.dialog.ActionDialog", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for an ActionDialog control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.watt.ui.control.dialog.SimpleDialog", "ui5-metadata": { "aggregations": [], "associations": [], "properties": [ { "name": "acceptButtonText", "type": "string", "defaultValue": null, "group": "Misc", "visibility": "public", "description": "Determines the text of the dialog's accept button, which is rendered before the close button.", "methods": [ "getAcceptButtonText", "setAcceptButtonText" ] }, { "name": "acceptButtonEnabled", "type": "boolean", "defaultValue": true, "group": "Behavior", "visibility": "public", "description": "Determines whether the accept button is enabled.", "methods": [ "getAcceptButtonEnabled", "setAcceptButtonEnabled" ] } ] }, "description": "A dialog control in SAP Web IDE that has two buttons in the footer area: accept and cancel.", "events": {}, "methods": { "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.dialog.ActionDialog class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.watt.ui.control.dialog.SimpleDialog/methods/sap.watt.ui.control.dialog.SimpleDialog.extend sap.watt.ui.control.dialog.SimpleDialog.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getAcceptButtonEnabled": { "name": "getAcceptButtonEnabled", "visibility": "public", "description": "Gets current value of the acceptButtonEnabled property.\n\nDetermines whether the accept button is enabled.\n\nThe default value is true.", "returns": { "type": "boolean", "description": "The value of the acceptButtonEnabled property." } }, "getAcceptButtonText": { "name": "getAcceptButtonText", "visibility": "public", "description": "Gets current value of the acceptButtonText property.\n\nDetermines the text of the dialog's accept button, which is rendered before the close button.", "returns": { "type": "string", "description": "The value of the acceptButtonText property." } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.dialog.ActionDialog class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "setAcceptButtonEnabled": { "name": "setAcceptButtonEnabled", "visibility": "public", "description": "Sets a new value for the acceptButtonEnabled property.\n\nDetermines whether the accept button is enabled.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is true.", "params": [ { "name": "bAcceptButtonEnabled", "type": "boolean", "optional": "false", "description": "The new value for the acceptButtonEnabled property." } ], "returns": { "type": "sap.watt.ui.control.dialog.ActionDialog", "description": "Reference to this in order to allow method chaining." } }, "setAcceptButtonText": { "name": "setAcceptButtonText", "visibility": "public", "description": "Sets a new value for the acceptButtonText property.\n\nDetermines the text of the dialog's accept button, which is rendered before the close button.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sAcceptButtonText", "type": "string", "optional": "false", "description": "The new value for the acceptButtonText property." } ], "returns": { "type": "sap.watt.ui.control.dialog.ActionDialog", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.dialog.CustomActionDialog": { "kind": "control", "name": "Controls.sap.watt.ui.control.dialog.CustomActionDialog", "basename": "sap.watt.ui.control.dialog.CustomActionDialog", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a CustomActionDialog control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.watt.ui.control.dialog.ActionDialog", "ui5-metadata": { "aggregations": [], "associations": [], "properties": [ { "name": "customButtonText", "type": "string", "defaultValue": null, "group": "Misc", "visibility": "public", "description": "Determines the text of the dialog's custom button, which is rendered before the accept button.", "methods": [ "getCustomButtonText", "setCustomButtonText" ] }, { "name": "customButtonEnabled", "type": "boolean", "defaultValue": true, "group": "Behavior", "visibility": "public", "description": "Determines whether the custom button is enabled.", "methods": [ "getCustomButtonEnabled", "setCustomButtonEnabled" ] } ] }, "description": "A dialog control in SAP Web IDE that has three buttons in the footer area: custom, accept and cancel.", "component": "CA-WDE-TFL", "events": {}, "methods": { "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.dialog.CustomActionDialog class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.watt.ui.control.dialog.ActionDialog/methods/sap.watt.ui.control.dialog.ActionDialog.extend sap.watt.ui.control.dialog.ActionDialog.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getCustomButtonEnabled": { "name": "getCustomButtonEnabled", "visibility": "public", "description": "Gets current value of the customButtonEnabled property.\n\nDetermines whether the custom button is enabled.\n\nThe default value is true.", "returns": { "type": "boolean", "description": "The value of the customButtonEnabled property." } }, "getCustomButtonText": { "name": "getCustomButtonText", "visibility": "public", "description": "Gets current value of the customButtonText property.\n\nDetermines the text of the dialog's custom button, which is rendered before the accept button.", "returns": { "type": "string", "description": "The value of the customButtonText property." } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.dialog.CustomActionDialog class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "setCustomButtonEnabled": { "name": "setCustomButtonEnabled", "visibility": "public", "description": "Sets a new value for the customButtonEnabled property.\n\nDetermines whether the custom button is enabled.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is true.", "params": [ { "name": "bCustomButtonEnabled", "type": "boolean", "optional": "false", "description": "The new value for the customButtonEnabled property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomActionDialog", "description": "Reference to this in order to allow method chaining." } }, "setCustomButtonText": { "name": "setCustomButtonText", "visibility": "public", "description": "Sets a new value for the customButtonText property.\n\nDetermines the text of the dialog's custom button, which is rendered before the accept button.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sCustomButtonText", "type": "string", "optional": "false", "description": "The new value for the customButtonText property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomActionDialog", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.dialog.CustomSelectDialog": { "kind": "control", "name": "Controls.sap.watt.ui.control.dialog.CustomSelectDialog", "basename": "sap.watt.ui.control.dialog.CustomSelectDialog", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a CustomSelectDialog control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.watt.ui.control.dialog.ActionDialog", "ui5-metadata": { "aggregations": [ { "name": "filter", "singularName": "filter", "type": "sap.ui.core.Control", "cardinality": "0..1", "visibility": "public", "description": "An additional control of the filter bar of the dialog that is displayed near the search control; its order depends on the searchFirst property. To hide the search control, it is mandatory to first set the filterOnly property.", "methods": [ "getFilter", "destroyFilter", "setFilter" ] } ], "associations": [], "properties": [ { "name": "instructions", "type": "string", "defaultValue": null, "group": "Appearance", "visibility": "public", "description": "Determines the instruction text that appears at the top of the dialog.", "methods": [ "getInstructions", "setInstructions" ] }, { "name": "countMessage", "type": "string", "defaultValue": null, "group": "Misc", "visibility": "public", "description": "Determines the message that appears below the selection area of the dialog.", "methods": [ "getCountMessage", "setCountMessage" ] }, { "name": "showCountMessage", "type": "boolean", "defaultValue": false, "group": "Appearance", "visibility": "public", "description": "Determines the visibility of the countMessage property.", "methods": [ "getShowCountMessage", "setShowCountMessage" ] }, { "name": "searchFirst", "type": "boolean", "defaultValue": true, "group": "Appearance", "visibility": "public", "description": "Determines whether the search field is displayed before the filter control.", "methods": [ "getSearchFirst", "setSearchFirst" ] }, { "name": "filterOnly", "type": "boolean", "defaultValue": false, "group": "Appearance", "visibility": "public", "description": "Determines whether the search field is visible. Mandatory to first set the filter aggregation or this property has no effect.", "methods": [ "getFilterOnly", "setFilterOnly" ] } ] }, "description": "A dialog control in SAP Web IDE that has two buttons in the footer area: accept and cancel.", "events": { "search": { "name": "search", "visibility": "public", "description": "Fires on click of the search button in the dialog.", "methods": [ "attachSearch", "detachSearch", "fireSearch" ], "params": { "value": { "name": "value", "type": "string", "description": "Specifies the value entered in the search field." } } }, "liveChange": { "name": "liveChange", "visibility": "public", "description": "Fires when the value of the search field is changed by a user, for example, on each key press.", "methods": [ "attachLiveChange", "detachLiveChange", "fireLiveChange" ], "params": { "value": { "name": "value", "type": "string", "description": "Specifies the value entered in the search field." } } } }, "methods": { "attachLiveChange": { "name": "attachLiveChange", "visibility": "public", "description": "Attaches the fnFunction event handler to the liveChange event of this sap.watt.ui.control.dialog.CustomSelectDialog.\n\nWhen called, the context of the event handler (its this) will be bound to the oListener object if specified; \notherwise, it will be bound to the sap.watt.ui.control.dialog.CustomSelectDialog object itself.\n\nFires when the value of the search field is changed by a user, for example, on each key press.", "params": [ { "name": "oData", "type": "object", "optional": "true", "description": "An application-specific payload object that will be passed to the event handler along with the event object when firing the event." }, { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "true", "description": "Context object with which to call the event handler. Defaults to the sap.watt.ui.control.dialog.CustomSelectDialog object itself." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "attachSearch": { "name": "attachSearch", "visibility": "public", "description": "Attaches the fnFunction event handler to the search event of this sap.watt.ui.control.dialog.CustomSelectDialog.\n\nWhen called, the context of the event handler (its this) will be bound to the oListener object if specified; \notherwise, it will be bound to the sap.watt.ui.control.dialog.CustomSelectDialog object itself.\n\nFires on click of the search button in the dialog.", "params": [ { "name": "oData", "type": "object", "optional": "true", "description": "An application-specific payload object that will be passed to the event handler along with the event object when firing the event." }, { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "true", "description": "Context object with which to call the event handler. Defaults to the sap.watt.ui.control.dialog.CustomSelectDialog object itself." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "destroyFilter": { "name": "destroyFilter", "visibility": "public", "description": "Destroys the filter in the filter aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "detachLiveChange": { "name": "detachLiveChange", "visibility": "public", "description": "Detaches the fnFunction event handler from the liveChange event of the sap.watt.ui.control.dialog.CustomSelectDialog object.\n\nThe passed function and listener object must match the ones used for the event registration.", "params": [ { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "false", "description": "The context object on which the given function is called." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "detachSearch": { "name": "detachSearch", "visibility": "public", "description": "Detaches the fnFunction event handler from the search event of the sap.watt.ui.control.dialog.CustomSelectDialog object.\n\nThe passed function and listener object must match the ones used for the event registration.", "params": [ { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "false", "description": "The context object on which the given function is called." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.dialog.CustomSelectDialog class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.watt.ui.control.dialog.ActionDialog/methods/sap.watt.ui.control.dialog.ActionDialog.extend sap.watt.ui.control.dialog.ActionDialog.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getCountMessage": { "name": "getCountMessage", "visibility": "public", "description": "Gets current value of the countMessage property.\n\nDetermines the message that appears below the selection area of the dialog.", "returns": { "type": "string", "description": "The value of the countMessage property." } }, "getFilter": { "name": "getFilter", "visibility": "public", "description": "Gets the content of the filter aggregation.\n\nAn additional control of the filter bar of the dialog that is displayed near the search control; its order depends on the searchFirst property. To hide the search control, it is mandatory to first set the filterOnly property.", "returns": { "type": "sap.ui.core.Control" } }, "getFilterOnly": { "name": "getFilterOnly", "visibility": "public", "description": "Gets current value of the filterOnly property.\n\nDetermines whether the search field is visible. Mandatory to first set the filter aggregation or this property has no effect.\n\nThe default value is false.", "returns": { "type": "boolean", "description": "The value of the filterOnly property." } }, "getInstructions": { "name": "getInstructions", "visibility": "public", "description": "Gets current value of the instructions property.\n\nDetermines the instruction text that appears at the top of the dialog.", "returns": { "type": "string", "description": "The value of the instructions property." } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.dialog.CustomSelectDialog class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "getSearchFirst": { "name": "getSearchFirst", "visibility": "public", "description": "Gets current value of the searchFirst property.\n\nDetermines whether the search field is displayed before the filter control.\n\nThe default value is true.", "returns": { "type": "boolean", "description": "The value of the searchFirst property." } }, "getShowCountMessage": { "name": "getShowCountMessage", "visibility": "public", "description": "Gets current value of the showCountMessage property.\n\nDetermines the visibility of the countMessage property.\n\nThe default value is false.", "returns": { "type": "boolean", "description": "The value of the showCountMessage property." } }, "setCountMessage": { "name": "setCountMessage", "visibility": "public", "description": "Sets a new value for the countMessage property.\n\nDetermines the message that appears below the selection area of the dialog.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sCountMessage", "type": "string", "optional": "false", "description": "The new value for the countMessage property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setFilter": { "name": "setFilter", "visibility": "public", "description": "Sets the aggregated filter.", "params": [ { "name": "oFilter", "type": "sap.ui.core.Control", "optional": "false", "description": "The filter to set." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setFilterOnly": { "name": "setFilterOnly", "visibility": "public", "description": "Sets a new value for the filterOnly property.\n\nDetermines whether the search field is visible. Mandatory to first set the filter aggregation or this property has no effect.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is false.", "params": [ { "name": "bFilterOnly", "type": "boolean", "optional": "false", "description": "The new value for the filterOnly property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setInstructions": { "name": "setInstructions", "visibility": "public", "description": "Sets a new value for the instructions property.\n\nDetermines the instruction text that appears at the top of the dialog.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sInstructions", "type": "string", "optional": "false", "description": "The new value for the instructions property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setSearchFirst": { "name": "setSearchFirst", "visibility": "public", "description": "Sets a new value for the searchFirst property.\n\nDetermines whether the search field is displayed before the filter control.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is true.", "params": [ { "name": "bSearchFirst", "type": "boolean", "optional": "false", "description": "The new value for the searchFirst property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setShowCountMessage": { "name": "setShowCountMessage", "visibility": "public", "description": "Sets a new value for the showCountMessage property.\n\nDetermines the visibility of the countMessage property.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is false.", "params": [ { "name": "bShowCountMessage", "type": "boolean", "optional": "false", "description": "The new value for the showCountMessage property." } ], "returns": { "type": "sap.watt.ui.control.dialog.CustomSelectDialog", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.dialog.ListSelectDialog": { "kind": "control", "name": "Controls.sap.watt.ui.control.dialog.ListSelectDialog", "basename": "sap.watt.ui.control.dialog.ListSelectDialog", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a ListSelectDialog control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.watt.ui.control.dialog.CustomSelectDialog", "ui5-metadata": { "aggregations": [ { "name": "items", "singularName": "item", "type": "sap.m.ListItemBase", "cardinality": "0..n", "visibility": "public", "description": "Defines the items of the list. It is recommended to use a StandardListItem for the dialog but other combinations are also possible.", "methods": [ "getItems", "destroyItems", "insertItem", "addItem", "removeItem", "indexOfItem", "removeAllItems" ] } ], "associations": [], "properties": [ { "name": "noDataText", "type": "string", "defaultValue": null, "group": "Appearance", "visibility": "public", "description": "Determines the text shown when the list has no data.", "methods": [ "getNoDataText", "setNoDataText" ] }, { "name": "multiSelect", "type": "boolean", "defaultValue": false, "group": "Appearance", "visibility": "public", "description": "Determines whether the user can select several options from the list.", "methods": [ "getMultiSelect", "setMultiSelect" ] }, { "name": "acceptWithSelection", "type": "boolean", "defaultValue": false, "group": "Appearance", "visibility": "public", "description": "If this property is set to true, the accept button can be enabled only if the list has at least one selected item.", "methods": [ "getAcceptWithSelection", "setAcceptWithSelection" ] } ] }, "description": "A dialog control in SAP Web IDE that enables users to select one or more items from a comprehensive list.\n

Overview

\nA ListSelectDialog is a dialog containing a list, search functionality to filter it and accept and cancel buttons.\nThe list used in the dialog can be filled with any kind of list item.\n\nNOTE: The content aggregation is ignored in this dialog.", "events": { "close": { "name": "close", "visibility": "public", "description": "Fired when the user clicks on one of the dialog’s buttons or presses the ESC key.\n\nListeners may prevent the default action of this event by using the preventDefault method on the event object.\n\n", "methods": [ "attachClose", "detachClose", "fireClose" ], "params": { "action": { "name": "action", "type": "sap.watt.ui.DialogAction", "description": "The action type associated with button that was pressed.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogAction.Accept (accept action)
    • \n
  • sap.watt.ui.DialogAction.Cancel (cancel action)
    • \n
  • sap.watt.ui.DialogAction.Custom (custom action)
    • \n
  • sap.watt.ui.DialogAction.None (no action)
\n\nESC key is associated with sap.watt.ui.DialogAction.Cancel action." }, "selectedItem": { "name": "selectedItem", "type": "sap.m.ListItemBase", "description": "Returns the selected list item. When no item is selected, null is returned. When a multi-selection is enabled and multiple items are selected, only the first selected item is returned." }, "selectedItems": { "name": "selectedItems", "type": "sap.m.ListItemBase[]", "description": "Returns an array containing the visible selected list items. If no items are selected, an empty array is returned." }, "selectedContexts": { "name": "selectedContexts", "type": "object[]", "description": "Returns the binding contexts of the selected items including the non-visible items.\nNOTE: In contrast to the selectedItems parameter, this parameter also includes the selected but NOT visible items; for example, if list filtering is implemented. An empty array is set for this parameter if no data binding is used.\nNOTE: When the list binding is pre-filtered and there are items in the selection that are not visible upon opening the dialog, these contexts are not loaded. Therefore, these items are not included in the selectedContexts array unless they are displayed at least once." } } }, "search": { "name": "search", "visibility": "public", "description": "Fires on click of the search button in the dialog.", "methods": [ "attachSearch", "detachSearch", "fireSearch" ], "params": { "value": { "name": "value", "type": "string", "description": "Specifies the value entered in the search field." }, "itemsBinding": { "name": "itemsBinding", "type": "any", "description": "The binding of items in the dialog. Only available if the items aggregation is bound to a model." } } }, "liveChange": { "name": "liveChange", "visibility": "public", "description": "Fires when the value of the search field is changed by a user; for example, on each key press.", "methods": [ "attachLiveChange", "detachLiveChange", "fireLiveChange" ], "params": { "value": { "name": "value", "type": "string", "description": "Specifies the value entered in the search field." }, "itemsBinding": { "name": "itemsBinding", "type": "any", "description": "The binding of items in the dialog. Only available if the items aggregation is bound to a model." } } } }, "methods": { "addItem": { "name": "addItem", "visibility": "public", "description": "Adds the oItem parameter to the items aggregation.", "params": [ { "name": "oItem", "type": "sap.m.ListItemBase", "optional": "false", "description": "The oItem parameter to add; if empty, nothing is inserted." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "attachClose": { "name": "attachClose", "visibility": "public", "description": "Attaches the fnFunction event handler to the close event of this sap.watt.ui.control.dialog.ListSelectDialog.\n\nWhen called, the context of the event handler (its this) will be bound to the oListener object if specified; \notherwise, it will be bound to the sap.watt.ui.control.dialog.ListSelectDialog object itself.\n\nFired when the user clicks on one of the dialog’s buttons or presses the ESC key.\n\nListeners may prevent the default action of this event by using the preventDefault method on the event object.", "params": [ { "name": "oData", "type": "object", "optional": "true", "description": "An application-specific payload object that will be passed to the event handler along with the event object when firing the event." }, { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "true", "description": "Context object with which to call the event handler. Defaults to the sap.watt.ui.control.dialog.ListSelectDialog object itself." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "attachLiveChange": { "name": "attachLiveChange", "visibility": "public", "description": "Attaches the fnFunction event handler to the liveChange event of this sap.watt.ui.control.dialog.ListSelectDialog.\n\nWhen called, the context of the event handler (its this) will be bound to the oListener object if specified; \notherwise, it will be bound to the sap.watt.ui.control.dialog.ListSelectDialog object itself.\n\nFires when the value of the search field is changed by a user; for example, on each key press.", "params": [ { "name": "oData", "type": "object", "optional": "true", "description": "An application-specific payload object that will be passed to the event handler along with the event object when firing the event." }, { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "true", "description": "Context object with which to call the event handler. Defaults to the sap.watt.ui.control.dialog.ListSelectDialog object itself." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "attachSearch": { "name": "attachSearch", "visibility": "public", "description": "Attaches the fnFunction event handler to the search event of this sap.watt.ui.control.dialog.ListSelectDialog.\n\nWhen called, the context of the event handler (its this) will be bound to the oListener object if specified; \notherwise, it will be bound to the sap.watt.ui.control.dialog.ListSelectDialog object itself.\n\nFires on click of the search button in the dialog.", "params": [ { "name": "oData", "type": "object", "optional": "true", "description": "An application-specific payload object that will be passed to the event handler along with the event object when firing the event." }, { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "true", "description": "Context object with which to call the event handler. Defaults to the sap.watt.ui.control.dialog.ListSelectDialog object itself." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "destroyItems": { "name": "destroyItems", "visibility": "public", "description": "Destroys all the items in the items aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "detachClose": { "name": "detachClose", "visibility": "public", "description": "Detaches the fnFunction event handler from the close event of the sap.watt.ui.control.dialog.ListSelectDialog object.\n\nThe passed function and listener object must match the ones used for the event registration.", "params": [ { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "false", "description": "The context object on which the given function is called." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "detachLiveChange": { "name": "detachLiveChange", "visibility": "public", "description": "Detaches the fnFunction event handler from the liveChange event of the sap.watt.ui.control.dialog.ListSelectDialog object.\n\nThe passed function and listener object must match the ones used for the event registration.", "params": [ { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "false", "description": "The context object on which the given function is called." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "detachSearch": { "name": "detachSearch", "visibility": "public", "description": "Detaches the fnFunction event handler from the search event of the sap.watt.ui.control.dialog.ListSelectDialog object.\n\nThe passed function and listener object must match the ones used for the event registration.", "params": [ { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "false", "description": "The context object on which the given function is called." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.dialog.ListSelectDialog class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.watt.ui.control.dialog.CustomSelectDialog/methods/sap.watt.ui.control.dialog.CustomSelectDialog.extend sap.watt.ui.control.dialog.CustomSelectDialog.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getAcceptWithSelection": { "name": "getAcceptWithSelection", "visibility": "public", "description": "Gets current value of the acceptWithSelection property.\n\nIf this property is set to true, the accept button can be enabled only if the list has at least one selected item.\n\nThe default value is false.", "returns": { "type": "boolean", "description": "The value of the acceptWithSelection property." } }, "getItems": { "name": "getItems", "visibility": "public", "description": "Gets the content of the items aggregation.\n\nDefines the items of the list. It is recommended to use a StandardListItem for the dialog but other combinations are also possible.", "returns": { "type": "sap.m.ListItemBase[]" } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.dialog.ListSelectDialog class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "getMultiSelect": { "name": "getMultiSelect", "visibility": "public", "description": "Gets current value of the multiSelect property.\n\nDetermines whether the user can select several options from the list.\n\nThe default value is false.", "returns": { "type": "boolean", "description": "The value of the multiSelect property." } }, "getNoDataText": { "name": "getNoDataText", "visibility": "public", "description": "Gets current value of the noDataText property.\n\nDetermines the text shown when the list has no data.", "returns": { "type": "string", "description": "The value of the noDataText property." } }, "indexOfItem": { "name": "indexOfItem", "visibility": "public", "description": "Looks for the provided sap.m.ListItemBase in the items aggregation\nand returns its index if found or -1 otherwise.", "params": [ { "name": "oItem", "type": "sap.m.ListItemBase", "optional": "false", "description": "The item to look for." } ], "returns": { "type": "int", "description": "The index of the provided control in the aggregation if found, or -1 otherwise" } }, "insertItem": { "name": "insertItem", "visibility": "public", "description": "Inserts the oItem parameter into the items aggregation.", "params": [ { "name": "oItem", "type": "sap.m.ListItemBase", "optional": "false", "description": "The oItem parameter to insert; if empty, nothing is inserted." }, { "name": "iIndex", "type": "int", "optional": "false", "description": "The 0-based index at which the oItem parameter should be inserted; for\n a negative value of iIndex, the oItem parameter is inserted at the 0 position; for a value\n greater than the current size of the aggregation, the oItem parameter is inserted at\n the last position." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "removeAllItems": { "name": "removeAllItems", "visibility": "public", "description": "Removes all the controls from the items aggregation.\n\nAdditionally, it unregisters them from the hosting UIArea.", "returns": { "type": "sap.m.ListItemBase[]", "description": "An array of the removed controls." } }, "removeItem": { "name": "removeItem", "visibility": "public", "description": "Removes a item from the items aggregation.", "params": [ { "name": "vItem", "type": "int|string|sap.m.ListItemBase", "optional": "false", "description": "The item to remove or its index or its ID." } ], "returns": { "type": "sap.m.ListItemBase", "description": "The removed item or null." } }, "setAcceptWithSelection": { "name": "setAcceptWithSelection", "visibility": "public", "description": "Sets a new value for the acceptWithSelection property.\n\nIf this property is set to true, the accept button can be enabled only if the list has at least one selected item.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is false.", "params": [ { "name": "bAcceptWithSelection", "type": "boolean", "optional": "false", "description": "The new value for the acceptWithSelection property." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setMultiSelect": { "name": "setMultiSelect", "visibility": "public", "description": "Sets a new value for the multiSelect property.\n\nDetermines whether the user can select several options from the list.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is false.", "params": [ { "name": "bMultiSelect", "type": "boolean", "optional": "false", "description": "The new value for the multiSelect property." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "setNoDataText": { "name": "setNoDataText", "visibility": "public", "description": "Sets a new value for the noDataText property.\n\nDetermines the text shown when the list has no data.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sNoDataText", "type": "string", "optional": "false", "description": "The new value for the noDataText property." } ], "returns": { "type": "sap.watt.ui.control.dialog.ListSelectDialog", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.dialog.SimpleDialog": { "kind": "control", "name": "Controls.sap.watt.ui.control.dialog.SimpleDialog", "basename": "sap.watt.ui.control.dialog.SimpleDialog", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a SimpleDialog control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.ui.core.Control", "ui5-metadata": { "defaultAggregation": "content", "aggregations": [ { "name": "message", "singularName": "message", "type": "sap.watt.ui.control.MessageStrip", "cardinality": "0..1", "visibility": "public", "description": "Adds a MessageStrip control which is displayed before the dialog's content; otherwise, it is hidden.", "methods": [ "getMessage", "destroyMessage", "setMessage" ] }, { "name": "formContent", "singularName": "formContent", "type": "sap.ui.core.Element", "cardinality": "0..n", "visibility": "public", "description": "The content of the form inside the dialog.\n\nSee {@link sap.ui.layout.form.SimpleForm/methods/getContent sap.ui.layout.form.SimpleForm#content}\n\nNOTE: If a content aggregation is used, the formContent aggregation is ignored.", "methods": [ "getFormContent", "destroyFormContent", "insertFormContent", "addFormContent", "removeFormContent", "indexOfFormContent", "removeAllFormContent" ] }, { "name": "content", "singularName": "content", "type": "sap.ui.core.Control", "cardinality": "0..n", "visibility": "public", "description": "The content inside the dialog.\n\nNOTE: If a content aggregation is used, the formContent aggregation is ignored.", "methods": [ "getContent", "destroyContent", "insertContent", "addContent", "removeContent", "indexOfContent", "removeAllContent" ] } ], "associations": [ { "name": "initialFocus", "singularName": "initialFocu", "type": "sap.ui.core.Control", "cardinality": "0..1", "visibility": "public", "description": "Defines the control that gets the focus when the dialog is opened.", "methods": [ "getInitialFocus", "setInitialFocus" ] } ], "properties": [ { "name": "title", "type": "string", "defaultValue": null, "group": "Appearance", "visibility": "public", "description": "The title text appears in the dialog header.", "methods": [ "getTitle", "setTitle" ] }, { "name": "contentHeight", "type": "sap.ui.core.CSSSize", "defaultValue": null, "group": "Dimension", "visibility": "public", "description": "The preferred height of the content in the dialog. If the preferred height is greater than the available space on screen, it is overwritten by the maximum available height on screen in order to make sure that dialog isn't cut off.", "methods": [ "getContentHeight", "setContentHeight" ] }, { "name": "width", "type": "sap.watt.ui.DialogWidth", "defaultValue": "Tiny", "group": "Dimension", "visibility": "public", "description": "The preferred width of the dialog window.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogWidth.Tiny (480px)
    • \n
  • sap.watt.ui.DialogWidth.Small (560px)
    • \n
  • sap.watt.ui.DialogWidth.Medium (640px)
    • \n
  • sap.watt.ui.DialogWidth.Large (720px)
    • \n
  • sap.watt.ui.DialogWidth.XLarge (800px)
", "methods": [ "getWidth", "setWidth" ] }, { "name": "cancelButtonText", "type": "string", "defaultValue": null, "group": "Misc", "visibility": "public", "description": "Determines the text of the dialog's cancel button which is rendered on the right side of the footer area inside the dialog. NOTE: The cancel button is rendered on the left side in right-to-left (RTL) mode.", "methods": [ "getCancelButtonText", "setCancelButtonText" ] }, { "name": "destroyAfterClose", "type": "boolean", "defaultValue": false, "group": "Misc", "visibility": "public", "description": "If the property is set to true, the dialog is destroyed automatically after closing.", "methods": [ "getDestroyAfterClose", "setDestroyAfterClose" ] }, { "name": "contentStyleClass", "type": "string", "defaultValue": "", "group": "Misc", "visibility": "public", "description": "The style class is applied to the dialog's content and can be used for CSS selectors.", "methods": [ "getContentStyleClass", "setContentStyleClass" ] }, { "name": "labelWidth", "type": "sap.watt.ui.DialogLabelWidth", "defaultValue": "Auto", "group": "Misc", "visibility": "public", "description": "Default label width.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogLabelWidth.Tiny (2 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Short (3 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Long (4 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Full (12 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Auto (label width is calculated automatically)
\n\nNOTE: This property used only in the formContent aggregation.", "methods": [ "getLabelWidth", "setLabelWidth" ] }, { "name": "defaultAction", "type": "sap.watt.ui.DialogAction", "defaultValue": "None", "group": "Misc", "visibility": "public", "description": "Defines one of the buttons as the default button. This default button is initially selected if no control is explicitly set using the initialFocus association. The default button is activated when the Enter key is pressed in the context of the dialog and when the currently selected element does not handle the Enter event itself.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogAction.Accept (accept action)
    • \n
  • sap.watt.ui.DialogAction.Cancel (cancel action)
    • \n
  • sap.watt.ui.DialogAction.Custom (custom action)
    • \n
  • sap.watt.ui.DialogAction.None (no action)
", "methods": [ "getDefaultAction", "setDefaultAction" ] } ] }, "description": "A dialog control in SAP Web IDE that has one close button in the footer area.", "component": "CA-WDE-TFL", "events": { "close": { "name": "close", "visibility": "public", "description": "Fired when the user clicks on one of the dialog’s buttons or presses the ESC key.\n\nListeners may prevent the default action of this event by using the preventDefault method on the event object.\n\n", "methods": [ "attachClose", "detachClose", "fireClose" ], "params": { "action": { "name": "action", "type": "sap.watt.ui.DialogAction", "description": "The action type associated with button that was pressed.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogAction.Accept (accept action)
    • \n
  • sap.watt.ui.DialogAction.Cancel (cancel action)
    • \n
  • sap.watt.ui.DialogAction.Custom (custom action)
    • \n
  • sap.watt.ui.DialogAction.None (no action)
\nESC key is associated with sap.watt.ui.DialogAction.Cancel action." } } } }, "methods": { "addContent": { "name": "addContent", "visibility": "public", "description": "Adds the oContent parameter to the content aggregation.", "params": [ { "name": "oContent", "type": "sap.ui.core.Control", "optional": "false", "description": "The oContent parameter to add; if empty, nothing is inserted." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "addFormContent": { "name": "addFormContent", "visibility": "public", "description": "Adds the oFormContent parameter to the formContent aggregation.", "params": [ { "name": "oFormContent", "type": "sap.ui.core.Element", "optional": "false", "description": "The oFormContent parameter to add; if empty, nothing is inserted." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "attachClose": { "name": "attachClose", "visibility": "public", "description": "Attaches the fnFunction event handler to the close event of this sap.watt.ui.control.dialog.SimpleDialog.\n\nWhen called, the context of the event handler (its this) will be bound to the oListener object if specified; \notherwise, it will be bound to the sap.watt.ui.control.dialog.SimpleDialog object itself.\n\nFired when the user clicks on one of the dialog’s buttons or presses the ESC key.\n\nListeners may prevent the default action of this event by using the preventDefault method on the event object.", "params": [ { "name": "oData", "type": "object", "optional": "true", "description": "An application-specific payload object that will be passed to the event handler along with the event object when firing the event." }, { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "true", "description": "Context object with which to call the event handler. Defaults to the sap.watt.ui.control.dialog.SimpleDialog object itself." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "close": { "name": "close", "visibility": "public", "description": "Close the dialog." }, "destroyContent": { "name": "destroyContent", "visibility": "public", "description": "Destroys all the content in the content aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "destroyFormContent": { "name": "destroyFormContent", "visibility": "public", "description": "Destroys all the formContent in the formContent aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "destroyMessage": { "name": "destroyMessage", "visibility": "public", "description": "Destroys the message in the message aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "detachClose": { "name": "detachClose", "visibility": "public", "description": "Detaches the fnFunction event handler from the close event of the sap.watt.ui.control.dialog.SimpleDialog object.\n\nThe passed function and listener object must match the ones used for the event registration.", "params": [ { "name": "fnFunction", "type": "function", "optional": "false", "description": "The function to call when the event occurs." }, { "name": "oListener", "type": "object", "optional": "false", "description": "The context object on which the given function is called." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.dialog.SimpleDialog class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.ui.core.Control/methods/sap.ui.core.Control.extend sap.ui.core.Control.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getCancelButtonText": { "name": "getCancelButtonText", "visibility": "public", "description": "Gets current value of the cancelButtonText property.\n\nDetermines the text of the dialog's cancel button which is rendered on the right side of the footer area inside the dialog. NOTE: The cancel button is rendered on the left side in right-to-left (RTL) mode.", "returns": { "type": "string", "description": "The value of the cancelButtonText property." } }, "getContent": { "name": "getContent", "visibility": "public", "description": "Gets the content of the content aggregation.\n\nThe content inside the dialog.\n\nNOTE: If a content aggregation is used, the formContent aggregation is ignored.", "returns": { "type": "sap.ui.core.Control[]" } }, "getContentHeight": { "name": "getContentHeight", "visibility": "public", "description": "Gets current value of the contentHeight property.\n\nThe preferred height of the content in the dialog. If the preferred height is greater than the available space on screen, it is overwritten by the maximum available height on screen in order to make sure that dialog isn't cut off.", "returns": { "type": "sap.ui.core.CSSSize", "description": "The value of the contentHeight property." } }, "getContentStyleClass": { "name": "getContentStyleClass", "visibility": "public", "description": "Gets current value of the contentStyleClass property.\n\nThe style class is applied to the dialog's content and can be used for CSS selectors.\n\nThe default value is .", "returns": { "type": "string", "description": "The value of the contentStyleClass property." } }, "getDefaultAction": { "name": "getDefaultAction", "visibility": "public", "description": "Gets current value of the defaultAction property.\n\nDefines one of the buttons as the default button. This default button is initially selected if no control is explicitly set using the initialFocus association. The default button is activated when the Enter key is pressed in the context of the dialog and when the currently selected element does not handle the Enter event itself.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogAction.Accept (accept action)
    • \n
  • sap.watt.ui.DialogAction.Cancel (cancel action)
    • \n
  • sap.watt.ui.DialogAction.Custom (custom action)
    • \n
  • sap.watt.ui.DialogAction.None (no action)
\n\nThe default value is None.", "returns": { "type": "sap.watt.ui.DialogAction", "description": "The value of the defaultAction property." } }, "getDestroyAfterClose": { "name": "getDestroyAfterClose", "visibility": "public", "description": "Gets current value of the destroyAfterClose property.\n\nIf the property is set to true, the dialog is destroyed automatically after closing.\n\nThe default value is false.", "returns": { "type": "boolean", "description": "The value of the destroyAfterClose property." } }, "getFormContent": { "name": "getFormContent", "visibility": "public", "description": "Gets the content of the formContent aggregation.\n\nThe content of the form inside the dialog.\n\nSee {@link sap.ui.layout.form.SimpleForm/methods/getContent sap.ui.layout.form.SimpleForm#content}\n\nNOTE: If a content aggregation is used, the formContent aggregation is ignored.", "returns": { "type": "sap.ui.core.Element[]" } }, "getInitialFocus": { "name": "getInitialFocus", "visibility": "public", "description": "Returns the ID of the element that is the current target of the initialFocus association, or null.", "returns": { "type": "sap.ui.core.ID" } }, "getLabelWidth": { "name": "getLabelWidth", "visibility": "public", "description": "Gets current value of the labelWidth property.\n\nDefault label width.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogLabelWidth.Tiny (2 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Short (3 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Long (4 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Full (12 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Auto (label width is calculated automatically)
\n\nNOTE: This property used only in the formContent aggregation.\n\nThe default value is Auto.", "returns": { "type": "sap.watt.ui.DialogLabelWidth", "description": "The value of the labelWidth property." } }, "getMessage": { "name": "getMessage", "visibility": "public", "description": "Gets the content of the message aggregation.\n\nAdds a MessageStrip control which is displayed before the dialog's content; otherwise, it is hidden.", "returns": { "type": "sap.watt.ui.control.MessageStrip" } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.dialog.SimpleDialog class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "getTitle": { "name": "getTitle", "visibility": "public", "description": "Gets current value of the title property.\n\nThe title text appears in the dialog header.", "returns": { "type": "string", "description": "The value of the title property." } }, "getWidth": { "name": "getWidth", "visibility": "public", "description": "Gets current value of the width property.\n\nThe preferred width of the dialog window.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogWidth.Tiny (480px)
    • \n
  • sap.watt.ui.DialogWidth.Small (560px)
    • \n
  • sap.watt.ui.DialogWidth.Medium (640px)
    • \n
  • sap.watt.ui.DialogWidth.Large (720px)
    • \n
  • sap.watt.ui.DialogWidth.XLarge (800px)
\n\nThe default value is Tiny.", "returns": { "type": "sap.watt.ui.DialogWidth", "description": "The value of the width property." } }, "indexOfContent": { "name": "indexOfContent", "visibility": "public", "description": "Looks for the provided sap.ui.core.Control in the content aggregation\nand returns its index if found or -1 otherwise.", "params": [ { "name": "oContent", "type": "sap.ui.core.Control", "optional": "false", "description": "The content to look for." } ], "returns": { "type": "int", "description": "The index of the provided control in the aggregation if found, or -1 otherwise" } }, "indexOfFormContent": { "name": "indexOfFormContent", "visibility": "public", "description": "Looks for the provided sap.ui.core.Element in the formContent aggregation\nand returns its index if found or -1 otherwise.", "params": [ { "name": "oFormContent", "type": "sap.ui.core.Element", "optional": "false", "description": "The formContent to look for." } ], "returns": { "type": "int", "description": "The index of the provided control in the aggregation if found, or -1 otherwise" } }, "insertContent": { "name": "insertContent", "visibility": "public", "description": "Inserts the oContent parameter into the content aggregation.", "params": [ { "name": "oContent", "type": "sap.ui.core.Control", "optional": "false", "description": "The oContent parameter to insert; if empty, nothing is inserted." }, { "name": "iIndex", "type": "int", "optional": "false", "description": "The 0-based index at which the oContent parameter should be inserted; for\n a negative value of iIndex, the oContent parameter is inserted at the 0 position; for a value\n greater than the current size of the aggregation, the oContent parameter is inserted at\n the last position." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "insertFormContent": { "name": "insertFormContent", "visibility": "public", "description": "Inserts the oFormContent parameter into the formContent aggregation.", "params": [ { "name": "oFormContent", "type": "sap.ui.core.Element", "optional": "false", "description": "The oFormContent parameter to insert; if empty, nothing is inserted." }, { "name": "iIndex", "type": "int", "optional": "false", "description": "The 0-based index at which the oFormContent parameter should be inserted; for\n a negative value of iIndex, the oFormContent parameter is inserted at the 0 position; for a value\n greater than the current size of the aggregation, the oFormContent parameter is inserted at\n the last position." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "open": { "name": "open", "visibility": "public", "description": "Open the dialog.", "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "removeAllContent": { "name": "removeAllContent", "visibility": "public", "description": "Removes all the controls from the content aggregation.\n\nAdditionally, it unregisters them from the hosting UIArea.", "returns": { "type": "sap.ui.core.Control[]", "description": "An array of the removed controls." } }, "removeAllFormContent": { "name": "removeAllFormContent", "visibility": "public", "description": "Removes all the controls from the formContent aggregation.\n\nAdditionally, it unregisters them from the hosting UIArea.", "returns": { "type": "sap.ui.core.Element[]", "description": "An array of the removed controls." } }, "removeContent": { "name": "removeContent", "visibility": "public", "description": "Removes a content from the content aggregation.", "params": [ { "name": "vContent", "type": "int|string|sap.ui.core.Control", "optional": "false", "description": "The content to remove or its index or its ID." } ], "returns": { "type": "sap.ui.core.Control", "description": "The removed content or null." } }, "removeFormContent": { "name": "removeFormContent", "visibility": "public", "description": "Removes a formContent from the formContent aggregation.", "params": [ { "name": "vFormContent", "type": "int|string|sap.ui.core.Element", "optional": "false", "description": "The formContent to remove or its index or its ID." } ], "returns": { "type": "sap.ui.core.Element", "description": "The removed formContent or null." } }, "setCancelButtonText": { "name": "setCancelButtonText", "visibility": "public", "description": "Sets a new value for the cancelButtonText property.\n\nDetermines the text of the dialog's cancel button which is rendered on the right side of the footer area inside the dialog. NOTE: The cancel button is rendered on the left side in right-to-left (RTL) mode.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sCancelButtonText", "type": "string", "optional": "false", "description": "The new value for the cancelButtonText property." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setContentHeight": { "name": "setContentHeight", "visibility": "public", "description": "Sets a new value for the contentHeight property.\n\nThe preferred height of the content in the dialog. If the preferred height is greater than the available space on screen, it is overwritten by the maximum available height on screen in order to make sure that dialog isn't cut off.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sContentHeight", "type": "sap.ui.core.CSSSize", "optional": "false", "description": "The new value for the contentHeight property." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setContentStyleClass": { "name": "setContentStyleClass", "visibility": "public", "description": "Setter for the contentStyleClass property.", "params": [ { "name": "sValue", "type": "string", "optional": "false", "description": "The style class." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setDefaultAction": { "name": "setDefaultAction", "visibility": "public", "description": "Setter for the defaultAction property.", "params": [ { "name": "sAction", "type": "sap.watt.ui.DialogAction", "optional": "false", "description": "The message type." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setDestroyAfterClose": { "name": "setDestroyAfterClose", "visibility": "public", "description": "Sets a new value for the destroyAfterClose property.\n\nIf the property is set to true, the dialog is destroyed automatically after closing.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is false.", "params": [ { "name": "bDestroyAfterClose", "type": "boolean", "optional": "false", "description": "The new value for the destroyAfterClose property." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setInitialFocus": { "name": "setInitialFocus", "visibility": "public", "description": "Sets the associated initialFocus.", "params": [ { "name": "oInitialFocus", "type": "sap.ui.core.Control", "optional": "false", "description": "The ID or the instance of an element that becomes the new target of this initialFocus association." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setLabelWidth": { "name": "setLabelWidth", "visibility": "public", "description": "Sets a new value for the labelWidth property.\n\nDefault label width.\n\n
    The possible values are:\n
  • sap.watt.ui.DialogLabelWidth.Tiny (2 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Short (3 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Long (4 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Full (12 grid spans)
    • \n
  • sap.watt.ui.DialogLabelWidth.Auto (label width is calculated automatically)
\n\nNOTE: This property used only in the formContent aggregation.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is Auto.", "params": [ { "name": "sLabelWidth", "type": "sap.watt.ui.DialogLabelWidth", "optional": "false", "description": "The new value for the labelWidth property." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setMessage": { "name": "setMessage", "visibility": "public", "description": "Sets the aggregated message.", "params": [ { "name": "oMessage", "type": "sap.watt.ui.control.MessageStrip", "optional": "false", "description": "The message to set." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setTitle": { "name": "setTitle", "visibility": "public", "description": "Sets a new value for the title property.\n\nThe title text appears in the dialog header.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "params": [ { "name": "sTitle", "type": "string", "optional": "false", "description": "The new value for the title property." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } }, "setWidth": { "name": "setWidth", "visibility": "public", "description": "Setter for the width property.", "params": [ { "name": "sWidth", "type": "sap.watt.ui.DialogWidth", "optional": "false", "description": "The dialog width." } ], "returns": { "type": "sap.watt.ui.control.dialog.SimpleDialog", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.dialog.TableSelectDialog": { "kind": "control", "name": "Controls.sap.watt.ui.control.dialog.TableSelectDialog", "basename": "sap.watt.ui.control.dialog.TableSelectDialog", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a TableSelectDialog control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.watt.ui.control.dialog.ListSelectDialog", "ui5-metadata": { "aggregations": [ { "name": "items", "singularName": "item", "type": "sap.m.ColumnListItem", "cardinality": "0..n", "visibility": "public", "description": "Defines the items of the table.", "methods": [ "getItems", "destroyItems", "insertItem", "addItem", "removeItem", "indexOfItem", "removeAllItems" ] }, { "name": "columns", "singularName": "column", "type": "sap.m.Column", "cardinality": "0..n", "visibility": "public", "description": "Defines the columns of the table.", "methods": [ "getColumns", "destroyColumns", "insertColumn", "addColumn", "removeColumn", "indexOfColumn", "removeAllColumns" ] } ], "associations": [], "properties": [] }, "description": "A dialog control in SAP Web IDE that enables users to select one or more items from a table-like structure containing multiple values and attributes per item.\n

Overview

\nA TableSelectDialog is a dialog containing a table-like structure, search functionality to filter it and accept and cancel buttons.\n\nNOTE: The content aggregation is ignored in this dialog.", "events": {}, "methods": { "addColumn": { "name": "addColumn", "visibility": "public", "description": "Adds the oColumn parameter to the columns aggregation.", "params": [ { "name": "oColumn", "type": "sap.m.Column", "optional": "false", "description": "The oColumn parameter to add; if empty, nothing is inserted." } ], "returns": { "type": "sap.watt.ui.control.dialog.TableSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "addItem": { "name": "addItem", "visibility": "public", "description": "Adds the oItem parameter to the items aggregation.", "params": [ { "name": "oItem", "type": "sap.m.ColumnListItem", "optional": "false", "description": "The oItem parameter to add; if empty, nothing is inserted." } ], "returns": { "type": "sap.watt.ui.control.dialog.TableSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "destroyColumns": { "name": "destroyColumns", "visibility": "public", "description": "Destroys all the columns in the columns aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.TableSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "destroyItems": { "name": "destroyItems", "visibility": "public", "description": "Destroys all the items in the items aggregation.", "returns": { "type": "sap.watt.ui.control.dialog.TableSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.dialog.TableSelectDialog class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.watt.ui.control.dialog.ListSelectDialog/methods/sap.watt.ui.control.dialog.ListSelectDialog.extend sap.watt.ui.control.dialog.ListSelectDialog.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getColumns": { "name": "getColumns", "visibility": "public", "description": "Gets the content of the columns aggregation.\n\nDefines the columns of the table.", "returns": { "type": "sap.m.Column[]" } }, "getItems": { "name": "getItems", "visibility": "public", "description": "Gets the content of the items aggregation.\n\nDefines the items of the table.", "returns": { "type": "sap.m.ColumnListItem[]" } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.dialog.TableSelectDialog class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "indexOfColumn": { "name": "indexOfColumn", "visibility": "public", "description": "Looks for the provided sap.m.Column in the columns aggregation\nand returns its index if found or -1 otherwise.", "params": [ { "name": "oColumn", "type": "sap.m.Column", "optional": "false", "description": "The column to look for." } ], "returns": { "type": "int", "description": "The index of the provided control in the aggregation if found, or -1 otherwise" } }, "indexOfItem": { "name": "indexOfItem", "visibility": "public", "description": "Looks for the provided sap.m.ColumnListItem in the items aggregation\nand returns its index if found or -1 otherwise.", "params": [ { "name": "oItem", "type": "sap.m.ColumnListItem", "optional": "false", "description": "The item to look for." } ], "returns": { "type": "int", "description": "The index of the provided control in the aggregation if found, or -1 otherwise" } }, "insertColumn": { "name": "insertColumn", "visibility": "public", "description": "Inserts the oColumn parameter into the columns aggregation.", "params": [ { "name": "oColumn", "type": "sap.m.Column", "optional": "false", "description": "The oColumn parameter to insert; if empty, nothing is inserted." }, { "name": "iIndex", "type": "int", "optional": "false", "description": "The 0-based index at which the oColumn parameter should be inserted; for\n a negative value of iIndex, the oColumn parameter is inserted at the 0 position; for a value\n greater than the current size of the aggregation, the oColumn parameter is inserted at\n the last position." } ], "returns": { "type": "sap.watt.ui.control.dialog.TableSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "insertItem": { "name": "insertItem", "visibility": "public", "description": "Inserts the oItem parameter into the items aggregation.", "params": [ { "name": "oItem", "type": "sap.m.ColumnListItem", "optional": "false", "description": "The oItem parameter to insert; if empty, nothing is inserted." }, { "name": "iIndex", "type": "int", "optional": "false", "description": "The 0-based index at which the oItem parameter should be inserted; for\n a negative value of iIndex, the oItem parameter is inserted at the 0 position; for a value\n greater than the current size of the aggregation, the oItem parameter is inserted at\n the last position." } ], "returns": { "type": "sap.watt.ui.control.dialog.TableSelectDialog", "description": "Reference to this in order to allow method chaining." } }, "removeAllColumns": { "name": "removeAllColumns", "visibility": "public", "description": "Removes all the controls from the columns aggregation.\n\nAdditionally, it unregisters them from the hosting UIArea.", "returns": { "type": "sap.m.Column[]", "description": "An array of the removed controls." } }, "removeAllItems": { "name": "removeAllItems", "visibility": "public", "description": "Removes all the controls from the items aggregation.\n\nAdditionally, it unregisters them from the hosting UIArea.", "returns": { "type": "sap.m.ColumnListItem[]", "description": "An array of the removed controls." } }, "removeColumn": { "name": "removeColumn", "visibility": "public", "description": "Removes a column from the columns aggregation.", "params": [ { "name": "vColumn", "type": "int|string|sap.m.Column", "optional": "false", "description": "The column to remove or its index or its ID." } ], "returns": { "type": "sap.m.Column", "description": "The removed column or null." } }, "removeItem": { "name": "removeItem", "visibility": "public", "description": "Removes a item from the items aggregation.", "params": [ { "name": "vItem", "type": "int|string|sap.m.ColumnListItem", "optional": "false", "description": "The item to remove or its index or its ID." } ], "returns": { "type": "sap.m.ColumnListItem", "description": "The removed item or null." } } } }, "sap.watt.ui.control.form.FormFieldsBox": { "kind": "control", "name": "Controls.sap.watt.ui.control.form.FormFieldsBox", "basename": "sap.watt.ui.control.form.FormFieldsBox", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a new FormFieldsBox control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.ui.core.Control", "ui5-metadata": { "defaultAggregation": "fields", "aggregations": [ { "name": "fields", "singularName": "field", "type": "sap.ui.core.Control", "cardinality": "0..n", "visibility": "public", "description": "Form controls that belong together to be displayed in one row of a Form control.\n\nWarning: Do not put any layout, other container controls, or views in here.\nThis could damage the visual layout, keyboard support, and screen reader support.\nOnly form controls are allowed.\nAllowed controls implement the interface sap.ui.core.IFormContent.", "methods": [ "getFields", "destroyFields", "insertField", "addField", "removeField", "indexOfField", "removeAllFields" ] } ], "associations": [], "properties": [ { "name": "width", "type": "sap.ui.core.CSSSize", "defaultValue": "100%", "group": "Appearance", "visibility": "public", "description": "Defines the width of the control.", "methods": [ "getWidth", "setWidth" ] } ] }, "description": "A FormFieldsBox control represents a row of fields in a {@link sap.ui.layout.form.FormElement FormElement} control.", "component": "CA-WDE-TFL", "events": {}, "methods": { "addField": { "name": "addField", "visibility": "public", "description": "Adds the oField parameter to the fields aggregation.", "params": [ { "name": "oField", "type": "sap.ui.core.Control", "optional": "false", "description": "The oField parameter to add; if empty, nothing is inserted." } ], "returns": { "type": "sap.watt.ui.control.form.FormFieldsBox", "description": "Reference to this in order to allow method chaining." } }, "destroyFields": { "name": "destroyFields", "visibility": "public", "description": "Destroys all the fields in the fields aggregation.", "returns": { "type": "sap.watt.ui.control.form.FormFieldsBox", "description": "Reference to this in order to allow method chaining." } }, "extend": { "name": "extend", "module": "config-preload", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.form.FormFieldsBox class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.ui.base.Object/methods/sap.ui.base.Object.extend sap.ui.base.Object.extend} method.", "resource": "config-preload.js", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getFields": { "name": "getFields", "visibility": "public", "description": "Gets the content of the fields aggregation.\n\nForm controls that belong together to be displayed in one row of a Form control.\n\nWarning: Do not put any layout, other container controls, or views in here.\nThis could damage the visual layout, keyboard support, and screen reader support.\nOnly form controls are allowed.\nAllowed controls implement the interface sap.ui.core.IFormContent.", "returns": { "type": "sap.ui.core.Control[]" } }, "getMetadata": { "name": "getMetadata", "module": "config-preload", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.form.FormFieldsBox class.", "resource": "config-preload.js", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "getWidth": { "name": "getWidth", "visibility": "public", "description": "Gets current value of the width property.\n\nDefines the width of the control.\n\nThe default value is 100%.", "returns": { "type": "sap.ui.core.CSSSize", "description": "The value of the width property." } }, "indexOfField": { "name": "indexOfField", "visibility": "public", "description": "Looks for the provided sap.ui.core.Control in the fields aggregation\nand returns its index if found or -1 otherwise.", "params": [ { "name": "oField", "type": "sap.ui.core.Control", "optional": "false", "description": "The field to look for." } ], "returns": { "type": "int", "description": "The index of the provided control in the aggregation if found, or -1 otherwise" } }, "insertField": { "name": "insertField", "visibility": "public", "description": "Inserts the oField parameter into the fields aggregation.", "params": [ { "name": "oField", "type": "sap.ui.core.Control", "optional": "false", "description": "The oField parameter to insert; if empty, nothing is inserted." }, { "name": "iIndex", "type": "int", "optional": "false", "description": "The 0-based index at which the oField parameter should be inserted; for\n a negative value of iIndex, the oField parameter is inserted at the 0 position; for a value\n greater than the current size of the aggregation, the oField parameter is inserted at\n the last position." } ], "returns": { "type": "sap.watt.ui.control.form.FormFieldsBox", "description": "Reference to this in order to allow method chaining." } }, "removeAllFields": { "name": "removeAllFields", "visibility": "public", "description": "Removes all the controls from the fields aggregation.\n\nAdditionally, it unregisters them from the hosting UIArea.", "returns": { "type": "sap.ui.core.Control[]", "description": "An array of the removed controls." } }, "removeField": { "name": "removeField", "visibility": "public", "description": "Removes a field from the fields aggregation.", "params": [ { "name": "vField", "type": "int|string|sap.ui.core.Control", "optional": "false", "description": "The field to remove or its index or its ID." } ], "returns": { "type": "sap.ui.core.Control", "description": "The removed field or null." } }, "setFields": { "name": "setFields", "module": "config-preload", "visibility": "public", "description": "Sets the aggregated fields.", "resource": "config-preload.js", "params": [ { "name": "oFields", "type": "sap.ui.core.Control", "optional": "false", "description": "The fields to set." } ], "returns": { "type": "sap.watt.ui.control.form.FormFieldsBox", "description": "Reference to this in order to allow method chaining." } }, "setWidth": { "name": "setWidth", "module": "config-preload", "visibility": "public", "description": "Sets a new value for the width property.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is 100%.", "resource": "config-preload.js", "params": [ { "name": "sWidth", "type": "sap.ui.core.CSSSize", "optional": "false", "description": "The new value for the width property." } ], "returns": { "type": "sap.watt.ui.control.form.FormFieldsBox", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.form.HelpIcon": { "kind": "control", "name": "Controls.sap.watt.ui.control.form.HelpIcon", "basename": "sap.watt.ui.control.form.HelpIcon", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for a new HelpIcon control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.ui.core.Icon", "ui5-metadata": { "aggregations": [], "associations": [], "properties": [ { "name": "title", "type": "string", "defaultValue": null, "group": "Misc", "visibility": "public", "description": "The text to be displayed in the tooltip header.", "methods": [ "getTitle", "setTitle" ] }, { "name": "helpTooltip", "type": "string", "defaultValue": null, "group": "Misc", "visibility": "public", "description": "The tooltip that should be displayed for this element.", "methods": [ "getHelpTooltip", "setHelpTooltip" ] } ] }, "description": "HelpIcon is an icon with embedded rich tooltip.\n

Overview

\nThe embedded tooltip control allows the usage of a limited set of HTML tags for display including i and b tags.", "component": "CA-WDE-TFL", "events": {}, "methods": { "extend": { "name": "extend", "module": "config-preload", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.form.HelpIcon class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.ui.base.Object/methods/sap.ui.base.Object.extend sap.ui.base.Object.extend} method.", "resource": "config-preload.js", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getHelpTooltip": { "name": "getHelpTooltip", "visibility": "public", "description": "Gets current value of the helpTooltip property.\n\nThe tooltip that should be displayed for this element.", "returns": { "type": "string", "description": "The value of the helpTooltip property." } }, "getMetadata": { "name": "getMetadata", "module": "config-preload", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.form.HelpIcon class.", "resource": "config-preload.js", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "getTitle": { "name": "getTitle", "module": "config-preload", "visibility": "public", "description": "Gets current value of the title property.", "resource": "config-preload.js", "returns": { "type": "string", "description": "The value of the title property." } }, "setHelpTooltip": { "name": "setHelpTooltip", "module": "config-preload", "visibility": "public", "description": "Sets a new value for the helpTooltip property.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "resource": "config-preload.js", "params": [ { "name": "sHelpTooltip", "type": "string", "optional": "false", "description": "The new value for the helpTooltip property." } ], "returns": { "type": "sap.watt.ui.control.form.HelpIcon", "description": "Reference to this in order to allow method chaining." } }, "setTitle": { "name": "setTitle", "module": "config-preload", "visibility": "public", "description": "Sets a new value for the title property.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.", "resource": "config-preload.js", "params": [ { "name": "sTitle", "type": "string", "optional": "false", "description": "The new value for the title property." } ], "returns": { "type": "sap.watt.ui.control.form.HelpIcon", "description": "Reference to this in order to allow method chaining." } } } }, "sap.watt.ui.control.MessageStrip": { "kind": "control", "name": "Controls.sap.watt.ui.control.MessageStrip", "basename": "sap.watt.ui.control.MessageStrip", "visibility": "public", "constructor": { "visibility": "public", "description": "Constructor for the MessageStrip control.\n\n\nAccepts an mSettings object literal that defines initial\nproperty values, aggregated and associated objects as well as event handlers.\nSee the {@link sap.ui.base.ManagedObject/constructor ManagedObject constructor} for a general description of the syntax of the settings object.", "parameters": [ { "name": "sId", "type": "string", "optional": "true", "description": "The ID for the new control that is generated automatically if no ID is provided." }, { "name": "mSettings", "type": "object", "optional": "true", "description": "Initial settings." } ] }, "extends": "sap.ui.core.Control", "ui5-metadata": { "defaultAggregation": "link", "aggregations": [ { "name": "link", "singularName": "link", "type": "sap.m.Link", "cardinality": "0..1", "visibility": "public", "description": "Adds a sap.m.Link control which is displayed at the end of the message.", "methods": [ "getLink", "destroyLink", "setLink" ] } ], "associations": [], "properties": [ { "name": "text", "type": "string", "defaultValue": "", "group": "Appearance", "visibility": "public", "description": "Determines the text of the message.", "methods": [ "getText", "setText" ] }, { "name": "type", "type": "sap.watt.ui.MessageStripType", "defaultValue": "Information", "group": "Appearance", "visibility": "public", "description": "Determines the type of message.\n\n
    The possible values are:\n
  • sap.watt.ui.MessageStripType.Information (gray message)
    • \n
  • sap.watt.ui.MessageStripType.Warning (yellow message)
    • \n
  • sap.watt.ui.MessageStripType.Error (red message)
    • \n
  • sap.watt.ui.MessageStripType.Progress (blue message)
    • \n
  • sap.watt.ui.MessageStripType.Success (green message)
", "methods": [ "getType", "setType" ] } ] }, "description": "The MessageStrip control enables the embedding of application-related messages in the application.\n

Overview

\nThe MessageStrip control can display five message types, each with a corresponding semantic color and icon: Information, Success, Warning, Error, and Progress.", "component": "CA-WDE-TFL", "events": {}, "methods": { "destroyLink": { "name": "destroyLink", "visibility": "public", "description": "Destroys the link in the link aggregation.", "returns": { "type": "sap.watt.ui.control.MessageStrip", "description": "Reference to this in order to allow method chaining." } }, "extend": { "name": "extend", "visibility": "public", "static": true, "description": "Creates a new subclass of the sap.watt.ui.control.MessageStrip class with sClassName name\nand enriches it with the information contained in the oClassInfo parameter.\n\nThe oClassInfo parameter can contain the same kind of information as described in the {@link sap.ui.core.Control/methods/sap.ui.core.Control.extend sap.ui.core.Control.extend} method.", "params": [ { "name": "sClassName", "type": "string", "optional": "false", "description": "The name of the class being created." }, { "name": "oClassInfo", "type": "object", "optional": "true", "description": "The object literal with information about the class." }, { "name": "FNMetaImpl", "type": "function", "optional": "true", "description": "The constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata." } ], "returns": { "type": "function", "description": "The created class." } }, "getLink": { "name": "getLink", "visibility": "public", "description": "Gets the content of the link aggregation.\n\nAdds a sap.m.Link control which is displayed at the end of the message.", "returns": { "type": "sap.m.Link" } }, "getMetadata": { "name": "getMetadata", "visibility": "public", "static": true, "description": "Returns a metadata object for the sap.watt.ui.control.MessageStrip class.", "returns": { "type": "sap.ui.base.Metadata", "description": "The metadata object describing this class." } }, "getText": { "name": "getText", "visibility": "public", "description": "Gets current value of the text property.\n\nDetermines the text of the message.\n\nThe default value is .", "returns": { "type": "string", "description": "The value of the text property." } }, "getType": { "name": "getType", "visibility": "public", "description": "Gets current value of the type property.\n\nDetermines the type of message.\n\n
    The possible values are:\n
  • sap.watt.ui.MessageStripType.Information (gray message)
    • \n
  • sap.watt.ui.MessageStripType.Warning (yellow message)
    • \n
  • sap.watt.ui.MessageStripType.Error (red message)
    • \n
  • sap.watt.ui.MessageStripType.Progress (blue message)
    • \n
  • sap.watt.ui.MessageStripType.Success (green message)
\n\nThe default value is Information.", "returns": { "type": "sap.watt.ui.MessageStripType", "description": "The value of the type property." } }, "setLink": { "name": "setLink", "visibility": "public", "description": "Sets the aggregated link.", "params": [ { "name": "oLink", "type": "sap.m.Link", "optional": "false", "description": "The link to set." } ], "returns": { "type": "sap.watt.ui.control.MessageStrip", "description": "Reference to this in order to allow method chaining." } }, "setText": { "name": "setText", "visibility": "public", "description": "Sets a new value for the text property.\n\nDetermines the text of the message.\n\nWhen called with a value of null or undefined, the default value of the property will be restored.\n\nThe default value is .", "params": [ { "name": "sText", "type": "string", "optional": "false", "description": "The new value for the text property." } ], "returns": { "type": "sap.watt.ui.control.MessageStrip", "description": "Reference to this in order to allow method chaining." } }, "setType": { "name": "setType", "visibility": "public", "description": "Setter for the type property.", "params": [ { "name": "sType", "type": "sap.watt.ui.MessageStripType", "optional": "false", "description": "The message type." } ], "returns": { "type": "sap.watt.ui.control.MessageStrip", "description": "Reference to this in order to allow method chaining." } } } } } }