Class Index | File Index

## Classes

- _global_
- Array
- Boolean
- Date
- Function
- javascript.ASTManager
- javascript.Indexer
- javascript.JavaScriptOccurrences
- javascript.JSOutliner
- javascript.Summary
- Object
- org.eclipse.orion.client.cf.CFService
- orion.breadcrumbs.BreadCrumbs
- orion.browse.FileBrowser
- orion.browse.FileBrowserOptions
- orion.BrowseView
- orion.cm.Configuration
- orion.cm.ConfigurationAdmin
- orion.cm.ConfigurationProperties
- orion.cm.ManagedService
- orion.commandregistry.CommandRegistry
- orion.commandregistry.ParameterCollector
- orion.commands.Command
- orion.commands.CommandInvocation
- orion.commands.CommandParameter
- orion.commands.ParametersDescription
- orion.commands.URLBinding
- orion.compare.CompareCommandFactory
- orion.compare.CompareSyntaxHighlighter
- orion.compare.CompareView
- orion.compare.CompareViewOptions
- orion.compare.DiffProvider
- orion.compare.FileOptions
- orion.compare.rulers.CompareRuler
- orion.compare.rulers.LineNumberCompareRuler
- orion.compare.toggleableCompareView
- orion.compare.TwoWayCompareView
- orion.compareUtils
- orion.core.ContentType
- orion.core.ContentTypeRegistry
- orion.core.TypeDef
- orion.core.TypeDefProperties
- orion.core.TypeDefRegistry
- orion.Deferred
- orion.dialogs.DialogService
- orion.DiffTreeNavigator.DiffTreeNavigator
- orion.DiffTreeNavigator.inlineDiffBlockFeeder
- orion.DiffTreeNavigator.TwoWayDiffBlockFeeder
- orion.edit.Dispatcher
- orion.edit.EditorContext
- orion.editor.ActionDescription
- orion.editor.Annotation
- orion.editor.AnnotationIterator
- orion.editor.AnnotationModel
- orion.editor.AnnotationRuler
- orion.editor.AnnotationStyler
- orion.editor.AnnotationType
- orion.editor.AnnotationTypeList
- orion.editor.AsyncStyler
- orion.editor.BaseEditor
- orion.editor.BlurEvent
- orion.editor.ContentAssist
- orion.editor.ContentAssistMode
- orion.editor.ContentAssistProvider
- orion.editor.ContentAssistProvider.Context
- orion.editor.ContentAssistProviderInfo
- orion.editor.ContentAssistWidget
- orion.editor.ContextMenuEvent
- orion.editor.CssContentAssistProvider
- orion.editor.DestroyEvent
- orion.editor.EditOptions
- orion.editor.Editor
- orion.editor.EventTarget
- orion.editor.FindIterator
- orion.editor.FindOptions
- orion.editor.FocusEvent
- orion.editor.FoldingAnnotation
- orion.editor.HTMLContentAssistProvider
- orion.editor.InputManager
- orion.editor.KeyEvent
- orion.editor.LineNumberRuler
- orion.editor.LineStyleEvent
- orion.editor.ModelChangedEvent
- orion.editor.ModelChangingEvent
- orion.editor.ModifyEvent
- orion.editor.OverviewRuler
- orion.editor.Projection
- orion.editor.ProjectionTextModel
- orion.editor.Ruler
- orion.editor.ScrollEvent
- orion.editor.Selection
- orion.editor.SelectionEvent
- orion.editor.Style
- orion.editor.StyleRange
- orion.editor.StyleReadyEvent
- orion.editor.StyleReadyEvent#LineStyle
- orion.editor.TextChange
- orion.editor.TextMateStyler
- orion.editor.TextModel
- orion.editor.TextTheme
- orion.editor.TextView
- orion.editor.TextViewOptions
- orion.editor.TextViewShowOptions
- orion.editor.ThemeChangedEvent
- orion.editor.ThemeStyleSheet
- orion.editor.UndoStack
- orion.editor.VerifyEvent
- orion.EditorView
- orion.EventTarget
- orion.explorer.Explorer
- orion.explorer.ExplorerFlatModel
- orion.explorer.ExplorerModel
- orion.explorer.FileExplorer
- orion.explorer.FileExplorer.ModelHandler
- orion.explorer.NavigatorRenderer
- orion.explorer.SelectionRenderer
- orion.explorerNavHandler.ExplorerNavDict
- orion.explorerNavHandler.ExplorerNavHandler
- orion.extensionCommands
- orion.fileClient.FileClient
- orion.fileCommands
- orion.fileUtils
- orion.FolderView
- orion.form
- orion.git.GitCommitExplorer
- orion.git.GitLogExplorer
- orion.git.GitRepositoryExplorer
- orion.git.GitReviewRequestExplorer
- orion.git.GitService
- orion.git.GitStatusExplorer
- orion.git.widgets.OpenCommitDialog
- orion.globalCommands
- orion.highlight.SyntaxHighlighter
- orion.KeyBinding
- orion.KeySequence
- orion.KeyStroke
- orion.links.TextLinkService
- orion.log.LogService
- orion.metatype.AttributeDefinition
- orion.metatype.MetaTypeRegistry
- orion.metatype.ObjectClassDefinition
- orion.mirror.CodeMirrorStyler
- orion.mirror.Mirror
- orion.mirror.MirrorLineStyle
- orion.mirror.ModeApplier
- orion.navoutliner.NavigationOutliner
- orion.objects
- orion.operation
- orion.outliner.Outliner
- orion.outliner.OutlineService
- orion.PageLinks
- orion.PageLinks.PageLinksInfo
- orion.parametercollectors.CommandParameterCollector
- orion.pluginregistry.Plugin
- orion.pluginregistry.PluginRegistry
- orion.preferences.Preferences
- orion.preferences.PreferencesService
- orion.problems.ProblemService
- orion.profile.usersClient.UsersClient
- orion.progress.ProgressService
- orion.projectClient.ProjectClient
- orion.Promise
- orion.ReadonlyEditorView
- orion.regex
- orion.search.AdvSearchOptRenderer
- orion.searchClient.Searcher
- orion.searches.SavedSearches
- orion.Searches.SearchBuilder
- orion.Searches.SearchList
- orion.searchResults.SearchResultsGenerator
- orion.searchUtils
- orion.searchUtils.SearchParams
- orion.selection.Selection
- orion.serviceregistry.ServiceEvent
- orion.serviceregistry.ServiceReference
- orion.serviceregistry.ServiceRegistration
- orion.serviceregistry.ServiceRegistry
- orion.ServiceTracker
- orion.settings.Setting
- orion.settings.SettingsRegistry
- orion.settings.ui.PropertyWidget
- orion.shell.Command
- orion.shell.Parameter
- orion.shell.ParameterType
- orion.shell.Shell
- orion.sidebar.MiniNavViewMode
- orion.sidebar.ProjectNavViewMode
- orion.sidebar.Sidebar
- orion.sidebar.ViewMode
- orion.sites.SiteClient
- orion.sites.SiteConfiguration
- orion.sites.SiteEditor
- orion.sites.SiteService
- orion.sites.ViewOnSiteTree
- orion.status.StatusReportingService
- orion.SyntaxChecker
- orion.tasks.TaskList
- orion.TreeModelIterator.TreeModelIterator
- orion.treetable.TableTree
- orion.uiUtils
- orion.URITemplate
- orion.webui.contextmenu.ContextMenu
- orion.webui.dialogs.ConfirmDialog
- orion.webui.dialogs.OpenResourceDialog
- orion.webui.dialogs.OperationsDialog
- orion.webui.dialogs.PromptDialog
- orion.webui.littlelib
- orion.webui.Splitter
- orion.widgets.browse.ResourceSelector
- orion.widgets.Filesystem.FilesystemSwitcher
- orion.widgets.Section
- orion.widgets.settings.SplitSelectionLayout
- orion.xhr
- orion.xhr.Result
- String

# Class orion.explorer.FileExplorer

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

Class Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| orion.explorer.FileExplorer() Creates a new file explorer.

Field Summary
Field Attributes | Field Name and Description
--- | ---
| modelEventDispatcher Dispatches events describing model changes.
| modelHandler Handles model changes.
| treeRoot Root model item of the tree.

Method Summary
Method Attributes | Method Name and Description
--- | ---
| changedItem(parent, forceExpand)
| createModel()
| destroy()
| expandItem(The, reroot) Expands the given item.
| getNameNode(item) Returns the node that a rename text input box should appear over top of.
| isExpanded(The) 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.
| onLinkClick(clickEvent)
| 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.
| scopeDown() The explorerNavHandler hooked up by the explorer will call this function when the focus into command is clicked.
| 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.
| showItem(The, reroot) Shows the given item.

Methods borrowed from class orion.explorer.Explorer:
  collapseAll, createTree, expandAll, getNavDict, getNavHandler, getRootPath, getRow, initNavHandler, makeNewItemPlaceholder, refreshSelection, 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}

{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

onLinkClick(clickEvent)

Parameters:
clickEvent

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 Mon May 05 2014 22:06:15 GMT-0400 (EDT)