IEditorStatusLine


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

A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame

Popular Tags