| /******************************************************************************* |
| * Copyright (c) 2005, 2011 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.ltk.ui.refactoring.history; |
| |
| import org.eclipse.swt.widgets.Control; |
| |
| import org.eclipse.jface.viewers.ICheckStateListener; |
| import org.eclipse.jface.viewers.ISelectionChangedListener; |
| |
| import org.eclipse.ltk.core.refactoring.RefactoringDescriptorProxy; |
| import org.eclipse.ltk.core.refactoring.history.RefactoringHistory; |
| import org.eclipse.ltk.ui.refactoring.RefactoringUI; |
| |
| |
| /** |
| * Control which is capable of displaying parts of a refactoring history. |
| * <p> |
| * Clients of this interface should call {@link #createControl()} before calling |
| * {@link #setInput(RefactoringHistory)}. |
| * </p> |
| * <p> |
| * An instanceof of a refactoring history control may be obtained by calling |
| * {@link RefactoringUI#createRefactoringHistoryControl(org.eclipse.swt.widgets.Composite, RefactoringHistoryControlConfiguration)} |
| * . |
| * </p> |
| * <p> |
| * Note: this interface is not intended to be implemented by clients. |
| * </p> |
| * |
| * @see RefactoringHistoryControlConfiguration |
| * @see RefactoringHistoryContentProvider |
| * @see RefactoringHistoryLabelProvider |
| * |
| * @since 3.2 |
| * |
| * @noimplement This interface is not intended to be implemented by clients. |
| * @noextend This interface is not intended to be extended by clients. |
| */ |
| public interface IRefactoringHistoryControl { |
| |
| /** |
| * Registers the specified check state listener with this control. |
| * <p> |
| * If the listener is already registered with the control, or the control |
| * has no checkable viewer or has not yet been created, nothing happens. |
| * </p> |
| * |
| * @param listener |
| * the listener to register |
| */ |
| void addCheckStateListener(ICheckStateListener listener); |
| |
| /** |
| * Registers the specified selection changed listener with this control. |
| * <p> |
| * If the listener is already registered with the control or has not yet |
| * been created, nothing happens. |
| * </p> |
| * |
| * @param listener |
| * the listener to register |
| */ |
| void addSelectionChangedListener(ISelectionChangedListener listener); |
| |
| /** |
| * Creates the refactoring history control. |
| * <p> |
| * This method creates the necessary widgets and initializes the refactoring |
| * history control. It is called only once. Method <code>getControl()</code> |
| * should be used to retrieve the widget hierarchy. |
| * </p> |
| * |
| * @see #getControl() |
| */ |
| void createControl(); |
| |
| /** |
| * Returns the checked refactoring descriptors. |
| * <p> |
| * In case the refactoring history control is created with a non-checkable |
| * tree viewer, this method is equivalent to |
| * {@link #getSelectedDescriptors()}. |
| * </p> |
| * |
| * @return the selected refactoring descriptors, or an empty array. |
| * |
| * @see IRefactoringHistoryControl#getSelectedDescriptors() |
| * @see RefactoringHistoryControlConfiguration#isCheckableViewer() |
| */ |
| RefactoringDescriptorProxy[] getCheckedDescriptors(); |
| |
| /** |
| * Returns the SWT control of this refactoring history control. |
| * |
| * @return the SWT control, or <code>null</code> if the control's widget |
| * hierarchy has not yet been created |
| */ |
| Control getControl(); |
| |
| /** |
| * Returns the selected refactoring descriptors. |
| * |
| * @return the selected refactoring descriptors, or an empty array. |
| */ |
| RefactoringDescriptorProxy[] getSelectedDescriptors(); |
| |
| /** |
| * Unregisters the specified check state listener with this control. |
| * <p> |
| * If the listener is not registered with this control, nothing happens. |
| * </p> |
| * |
| * @param listener |
| * the listener to unregister |
| */ |
| void removeCheckStateListener(ICheckStateListener listener); |
| |
| /** |
| * Unregisters the specified selection changed listener with this control. |
| * <p> |
| * If the listener is not registered with this control, nothing happens. |
| * </p> |
| * |
| * @param listener |
| * the listener to unregister |
| */ |
| void removeSelectionChangedListener(ISelectionChangedListener listener); |
| |
| /** |
| * Sets the checked refactoring descriptors. |
| * <p> |
| * In case the refactoring history control is created with a non-checkable |
| * tree viewer, this method is equivalent to |
| * {@link #setSelectedDescriptors(RefactoringDescriptorProxy[])}. |
| * </p> |
| * |
| * @param descriptors |
| * the refactoring descriptors to check, or an empty array |
| * |
| * @see IRefactoringHistoryControl#setSelectedDescriptors(RefactoringDescriptorProxy[]) |
| * @see RefactoringHistoryControlConfiguration#isCheckableViewer() |
| */ |
| void setCheckedDescriptors(RefactoringDescriptorProxy[] descriptors); |
| |
| /** |
| * Sets the refactoring history of this control. |
| * |
| * @param history |
| * the refactoring history, or <code>null</code> to clear the |
| * viewer input |
| */ |
| void setInput(RefactoringHistory history); |
| |
| /** |
| * Sets the selected refactoring descriptors. |
| * |
| * @param descriptors |
| * the refactoring descriptors to select, or an empty array |
| */ |
| void setSelectedDescriptors(RefactoringDescriptorProxy[] descriptors); |
| } |