Class Index | File Index

Classes


Class orion.explorer.NavigatorRenderer

Renderer for a tree-table of files, like the Orion Navigator.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/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.
 
Creates a image DOM Element for the specified folder.
 
Whether the default implementation of #createFolderNode should show folders should as links (true), or just plain text (false).
 
Subclasses can override this function to customize the DOM Element that is created to represent a file.
Method Summary
Method Attributes Method Name and Description
<static>  
orion.explorer.NavigatorRenderer.createLink(folderPageURL, item, commandService, openWithCommands, linkProperties, uriParams, separateImageHolder, renderer)
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.
<static>  
orion.explorer.NavigatorRenderer.getClickedItem()
Returns the last item clicked by links created with #createLink.
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.ContentTypeRegistry} 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:
orion.explorer.NavigatorRenderer#showFolderLinks
orion.explorer.NavigatorRenderer#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:
""

getFolderImage
Creates a image DOM Element for the specified folder.

showFolderLinks
Whether the default implementation of #createFolderNode should show folders should as links (true), or just plain text (false).
Default Value:
true

updateFileNode
Subclasses can override this function to customize the DOM Element that is created to represent a file. The returned element must have an id property. The default implementation does nothing.
Method Detail
<static> orion.explorer.NavigatorRenderer.createLink(folderPageURL, item, commandService, openWithCommands, linkProperties, uriParams, separateImageHolder, renderer)
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} linkProperties Optional
gives additional properties to mix in to the HTML anchor element.
{Object} uriParams Optional
A map giving additional parameters that will be provided to the URI template that generates the href.
{Object} separateImageHolder Optional
Separate image holder object. {holderDom: dom}. If separateImageHolder is not defined, the file icon image is rendered in the link as the first child.
{NavigatorRenderer} renderer Optional
The renderer object. Optional. If defined, renderer.updateFileNode() is called to update the file element for sub classes. If separateImageHolder is defined with holderDom property, the file icon iamge is rendered in separateImageHolder.holderDom. IF separateImageHolder is defined as an empty object, {}, the file icon iamge is not rendered at all.

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

<static> orion.explorer.NavigatorRenderer.getClickedItem()
Returns the last item clicked by links created with #createLink.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 18 2017 12:15:12 GMT-0500 (EST)