oracle.jdeveloper.compare
Class CompareViewer

java.lang.Object
  oracle.jdeveloper.compare.CompareViewer

public abstract class CompareViewer
extends java.lang.Object

Public API to the standalone compare viewer. JDeveloper extensions can use this API to integrate into compare functionality in the IDE. This API exists partly for backward compatibility with previous releases of JDeveloper. A new API will probably arise in 10.0.3 Obtain an instance of CompareViewer using the JNDI namespace "jdeveloper/compareviewer" Example:

   import javax.naming.InitialContext;
   ...
   InitialContext ic = new InitialContext();
   CompareViewer viewer = (CompareViewer) ic.lookup( "jdeveloper/compareviewer" );
 

Field Summary

static java.lang.String	COMPARE_EACH_OTHER_COMMAND Use this constant to retrieve the cmdId of the Compare with > Each Other action.
static java.lang.String	COMPARE_FILE_ON_DISK_COMMAND Use this constant to retrieve the cmdId of the Compare with > File on Disk action.
static java.lang.String	COMPARE_OTHER_FILE_COMMAND Use this constant to retrieve the cmdId of the Compare with > Other File...
static float	COMPARE_WITH_SECTION_MULTI
static float	COMPARE_WITH_SECTION_SINGLE
static float	COMPARE_WITH_WEIGHT_EACH_OTHER
static float	COMPARE_WITH_WEIGHT_FILE_ON_DISK
static float	COMPARE_WITH_WEIGHT_OTHER_FILE

Constructor Summary

CompareViewer()

Method Summary

static CompareViewer	get() Convenience method that gets the compare viewer instance using JNDI.
abstract javax.swing.JMenu	getContextCompareMenu() Get the compare context menu
abstract javax.swing.JMenu	getMainCompareMenu() Get the compare menu.
static boolean	isContentComparable(java.net.URL url) Deprecated. replaced by CompareManager.isContentComparable(java.net.URL). Note that the new method returns true for certain comparable binary file types, as recognized by a registered CompareMethod.
void	show(CompareContributor left, CompareContributor right) Display the compare viewer for the specified two contributors.
void	show(CompareContributor left, CompareContributor right, Node contextNode) Display the compare viewer for the specified two contributors.
void	show(java.net.URL left, java.net.URL right) Display the compare viewer for the specified two URLs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPARE_WITH_SECTION_MULTI

public static final float COMPARE_WITH_SECTION_MULTI

See Also:

Constant Field Values

COMPARE_WITH_SECTION_SINGLE

public static final float COMPARE_WITH_SECTION_SINGLE

See Also:

Constant Field Values

COMPARE_WITH_WEIGHT_EACH_OTHER

public static final float COMPARE_WITH_WEIGHT_EACH_OTHER

See Also:

Constant Field Values

COMPARE_WITH_WEIGHT_FILE_ON_DISK

public static final float COMPARE_WITH_WEIGHT_FILE_ON_DISK

See Also:

Constant Field Values

COMPARE_WITH_WEIGHT_OTHER_FILE

public static final float COMPARE_WITH_WEIGHT_OTHER_FILE

See Also:

Constant Field Values

COMPARE_FILE_ON_DISK_COMMAND

public static final java.lang.String COMPARE_FILE_ON_DISK_COMMAND

Use this constant to retrieve the cmdId of the Compare with > File on Disk action. e.g.:

   Integer cmdId = Ide.findCmdID( CompareViewer.COMPARE_FILE_ON_DISK_COMMAND );
   if ( cmdId != null ) {
     IdeAction action = IdeAction.find( cmdId.intValue() );
   }
 

This can be used to override the default behavior of this action, e.g. by hooking in a chained controller.

See Also:

Constant Field Values

COMPARE_OTHER_FILE_COMMAND

public static final java.lang.String COMPARE_OTHER_FILE_COMMAND

Use this constant to retrieve the cmdId of the Compare with > Other File... action. e.g.:

   Integer cmdId = Ide.findCmdID( CompareViewer.COMPARE_OTHER_FILE_COMMAND );
   if ( cmdId != null ) {
     IdeAction action = IdeAction.find( cmdId.intValue() );
   }
 

This can be used to override the default behavior of this action, e.g. by hooking in a chained controller.

See Also:

Constant Field Values

COMPARE_EACH_OTHER_COMMAND

public static final java.lang.String COMPARE_EACH_OTHER_COMMAND

Use this constant to retrieve the cmdId of the Compare with > Each Other action. e.g.:

   Integer cmdId = Ide.findCmdID( CompareViewer.COMPARE_EACH_OTHER_COMMAND );
   if ( cmdId != null ) {
     IdeAction action = IdeAction.find( cmdId.intValue() );
   }
 

This can be used to override the default behavior of this action, e.g. by hooking in a chained controller.

See Also:

Constant Field Values

Constructor Detail

CompareViewer

public CompareViewer()

Method Detail

get

public static final CompareViewer get()

Convenience method that gets the compare viewer instance using JNDI. This method may return null.

isContentComparable

@Deprecated
public static final boolean isContentComparable(java.net.URL url)

Deprecated. replaced by CompareManager.isContentComparable(java.net.URL). Note that the new method returns true for certain comparable binary file types, as recognized by a registered CompareMethod.

Asks whether the content of the given URL is comparable.

Parameters:

url - the url.

Returns:

true if the URL represents comparable content.

getMainCompareMenu

public abstract javax.swing.JMenu getMainCompareMenu()

Get the compare menu.

Returns:

the compare menu.

getContextCompareMenu

public abstract javax.swing.JMenu getContextCompareMenu()

Get the compare context menu

Returns:

the compare context menu.

show

public void show(CompareContributor left,
                 CompareContributor right)

Display the compare viewer for the specified two contributors.

Parameters:

left - the contributor to display on the left of the compare viewer

right - the contributor to display on the right of the compare viewer

show

public void show(CompareContributor left,
                 CompareContributor right,
                 Node contextNode)

Display the compare viewer for the specified two contributors.

Parameters:

left - the contributor to display on the left of the compare viewer

right - the contributor to display on the right of the compare viewer

contextNode - the real node from the context, used when an artificial node (and URL) is associated with the view.

show

public final void show(java.net.URL left,
                       java.net.URL right)

Display the compare viewer for the specified two URLs.

Parameters:

left - the url of the file to display on the left of the compare viewer

right - the url of the file to display on the right of the compare viewer