Class sap.landvisz.OptionEntityModule: sap/landvisz/OptionEntity

extends OptionSource

Options for solution entities

Constructor Summary
new sap.landvisz.OptionEntity(sId?, mSettings?)Constructor for a new OptionEntity.
Event Summary
selectOption(oControlEvent)Select event for option entity
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.landvisz.OptionEntity.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.OptionEntity with name sClassName and enriches it with the information contained in oClassInfo.
sap.landvisz.OptionEntity.getMetadata()Returns a metadata object for class sap.landvisz.OptionEntity.
addOptionSource(oOptionSource)Adds some optionSource oOptionSource to the aggregation named optionSources.
attachSelectOption(oData?, fnFunction, oListener?)Attach event handler fnFunction to the 'selectOption' event of this sap.landvisz.OptionEntity.
destroyOptionSources()Destroys all the optionSources in the aggregation named optionSources.
detachSelectOption(fnFunction, oListener)Detach event handler fnFunction from the 'selectOption' event of this sap.landvisz.OptionEntity.
fireSelectOption(mArguments?)Fire event selectOption to attached listeners.
getEnable()Getter for property enable.
getLabel()Getter for property label.
getOptionSources()Getter for aggregation optionSources.
getOptionTextTooltip()Getter for property optionTextTooltip.
getSelected()Getter for property selected.
indexOfOptionSource(oOptionSource)Checks for the provided sap.landvisz.OptionSource in the aggregation named optionSources and returns its index if found or -1 otherwise.
insertOptionSource(oOptionSource, iIndex)Inserts a optionSource into the aggregation named optionSources.
removeAllOptionSources()Removes all the controls in the aggregation named optionSources.
removeOptionSource(vOptionSource)Removes an optionSource from the aggregation named optionSources.
setEnable(bEnable)Setter for property enable.
setLabel(sLabel)Setter for property label.
setOptionTextTooltip(sOptionTextTooltip)Setter for property optionTextTooltip.
setSelected(bSelected)Setter for property selected.
Methods borrowed from class sap.landvisz.OptionSource
getSource, setSource
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
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.landvisz.OptionEntity(sId?, mSettings?)
Constructor for a new OptionEntity.

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
  • Aggregations
  • Associations
    • Events
      • selectOption : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

    In addition, all settings applicable to the base type sap.landvisz.OptionSource 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
    selectOption(oControlEvent)
    Select event for option entity
    Parameters:
    {sap.ui.base.Event}oControlEvent
    {sap.ui.base.EventProvider}oControlEvent.getSource
    {object}oControlEvent.getParameters
    Method Detail
    sap.landvisz.OptionEntity.extend(sClassName, oClassInfo?, FNMetaImpl?): function
    Creates a new subclass of class sap.landvisz.OptionEntity 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.OptionEntity.getMetadata(): sap.ui.base.Metadata
    Returns a metadata object for class sap.landvisz.OptionEntity.
    Returns:
    {sap.ui.base.Metadata} Metadata object describing this class
    addOptionSource(oOptionSource): sap.landvisz.OptionEntity
    Adds some optionSource oOptionSource to the aggregation named optionSources.
    Parameters:
    {sap.landvisz.OptionSource}oOptionSource the optionSource to add; if empty, nothing is inserted
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    attachSelectOption(oData?, fnFunction, oListener?): sap.landvisz.OptionEntity
    Attach event handler fnFunction to the 'selectOption' event of this sap.landvisz.OptionEntity.
    . When called, the context of the event handler (its this) will be bound to oListener if specified otherwise to this sap.landvisz.OptionEntity.
    itself.

    Select event for option entity

    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.OptionEntity.
    itself.
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    destroyOptionSources(): sap.landvisz.OptionEntity
    Destroys all the optionSources in the aggregation named optionSources.
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    detachSelectOption(fnFunction, oListener): sap.landvisz.OptionEntity
    Detach event handler fnFunction from the 'selectOption' event of this sap.landvisz.OptionEntity.

    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.OptionEntity}this to allow method chaining
    fireSelectOption(mArguments?): sap.landvisz.OptionEntity
    Fire event selectOption to attached listeners.
    Parameters:
    {Map}mArguments? the arguments to pass along with the event.
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    getEnable(): boolean
    Getter for property enable. enabling/disabling options

    Default value is true

    Returns:
    {boolean} the value of property enable
    getLabel(): string
    Getter for property label. label for option entity

    Default value is empty/undefined

    Returns:
    {string} the value of property label
    getOptionSources(): sap.landvisz.OptionSource[]
    Getter for aggregation optionSources.
    Option Renderer Control
    Returns:
    {sap.landvisz.OptionSource[]}
    getOptionTextTooltip(): string
    Getter for property optionTextTooltip. tooltip for options

    Default value is empty/undefined

    Returns:
    {string} the value of property optionTextTooltip
    getSelected(): boolean
    Getter for property selected. determines current selected option

    Default value is false

    Returns:
    {boolean} the value of property selected
    indexOfOptionSource(oOptionSource): int
    Checks for the provided sap.landvisz.OptionSource in the aggregation named optionSources and returns its index if found or -1 otherwise.
    Parameters:
    {sap.landvisz.OptionSource}oOptionSource the optionSource whose index is looked for.
    Returns:
    {int} the index of the provided control in the aggregation if found, or -1 otherwise
    insertOptionSource(oOptionSource, iIndex): sap.landvisz.OptionEntity
    Inserts a optionSource into the aggregation named optionSources.
    Parameters:
    {sap.landvisz.OptionSource}oOptionSource the optionSource to insert; if empty, nothing is inserted
    {int}iIndex the 0-based index the optionSource should be inserted at; for a negative value of iIndex, the optionSource is inserted at position 0; for a value greater than the current size of the aggregation, the optionSource is inserted at the last position
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    removeAllOptionSources(): sap.landvisz.OptionSource[]
    Removes all the controls in the aggregation named optionSources.
    Additionally unregisters them from the hosting UIArea.
    Returns:
    {sap.landvisz.OptionSource[]} an array of the removed elements (might be empty)
    removeOptionSource(vOptionSource): sap.landvisz.OptionSource
    Removes an optionSource from the aggregation named optionSources.
    Parameters:
    {int|string|sap.landvisz.OptionSource}vOptionSource the optionSource to remove or its index or id
    Returns:
    {sap.landvisz.OptionSource} the removed optionSource or null
    setEnable(bEnable): sap.landvisz.OptionEntity
    Setter for property enable.

    Default value is true

    Parameters:
    {boolean}bEnable new value for property enable
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    setLabel(sLabel): sap.landvisz.OptionEntity
    Setter for property label.

    Default value is empty/undefined

    Parameters:
    {string}sLabel new value for property label
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    setOptionTextTooltip(sOptionTextTooltip): sap.landvisz.OptionEntity
    Setter for property optionTextTooltip.

    Default value is empty/undefined

    Parameters:
    {string}sOptionTextTooltip new value for property optionTextTooltip
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining
    setSelected(bSelected): sap.landvisz.OptionEntity
    Setter for property selected.

    Default value is false

    Parameters:
    {boolean}bSelected new value for property selected
    Returns:
    {sap.landvisz.OptionEntity}this to allow method chaining