Java tutorial
/******************************************************************************* * Copyright (c) 2010 JVM Monitor project. All rights reserved. * * This code is distributed under the terms of the Eclipse Public License v1.0 * which is available at http://www.eclipse.org/legal/epl-v10.html *******************************************************************************/ package org.jboss.tools.jmx.jvmmonitor.internal.ui.properties; import java.lang.reflect.Field; import org.eclipse.core.runtime.IStatus; import org.eclipse.jface.action.IAction; import org.eclipse.jface.action.IContributionItem; import org.eclipse.jface.action.IMenuManager; import org.eclipse.jface.action.IStatusLineManager; import org.eclipse.jface.action.IToolBarManager; import org.eclipse.jface.action.StatusLineContributionItem; import org.eclipse.jface.util.Util; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.swt.SWT; import org.eclipse.swt.layout.FillLayout; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.layout.GridLayout; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Sash; import org.eclipse.ui.IActionBars; import org.eclipse.ui.IViewSite; import org.eclipse.ui.IWorkbenchPage; import org.eclipse.ui.IWorkbenchPart; import org.eclipse.ui.IWorkbenchWindow; import org.eclipse.ui.PlatformUI; import org.eclipse.ui.forms.events.HyperlinkAdapter; import org.eclipse.ui.forms.events.HyperlinkEvent; import org.eclipse.ui.forms.widgets.FormToolkit; import org.eclipse.ui.forms.widgets.Hyperlink; import org.eclipse.ui.part.PageBook; import org.eclipse.ui.part.PageSite; import org.eclipse.ui.views.properties.PropertySheet; import org.eclipse.ui.views.properties.tabbed.AbstractPropertySection; import org.eclipse.ui.views.properties.tabbed.TabbedPropertySheetPage; import org.jboss.tools.jmx.jvmmonitor.core.IActiveJvm; import org.jboss.tools.jmx.jvmmonitor.core.IJvmFacade; import org.jboss.tools.jmx.jvmmonitor.core.IJvmModelChangeListener; import org.jboss.tools.jmx.jvmmonitor.core.JvmModel; import org.jboss.tools.jmx.jvmmonitor.core.JvmModelEvent; import org.jboss.tools.jmx.jvmmonitor.core.JvmModelEvent.State; import org.jboss.tools.jmx.jvmmonitor.internal.ui.actions.PreferencesAction; import org.jboss.tools.jmx.jvmmonitor.ui.Activator; /** * The abstract property section for JVM. */ abstract public class AbstractJvmPropertySection extends AbstractPropertySection implements IJvmModelChangeListener { /** The URL for FAQ page. */ private static final String FAQ_URL = "/org.jvmmonitor.doc/faq.html#Cannot_Connect_to_JVM"; //$NON-NLS-1$ /** The page book. */ private PageBook pageBook; /** The message page. */ private Composite messagePage; /** The message label. */ private Label messageLabel; /** The hyper link to FAQ page. */ private Hyperlink faqHyperlink; /** The content page. */ private Composite contentPage; /** The active JVM. */ private IActiveJvm jvm; /** The state indicating if suspending refresh. */ private boolean suspendRefresh; /** The part listener. */ private PartListener partListener; /** The property sheet. */ PropertySheet propertySheet; /** The perspective listener. */ private PerspectiveListener perspectiveListener; /** The preferences action. */ IAction preferencesAction; /** The state indicating if section is activated. */ protected boolean isSectionActivated; @SuppressWarnings("unused") private TabbedPropertySheetPage tabbedPropertySheetPage; /** * The constructor. */ public AbstractJvmPropertySection() { preferencesAction = new PreferencesAction(); } /* * @see AbstractPropertySection#createControls(Composite, * TabbedPropertySheetPage) */ @Override public final void createControls(Composite parent, final TabbedPropertySheetPage tabbedPropertySheetPage) { super.createControls(parent, tabbedPropertySheetPage); parent.setLayoutData(new GridData(GridData.FILL_BOTH)); pageBook = new PageBook(parent, SWT.NONE); messagePage = createMessagePage(pageBook); contentPage = new Composite(pageBook, SWT.NONE); contentPage.setLayout(new FillLayout()); pageBook.showPage(contentPage); propertySheet = getPropertySheet((PageSite) tabbedPropertySheetPage.getSite()); createControls(contentPage); partListener = new PartListener(this, tabbedPropertySheetPage); perspectiveListener = new PerspectiveListener(this, tabbedPropertySheetPage.getSite(), propertySheet); JvmModel.getInstance().addJvmModelChangeListener(this); suspendRefresh = false; } /* * @see AbstractPropertySection#dispose() */ @Override public void dispose() { if (partListener != null) { partListener.dispose(); } if (perspectiveListener != null) { perspectiveListener.dispose(); } JvmModel.getInstance().removeJvmModelChangeListener(this); } /* * @see AbstractPropertySection#setInput(IWorkbenchPart, ISelection) */ @Override public final void setInput(IWorkbenchPart part, ISelection selection) { super.setInput(part, selection); if (!(selection instanceof StructuredSelection)) { return; } StructuredSelection structuredSelection = (StructuredSelection) selection; Object firstElement = structuredSelection.getFirstElement(); IActiveJvm newJvm = null; if (firstElement instanceof IActiveJvm) { newJvm = (IActiveJvm) firstElement; } else if (firstElement instanceof IJvmFacade) { IJvmFacade facade = (IJvmFacade) firstElement; newJvm = facade.getActiveJvm(); } if (newJvm == null) { super.setInput(part, null); return; } IActiveJvm oldJvm = jvm; jvm = newJvm; if (oldJvm != newJvm || newJvm.isConnected()) { updatePage(); } addToolBarActions(); addLocalMenus(); getActionBars().updateActionBars(); if (newJvm.isConnected()) { activateSection(); } setInput(part, selection, newJvm, oldJvm); } /* * @see AbstractPropertySection#aboutToBeHidden() */ @Override final public void aboutToBeHidden() { //if (isFocused() || !propertySheet.isPinned()) { // hidden by selecting another tab deactivateSection(); //} } /* * @see AbstractPropertySection#aboutToBeShown() */ @Override final public void aboutToBeShown() { activateSection(); } /* * @see IJvmModelChangeListener#jvmModelChanged(JvmModelEvent) */ @Override public void jvmModelChanged(final JvmModelEvent e) { if (e.state != State.JvmModified && e.state != State.JvmConnected && e.state != State.JvmDisconnected) { return; } // note that setInput() is invoked only when section is activated if (!isSectionActivated && !propertySheet.isPinned()) { jvm = (IActiveJvm) e.jvm; return; } if (e.state == State.JvmDisconnected) { Display.getDefault().asyncExec(new Runnable() { @Override public void run() { propertySheet.getCurrentPage().getControl().forceFocus(); } }); } if (pageBook.isDisposed() || contentPage.isDisposed() || messagePage.isDisposed() || messageLabel.isDisposed() || jvm == null || e.jvm.getPid() != jvm.getPid()) { return; } Display.getDefault().asyncExec(new Runnable() { @Override public void run() { if (e.state == State.JvmDisconnected) { propertySheet.setPinned(false); } else if (e.state == State.JvmConnected) { updatePage(); propertySheet.setPinned(false); } refresh(); } }); } /** * Suspends the refresh. * * @param suspend * True if suspending refresh */ public void suspendRefresh(boolean suspend) { suspendRefresh = suspend; } /** * Gets the active JVM. * * @return The active JVM */ public IActiveJvm getJvm() { return jvm; } /** * Gets the state indicating if refresh is suspended. * * @return True if refresh is suspended */ public boolean isRefreshSuspended() { return suspendRefresh; } /** * Gets the state indicating if error message is shown. * * @return True if error message is shown */ public boolean hasErrorMessage() { if (!messageLabel.isDisposed()) { return !messageLabel.getText().isEmpty(); } return false; } /** * Refreshes the background of given control with given color. * * @param control * The control * @param jvmConnected * The state indicating if JVM is connected */ public void refreshBackground(final Control control, boolean jvmConnected) { final int color; if (jvmConnected) { color = SWT.COLOR_LIST_BACKGROUND; } else { color = SWT.COLOR_WIDGET_BACKGROUND; } if (!control.isDisposed() && !(control instanceof Sash) && !(control instanceof Label)) { control.setBackground(Display.getDefault().getSystemColor(color)); } } /** * Refreshes the background of given controls and its child controls with * given color. * * @param controls * The controls * @param jvmConnected * The state indicating if JVM is connected */ public void refreshBackground(Control[] controls, boolean jvmConnected) { for (Control control : controls) { if (control.isDisposed()) { continue; } refreshBackground(control, jvmConnected); if (control instanceof Composite) { refreshBackground(((Composite) control).getChildren(), jvmConnected); } } } /** * Clears the status line. */ public void clearStatusLine() { IStatusLineManager manager = propertySheet.getViewSite().getActionBars().getStatusLineManager(); IContributionItem[] items = manager.getItems(); for (IContributionItem item : items) { if (item instanceof StatusLineContributionItem) { ((StatusLineContributionItem) item).setText(Util.ZERO_LENGTH_STRING); } } } /** * Gets the action bars. * * @return The action bars. */ public IActionBars getActionBars() { return propertySheet.getViewSite().getActionBars(); } /** * Gets the property sheet. * * @return The property sheet */ public PropertySheet getPropertySheet() { return propertySheet; } /** * Sets pinned. * * @param pinned * <tt>true</tt> to set pinned */ public void setPinned(final boolean pinned) { Display.getDefault().asyncExec(new Runnable() { @Override public void run() { propertySheet.setPinned(pinned); } }); } /** * Notifies that the part is closed. */ protected void partClosed() { // do nothing } /** * Deactivates the section. */ protected void deactivateSection() { isSectionActivated = false; if (pageBook.isDisposed() || messagePage.isDisposed() || messageLabel.isDisposed()) { return; } // remove tool bar actions IToolBarManager toolBarManager = getToolBarManager(); if (toolBarManager != null) { removeToolBarActions(toolBarManager); toolBarManager.update(false); updateActionBars(); } // remove local menus IMenuManager menuManager = getMenuManager(); if (menuManager != null) { menuManager.remove(preferencesAction.getId()); removeLocalMenus(menuManager); menuManager.update(false); updateActionBars(); } // clear status line clearStatusLine(); } /** * Activates the section. */ protected void activateSection() { isSectionActivated = true; addToolBarActions(); addLocalMenus(); getActionBars().updateActionBars(); } /** * Gets the property sheet id. * * @return The property sheet id */ protected String getPropertySheetId() { return propertySheet.toString(); } /** * Adds the tool bar actions. * * @param manager * The toolbar manager */ protected void addToolBarActions(IToolBarManager manager) { // do nothing } /** * Removes the tool bar actions. * * @param manager * The toolbar manager */ protected void removeToolBarActions(IToolBarManager manager) { // do nothing } /** * Adds the local menus. * * @param manager * The menu manager */ protected void addLocalMenus(IMenuManager manager) { // do nothing } /** * Removes the local menus. * * @param manager * The menu manager */ protected void removeLocalMenus(IMenuManager manager) { // do nothing } /** * Updates the page. */ protected void updatePage() { if (jvm == null || pageBook.isDisposed() || messagePage.isDisposed() || messageLabel.isDisposed()) { return; } if (jvm.isConnected()) { messageLabel.setText(""); //$NON-NLS-1$ } else { if (jvm.isConnectionSupported()) { messageLabel.setText(Messages.monitoringNotStartedMsg); showFaqHyperLink(false); } else { StringBuffer buffer = new StringBuffer(Messages.monitoringNotSupportedMsg); String errorMessage = jvm.getErrorStateMessage(); if (errorMessage != null && !errorMessage.isEmpty()) { buffer.append('\n').append('(').append(errorMessage).append(')'); } messageLabel.setText(buffer.toString()); showFaqHyperLink(true); } messagePage.layout(); } pageBook.showPage(hasErrorMessage() ? messagePage : contentPage); } /** * Sets the input. * * @param part * The workbench part * @param selection * The selection * @param newJvm * The active JVM * @param oldJvm * The old active JVM */ abstract protected void setInput(IWorkbenchPart part, ISelection selection, IActiveJvm newJvm, IActiveJvm oldJvm); /** * Creates the controls. * * @param parent * The parent */ abstract protected void createControls(Composite parent); /** * Creates the message page. * * @param parent * The parent composite * @return The message page */ private Composite createMessagePage(Composite parent) { Composite composite = new Composite(parent, SWT.NONE); composite.setLayout(new GridLayout(1, false)); messageLabel = new Label(composite, SWT.NONE); messageLabel.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); FormToolkit toolkit = new FormToolkit(Display.getDefault()); toolkit.setBackground(composite.getBackground()); faqHyperlink = toolkit.createHyperlink(composite, Messages.seeFaqMsg, SWT.NONE); faqHyperlink.addHyperlinkListener(new HyperlinkAdapter() { @Override public void linkActivated(HyperlinkEvent e) { PlatformUI.getWorkbench().getHelpSystem().displayHelpResource(FAQ_URL); } }); return composite; } /** * Shows the hyper link to FAQ page. * * @param show * <tt>true</tt> to show */ private void showFaqHyperLink(boolean show) { faqHyperlink.setVisible(show); } /** * Gets the property sheet. * * @param pageSite * The page site * @return The property sheet, or <tt>null</tt> if not accessible */ private static PropertySheet getPropertySheet(PageSite pageSite) { try { Field field = PageSite.class.getDeclaredField("parentSite"); //$NON-NLS-1$ field.setAccessible(true); return (PropertySheet) ((IViewSite) field.get(pageSite)).getPart(); } catch (Exception e) { Activator.log(IStatus.ERROR, "", e); //$NON-NLS-1$ } return null; } /** * Gets the tool bar manager. * * @return The tool bar manager */ private IToolBarManager getToolBarManager() { return propertySheet.getViewSite().getActionBars().getToolBarManager(); } /** * Gets the menu manager. * * @return The menu manager */ IMenuManager getMenuManager() { return propertySheet.getViewSite().getActionBars().getMenuManager(); } /** * Adds the tool bar actions. */ private void addToolBarActions() { IToolBarManager toolBarManager = getToolBarManager(); if (toolBarManager != null) { addToolBarActions(toolBarManager); toolBarManager.update(false); updateActionBars(); } } /** * Updates the action bars. */ private void updateActionBars() { propertySheet.getViewSite().getActionBars().updateActionBars(); } /** * Adds the local menus. */ private void addLocalMenus() { // defer adding menus to properly order menus Display.getDefault().asyncExec(new Runnable() { @Override public void run() { IMenuManager menuManager = getMenuManager(); if (menuManager != null && menuManager.find(preferencesAction.getId()) == null) { addLocalMenus(menuManager); menuManager.add(preferencesAction); menuManager.update(false); updateActionBars(); } } }); } /** * Gets the state indicating if property sheet containing this property * section is focused. * * @return True of property sheet is focused. */ private boolean isFocused() { IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow(); if (window == null) { return false; } IWorkbenchPage page = window.getActivePage(); if (page == null) { return false; } IWorkbenchPart part = page.getActivePart(); if (part != null) { return part.equals(propertySheet); } return false; } }