Eclipse Platform
Release 3.0

Package org.eclipse.jface.text.link

Application programming interfaces for interaction with the Eclipse Java User Interface text support.

See:
          Description

Interface Summary
ILinkedModeListener Protocol used by LinkedModeModels to communicate state changes, such as leaving linked mode, suspending it due to a child mode coming up, and resuming after a child mode has left.
LinkedModeUI.IExitPolicy An exit policy can be registered by a caller to get custom exit behavior.
LinkedModeUI.ILinkedModeUIFocusListener Listener that gets notified when the linked mode UI switches its focus position.
 

Class Summary
InclusivePositionUpdater Position updater that takes any change in [position.offset, position.offset + position.length] as belonging to the position.
LinkedModeModel A LinkedModeModel umbrellas several LinkedPositionGroups.
LinkedModeUI The UI for linked mode.
LinkedModeUI.ExitFlags Exit flags returned if a custom exit policy wants to exit linked mode.
LinkedModeUI.LinkedModeUITarget A link target consists of a viewer and gets notified if the linked mode UI on it is being shown.
LinkedPosition A Position on a document that knows which document it is registered with and has a sequence number for tab stops.
LinkedPositionGroup A group of positions in multiple documents that are simultaneously modified - if one gets edited, all other positions in a PositionGroup are edited the same way.
ProposalPosition LinkedPosition with added completion proposals.
 

Package org.eclipse.jface.text.link Description

Application programming interfaces for interaction with the Eclipse Java User Interface text support.

Linked Position Infrastructure

package org.eclipse.jface.text.link

The Linked Position Infrastructure lets one set up a mode in an editor in which regions in a document (or several documents) are linked, i.e. editions of one linked position will be reflected in the others.

Classes

Example

	IDocument doc1, doc2;
ITextViewer viewer1, viewer2;

/* create groups - this step is independent of the linked mode */
LinkedPositionGroup group1= new LinkedPositionGroup();
group1.addPosition(new LinkedPosition(doc1, 3, 4));
group1.addPosition(new LinkedPosition(doc1, 7, 8));

LinkedPositionGroup group2= new LinkedPositionGroup();
group2.addPosition(new LinkedPosition(doc1, 15, 25));
group2.addPosition(new LinkedPosition(doc2, 0, 10));

/* set up linked mode */
LinkedModeModel model= new LinkedModeModel();
model.addGroup(group1);
model.addGroup(group2);
model.forceInstall();

/* create UI */
LinkedModeUI ui= new LinkedModeUI(model, new ITextViewer[] { viewer1, viewer2 });
ui.enter();


Eclipse Platform
Release 3.0

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.