Class sap.landvisz.internal.TreeFieldModule: sap/landvisz/internal/TreeField

extends Control

A control to render tree field in the control

Constructor Summary
new sap.landvisz.internal.TreeField(sId?, mSettings?)Constructor for a new internal/TreeField.
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.internal.TreeField.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.landvisz.internal.TreeField with name sClassName and enriches it with the information contained in oClassInfo.
sap.landvisz.internal.TreeField.getMetadata()Returns a metadata object for class sap.landvisz.internal.TreeField.
addTreeNode(oTreeNode)Adds some treeNode oTreeNode to the aggregation named treeNode.
destroyTreeNode()Destroys all the treeNode in the aggregation named treeNode.
getBindingName()Getter for property bindingName.
getRenderingSize()Getter for property renderingSize.
getTreeModel()Getter for property treeModel.
getTreeNode()Getter for aggregation treeNode.
indexOfTreeNode(oTreeNode)Checks for the provided sap.ui.commons.TreeNode in the aggregation named treeNode and returns its index if found or -1 otherwise.
insertTreeNode(oTreeNode, iIndex)Inserts a treeNode into the aggregation named treeNode.
removeAllTreeNode()Removes all the controls in the aggregation named treeNode.
removeTreeNode(vTreeNode)Removes an treeNode from the aggregation named treeNode.
setBindingName(sBindingName)Setter for property bindingName.
setRenderingSize(oRenderingSize)Setter for property renderingSize.
setTreeModel(oTreeModel)Setter for property treeModel.
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.internal.TreeField(sId?, mSettings?)
Constructor for a new internal/TreeField.

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.internal.TreeField.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.landvisz.internal.TreeField 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.TreeField.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.landvisz.internal.TreeField.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addTreeNode(oTreeNode): sap.landvisz.internal.TreeField
Adds some treeNode oTreeNode to the aggregation named treeNode.
Parameters:
{sap.ui.commons.TreeNode}oTreeNode the treeNode to add; if empty, nothing is inserted
Returns:
{sap.landvisz.internal.TreeField}this to allow method chaining
destroyTreeNode(): sap.landvisz.internal.TreeField
Destroys all the treeNode in the aggregation named treeNode.
Returns:
{sap.landvisz.internal.TreeField}this to allow method chaining
getBindingName(): string
Getter for property bindingName. binding name

Default value is empty/undefined

Returns:
{string} the value of property bindingName
getRenderingSize(): sap.landvisz.EntityCSSSize
Getter for property renderingSize. rendering size of the control

Default value is empty/undefined

Returns:
{sap.landvisz.EntityCSSSize} the value of property renderingSize
getTreeModel(): object
Getter for property treeModel. treeModel to be rendered in the control

Default value is empty/undefined

Returns:
{object} the value of property treeModel
getTreeNode(): sap.ui.commons.TreeNode[]
Getter for aggregation treeNode.
aggregation on the tree field to render tree nodes
Returns:
{sap.ui.commons.TreeNode[]}
indexOfTreeNode(oTreeNode): int
Checks for the provided sap.ui.commons.TreeNode in the aggregation named treeNode and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.commons.TreeNode}oTreeNode the treeNode whose index is looked for.
Returns:
{int} the index of the provided control in the aggregation if found, or -1 otherwise
insertTreeNode(oTreeNode, iIndex): sap.landvisz.internal.TreeField
Inserts a treeNode into the aggregation named treeNode.
Parameters:
{sap.ui.commons.TreeNode}oTreeNode the treeNode to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the treeNode should be inserted at; for a negative value of iIndex, the treeNode is inserted at position 0; for a value greater than the current size of the aggregation, the treeNode is inserted at the last position
Returns:
{sap.landvisz.internal.TreeField}this to allow method chaining
removeAllTreeNode(): sap.ui.commons.TreeNode[]
Removes all the controls in the aggregation named treeNode.
Additionally unregisters them from the hosting UIArea.
Returns:
{sap.ui.commons.TreeNode[]} an array of the removed elements (might be empty)
removeTreeNode(vTreeNode): sap.ui.commons.TreeNode
Removes an treeNode from the aggregation named treeNode.
Parameters:
{int|string|sap.ui.commons.TreeNode}vTreeNode the treeNode to remove or its index or id
Returns:
{sap.ui.commons.TreeNode} the removed treeNode or null
setBindingName(sBindingName): sap.landvisz.internal.TreeField
Setter for property bindingName.

Default value is empty/undefined

Parameters:
{string}sBindingName new value for property bindingName
Returns:
{sap.landvisz.internal.TreeField}this to allow method chaining
setRenderingSize(oRenderingSize): sap.landvisz.internal.TreeField
Setter for property renderingSize.

Default value is empty/undefined

Parameters:
{sap.landvisz.EntityCSSSize}oRenderingSize new value for property renderingSize
Returns:
{sap.landvisz.internal.TreeField}this to allow method chaining
setTreeModel(oTreeModel): sap.landvisz.internal.TreeField
Setter for property treeModel.

Default value is empty/undefined

Parameters:
{object}oTreeModel new value for property treeModel
Returns:
{sap.landvisz.internal.TreeField}this to allow method chaining