org.eclipse.jface.text.hyperlink.IHyperlink Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.jface.text Show documentation

This is org.eclipse.jface.text jar used by Scout SDK

There is a newer version: 3.11.0.v20160505-1301

Show newest version

/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jface.text.hyperlink;

import org.eclipse.jface.text.IRegion;


/**
 * Represents a hyperlink.
 * 
 * Clients may implement this interface.
 * 
 *
 * @since 3.1
 */
public interface IHyperlink {

	/**
	 * The region covered by this type of hyperlink.
	 *
	 * @return the hyperlink region
	 */
	IRegion getHyperlinkRegion();

	/**
	 * Optional label for this type of hyperlink.
	 * 
	 * This type label can be used by {@link IHyperlinkPresenter}s
	 * which show several hyperlinks at once.
	 * 
	 *
	 * @return the type label or null if none
	 */
	String getTypeLabel();

	/**
	 * Optional text for this hyperlink.
	 * 
	 * This can be used in situations where there are
	 * several targets for the same hyperlink location.
	 * 
	 *
	 * @return the text or null if none
	 */
	String getHyperlinkText();

	/**
	 * Opens the given hyperlink.
	 */
	void open();
}