Class sap.landvisz.internal.IdentificationBarModule: sap/landvisz/internal/IdentificationBar
extends Control
Acontrol to render identification bar of a system
Constructor Summary
new sap.landvisz.internal.IdentificationBar(sId?, mSettings?)Constructor for a new internal/IdentificationBar.
Event Summary
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.landvisz.internal.IdentificationBar.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.internal.IdentificationBar with name
sClassName and enriches it with the information contained in oClassInfo.sap.landvisz.internal.IdentificationBar.getMetadata()Returns a metadata object for class sap.landvisz.internal.IdentificationBar.
attachSelect(oData?, fnFunction, oListener?)Attach event handler
fnFunction to the 'select' event of this sap.landvisz.internal.IdentificationBar.detachSelect(fnFunction, oListener)Detach event handler
fnFunction from the 'select' event of this sap.landvisz.internal.IdentificationBar.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, 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
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
Constructor Detail
new sap.landvisz.internal.IdentificationBar(sId?, mSettings?)
Constructor for a new internal/IdentificationBar.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers.
If the name of a setting is ambiguous (e.g. a property has the same name as an event), then the framework assumes property, aggregation, association, event in that order. To override this automatic resolution, one of the prefixes "aggregation:", "association:" or "event:" can be added to the name of the setting (such a prefixed name must be enclosed in single or double quotes).
The supported settings are:
- Properties
- text : string
- type : string
- qualifierText : string
- qualifierTooltip : string
- qualifierType : string
- renderingSize : sap.landvisz.EntityCSSSize (default: sap.landvisz.EntityCSSSize.Regular)
- defaultState : string
- description : string
- componentType : sap.landvisz.ComponentType
- Aggregations
- Associations
- Events
- select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
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
select(oControlEvent)
fires click event on selection
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters |
Method Detail
sap.landvisz.internal.IdentificationBar.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.landvisz.internal.IdentificationBar with name
sClassName and enriches it with the information contained in oClassInfo. oClassInfo might contain the same kind of informations as described in Element.extend.
Parameters:
| {string} | sClassName | name of the class to be created |
| {object} | oClassInfo? | object literal with informations about the class |
| {function} | FNMetaImpl? | constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata. |
Returns:
| {function} | the created class / constructor function |
sap.landvisz.internal.IdentificationBar.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.landvisz.internal.IdentificationBar.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
attachSelect(oData?, fnFunction, oListener?): sap.landvisz.internal.IdentificationBar
Attach event handler
. When called, the context of the event handler (its
fnFunction to the 'select' event of this sap.landvisz.internal.IdentificationBar.. When called, the context of the event handler (its
this) will be bound to oListener if specified otherwise to this sap.landvisz.internal.IdentificationBar.
itself. fires click event on selection
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 call, when the event occurs. |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.landvisz.internal.IdentificationBar.itself. |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
detachSelect(fnFunction, oListener): sap.landvisz.internal.IdentificationBar
Detach event handler
fnFunction from the 'select' event of this sap.landvisz.internal.IdentificationBar.The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to call, when the event occurs. |
| {object} | oListener | Context object on which the given function had to be called. |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
fireSelect(mArguments?): sap.landvisz.internal.IdentificationBar
Fire event select to attached listeners.
Parameters:
| {Map} | mArguments? | the arguments to pass along with the event. |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
getComponentType(): sap.landvisz.ComponentType
Getter for property
componentType. Component type of the entity Default value is empty/undefined
Returns:
| {sap.landvisz.ComponentType} | the value of property componentType |
getDefaultState(): string
Getter for property
defaultState. determines the default state of the control Default value is empty/undefined
Returns:
| {string} | the value of property defaultState |
getDescription(): string
Getter for property
description. despriction of the identification region of a control Default value is empty/undefined
Returns:
| {string} | the value of property description |
getQualifierText(): string
Getter for property
qualifierText. text that identifies the server Default value is empty/undefined
Returns:
| {string} | the value of property qualifierText |
getQualifierTooltip(): string
Getter for property
qualifierTooltip. tooltip to identify the server Default value is empty/undefined
Returns:
| {string} | the value of property qualifierTooltip |
getQualifierType(): string
Getter for property
qualifierType. icon to identify the server Default value is empty/undefined
Returns:
| {string} | the value of property qualifierType |
getRenderingSize(): sap.landvisz.EntityCSSSize
Getter for property
renderingSize. rendering size of the control Default value is sap.landvisz.EntityCSSSize.Regular
Returns:
| {sap.landvisz.EntityCSSSize} | the value of property renderingSize |
getText(): string
Getter for property
text. text that identifies a system Default value is empty/undefined
Returns:
| {string} | the value of property text |
getType(): string
Getter for property
type. type of system rendered Default value is empty/undefined
Returns:
| {string} | the value of property type |
setComponentType(oComponentType): sap.landvisz.internal.IdentificationBar
Setter for property
componentType. Default value is empty/undefined
Parameters:
| {sap.landvisz.ComponentType} | oComponentType | new value for property componentType |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setDefaultState(sDefaultState): sap.landvisz.internal.IdentificationBar
Setter for property
defaultState. Default value is empty/undefined
Parameters:
| {string} | sDefaultState | new value for property defaultState |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setDescription(sDescription): sap.landvisz.internal.IdentificationBar
Setter for property
description. Default value is empty/undefined
Parameters:
| {string} | sDescription | new value for property description |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setQualifierText(sQualifierText): sap.landvisz.internal.IdentificationBar
Setter for property
qualifierText. Default value is empty/undefined
Parameters:
| {string} | sQualifierText | new value for property qualifierText |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setQualifierTooltip(sQualifierTooltip): sap.landvisz.internal.IdentificationBar
Setter for property
qualifierTooltip. Default value is empty/undefined
Parameters:
| {string} | sQualifierTooltip | new value for property qualifierTooltip |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setQualifierType(sQualifierType): sap.landvisz.internal.IdentificationBar
Setter for property
qualifierType. Default value is empty/undefined
Parameters:
| {string} | sQualifierType | new value for property qualifierType |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setRenderingSize(oRenderingSize): sap.landvisz.internal.IdentificationBar
Setter for property
renderingSize. Default value is sap.landvisz.EntityCSSSize.Regular
Parameters:
| {sap.landvisz.EntityCSSSize} | oRenderingSize | new value for property renderingSize |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setText(sText): sap.landvisz.internal.IdentificationBar
Setter for property
text. Default value is empty/undefined
Parameters:
| {string} | sText | new value for property text |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |
setType(sType): sap.landvisz.internal.IdentificationBar
Setter for property
type. Default value is empty/undefined
Parameters:
| {string} | sType | new value for property type |
Returns:
| {sap.landvisz.internal.IdentificationBar} | this to allow method chaining |