|
Last change
on this file since 25584 was 25584, checked in by davidb, 12 years ago |
|
Initial cut an a text edit area for GLI that supports color syntax highlighting
|
|
File size:
1.1 KB
|
| Line | |
|---|
| 1 | /*
|
|---|
| 2 | * 02/19/2009
|
|---|
| 3 | *
|
|---|
| 4 | * GutterIconInfo.java - Information about an Icon in a Gutter.
|
|---|
| 5 | *
|
|---|
| 6 | * This library is distributed under a modified BSD license. See the included
|
|---|
| 7 | * RSyntaxTextArea.License.txt file for details.
|
|---|
| 8 | */
|
|---|
| 9 | package org.fife.ui.rtextarea;
|
|---|
| 10 |
|
|---|
| 11 | import javax.swing.Icon;
|
|---|
| 12 |
|
|---|
| 13 |
|
|---|
| 14 | /**
|
|---|
| 15 | * Information about an icon displayed in a {@link Gutter}. Instances of this
|
|---|
| 16 | * class are returned by {@link Gutter#addLineTrackingIcon(int, Icon)} and
|
|---|
| 17 | * {@link Gutter#addOffsetTrackingIcon(int, Icon)}. They can later be used
|
|---|
| 18 | * in calls to {@link Gutter#removeTrackingIcon(GutterIconInfo)} to be
|
|---|
| 19 | * individually removed.
|
|---|
| 20 | *
|
|---|
| 21 | * @author Robert Futrell
|
|---|
| 22 | * @version 1.0
|
|---|
| 23 | * @see Gutter
|
|---|
| 24 | */
|
|---|
| 25 | public interface GutterIconInfo {
|
|---|
| 26 |
|
|---|
| 27 |
|
|---|
| 28 | /**
|
|---|
| 29 | * Returns the icon being rendered.
|
|---|
| 30 | *
|
|---|
| 31 | * @return The icon being rendered.
|
|---|
| 32 | */
|
|---|
| 33 | public Icon getIcon();
|
|---|
| 34 |
|
|---|
| 35 |
|
|---|
| 36 | /**
|
|---|
| 37 | * Returns the offset that is being tracked. The line of this offset is
|
|---|
| 38 | * where the icon is rendered. This offset may change as the user types
|
|---|
| 39 | * to track the new location of the marked offset.
|
|---|
| 40 | *
|
|---|
| 41 | * @return The offset being tracked.
|
|---|
| 42 | */
|
|---|
| 43 | public int getMarkedOffset();
|
|---|
| 44 |
|
|---|
| 45 | } |
|---|
Note:
See
TracBrowser
for help on using the repository browser.
