01: /*******************************************************************************
02: * Copyright (c) 2000, 2005 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.texteditor;
11:
12: import org.eclipse.swt.graphics.Image;
13:
14: /**
15: * Extends {@link org.eclipse.ui.texteditor.IStatusField} with the following
16: * concepts:
17: * <ul>
18: * <li>set error text and image</li>
19: * <li>set tool tip</li>
20: * <li>control visibility</li>
21: * </ul>
22: *
23: * @since 3.0
24: */
25: public interface IStatusFieldExtension {
26: /**
27: * Sets the text of this status field.
28: * <p>
29: * The error text overrides the current text until the error
30: * text is cleared (set to <code>null</code>).
31: * </p>
32: *
33: * @param text the error text shown in the status field or <code>null</code> to clear
34: * @see IStatusField#setText(String)
35: */
36: void setErrorText(String text);
37:
38: /**
39: * Sets the error image of this status field.
40: * <p>
41: * The error image overrides the current image until the error
42: * image is cleared (set to <code>null</code>).
43: * </p>
44: *
45: * @param image the error image shown in the status field or <code>null</code> to clear
46: * @see IStatusField#setImage(Image)
47: */
48: void setErrorImage(Image image);
49:
50: /**
51: * Sets tool tip text for this status field.
52: *
53: * @param string the new tool tip text or <code>null</code> to clear
54: */
55: void setToolTipText(String string);
56:
57: /**
58: * Sets whether this status field is visible within the status line.
59: *
60: * @param visible <code>true</code> if this item should be visible, <code>false</code> otherwise
61: */
62: void setVisible(boolean visible);
63: }
|