+ * The view listens to selection changes both in the (1)workbench, to + * know when the user changes between the instances of the PHPEditor + * or when a new instance is created; and in the (2)PHPEditor, to know + * when the user changes the cursor position. This explains the need + * to implement both ISelectionListener and ISelectionListenerWithAST. *
- * The view uses a label provider to define how model - * objects should be presented in the view. Each - * view can present the same model objects using - * different labels and icons, if needed. Alternatively, - * a single label provider can be shared between views - * in order to ensure that objects of the same type are - * presented in the same way everywhere. + * Up to now, the ViewPart show reference pages from HTML stored in the + * doc.zip file from the net.sourceforge.phpeclipse.phphelp plugin. It + * also depends on net.sourceforge.phpeclipse.phpmanual.htmlparser to + * parse these HTML files. *
+ * @author scorphus */ +public class PHPManualView extends ViewPart implements ISelectionListener, ISelectionListenerWithAST { -public class PHPManualView extends ViewPart implements ISelectionListenerWithAST { + /** + * The ViewPart's browser + */ private Browser browser; - private Action action1; - private Action action2; - private PHPEditor phpEditor; + + /** + * A reference to store last active editor to know when we've + * got a new instance of the PHPEditor + */ + private PHPEditor lastEditor; + + /** + * The path to the doc.zip file containing the PHP Manual + * in HTML format + */ private final Path docPath = new Path("doc.zip"); /** @@ -86,30 +83,41 @@ public class PHPManualView extends ViewPart implements ISelectionListenerWithAST } /** - * Initializes the view + * This method initializes the ViewPart. It instantiates components + * and add listeners + * + * @param parent The parent control */ public void createPartControl(Composite parent) { browser = new Browser(parent, SWT.NONE); parent.pack(); - phpEditor = getJavaEditor(); - makeActions(); - hookContextMenu(); - SelectionListenerWithASTManager.getDefault().addListener(phpEditor, this); - if (phpEditor.getSelectionProvider() != null) { - ISelection its = phpEditor.getSelectionProvider().getSelection(); - SelectionListenerWithASTManager.getDefault().forceSelectionChange( - phpEditor, (ITextSelection) its); + if ((lastEditor = getJavaEditor()) != null) { + SelectionListenerWithASTManager.getDefault().addListener(lastEditor, this); } + getSite().getWorkbenchWindow().getSelectionService() + .addSelectionListener(PHPeclipsePlugin.EDITOR_ID, this); } - /* (non-Javadoc) - * @see net.sourceforge.phpdt.internal.ui.viewsupport.ISelectionListenerWithAST#selectionChanged() + /** + * Cleanup to remove the selection listener + */ + public void dispose() { + getSite().getWorkbenchWindow().getSelectionService() + .removeSelectionListener(PHPeclipsePlugin.EDITOR_ID, this); + } + + /** + * Passing the focus request to the viewer's control. + */ + public void setFocus() { + browser.setFocus(); + } + + /** + * Treats selection changes from the PHPEditor */ public void selectionChanged(IEditorPart part, ITextSelection selection) { - if (getJavaEditor() != null) { - phpEditor = getJavaEditor(); - } - IDocument document = phpEditor.getViewer().getDocument(); + IDocument document = ((PHPEditor)part).getViewer().getDocument(); int offset = selection.getOffset(); IRegion iRegion = JavaWordFinder.findWord(document, offset); try { @@ -117,12 +125,22 @@ public class PHPManualView extends ViewPart implements ISelectionListenerWithAST iRegion.getLength()); showReference(wordStr); } catch (Exception e) { - // TODO Auto-generated catch block e.printStackTrace(); } } /** + * Treats selection changes from the workbench. When part is new + * instance of PHPEditor it gets a listener attached + */ + public void selectionChanged(IWorkbenchPart part, ISelection selection) { + if (!((PHPEditor)part).equals(lastEditor)) { + SelectionListenerWithASTManager.getDefault().addListener((PHPEditor)part, this); + lastEditor = (PHPEditor)part; + } + } + + /** * Updates the browser with the reference page for a given function * * @param funcName Function name @@ -141,55 +159,6 @@ public class PHPManualView extends ViewPart implements ISelectionListenerWithAST }).start(); } - private void hookContextMenu() { - MenuManager menuMgr = new MenuManager("#PopupMenu"); - menuMgr.setRemoveAllWhenShown(true); - menuMgr.addMenuListener(new IMenuListener() { - public void menuAboutToShow(IMenuManager manager) { - PHPManualView.this.fillContextMenu(manager); - } - }); -// Menu menu = menuMgr.createContextMenu(viewer.getControl()); -// viewer.getControl().setMenu(menu); -// getSite().registerContextMenu(menuMgr, viewer); - } - - private void fillContextMenu(IMenuManager manager) { - manager.add(action1); - manager.add(action2); - // Other plug-ins can contribute there actions here - manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS)); - } - - private void makeActions() { - action1 = new Action() { - public void run() { - showMessage("Action 1 executed"); - } - }; - action1.setText("Action 1"); - action1.setToolTipText("Action 1 tooltip"); - action1.setImageDescriptor(PlatformUI.getWorkbench().getSharedImages(). - getImageDescriptor(ISharedImages.IMG_OBJS_INFO_TSK)); - - action2 = new Action() { - public void run() { - showMessage("Action 2 executed"); - } - }; - action2.setText("Action 2"); - action2.setToolTipText("Action 2 tooltip"); - action2.setImageDescriptor(PlatformUI.getWorkbench().getSharedImages(). - getImageDescriptor(ISharedImages.IMG_OBJS_INFO_TSK)); - } - - private void showMessage(String message) { -// MessageDialog.openInformation( -// viewer.getControl().getShell(), -// "%phpManualView", -// message); - } - /** * Filters the function's reference page extracting only parts of it * @@ -221,7 +190,6 @@ public class PHPManualView extends ViewPart implements ISelectionListenerWithAST return output.toString().replace("â", "-"); //.replace("
null if it
* cannot be determined.
*
@@ -317,7 +277,6 @@ public class PHPManualView extends ViewPart implements ISelectionListenerWithAST
else
return null;
} catch (Exception e) {
- e.printStackTrace();
return null;
}
}