/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
- * All rights reserved. This program and the accompanying materials
+ * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
- *
+ *
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.ITextViewerExtension;
import org.eclipse.jface.text.ITextViewerExtension2;
-import org.eclipse.jface.text.ITextViewerExtension3;
+import org.eclipse.jface.text.ITextViewerExtension5;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.Region;
import org.eclipse.jface.text.TextEvent;
public interface ExitListener {
void exit(boolean accept);
}
-
+
public static class ExitFlags {
- public int flags;
+ public int flags;
public boolean doit;
public ExitFlags(int flags, boolean doit) {
this.flags= flags;
this.doit= doit;
- }
+ }
}
-
+
public interface ExitPolicy {
ExitFlags doExit(LinkedPositionManager manager, VerifyEvent event, int offset, int length);
}
-
+
// leave flags
private static final int UNINSTALL= 1; // uninstall linked position manager
public static final int COMMIT= 2; // commit changes
private static final IPreferenceStore fgStore= PHPeclipsePlugin.getDefault().getPreferenceStore();
private static final String CARET_POSITION_PREFIX= "LinkedPositionUI.caret.position"; //$NON-NLS-1$
private static int fgCounter= 0;
-
-
+
+
private final ITextViewer fViewer;
private final LinkedPositionManager fManager;
private final IPositionUpdater fUpdater;
private Position fFramePosition;
private int fInitialOffset= -1;
private int fCaretOffset;
-
+
private ExitPolicy fExitPolicy;
private ExitListener fExitListener;
-
+
private boolean fNeedRedraw;
-
+
private String fContentType;
private Position fPreviousPosition;
// private ContentAssistant2 fAssistant;
- /**
+ /**
* Flag that records the state of this ui object. As there are many different entities that may
* call leave or exit, these cannot always be sure whether the linked position infrastructure is
- * still active. This is especially true for multithreaded situations.
+ * still active. This is especially true for multithreaded situations.
*/
private boolean fIsActive= false;
/**
* Creates a user interface for <code>LinkedPositionManager</code>.
- *
+ *
* @param viewer the text viewer.
* @param manager the <code>LinkedPositionManager</code> managing a <code>IDocument</code> of the <code>ITextViewer</code>.
*/
public LinkedPositionUI(ITextViewer viewer, LinkedPositionManager manager) {
Assert.isNotNull(viewer);
Assert.isNotNull(manager);
-
+
fViewer= viewer;
fManager= manager;
-
+
fPositionCategoryName= CARET_POSITION_PREFIX + (fgCounter++);
fUpdater= new DefaultPositionUpdater(fPositionCategoryName);
-
+
fManager.setLinkedPositionListener(this);
initializeHighlightColor(viewer);
* Returns <code>null</code> if there is no such information available.
*/
private Color createColor(IPreferenceStore store, String key, Display display) {
-
- RGB rgb= null;
-
+
+ RGB rgb= null;
+
if (store.contains(key)) {
-
+
if (store.isDefault(key))
rgb= PreferenceConverter.getDefaultColor(store, key);
else
rgb= PreferenceConverter.getColor(store, key);
-
+
if (rgb != null)
return new Color(display, rgb);
}
-
+
return null;
}
* @param offset
*/
public void setInitialOffset(int offset) {
- fInitialOffset= offset;
+ fInitialOffset= offset;
}
-
+
/**
* Sets the final position of the caret when the linked mode is exited
* successfully by leaving the last linked position using TAB.
* <code>LinkedPositionManager</code>.
*/
public void setFinalCaretOffset(int offset) {
- fFinalCaretOffset= offset;
+ fFinalCaretOffset= offset;
}
/**
public void setCurrentPosition(Position position, int caretOffset) {
if (!fIsActive)
;//JavaPlugin.log(new Status(IStatus.WARNING, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI is not active: "+fPositionCategoryName, new IllegalStateException())); //$NON-NLS-1$
-
+
if (!fFramePosition.equals(position)) {
fNeedRedraw= true;
fFramePosition= position;
/**
* Enters the linked mode. The linked mode can be left by calling
* <code>exit</code>.
- *
+ *
* @see #exit(boolean)
*/
public void enter() {
fIsActive= true;
// JavaPlugin.log(new Status(IStatus.INFO, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI activated: "+fPositionCategoryName, new Exception())); //$NON-NLS-1$
}
-
+
// track final caret
IDocument document= fViewer.getDocument();
fViewer.addTextInputListener(this);
fViewer.addTextListener(this);
-
+
ITextViewerExtension extension= (ITextViewerExtension) fViewer;
extension.prependVerifyKeyListener(this);
- StyledText text= fViewer.getTextWidget();
+ StyledText text= fViewer.getTextWidget();
text.addVerifyListener(this);
text.addModifyListener(this);
text.addPaintListener(this);
Shell shell= text.getShell();
shell.addShellListener(this);
-
+
fFramePosition= (fInitialOffset == -1) ? fManager.getFirstPosition() : fManager.getPosition(fInitialOffset);
if (fFramePosition == null) {
leave(UNINSTALL | COMMIT | UPDATE_CARET);
public IRegion getSelectedRegion() {
if (!fIsActive)
;//JavaPlugin.log(new Status(IStatus.WARNING, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI is not active: "+fPositionCategoryName, new IllegalStateException())); //$NON-NLS-1$
-
+
if (fFramePosition == null)
return new Region(fFinalCaretOffset, 0);
else
return new Region(fFramePosition.getOffset(), fFramePosition.getLength());
}
-
+
private void leave(int flags) {
if (!fIsActive)
;//JavaPlugin.log(new Status(IStatus.WARNING, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI is not active: "+fPositionCategoryName, new IllegalStateException())); //$NON-NLS-1$
fIsActive= false;
//JavaPlugin.log(new Status(IStatus.INFO, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI deactivated: "+fPositionCategoryName, new Exception())); //$NON-NLS-1$
}
-
+
fInitialOffset= -1;
-
+
if ((flags & UNINSTALL) != 0)
fManager.uninstall((flags & COMMIT) != 0);
fgStore.removePropertyChangeListener(this);
-
+
if (fFrameColor != null) {
fFrameColor.dispose();
fFrameColor= null;
- }
-
+ }
+
StyledText text= fViewer.getTextWidget();
// bail out if the styled text is null, meaning the viewer has been disposed (-> document is null as well)
// see pr https://bugs.eclipse.org/bugs/show_bug.cgi?id=46821
if (text == null)
return;
-
+
text.removePaintListener(this);
text.removeModifyListener(this);
text.removeVerifyListener(this);
Shell shell= text.getShell();
shell.removeShellListener(this);
-
+
// if (fAssistant != null) {
// Display display= text.getDisplay();
// if (display != null && !display.isDisposed()) {
ITextViewerExtension extension= (ITextViewerExtension) fViewer;
extension.removeVerifyKeyListener(this);
-
+
IRewriteTarget target= extension.getRewriteTarget();
target.endCompoundChange();
fViewer.removeTextListener(this);
fViewer.removeTextInputListener(this);
-
+
try {
IDocument document= fViewer.getDocument();
{
Position[] positions= document.getPositions(fPositionCategoryName);
if ((positions != null) && (positions.length != 0)) {
-
- if (fViewer instanceof ITextViewerExtension3) {
- ITextViewerExtension3 extension3= (ITextViewerExtension3) fViewer;
+
+ if (fViewer instanceof ITextViewerExtension5) {
+ ITextViewerExtension5 extension3= (ITextViewerExtension5) fViewer;
int widgetOffset= extension3.modelOffset2WidgetOffset(positions[0].getOffset());
if (widgetOffset >= 0)
text.setSelection(widgetOffset, widgetOffset);
-
+
} else {
IRegion region= fViewer.getVisibleRegion();
int offset= positions[0].getOffset() - region.getOffset();
document.removePositionUpdater(fUpdater);
document.removePositionCategory(fPositionCategoryName);
-
+
if (fExitListener != null)
fExitListener.exit(
((flags & COMMIT) != 0) ||
private void next() {
if (!fIsActive)
;//JavaPlugin.log(new Status(IStatus.WARNING, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI is not active: "+fPositionCategoryName, new IllegalStateException())); //$NON-NLS-1$
-
+
redrawRegion();
-
+
if (fFramePosition == fFinalCaretPosition)
fFramePosition= fManager.getFirstPosition();
else
redrawRegion();
}
}
-
+
private void previous() {
if (!fIsActive)
;//JavaPlugin.log(new Status(IStatus.WARNING, JavaPlugin.getPluginId(), IStatus.OK, "LinkedPositionUI is not active: "+fPositionCategoryName, new IllegalStateException())); //$NON-NLS-1$
-
+
redrawRegion();
-
+
fFramePosition= fManager.getPreviousPosition(fFramePosition.getOffset());
if (fFramePosition == null) {
if (fFinalCaretPosition != null)
/** Trigger content assist on choice positions */
// private void triggerContentAssist() {
// if (fFramePosition instanceof ProposalPosition) {
-//
+//
// ProposalPosition pp= (ProposalPosition) fFramePosition;
// initializeContentAssistant();
// if (fAssistant == null)
// fAssistant.setCompletions(new ICompletionProposal[0]);
// }
// }
-
+
/** Lazy initialize content assistant for this linked ui */
// private void initializeContentAssistant() {
// if (fAssistant != null)
if (!event.doit || !fIsActive)
return;
-
+
Point selection= fViewer.getSelectedRange();
int offset= selection.x;
int length= selection.y;
-
+
ExitFlags exitFlags= fExitPolicy == null ? null : fExitPolicy.doExit(fManager, event, offset, length);
if (exitFlags != null) {
leave(UNINSTALL | exitFlags.flags);
event.doit= exitFlags.doit;
return;
}
-
+
switch (event.character) {
// [SHIFT-]TAB = hop between edit boxes
case 0x09:
return;
}
}
-
+
if (event.stateMask == SWT.SHIFT)
previous();
- else
- next();
-
+ else
+ next();
+
event.doit= false;
break;
// event.doit= false;
// break;
// }
-
+
// if enter was treated as a document change, would it exceed variable range?
if (!LinkedPositionManager.includes(fFramePosition, offset, length)
|| (fFramePosition == fFinalCaretPosition)) {
return;
}
}
-
+
leave(UNINSTALL | COMMIT | UPDATE_CARET);
event.doit= false;
break;
leave(UNINSTALL | COMMIT);
event.doit= false;
break;
-
+
case ';':
leave(UNINSTALL | COMMIT);
event.doit= true;
break;
-
+
default:
if (event.character != 0) {
if (!controlUndoBehavior(offset, length) || fFramePosition == fFinalCaretPosition) {
leave(UNINSTALL | COMMIT);
- break;
+ break;
}
}
}
}
-
+
private boolean controlUndoBehavior(int offset, int length) {
-
+
Position position= fManager.getEmbracingPosition(offset, length);
if (position != null) {
-
+
ITextViewerExtension extension= (ITextViewerExtension) fViewer;
IRewriteTarget target= extension.getRewriteTarget();
-
+
if (fPreviousPosition != null && !fPreviousPosition.equals(position))
target.endCompoundChange();
target.beginCompoundChange();
}
-
+
fPreviousPosition= position;
return fPreviousPosition != null;
}
-
+
/*
* @see VerifyListener#verifyText(VerifyEvent)
*/
public void verifyText(VerifyEvent event) {
if (!event.doit)
return;
-
-
+
+
int offset= 0;
int length= 0;
-
- if (fViewer instanceof ITextViewerExtension3) {
- ITextViewerExtension3 extension= (ITextViewerExtension3) fViewer;
+
+ if (fViewer instanceof ITextViewerExtension5) {
+ ITextViewerExtension5 extension= (ITextViewerExtension5) fViewer;
IRegion modelRange= extension.widgetRange2ModelRange(new Region(event.start, event.end - event.start));
if (modelRange == null)
return;
-
+
offset= modelRange.getOffset();
length= modelRange.getLength();
-
+
} else {
IRegion visibleRegion= fViewer.getVisibleRegion();
offset= event.start + visibleRegion.getOffset();
length= event.end - event.start;
}
-
+
// allow changes only within linked positions when coming through UI
if (!fManager.anyPositionIncludes(offset, length))
leave(UNINSTALL | COMMIT);
/*
* @see PaintListener#paintControl(PaintEvent)
*/
- public void paintControl(PaintEvent event) {
+ public void paintControl(PaintEvent event) {
if (fFramePosition == null)
return;
-
+
IRegion widgetRange= asWidgetRange(fFramePosition);
if (widgetRange == null) {
leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
int length= widgetRange.getLength();
StyledText text= fViewer.getTextWidget();
-
+
// support for bidi
Point minLocation= getMinimumLocation(text, offset, length);
Point maxLocation= getMaximumLocation(text, offset, length);
int x1= minLocation.x;
int x2= minLocation.x + maxLocation.x - minLocation.x - 1;
int y= minLocation.y + text.getLineHeight() - 1;
-
+
GC gc= event.gc;
gc.setForeground(fFrameColor);
gc.drawLine(x1, y, x2, y);
}
-
+
protected IRegion asWidgetRange(Position position) {
- if (fViewer instanceof ITextViewerExtension3) {
-
- ITextViewerExtension3 extension= (ITextViewerExtension3) fViewer;
+ if (fViewer instanceof ITextViewerExtension5) {
+
+ ITextViewerExtension5 extension= (ITextViewerExtension5) fViewer;
return extension.modelRange2WidgetRange(new Region(position.getOffset(), position.getLength()));
-
+
} else {
-
+
IRegion region= fViewer.getVisibleRegion();
if (includes(region, position))
return new Region(position.getOffset() - region.getOffset(), position.getLength());
}
-
+
return null;
}
for (int i= 0; i <= length; i++) {
Point location= text.getLocationAtOffset(offset + i);
-
+
if (location.x < minLocation.x)
- minLocation.x= location.x;
+ minLocation.x= location.x;
if (location.y < minLocation.y)
- minLocation.y= location.y;
- }
-
+ minLocation.y= location.y;
+ }
+
return minLocation;
}
for (int i= 0; i <= length; i++) {
Point location= text.getLocationAtOffset(offset + i);
-
+
if (location.x > maxLocation.x)
- maxLocation.x= location.x;
+ maxLocation.x= location.x;
if (location.y > maxLocation.y)
- maxLocation.y= location.y;
- }
-
+ maxLocation.y= location.y;
+ }
+
return maxLocation;
}
IRegion widgetRange= asWidgetRange(fFramePosition);
if (widgetRange == null) {
leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
- return;
+ return;
}
-
+
StyledText text= fViewer.getTextWidget();
- if (text != null && !text.isDisposed())
+ if (text != null && !text.isDisposed())
text.redrawRange(widgetRange.getOffset(), widgetRange.getLength(), true);
}
private void selectRegion() {
-
+
IRegion widgetRange= asWidgetRange(fFramePosition);
if (widgetRange == null) {
leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
- return;
+ return;
}
StyledText text= fViewer.getTextWidget();
text.setSelection(start, end);
}
}
-
+
private void updateCaret() {
-
+
IRegion widgetRange= asWidgetRange(fFramePosition);
if (widgetRange == null) {
leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
- return;
+ return;
}
-
+
int offset= widgetRange.getOffset() + fCaretOffset;
StyledText text= fViewer.getTextWidget();
if (text != null && !text.isDisposed())
/*
* @see ModifyListener#modifyText(ModifyEvent)
- */
+ */
public void modifyText(ModifyEvent e) {
// reposition caret after StyledText
redrawRegion();
public void textChanged(TextEvent event) {
if (!fNeedRedraw)
return;
-
+
redrawRegion();
fNeedRedraw= false;
}
// don't deactivate on focus lost, since the proposal popups may take focus
// plus: it doesn't hurt if you can check with another window without losing linked mode
// since there is no intrusive popup sticking out.
-
+
// need to check first what happens on reentering based on an open action
// Seems to be no problem
-
+
// TODO check whether we can leave it or uncomment it after debugging
// PS: why DOCUMENT_CHANGED? We want to trigger a redraw! (Shell deactivated does not mean
// it is not visible any longer.
// leave(UNINSTALL | COMMIT | DOCUMENT_CHANGED);
-
+
// Better:
- // Check with content assistant and only leave if its not the proposal shell that took the
+ // Check with content assistant and only leave if its not the proposal shell that took the
// focus away.
-
+
StyledText text;
Display display;
-// if (fAssistant == null || fViewer == null || (text= fViewer.getTextWidget()) == null
+// if (fAssistant == null || fViewer == null || (text= fViewer.getTextWidget()) == null
// || (display= text.getDisplay()) == null || display.isDisposed()) {
- if ( fViewer == null || (text= fViewer.getTextWidget()) == null
+ if ( fViewer == null || (text= fViewer.getTextWidget()) == null
|| (display= text.getDisplay()) == null || display.isDisposed()) {
leave(UNINSTALL | COMMIT);
} else {
git://git.phpeclipse.com / phpeclipse.git / blobdiff