A control to be placed in the tool area
Since: 1.30.5.
Event Summary
expand(oControlEvent)Event is fired when the user presses the Expand icon. press(oControlEvent)Event is fired when the user presses the item. Method Summary
sap.ushell.ui.shell.ToolAreaItem.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ushell.ui.shell.ToolAreaItem with name sClassName and enriches it with the information contained in oClassInfo. attachExpand(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the expand event of this sap.ushell.ui.shell.ToolAreaItem. attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.ushell.ui.shell.ToolAreaItem. detachExpand(fnFunction, oListener)Detaches event handler fnFunction from the expand event of this sap.ushell.ui.shell.ToolAreaItem. detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.ushell.ui.shell.ToolAreaItem. fireExpand(mArguments?)Fires event expand to attached listeners. firePress(mArguments?)Fires event press to attached listeners. getIcon()Gets current value of property icon. getText()Gets current value of property text. getVisible()Gets current value of property visible. setAriaLabel(sAriaLabel)Sets a new value for property ariaLabel. setExpandable(bExpandable)Sets a new value for property expandable. setIcon(sIcon)Sets a new value for property icon. setSelected(bSelected)Sets a new value for property selected. setText(sText)Sets a new value for property text. setVisible(bVisible)Sets a new value for property visible. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
hasStyleClass,
invalidate,
isBusy,
onAfterRendering,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement 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 Constructor Detail
new sap.ushell.ui.shell.ToolAreaItem(sId?, mSettings?)
Constructor for a new ToolAreaItem.
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
- Events
- press : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- expand : 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
expand(oControlEvent)
Event is fired when the user presses the Expand icon.
Parameters:
press(oControlEvent)
Event is fired when the user presses the item.
Parameters:
Method Detail
sap.ushell.ui.shell.ToolAreaItem.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ushell.ui.shell.ToolAreaItem 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 |
Returns a metadata object for class sap.ushell.ui.shell.ToolAreaItem.
Returns:
Attaches event handler
fnFunction to the
expand event of this
sap.ushell.ui.shell.ToolAreaItem.
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.ushell.ui.shell.ToolAreaItem itself.
Event is fired when the user presses the Expand icon.
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.ushell.ui.shell.ToolAreaItem itself |
Returns:
Attaches event handler
fnFunction to the
press event of this
sap.ushell.ui.shell.ToolAreaItem.
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.ushell.ui.shell.ToolAreaItem itself.
Event is fired when the user presses the item.
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.ushell.ui.shell.ToolAreaItem itself |
Returns:
Detaches event handler
fnFunction from the
expand event of this
sap.ushell.ui.shell.ToolAreaItem.
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:
Detaches event handler
fnFunction from the
press event of this
sap.ushell.ui.shell.ToolAreaItem.
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:
Fires event expand to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Fires event press to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
getAriaLabel(): string
Gets current value of property
ariaLabel.
Text which will be read by screenreader.
- Since:
- 1.30
Returns:
| {string} | Value of property ariaLabel |
getExpandable(): boolean
Gets current value of property
expandable.
Defines whether the control will have an expand functionality containing sub-items or actions. If the property is set to true, a small "expand" icon appears in the lower corner of the control. The "expand" event is fired when the "expand" icon is pressed.
Default value is false.
Returns:
| {boolean} | Value of property expandable |
Gets current value of property
icon.
Icon that is displayed in the item.
Returns:
getSelected(): boolean
Gets current value of property
selected.
Defines whether to mark the control as selected
Default value is false.
Returns:
| {boolean} | Value of property selected |
getText(): string
Gets current value of property text.
Returns:
| {string} | Value of property text |
getVisible(): boolean
Gets current value of property
visible.
Defines whether to display the control
Default value is true.
Returns:
| {boolean} | Value of property visible |
Sets a new value for property
ariaLabel.
Text which will be read by screenreader.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sAriaLabel | New value for property ariaLabel |
- Since:
- 1.30
Returns:
Sets a new value for property
expandable.
Defines whether the control will have an expand functionality containing sub-items or actions. If the property is set to true, a small "expand" icon appears in the lower corner of the control. The "expand" event is fired when the "expand" icon is pressed.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bExpandable | New value for property expandable |
Returns:
Sets a new value for property
icon.
Icon that is displayed in the item.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns:
Sets a new value for property
selected.
Defines whether to mark the control as selected
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bSelected | New value for property selected |
Returns:
Sets a new value for property
text.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sText | New value for property text |
Returns:
Sets a new value for property
visible.
Defines whether to display the control
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bVisible | New value for property visible |
Returns: