KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > part > components > services > IStatusHandler


1 /*******************************************************************************
2  * Copyright (c) 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ui.internal.part.components.services;
12
13 import org.eclipse.core.runtime.IStatus;
14 import org.eclipse.jface.resource.ImageDescriptor;
15
16 /**
17  * Allows a part to report its current status. Status messages remain until they are
18  * explicitly cleared or overwritten.
19  *
20  * @since 3.1
21  */
22 public interface IStatusHandler {
23     /**
24      * Sets or clears the current status message, replacing any existing status message.
25      *
26      * @param message new status message, or null to clear
27      * @param image custom image to be displayed next to the status message, or null
28      * to clear. The receiver may ignore the image if it is not capable of associating
29      * images with status messages.
30      */
31     public void set(IStatus message, ImageDescriptor image);
32 }
33
Popular Tags