KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > jface > text > source > IChangeRulerColumn


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.jface.text.source;
12
13 import org.eclipse.swt.graphics.Color;
14
15 /**
16  * An <code>IChangeRulerColumn</code> can display quick diff information.
17  *
18  * @since 3.0
19  */
20 public interface IChangeRulerColumn extends IVerticalRulerColumn, IVerticalRulerInfoExtension {
21
22     /** The ID under which the quick diff model is registered with a document's annotation model. */
23     public static final String JavaDoc QUICK_DIFF_MODEL_ID= "diff"; //$NON-NLS-1$
24
25     /**
26      * Sets the hover of this ruler column.
27      *
28      * @param hover the hover that will produce hover information text for this ruler column
29      */
30     public abstract void setHover(IAnnotationHover hover);
31
32     /**
33      * Sets the background color for normal lines. The color has to be disposed of by the caller when
34      * the receiver is no longer used.
35      *
36      * @param backgroundColor the new color to be used as standard line background
37      */
38     public abstract void setBackground(Color backgroundColor);
39
40     /**
41      * Sets the background color for added lines. The color has to be disposed of by the caller when
42      * the receiver is no longer used.
43      *
44      * @param addedColor the new color to be used for the added lines background
45      */
46     public abstract void setAddedColor(Color addedColor);
47
48     /**
49      * Sets the background color for changed lines. The color has to be disposed of by the caller when
50      * the receiver is no longer used.
51      *
52      * @param changedColor the new color to be used for the changed lines background
53      */
54     public abstract void setChangedColor(Color changedColor);
55
56     /**
57      * Sets the color for the deleted lines indicator. The color has to be disposed of by the caller when
58      * the receiver is no longer used.
59      *
60      * @param deletedColor the new color to be used for the deleted lines indicator.
61      */
62     public abstract void setDeletedColor(Color deletedColor);
63 }
64
Popular Tags