Extension SDK 10.1.2


oracle.jdeveloper.compare
Class CompareViewer

java.lang.Object
  extended byoracle.jdeveloper.compare.CompareViewer


public abstract class CompareViewer
extends java.lang.Object

Public API to the compare viewer. JDeveloper extensions can use this API to integrate into compare functionality in the IDE. 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.
abstract void show(oracle.scm.client.resource.Resource left, oracle.scm.client.resource.Resource right)
Display the compare viewer for the specified two resources.
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.

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 abstract void show(oracle.scm.client.resource.Resource left,
                          oracle.scm.client.resource.Resource right)
Display the compare viewer for the specified two resources. This method is reserved for use by version control extensions distributed by Oracle. Its use in third party extensions is currently not supported.
Parameters:
left - the resource to display on the left of the compare viewer
right - the resource to display on the right of the compare viewer

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

Extension SDK


Copyright © 1997, 2004, Oracle. All rights reserved.