org.netbeans.spi.diff.DiffControllerImpl Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.spi.diff;
import org.netbeans.api.diff.DiffController;
import javax.swing.*;
import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;
/**
* Provider class for DiffController, encapsulates a single Diff panel that displays differences between two files (sources).
*
* @author Maros Sandor
* @since 1.18
*/
public abstract class DiffControllerImpl {
/**
* A PropertyChangeSupport instance.
*/
protected final PropertyChangeSupport support = new PropertyChangeSupport(this);
private int differenceIndex = -1;
/**
* Default constructor, does nothing.
*/
protected DiffControllerImpl() {
}
/**
* 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.
*
* @param pane defines which pane the location parameter refers to
* @param type defines the location parameter, see below
* @param 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
*/
public void setLocation(DiffController.DiffPane pane, DiffController.LocationType type, int location) {
}
/**
* Retrieves visual presenter of the Diff.
*
* @return JComponent component to be embedded into client UI
*/
public abstract JComponent getJComponent();
/**
* Gets total number of Differences between sources currently displayed in the Diff view.
*
* @return total number of Differences in sources, an integer >= 0
*/
public abstract int getDifferenceCount();
/**
* Gets the current (highlighted) difference in the Diff view.
*
* @return current difference index or -1 of there is no Current difference
*/
public final int getDifferenceIndex() {
return differenceIndex;
}
/**
* Implementors use this method to set the current (highlighted) difference.
*
* @param idx a new current difference indox
*/
protected final void setDifferenceIndex(int idx) {
assert idx >= -1;
if (idx == differenceIndex) return;
differenceIndex = idx;
support.firePropertyChange(DiffController.PROP_DIFFERENCES, null, null);
}
/**
* Adds a property change listener.
*
* @param listener property change listener
*/
public final void addPropertyChangeListener(PropertyChangeListener listener) {
support.addPropertyChangeListener(listener);
}
/**
* Removes a property change listener.
*
* @param listener property change listener
*/
public final void removePropertyChangeListener(PropertyChangeListener listener) {
support.removePropertyChangeListener(listener);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy