class sap.ui.suite.TaskCircle

Control sample: sap.ui.suite.TaskCircle
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/suite/TaskCircle
Application Component: CA-UI5-CTR

This control shows a circle which radius and color depends on the given parameters


Constructor

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 sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.

new sap.ui.suite.TaskCircle(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
color sap.ui.suite.TaskCircleColor Gray

Color of the circle. The default color is red.

Visibility: public
maxValue int 100

Upper limit of the displayed values. Default is 100.

Visibility: public
minValue int 0

Lower limit of the displayed values. Default is 0.

Visibility: public
value int 0

Current value of the task circle to be displayed. In dependency of the parameters maxValue and minValue it controls the size of the circle.

Visibility: public

Associations

Name Cardinality Type Description
ariaDescribedBy 0..n sap.ui.core.Control

Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby).

ariaLabelledBy 0..n sap.ui.core.Control

Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby).


Events Overview

Event Description
press

Event is fired when the user clicks the control.

press

Event is fired when the user clicks the control.

Param Type Description
oControlEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

attachPress

Attaches event handler fnFunction to the 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.

detachPress

Detaches event handler fnFunction from the press event of this sap.ui.suite.TaskCircle.

The passed function and listener object must match the ones used for event registration.

sap.ui.suite.TaskCircle.extend

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 sap.ui.core.Control.extend.

firePress

Fires event press to attached listeners.

focus

Puts the focus to the control.

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getColor

Gets current value of property color.

Color of the circle. The default color is red.

Default value is Gray.

getMaxValue

Gets current value of property maxValue.

Upper limit of the displayed values. Default is 100.

Default value is 100.

sap.ui.suite.TaskCircle.getMetadata

Returns a metadata object for class sap.ui.suite.TaskCircle.

getMinValue

Gets current value of property minValue.

Lower limit of the displayed values. Default is 0.

Default value is 0.

getValue

Gets current value of property 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.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

setColor

Sets a new value for property 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.

setMaxValue

Sets a new value for property 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.

setMinValue

Sets a new value for property 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.

setValue

Sets a new value for property 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.

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to add; if empty, nothing is inserted

addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

Param Type DefaultValue Description
vAriaLabelledBy sap.ui.core.ID sap.ui.core.Control

The ariaLabelledBy to add; if empty, nothing is inserted

attachPress

Attaches event handler fnFunction to the 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.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnFunction function(sap.ui.base.Event) : void

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to this sap.ui.suite.TaskCircle itself

detachPress

Detaches event handler fnFunction from the press event of this sap.ui.suite.TaskCircle.

The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnFunction function(sap.ui.base.Event) : void

The function to be called, when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.suite.TaskCircle.extend

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 sap.ui.core.Control.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

firePress

Fires event press to attached listeners.

Param Type DefaultValue Description
mParameters object

Parameters to pass along with the event

focus

Puts the focus to the control.

getAriaDescribedBy

Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getColor

Gets current value of property color.

Color of the circle. The default color is red.

Default value is Gray.

getMaxValue

Gets current value of property maxValue.

Upper limit of the displayed values. Default is 100.

Default value is 100.

sap.ui.suite.TaskCircle.getMetadata

Returns a metadata object for class sap.ui.suite.TaskCircle.

getMinValue

Gets current value of property minValue.

Lower limit of the displayed values. Default is 0.

Default value is 0.

getValue

Gets current value of property 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.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy int sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to be removed or its index or ID

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

Param Type DefaultValue Description
vAriaLabelledBy int sap.ui.core.ID sap.ui.core.Control

The ariaLabelledBy to be removed or its index or ID

setColor

Sets a new value for property 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.

Param Type DefaultValue Description
sColor sap.ui.suite.TaskCircleColor Gray

New value for property color

setMaxValue

Sets a new value for property 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.

Param Type DefaultValue Description
iMaxValue int 100

New value for property maxValue

setMinValue

Sets a new value for property 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.

Param Type DefaultValue Description
iMinValue int 0

New value for property minValue

setValue

Sets a new value for property 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.

Param Type DefaultValue Description
iValue int 0

New value for property value