blob: 2c066d16c3f719a1b55d6998f9369e6ad682ebe0 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
/*******************************************************************************
* 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.
* <p>
* Clients may implement this interface.
* </p>
*
* @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.
* <p>
* This type label can be used by {@link IHyperlinkPresenter}s
* which show several hyperlinks at once.
* </p>
*
* @return the type label or <code>null</code> if none
*/
String getTypeLabel();
/**
* Optional text for this hyperlink.
* <p>
* This can be used in situations where there are
* several targets for the same hyperlink location.
* </p>
*
* @return the text or <code>null</code> if none
*/
String getHyperlinkText();
/**
* Opens the given hyperlink.
*/
void open();
}
|
