Class orion.explorers.FileExplorer
Extends
orion.explorer.Explorer.
A user interface component that displays a table-oriented file explorer
Defined in: </shared/eclipse/e4/orion/I201305292230/plugins/org.eclipse.orion.client.ui/web/orion/explorers/explorer-table.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Creates a new file explorer.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Root model item of the tree.
|
| Method Attributes | Method Name and Description |
|---|---|
|
changedItem(parent, forceExpand)
|
|
|
getNameNode(item)
Returns the node that a rename text input box should appear over top of.
|
|
|
load(root, progress)
Load the explorer with the given root
|
|
|
loadResourceList(path, force, postLoad)
Load the resource at the given path.
|
|
|
onchange(item)
Called when the root item changes.
|
|
|
scopeUp()
The explorerNavHandler hooked up by the explorer will call this function when left arrow key is pressed on a
top level item that is aleady collapsed.
|
- Methods borrowed from class orion.explorer.Explorer:
- collapseAll, createTree, expandAll, getNavDict, getNavHandler, getRootPath, getRow, initNavHandler, makeNewItemPlaceHolder, refreshSelection, updateCommands
Class Detail
orion.explorers.FileExplorer()
Creates a new file explorer.
- Parameters:
- {Object} options.treeRoot
- an Object representing the root of the tree.
- {orion.selection.Selection} options.selection
- the selection service used to track selections.
- {orion.fileClient.FileClient} options.fileClient
- the file service used to retrieve file information
- {String|Element} options.parentId
- the id of the parent DOM element, or the parent DOM element itself.
- {Function} options.rendererFactory
- a factory that creates a renderer
- {Boolean} options.excludeFiles
- specifies that files should not be shown. Optional.
- {Boolean} options.excludeFolders
- specifies that folders should not be shown. Optional.
- {Object} options.navHandlerFactory Optional
- Optional factory to use for creating the explorer's nav handler. Must provide a function
createNavHandler(explorer, explorerNavDict, options). - {orion.serviceregistry.ServiceRegistry} options.serviceRegistry
- the service registry to use for retrieving other Orion services. Optional. If not specified, then some features of the explorer will not be enabled, such as status reporting, honoring preference settings, etc.
- {Boolean} options.setFocus Optional, Default: true
- Whether the explorer should steal keyboard focus when rendered. The default is to steal focus.
Field Detail
treeRoot
Root model item of the tree.
Method Detail
{orion.Promise}
changedItem(parent, forceExpand)
- Returns:
- {orion.Promise}
{Element}
getNameNode(item)
Returns the node that a rename text input box should appear over top of.
- Parameters:
- {Object} item
- Item being renamed
- Returns:
- {Element}
{orion.Promise}
load(root, progress)
Load the explorer with the given root
- Parameters:
- {Object} root
- a root object or a deferred that will return the root of the FileModel
- {String} progress
- a string progress message describing the fetch of the root
- Returns:
- {orion.Promise} A promise that resolves to the loaded
treeRoot, or rejects with an error.
loadResourceList(path, force, postLoad)
Load the resource at the given path.
- Parameters:
- path
- The path of the resource to load
- {Boolean} force Optional
- If true, force reload even if the path is unchanged. Useful when the client knows the resource underlying the current path has changed.
- postLoad
- a function to call after loading the resource
onchange(item)
Called when the root item changes. This can be overridden.
- Parameters:
- {Object} item
scopeUp()
The explorerNavHandler hooked up by the explorer will call this function when left arrow key is pressed on a
top level item that is aleady collapsed. The default implementation does nothing.