Eclipse Plug-in Developer Guide (Galileo) - IMergeViewerContentProvider (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.compare.contentmergeviewer
Interface IMergeViewerContentProvider

All Superinterfaces:: IContentProvider

public interface IMergeViewerContentProvider
extends IContentProvider
extends IContentProvider

A content provider that mediates between a ContentMergeViewer's model and the viewer itself.

Clients may implement this interface.

See Also:: ContentMergeViewer

Method Summary

Object getAncestorContent ( Object input)
          Returns the contents for the ancestor side of a ContentMergeViewer.

Image getAncestorImage ( Object input)
          Returns an optional image for the ancestor side of a ContentMergeViewer.

String getAncestorLabel ( Object input)
          Returns the label for the ancestor side of a ContentMergeViewer.

Object getLeftContent ( Object input)
          Returns the contents for the left side of a ContentMergeViewer.

Image getLeftImage ( Object input)
          Returns an optional image for the left side of a ContentMergeViewer.

String getLeftLabel ( Object input)
          Returns the label for the left side of a ContentMergeViewer.

Object getRightContent ( Object input)
          Returns the contents for the right side of a ContentMergeViewer.

Image getRightImage ( Object input)
          Returns an optional image for the right side of a ContentMergeViewer.

String getRightLabel ( Object input)
          Returns the label for the right side of a ContentMergeViewer.

boolean isLeftEditable ( Object input)
          Returns whether the left side is editable.

boolean isRightEditable ( Object input)
          Returns whether the right side is editable.

void saveLeftContent ( Object input, byte[] bytes)
          Saves new contents for the left side of the ContentMergeViewer.

void saveRightContent ( Object input, byte[] bytes)
          Saves new contents for the right side of the ContentMergeViewer.

boolean showAncestor ( Object input)
          Returns whether the ancestor side of the given input element should be shown.

Methods inherited from interface org.eclipse.jface.viewers. IContentProvider

dispose, inputChanged

Method Detail

getAncestorLabel


String getAncestorLabel(
Object input)

Returns the label for the ancestor side of a ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the label for the ancestor side of a ContentMergeViewer

getAncestorImage


Image getAncestorImage(
Object input)

Returns an optional image for the ancestor side of a ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the image for the ancestor side of a ContentMergeViewer, or null if none

getAncestorContent


Object getAncestorContent(
Object input)

Returns the contents for the ancestor side of a ContentMergeViewer. The interpretation of the returned object depends on the concrete ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the content for the ancestor side of a ContentMergeViewer, or null if none

showAncestor

boolean showAncestor(
Object input)

Returns whether the ancestor side of the given input element should be shown.

Parameters:: input - the merge viewer's input
Returns:: true if the ancestor side of the given input element should be shown

getLeftLabel


String getLeftLabel(
Object input)

Returns the label for the left side of a ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the label for the left side of a ContentMergeViewer

getLeftImage


Image getLeftImage(
Object input)

Returns an optional image for the left side of a ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the image for the left side of a ContentMergeViewer, or null if none

getLeftContent


Object getLeftContent(
Object input)

Returns the contents for the left side of a ContentMergeViewer. The interpretation of the returned object depends on the concrete ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the content for the left side of a ContentMergeViewer, or null if none

isLeftEditable

boolean isLeftEditable(
Object input)

Returns whether the left side is editable.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: true if the left side of a ContentMergeViewer is editable

saveLeftContent

void saveLeftContent(
Object input,
                     byte[] bytes)

Saves new contents for the left side of the ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer; bytes - the new contents to save for the left side

getRightLabel


String getRightLabel(
Object input)

Returns the label for the right side of a ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the label for the right side of a ContentMergeViewer

getRightImage


Image getRightImage(
Object input)

Returns an optional image for the right side of a ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the image for the right side of a ContentMergeViewer, or null if none

getRightContent


Object getRightContent(
Object input)

Returns the contents for the right side of a ContentMergeViewer. The interpretation of the returned object depends on the concrete ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: the content for the right side of a ContentMergeViewer, or null if none

isRightEditable

boolean isRightEditable(
Object input)

Returns whether the right side is editable.

Parameters:: input - the input object of the ContentMergeViewer
Returns:: true if the right side of a ContentMergeViewer is editable

saveRightContent

void saveRightContent(
Object input,
                      byte[] bytes)

Saves new contents for the right side of the ContentMergeViewer.

Parameters:: input - the input object of the ContentMergeViewer; bytes - the new contents to save for the right side