Class Index | File Index

Classes


Class orion.compare.CompareViewOptions

This object describes the options for a compare view.

See:
orion.compare.FileOptions
orion.compare.CompareView
orion.compare.CompareView#setOptions orion.compare.CompareView#getOptions


Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/compare/compareView.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Optional.
 
Optional.
 
Optional.
 
Required.
 
Required.
 
Required.
 
Optional.
 
Optional.
Class Detail
orion.compare.CompareViewOptions()
Field Detail
{orion.compare.CompareCommandFactory} commandProvider
Optional. If defined it will render all the commands that the compare view requires.

{String} diffContent
Optional. the unified diff against the original/old file. If this option is defined, the newFile option is ignored or becomes optional.

{Array} highlighters
Optional. An array of two instances of orion.compare.CompareSyntaxHighlighter. If defined the highlighters are used to highlight the syntax of both side of the comapre view, respectively.

{orion.compare.FileOptions} newFile
Required. the options of the file that is compared against the original. Required. In the two way compare case, this file is dispalyed on the right hand side.

{orion.compare.FileOptions} oldFile
Required. the options of the file that is original. Required. In the two way compare case, this file is dispalyed on the left hand side.

{String} parentDivID
Required. the parent element id for the compare view. Required. The parentDivID is required to prefix the ids of sub components in case of side by side view.

{Boolean} showLineStatus
Optional. whether or not to show the current line and column number fo the caret on each side of the view. Not avaible for inline/unified compare view.
Default Value:
false

{Boolean} showTitle
Optional. whether or not to show the two file names on each side of the compare view.
Default Value:
false

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