// For Library Version: 1.149.0 declare namespace sap { namespace ui { /** * Suite controls library. * * @since 1.1 * @deprecated As of version 1.108. */ namespace suite { /** * Describes the settings that can be provided to the TaskCircle constructor. * * @deprecated As of version 1.108. there's no replacement for this functionality as no active use cases * are known * @experimental As of version 1.2. The API may change. Use with care. */ interface $TaskCircleSettings extends sap.ui.core.$ControlSettings { /** * Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue * it controls the size of the circle. */ value?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Upper limit of the displayed values. Default is 100. */ maxValue?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Lower limit of the displayed values. Default is 0. */ minValue?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Color of the circle. The default color is red. */ color?: | sap.ui.suite.TaskCircleColor | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Event is fired when the user clicks the control. */ press?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the VerticalProgressIndicator constructor. * * @deprecated As of version 1.108. there's no replacement for this functionality as no active use cases * are known * @experimental As of version 1.2. The API may change. Use with care. */ interface $VerticalProgressIndicatorSettings extends sap.ui.core.$ControlSettings { /** * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%. */ percentage?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Event is fired when the user clicks the control. */ press?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the TaskCircle#press event. */ interface TaskCircle$PressEventParameters {} /** * Parameters of the VerticalProgressIndicator#press event. */ interface VerticalProgressIndicator$PressEventParameters {} /** * This control shows a circle which radius and color depends on the given parameters * * @deprecated As of version 1.108. there's no replacement for this functionality as no active use cases * are known * @experimental As of version 1.2. The API may change. Use with care. */ class TaskCircle extends sap.ui.core.Control { /** * Constructor for a new TaskCircle. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.suite.$TaskCircleSettings ); /** * Constructor for a new TaskCircle. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.ui.suite.$TaskCircleSettings ); /** * Creates a new subclass of class sap.ui.suite.TaskCircle with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.suite.TaskCircle. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.suite.TaskCircle`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself. * * Event is fired when the user clicks the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.suite.TaskCircle` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.suite.TaskCircle`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.suite.TaskCircle` itself. * * Event is fired when the user clicks the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.suite.TaskCircle` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.TaskCircle`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Puts the focus to the control. */ focus(): void; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): sap.ui.core.ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getColor color}. * * Color of the circle. The default color is red. * * Default value is `Gray`. * * * @returns Value of property `color` */ getColor(): sap.ui.suite.TaskCircleColor; /** * Gets current value of property {@link #getMaxValue maxValue}. * * Upper limit of the displayed values. Default is 100. * * Default value is `100`. * * * @returns Value of property `maxValue` */ getMaxValue(): int; /** * Gets current value of property {@link #getMinValue minValue}. * * Lower limit of the displayed values. Default is 0. * * Default value is `0`. * * * @returns Value of property `minValue` */ getMinValue(): int; /** * Gets current value of property {@link #getValue value}. * * Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue * it controls the size of the circle. * * Default value is `0`. * * * @returns Value of property `value` */ getValue(): int; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): sap.ui.core.ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Sets a new value for property {@link #getColor color}. * * Color of the circle. The default color is red. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Gray`. * * * @returns Reference to `this` in order to allow method chaining */ setColor( /** * New value for property `color` */ sColor?: sap.ui.suite.TaskCircleColor ): this; /** * Sets a new value for property {@link #getMaxValue maxValue}. * * Upper limit of the displayed values. Default is 100. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `100`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxValue( /** * New value for property `maxValue` */ iMaxValue?: int ): this; /** * Sets a new value for property {@link #getMinValue minValue}. * * Lower limit of the displayed values. Default is 0. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMinValue( /** * New value for property `minValue` */ iMinValue?: int ): this; /** * Sets a new value for property {@link #getValue value}. * * Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue * it controls the size of the circle. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ iValue?: int ): this; } /** * This control shows a vertical progress bar in dependency of the given percentage. Only values between * 0 and 100 are valid. * * @deprecated As of version 1.108. there's no replacement for this functionality as no active use cases * are known * @experimental As of version 1.2. The API may change. Use with care. */ class VerticalProgressIndicator extends sap.ui.core.Control { /** * Constructor for a new VerticalProgressIndicator. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.suite.$VerticalProgressIndicatorSettings ); /** * Constructor for a new VerticalProgressIndicator. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.ui.suite.$VerticalProgressIndicatorSettings ); /** * Creates a new subclass of class sap.ui.suite.VerticalProgressIndicator with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.suite.VerticalProgressIndicator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself. * * Event is fired when the user clicks the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.suite.VerticalProgressIndicator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.suite.VerticalProgressIndicator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.suite.VerticalProgressIndicator` itself. * * Event is fired when the user clicks the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.suite.VerticalProgressIndicator` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.suite.VerticalProgressIndicator`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Puts the focus to the control. */ focus(): void; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): sap.ui.core.ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getPercentage percentage}. * * The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher * than 100 will be displayed as 100%, values lower than zero will be displayed as 0%. * * * @returns Value of property `percentage` */ getPercentage(): int; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): sap.ui.core.ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Property setter for the Percentage, which determines the height of the vertical bar. Values higher than * 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not * necessary, only the bar will be moved * * * @returns `this` to allow method chaining */ setPercentage(iPercentage: int): this; } /** * Defined color values for the Task Circle Control * * This enum is part of the 'sap/ui/suite/library' module export and must be accessed by the property 'TaskCircleColor'. * * @deprecated As of version 1.108. because it is part of the deprecated package sap.ui.suite */ enum TaskCircleColor { /** * Default value */ Gray = "Gray", /** * Green */ Green = "Green", /** * Red */ Red = "Red", /** * Yellow */ Yellow = "Yellow", } /** * Event object of the TaskCircle#press event. */ type TaskCircle$PressEvent = sap.ui.base.Event< TaskCircle$PressEventParameters, TaskCircle >; /** * Event object of the VerticalProgressIndicator#press event. */ type VerticalProgressIndicator$PressEvent = sap.ui.base.Event< VerticalProgressIndicator$PressEventParameters, VerticalProgressIndicator >; } } interface IUI5DefineDependencyNames { "sap/ui/suite/library": undefined; "sap/ui/suite/TaskCircle": undefined; "sap/ui/suite/VerticalProgressIndicator": undefined; } }