Class sap.landvisz.OptionModule: sap/landvisz/Option

extends Control
known direct subclasses: LandscapeViewer

Options for solution entities

Constructor Summary
new sap.landvisz.Option(sId?, mSettings?)Constructor for a new Option.
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.Option.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.Option with name sClassName and enriches it with the information contained in oClassInfo.
sap.landvisz.Option.getMetadata()Returns a metadata object for class sap.landvisz.Option.
addOptionEntity(oOptionEntity)Adds some optionEntity oOptionEntity to the aggregation named optionEntities.
destroyOptionEntities()Destroys all the optionEntities in the aggregation named optionEntities.
getCurrentEntity()Getter for property currentEntity.
getOptionEntities()Getter for aggregation optionEntities.
getType()Getter for property type.
indexOfOptionEntity(oOptionEntity)Checks for the provided sap.landvisz.OptionEntity in the aggregation named optionEntities and returns its index if found or -1 otherwise.
insertOptionEntity(oOptionEntity, iIndex)Inserts a optionEntity into the aggregation named optionEntities.
removeAllOptionEntities()Removes all the controls in the aggregation named optionEntities.
removeOptionEntity(vOptionEntity)Removes an optionEntity from the aggregation named optionEntities.
setCurrentEntity(sCurrentEntity)Setter for property currentEntity.
setType(sType)Setter for property type.
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.Option(sId?, mSettings?)
Constructor for a new Option.

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:

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.landvisz.Option.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.landvisz.Option 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.Option.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.landvisz.Option.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addOptionEntity(oOptionEntity): sap.landvisz.Option
Adds some optionEntity oOptionEntity to the aggregation named optionEntities.
Parameters:
{sap.landvisz.OptionEntity}oOptionEntity the optionEntity to add; if empty, nothing is inserted
Returns:
{sap.landvisz.Option}this to allow method chaining
destroyOptionEntities(): sap.landvisz.Option
Destroys all the optionEntities in the aggregation named optionEntities.
Returns:
{sap.landvisz.Option}this to allow method chaining
getCurrentEntity(): string
Getter for property currentEntity. Entity on which options are applicable

Default value is empty/undefined

Returns:
{string} the value of property currentEntity
getOptionEntities(): sap.landvisz.OptionEntity[]
Getter for aggregation optionEntities.
Entity to be rendered as options
Returns:
{sap.landvisz.OptionEntity[]}
getType(): string
Getter for property type. type of main entity which has a replacement

Default value is empty/undefined

Returns:
{string} the value of property type
indexOfOptionEntity(oOptionEntity): int
Checks for the provided sap.landvisz.OptionEntity in the aggregation named optionEntities and returns its index if found or -1 otherwise.
Parameters:
{sap.landvisz.OptionEntity}oOptionEntity the optionEntity whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertOptionEntity(oOptionEntity, iIndex): sap.landvisz.Option
Inserts a optionEntity into the aggregation named optionEntities.
Parameters:
{sap.landvisz.OptionEntity}oOptionEntity the optionEntity to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the optionEntity should be inserted at; for a negative value of iIndex, the optionEntity is inserted at position 0; for a value greater than the current size of the aggregation, the optionEntity is inserted at the last position
Returns:
{sap.landvisz.Option}this to allow method chaining
removeAllOptionEntities(): sap.landvisz.OptionEntity[]
Removes all the controls in the aggregation named optionEntities.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.landvisz.OptionEntity[]} an array of the removed elements (might be empty)
removeOptionEntity(vOptionEntity): sap.landvisz.OptionEntity
Removes an optionEntity from the aggregation named optionEntities.
Parameters:
{int|string|sap.landvisz.OptionEntity}vOptionEntity the optionEntity to remove or its index or id
Returns:
{sap.landvisz.OptionEntity} the removed optionEntity or null
setCurrentEntity(sCurrentEntity): sap.landvisz.Option
Setter for property currentEntity.

Default value is empty/undefined

Parameters:
{string}sCurrentEntity new value for property currentEntity
Returns:
{sap.landvisz.Option}this to allow method chaining
setType(sType): sap.landvisz.Option
Setter for property type.

Default value is empty/undefined

Parameters:
{string}sType new value for property type
Returns:
{sap.landvisz.Option}this to allow method chaining