ICompareInputLabelProvider


1   /*******************************************************************************
2    * Copyright (c) 2006 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.compare;
12  
13  import org.eclipse.jface.viewers.ILabelProvider;
14  import org.eclipse.swt.graphics.Image;
15  
16  /**
17   * A label provider that provides the label and image for the left, right and 
18   * ancestor sides for a compare input being shown in compare/merge viewers.
19   * <p>
20   * This interface may be implemented by clients.
21   * 
22   * @since 3.3
23   */
24  public interface ICompareInputLabelProvider extends ILabelProvider {
25  
26      /**
27       * Returns the label for the ancestor side of compare/merge viewers.
28       * This label is typically shown in the title of the ancestor area in a compare viewer.
29       *
30       * @param input the input object of a compare/merge viewer or <code>null</code>
31       * @return the label for the ancestor side or <code>null</code>
32       */
33      String   getAncestorLabel(Object   input);
34      
35      /**
36       * Returns the image for the ancestor side of compare/merge viewers.
37       * This image is typically shown in the title of the ancestor area in a compare viewer.
38       *
39       * @param input the input object of a compare/merge viewer or <code>null</code>
40       * @return the image for the ancestor side or <code>null</code>
41       */ 
42      Image getAncestorImage(Object   input);
43      
44      /**
45       * Returns the label for the left hand side of compare/merge viewers.
46       * This label is typically shown in the title of the left side of a compare viewer.
47       *
48       * @param input the input object of a compare/merge viewer or <code>null</code>
49       * @return the label for the left hand side or <code>null</code>
50       */
51      String   getLeftLabel(Object   input);
52      
53      /**
54       * Returns the image for the left hand side of compare/merge viewers.
55       * This image is typically shown in the title of the left side of a compare viewer.
56       *
57       * @param input the input object of a compare/merge viewer or <code>null</code>
58       * @return the image for the left hand side or <code>null</code>
59       */ 
60      Image getLeftImage(Object   input);
61      
62      /**
63       * Returns the label for the right hand side of compare/merge viewers.
64       * This label is typically shown in the title of the right side of a compare viewer.
65       *
66       * @param input the input object of a compare/merge viewer or <code>null</code>
67       * @return the label for the right hand side or <code>null</code>
68       */
69      String   getRightLabel(Object   input);
70      
71      /**
72       * Returns the image for the right hand side of compare/merge viewers.
73       * This image is typically shown in the title of the right side of a compare viewer.
74       *
75       * @param input the input object of a compare/merge viewer or <code>null</code>
76       * @return the image for the right hand side or <code>null</code>
77       */
78      Image getRightImage(Object   input);
79  }
80
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags