DiffController (Diff) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.diff/1 1.18.0 42

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.api.diff
Class DiffController

java.lang.Object
  org.netbeans.api.diff.DiffController

public final class DiffController
extends Object
extends Object

Encapsulates a single Diff window that displays differences between two files (sources).

Since:: 1.18

Nested Class Summary

static class DiffController.DiffPane
          Enumerates Base (left) and Modified (right) panes of a Diff view for setLocation() method

static class DiffController.LocationType
          Enumerates types of location for setLocation() method.

Field Summary

static String PROP_DIFFERENCES
          Property change that indicates that set of differences OR the current difference changed.

Method Summary

void addPropertyChangeListener(PropertyChangeListener listener)
          Adds a property change listener.

static DiffController create(StreamSource base, StreamSource modified)
          Creates a Diff Controller for supplied left and right sources.

int getDifferenceCount()
          Gets total number of Differences between sources currently displayed in the Diff view.

int getDifferenceIndex()
          Gets the current (highlighted) difference in the Diff view.

JComponent getJComponent()
          Intializes the Controller and creates visual presenter of the Diff.

void removePropertyChangeListener(PropertyChangeListener listener)
          Removes a property change listener.

void setLocation(DiffController.DiffPane pane, DiffController.LocationType type, int location)
          Ensure the requested location in the Diff view is visible on screen.

Methods inherited from class java.lang.Object

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

Nested Class Summary
`static class`	`DiffController.DiffPane` Enumerates Base (left) and Modified (right) panes of a Diff view for setLocation() method
`static class`	`DiffController.LocationType` Enumerates types of location for setLocation() method.

Field Summary
`static String`	`PROP_DIFFERENCES` Property change that indicates that set of differences OR the current difference changed.

Method Summary
`void`	`addPropertyChangeListener(PropertyChangeListener listener)` Adds a property change listener.
`static DiffController`	`create(StreamSource base, StreamSource modified)` Creates a Diff Controller for supplied left and right sources.
`int`	`getDifferenceCount()` Gets total number of Differences between sources currently displayed in the Diff view.
`int`	`getDifferenceIndex()` Gets the current (highlighted) difference in the Diff view.
`JComponent`	`getJComponent()` Intializes the Controller and creates visual presenter of the Diff.
`void`	`removePropertyChangeListener(PropertyChangeListener listener)` Removes a property change listener.
`void`	`setLocation(DiffController.DiffPane pane, DiffController.LocationType type, int location)` Ensure the requested location in the Diff view is visible on screen.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

PROP_DIFFERENCES

public static final String PROP_DIFFERENCES

Property change that indicates that set of differences OR the current difference changed. Current difference changes as the user navigates in the view and set of differences may change if the view is editable or a source changes programatically. Clients should update their state that depends on the current difference index or total number of differences.

See Also:: Constant Field Values

Method Detail

create

public static DiffController create(StreamSource base,
                                    StreamSource modified)
                             throws IOException

Creates a Diff Controller for supplied left and right sources.

Parameters:: base - defines content of the Base Diff pane; modified - defines content of the Modified (possibly editable) Diff pane
Returns:: DiffController implementation of the DiffController class
Throws:: IOException - when the reading from input streams fails.

setLocation

public void setLocation(DiffController.DiffPane pane,
                        DiffController.LocationType type,
                        int location)

Ensure the requested location in the Diff view is visible on screen. Diff view can be requested to jump to a given line in either source or to a given Difference. Diff controller may ignore the request if it does not support this functionality. This method must be called from AWT thread.

Parameters:: pane - defines which pane the location parameter refers to; type - defines the location parameter, see below; location - depending on the type parameter this defines either a line number or a Difference index, both 0-based
Throws:: IllegalArgumentException - if location parameter is out of range for the given pane and location type

getJComponent

public JComponent getJComponent()

Intializes the Controller and creates visual presenter of the Diff.

Returns:: JComponent component to be embedded into client UI

getDifferenceCount

public int getDifferenceCount()

Gets total number of Differences between sources currently displayed in the Diff view.

Returns:: total number of Differences in sources, an integer >= 0

getDifferenceIndex

public int getDifferenceIndex()

Gets the current (highlighted) difference in the Diff view.

Returns:: current difference index or -1 of there is no Current difference

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a property change listener.

Parameters:: listener - property change listener

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a property change listener.

Parameters:: listener - property change listener