KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > de > uka > ipd > coverage > plugin > ui > IField


1 package de.uka.ipd.coverage.plugin.ui;
2
3
4 /*******************************************************************************
5  * Copyright (c) 2000, 2003 IBM Corporation and others.
6  * All rights reserved. This program and the accompanying materials
7  * are made available under the terms of the Common Public License v1.0
8  * which accompanies this distribution, and is available at
9  * http://www.eclipse.org/legal/cpl-v10.html
10  *
11  * Contributors:
12  * IBM Corporation - initial API and implementation
13  *******************************************************************************/

14
15 import org.eclipse.swt.graphics.Image;
16
17 public interface IField {
18
19     /**
20      * @return the description of the field.
21      */

22     String JavaDoc getDescription();
23
24     /**
25      * @return the image associated with the description of the field or <code>null<code>.
26      */

27     Image getDescriptionImage();
28     
29     /**
30      * @return The text to be displayed in the column header for this field.
31      */

32     String JavaDoc getColumnHeaderText();
33     
34     /**
35      * @return The image to be displayed in the column header for this field or <code>null<code>.
36      */

37     Image getColumnHeaderImage();
38     
39     /**
40      * @param obj
41      * @return The String value of the object for this particular field to be displayed to the user.
42      */

43     String JavaDoc getValue(Object JavaDoc obj);
44
45     /**
46      * @param obj
47      * @return The image value of the object for this particular field to be displayed to the user
48      * or <code>null<code>.
49      */

50     Image getImage(Object JavaDoc obj);
51     
52     /**
53      * @param obj1
54      * @param obj2
55      * @return Either:
56      * <li>a negative number if the value of obj1 is less than the value of obj2 for this field.
57      * <li><code>0</code> if the value of obj1 and the value of obj2 are equal for this field.
58      * <li>a positive number if the value of obj1 is greater than the value of obj2 for this field.
59      */

60     int compare(Object JavaDoc obj1, Object JavaDoc obj2);
61 }
62
Popular Tags