| /******************************************************************************* |
| * Copyright (c) 2007, 2008 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.jface.text; |
| |
| import org.eclipse.swt.custom.StyledTextPrintOptions; |
| |
| |
| /** |
| * Extension interface for {@link org.eclipse.jface.text.ITextViewer}. Adds the |
| * ability to print and set how hovers should be enriched when the mouse is moved into them. |
| * |
| * @since 3.4 |
| */ |
| public interface ITextViewerExtension8 { |
| |
| /** |
| * Print the text viewer contents using the given options. |
| * |
| * @param options the print options |
| */ |
| void print(StyledTextPrintOptions options); |
| |
| /** |
| * Sets the hover enrich mode. |
| * A non-<code>null</code> <code>mode</code> defines when hovers |
| * should be enriched once the mouse is moved into them. |
| * If <code>mode</code> is <code>null</code>, hovers are automatically closed |
| * when the mouse is moved out of the {@link ITextHover#getHoverRegion(ITextViewer, int) hover region}. |
| * <p> |
| * Note that a hover can only be enriched if its {@link IInformationControlExtension5#getInformationPresenterControlCreator()} |
| * is not <code>null</code>. |
| * </p> |
| * |
| * @param mode the enrich mode, or <code>null</code> |
| */ |
| void setHoverEnrichMode(EnrichMode mode); |
| |
| |
| /** |
| * Type-safe enum of the available enrich modes. |
| */ |
| public static final class EnrichMode { |
| |
| /** |
| * Enrich the hover shortly after the mouse has been moved into it and |
| * stopped moving. |
| * |
| * @see ITextViewerExtension8#setHoverEnrichMode(org.eclipse.jface.text.ITextViewerExtension8.EnrichMode) |
| */ |
| public static final EnrichMode AFTER_DELAY= new EnrichMode("after delay"); //$NON-NLS-1$ |
| |
| /** |
| * Enrich the hover immediately when the mouse is moved into it. |
| * |
| * @see ITextViewerExtension8#setHoverEnrichMode(org.eclipse.jface.text.ITextViewerExtension8.EnrichMode) |
| */ |
| public static final EnrichMode IMMEDIATELY= new EnrichMode("immediately"); //$NON-NLS-1$ |
| |
| /** |
| * Enrich the hover on explicit mouse click. |
| * |
| * @see ITextViewerExtension8#setHoverEnrichMode(org.eclipse.jface.text.ITextViewerExtension8.EnrichMode) |
| */ |
| public static final EnrichMode ON_CLICK= new EnrichMode("on click"); //$NON-NLS-1$; |
| |
| |
| private String fName; |
| |
| private EnrichMode(String name) { |
| fName= name; |
| } |
| |
| @Override |
| public String toString() { |
| return fName; |
| } |
| } |
| |
| } |