Class sap.ui.suite.TaskCircleModule: sap/ui/suite/TaskCircle

extends Control

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

Experimental API:Since version 1.2. The API may change. User with care.

Constructor Summary
new sap.ui.suite.TaskCircle(sId?, mSettings?)Constructor for a new TaskCircle.
Event Summary
press(oControlEvent)Event is fired when the user clicks the control.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.suite.TaskCircle.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.suite.TaskCircle with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.suite.TaskCircle.getMetadata()Returns a metadata object for class sap.ui.suite.TaskCircle.
addAriaDescribedBy(vAriaDescribedBy)Adds some ariaDescribedBy into the association ariaDescribedBy.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.ui.suite.TaskCircle.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.ui.suite.TaskCircle.
firePress(mArguments?)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.
getMaxValue()Gets current value of property maxValue.
getMinValue()Gets current value of property minValue.
getValue()Gets current value of property value.
removeAllAriaDescribedBy()Removes all the controls in the association named ariaDescribedBy.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
setColor(sColor)Sets a new value for property color.
setMaxValue(iMaxValue)Sets a new value for property maxValue.
setMinValue(iMinValue)Sets a new value for property minValue.
setValue(iValue)Sets a new value for property value.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.suite.TaskCircle(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • value : int (default: 0)
    • maxValue : int (default: 100)
    • minValue : int (default: 0)
    • color : sap.ui.suite.TaskCircleColor (default: Gray)
  • Events
    • press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Event Detail
press(oControlEvent)
Event is fired when the user clicks the control.
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
Method Detail
sap.ui.suite.TaskCircle.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.suite.TaskCircle.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.suite.TaskCircle.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAriaDescribedBy(vAriaDescribedBy): sap.ui.suite.TaskCircle
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
{string|sap.ui.core.Control}vAriaDescribedBy the ariaDescribedBy to add; if empty, nothing is inserted
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.ui.suite.TaskCircle
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
{string|sap.ui.core.Control}vAriaLabelledBy the ariaLabelledBy to add; if empty, nothing is inserted
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
attachPress(oData?, fnFunction, oListener?): sap.ui.suite.TaskCircle
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.

Parameters:
{object}oData? An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}fnFunction The function to be called when the event occurs
{object}oListener? Context object to call the event handler with. Defaults to this sap.ui.suite.TaskCircle itself
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.ui.suite.TaskCircle
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.

Parameters:
{function}fnFunction The function to be called, when the event occurs
{object}oListener Context object on which the given function had to be called
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
firePress(mArguments?): sap.ui.suite.TaskCircle
Fires event press to attached listeners.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
focus(): void
Puts the focus to the control.
getAriaDescribedBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
{sap.ui.core.Control[]}
getAriaLabelledBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
{sap.ui.core.Control[]}
getColor(): sap.ui.suite.TaskCircleColor
Gets current value of property color.

Color of the circle. The default color is red.

Default value is Gray.

Returns:
{sap.ui.suite.TaskCircleColor} Value of property color
getMaxValue(): int
Gets current value of property maxValue.

Upper limit of the displayed values. Default is 100.

Default value is 100.

Returns:
{int} Value of property maxValue
getMinValue(): int
Gets current value of property minValue.

Lower limit of the displayed values. Default is 0.

Default value is 0.

Returns:
{int} Value of property minValue
getValue(): int
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.

Returns:
{int} Value of property value
removeAllAriaDescribedBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaDescribedBy.
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.Control
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaDescribedBy The ariaDescribedByto be removed or its index or ID
Returns:
{sap.ui.core.Control} the removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
{int|string|sap.ui.core.Control}vAriaLabelledBy The ariaLabelledByto be removed or its index or ID
Returns:
{sap.ui.core.Control} the removed ariaLabelledBy or null
setColor(sColor): sap.ui.suite.TaskCircle
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.

Parameters:
{sap.ui.suite.TaskCircleColor}sColor New value for property color
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
setMaxValue(iMaxValue): sap.ui.suite.TaskCircle
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.

Parameters:
{int}iMaxValue New value for property maxValue
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
setMinValue(iMinValue): sap.ui.suite.TaskCircle
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.

Parameters:
{int}iMinValue New value for property minValue
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining
setValue(iValue): sap.ui.suite.TaskCircle
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.

Parameters:
{int}iValue New value for property value
Returns:
{sap.ui.suite.TaskCircle} Reference to this in order to allow method chaining