Class sap.ui2.shell.Folder
Extends
sap.ui2.shell.Node.
A special sap.ui2.shell.Node representing a folder in the menu structure.
Defined in: startup.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
You cannot call this constructor;
sap.ui2.shell.Folder objects are created by the
framework in sap.ui2.shell.getUser(). |
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the folder's children.
|
|
|
isFolder()
Returns
true as this is a folder. |
|
|
isStub()
Tells whether the folder is still stub or has already been loaded.
|
|
|
load(iDepth, fnSuccess, fnFailure)
Loads the folder from the backend system.
|
- Methods borrowed from class sap.ui2.shell.Node:
- getId, getMenu, getParent, getText
Class Detail
sap.ui2.shell.Folder()
You cannot call this constructor;
sap.ui2.shell.Folder objects are created by the
framework in sap.ui2.shell.getUser().
- Since:
- 1.5.0
Method Detail
{sap.ui2.shell.Node[]}
getChildren()
Returns the folder's children.
- Since:
- 1.5.0
- Throws:
- Error if the folder is a stub
- Returns:
- {sap.ui2.shell.Node[]} The folder's children
{boolean}
isFolder()
Returns
true as this is a folder.
- Since:
- 1.5.0
- Returns:
- {boolean}
true
{boolean}
isStub()
Tells whether the folder is still stub or has already been loaded. A stub does not know its
children.
- Since:
- 1.5.0
- Returns:
- {boolean}
trueif the folder is still a stub
load(iDepth, fnSuccess, fnFailure)
Loads the folder from the backend system. Afterwards the folder is no stub anymore. This is
an asynchronous operation. When it is finished, either the success or the failure handler is
called.
- Parameters:
- {number} iDepth
- the depth of the loaded subtree, must be a non-negative integer including
Infinity - {function()} fnSuccess
- The parameterless success handler
- {function(string)} fnFailure Optional
- The failure handler which gets an error message. If missing, the menu's default error handler is used.
- Since:
- 1.5.0
- Throws:
- Error if the folder is no longer a stub