Class Index | File Index

Classes


Class orion.explorer.NavigatorRenderer

Renderer for a tree-table of files, like the Orion Navigator.
Defined in: </shared/eclipse/e4/orion/I201306251555/plugins/org.eclipse.orion.client.ui/web/orion/explorers/navigatorRenderer.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.explorer.NavigatorRenderer(options, explorer, commandRegistry, contentTypeService)
Renderer for a tree-table of files, like the Orion Navigator.
Field Summary
Field Attributes Field Name and Description
 
Subclasses can override this function to customize the DOM Element that is created to represent a folder.
 
Gives the base href to be used by the default implementation of #createFolderNode for creating folder links.
 
Whether the default implementation of #createFolderNode should show folders should as links (true), or just plain text (false).
Method Summary
Method Attributes Method Name and Description
<static>  
orion.explorer.NavigatorRenderer.createLink(folderPageURL, item, commandService, openWithCommands, defaultEditor, linkProperties)
Exported so that it can be used by other UI that wants to use navigator-style links.
 
Generate the DOM element for a cell.
 
Creates the column header element.
 
setTarget(target)
Sets the link target to be used for file links.
Class Detail
orion.explorer.NavigatorRenderer(options, explorer, commandRegistry, contentTypeService)
Renderer for a tree-table of files, like the Orion Navigator.
Parameters:
{Object} options
{orion.explorer.Explorer} explorer
{orion.commandregistry.CommandRegistry} commandRegistry
{orion.core.ContentTypeService} contentTypeService
Field Detail
createFolderNode
Subclasses can override this function to customize the DOM Element that is created to represent a folder. The default implementation creates either a hyperlink or a plain text node.
See:
#showFolderLinks
#folderLink

folderLink
Gives the base href to be used by the default implementation of #createFolderNode for creating folder links. This property only takes effect if #showFolderLinks is true. TODO see Bug 400121
Default Value:
""

showFolderLinks
Whether the default implementation of #createFolderNode should show folders should as links (true), or just plain text (false).
Default Value:
true
Method Detail
<static> orion.explorer.NavigatorRenderer.createLink(folderPageURL, item, commandService, openWithCommands, defaultEditor, linkProperties)
Exported so that it can be used by other UI that wants to use navigator-style links. commandService and contentTypeService are necessary to compute the proper editor for a file.
Parameters:
{String} folderPageURL
the page you want to direct folders to (such as navigator). Using a blank string will just hash the current page.
{Object} item
a json object describing an Orion file or folder
{Object} commandService
necessary to compute the proper editor for a file. Must be a synchronous, in-page service, not retrieved from the service registry.
{Object[]} openWithCommands Optional
The "open with" commands used to generate link hrefs. If this parameter is not provided, the caller must have already processed the service extension and added to the command registry (usually by calling orion.extensionCommands.createAndPlaceFileCommandsExtension).
{Object} defaultEditor Optional
The default editor to use. If not provided, this will be computed from openWithCommands.
{Object} linkProperties Optional
gives additional properties to mix in to the HTML anchor element.

{Element} getCellElement()
Generate the DOM element for a cell. If you override this function, you will most likely have to override orion.explorers.FileExplorer#getNameNode in your explorer class.
Returns:
{Element}

{Element} getCellHeaderElement()
Creates the column header element. We are really only using the header for a spacer at this point.
Returns:
{Element}

setTarget(target)
Sets the link target to be used for file links.
Parameters:
{String} target
The target (eg. "new", "_self").

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Jun 25 2013 15:58:41 GMT-0400 (EDT)