Class Index | File Index

Classes


Class orion.explorer.FileExplorer


Extends orion.explorer.Explorer.
A user interface component that displays a table-oriented file explorer
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/explorers/explorer-table.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a new file explorer.
Field Summary
Field Attributes Field Name and Description
 
Dispatches events describing model changes.
 
Handles model changes.
 
Root model item of the tree.
Method Summary
Method Attributes Method Name and Description
 
changedItem(parent, forceExpand)
 
 
 
expandItem(The, reroot)
Expands the given item.
 
Returns the node that a rename text input box should appear over top of.
 
 
Create and return the row for the given item
 
Returns whether the given item is expanded.
 
load(root, progress)
Load the explorer with the given root
 
loadResourceList(path, force, postLoad)
Load the resource at the given path.
 
makeNewChildItemPlaceholder(parentItem, child, domId)
 
onchange(item)
Called when the root item changes.
 
onModelCopy(modelEvent)
 
onModelCreate(modelEvent)
 
onModelDelete(modelEvent)
 
onModelMove(modelEvent)
 
reroot(The)
Re-roots the tree so that the given item is displayable.
 
reveal(The, reroot)
Shows and selects the given item.
 
The explorerNavHandler hooked up by the explorer will call this function when the focus into command is clicked.
 
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.
 
showItem(The, reroot)
Shows the given item.
Methods borrowed from class orion.explorer.Explorer:
collapseAll, createTree, expandAll, getNavDict, getNavHandler, getRootPath, getRow, handleLinkDoubleClick, initNavHandler, isDesktopSelectionMode, makeNewItemPlaceholder, refreshSelection, select, setRenderer, updateCommands
Class Detail
orion.explorer.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
{orion.EventTarget} modelEventDispatcher
Dispatches events describing model changes.

{orion.explorer.FileExplorer.ModelHandler} modelHandler
Handles model changes.

{Object} treeRoot
Root model item of the tree.
Method Detail
{orion.Promise} changedItem(parent, forceExpand)
Parameters:
{Object} parent
The parent item under which the change occurred.
{Boolean} forceExpand
Returns:
{orion.Promise}

{orion.explorer.FileModel} createModel()
Returns:
{orion.explorer.FileModel}

destroy()

{orion.Promise} expandItem(The, reroot)
Expands the given item.
Parameters:
{Object} The
item to be expanded.
{Booelan} reroot Optional, Default: true
whether the receiver should re-root the tree if the item is not displayable.
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}

handleResourceChange(evt)
Parameters:
evt

insertMissingItem(The, The)
Create and return the row for the given item
Parameters:
{Object} The
parent of the row.
{Object} The
contents of the row.

{orion.Promise} isExpanded(The)
Returns whether the given item is expanded.
Parameters:
{Object} The
item to be expanded.
Returns:
{orion.Promise}

{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.

{orion.Promise} loadResourceList(path, force, postLoad)
Load the resource at the given path.
Parameters:
{String|Object} path
The path of the resource to load, or an object with a ChildrenLocation or ContentLocation field giving the path.
{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.
{Function} postLoad
a function to call after loading the resource. Deprecated: use the returned promise instead.
Returns:
{orion.Promise}

makeNewChildItemPlaceholder(parentItem, child, domId)
Parameters:
{Object} parentItem
The item in the model which represents the new item's parent
{Object} child
An object describing the child that a placeholder needs to be created for. child.Name {String} The name of the child artifact child.Directory {Boolean} true if the child is a directory, false otherwise
{String} domId
The prefix to use for the Id of the newly created DOM nodes
Returns:
A deferred that resolves with the placeholder object (see explorer.js->makeNewItemPlaceholder())

onchange(item)
Called when the root item changes. This can be overridden.
Parameters:
{Object} item

onModelCopy(modelEvent)
Parameters:
modelEvent

onModelCreate(modelEvent)
Parameters:
modelEvent

onModelDelete(modelEvent)
Parameters:
modelEvent

onModelMove(modelEvent)
Parameters:
modelEvent

{orion.Promise} reroot(The)
Re-roots the tree so that the given item is displayable.
Parameters:
{Object} The
item to be expanded.
Returns:
{orion.Promise}

{orion.Promise} reveal(The, reroot)
Shows and selects the given item.
Parameters:
{Object} The
item to be revealed.
{Booelan} reroot Optional, Default: true
whether the receiver should re-root the tree if the item is not displayable.
Returns:
{orion.Promise}

scopeDown()
The explorerNavHandler hooked up by the explorer will call this function when the focus into command is clicked. The default implementation does nothing.

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.

{orion.Promise} showItem(The, reroot)
Shows the given item.
Parameters:
{Object} The
item to be shown.
{Booelan} reroot Optional, Default: true
whether the receiver should re-root the tree if the item is not displayable.
Returns:
{orion.Promise}

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Mar 17 2017 08:51:36 GMT-0400 (EDT)