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: * An interface to use the status line of an editor.
16: *
17: * @since 2.1
18: */
19: public interface IEditorStatusLine {
20: /**
21: * Sets the image and message to be displayed on the status line.
22: * <p>
23: * The error flag indicates that the message is an error message.
24: * If the error flag is set, a potential non-error message is overridden.
25: * If the error message is <code>null</code>, the non-error message is displayed.
26: * </p>
27: *
28: * @param error indicates that the message is an error message
29: * @param message the message to set (may be <code>null</code> to clear the message)
30: * @param image the image to set (may be <code>null</code> to clear the image)
31: */
32: void setMessage(boolean error, String message, Image image);
33:
34: }
|