KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > texteditor > IStatusField


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.ui.texteditor;
13
14
15 import org.eclipse.swt.graphics.Image;
16
17
18 /**
19  * Interface of a status field of a text editor. The field that shows up in the
20  * workbench's status line if the contributing editor is active.
21  * <p>
22  * In order to provided backward compatibility for clients of
23  * <code>IStatusField</code>, extension interfaces are used to provide a
24  * means of evolution. The following extension interface exists:
25  * <ul>
26  * <li>{@link org.eclipse.ui.texteditor.IStatusFieldExtension} since
27  * version 3.0 introducing error text, tooltips and visibility control.</li>
28  * </ul>
29  * </p>
30  *
31  * @see org.eclipse.ui.texteditor.IStatusFieldExtension
32  * @since 2.0
33  */
34 public interface IStatusField {
35
36     /**
37      * Sets the text of this status field.
38      *
39      * @param text the text shown in the status field
40      */
41     void setText(String JavaDoc text);
42
43     /**
44      * Sets the image of this status field.
45      *
46      * @param image the image shown in the status field
47      */
48     void setImage(Image image);
49 }
50
51
Popular Tags