org.eclipse.jst.jsf.ui.internal.jspeditor.BeanSuffixHyperlink.java Source code

Introduction

Here is the source code for org.eclipse.jst.jsf.ui.internal.jspeditor.BeanSuffixHyperlink.java

Source

/*******************************************************************************
 * Copyright (c) 2001, 2007 Oracle Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *     Oracle Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.jst.jsf.ui.internal.jspeditor;

import org.eclipse.core.runtime.IStatus;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
import org.eclipse.jdt.core.IMethod;
import org.eclipse.jdt.ui.JavaUI;
import org.eclipse.jface.text.IRegion;
import org.eclipse.jface.text.hyperlink.IHyperlink;
import org.eclipse.jst.jsf.common.util.JDTBeanProperty;
import org.eclipse.jst.jsf.context.symbol.IBeanMethodSymbol;
import org.eclipse.jst.jsf.context.symbol.IBeanPropertySymbol;
import org.eclipse.jst.jsf.context.symbol.ISymbol;
import org.eclipse.jst.jsf.context.symbol.internal.impl.JavaUtil;
import org.eclipse.jst.jsf.ui.internal.JSFUiPlugin;
import org.eclipse.jst.jsf.ui.internal.Messages;
import org.eclipse.osgi.util.NLS;
import org.eclipse.ui.IEditorPart;

/**
 * Hyperlink for IBeanPropertySymbol and IBeanMethodSymbol el symbols. This Class only exists
 *  in order to defer determining the (access) method to link to until user actually clicks
 *  on the link, since determining takes too long.
 */
class BeanSuffixHyperlink implements IHyperlink, ITestHyperlink {
    private final IRegion _fRegion;
    private final ISymbol _symbol;

    /**
     * Creates a BeanSuffixHyperlink for a symbol
     * @param region - the region of the hyperlink
     * @param symbol
     */
    public BeanSuffixHyperlink(final IRegion region, final ISymbol symbol) {
        _fRegion = region;
        _symbol = symbol;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.jface.text.hyperlink.IHyperlink#getHyperlinkRegion()
     */
    public IRegion getHyperlinkRegion() {
        return _fRegion;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.jface.text.hyperlink.IHyperlink#getTypeLabel()
     */
    public String getTypeLabel() {
        return null;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.jface.text.hyperlink.IHyperlink#getHyperlinkText()
     */
    public String getHyperlinkText() {
        //Bug 254452 - JSF hyperlink provider shows "unknown hyperlink" when in list
        final IJavaElement element = determineJavaElement();
        if (element != null) {
            final ICompilationUnit compilationUnit = (ICompilationUnit) element
                    .getAncestor(IJavaElement.COMPILATION_UNIT);
            if (compilationUnit != null) {
                return NLS.bind(Messages.Hyperlink_Open_JavaMethod, compilationUnit.getElementName(),
                        element.getElementName());
            }
            return Messages.Hyperlink_Open_JavaFile;
        }
        return Messages.Hyperlink_Open_JavaElement;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.eclipse.jface.text.hyperlink.IHyperlink#open()
     */
    public void open() {
        final IJavaElement element = determineJavaElement();
        if (element != null) {
            try {
                final IEditorPart editor = JavaUI.openInEditor(element);
                if (editor != null) {
                    JavaUI.revealInEditor(editor, element);
                }
            } catch (final Exception e) {
                JSFUiPlugin.log(IStatus.WARNING, e.getMessage(), e);
            }
        }
    }

    public IJavaElement determineJavaElement() {
        if (_symbol instanceof IBeanPropertySymbol) {
            return determinePropertyElement((IBeanPropertySymbol) _symbol);
        }
        if (_symbol instanceof IBeanMethodSymbol) {
            return JavaUtil.findCorrespondingMethod((IBeanMethodSymbol) _symbol);
        }
        return null;
    }

    private IMethod determinePropertyElement(final IBeanPropertySymbol propertySymbol) {
        final JDTBeanProperty property = JavaUtil.findCorrespondingJDTProperty(propertySymbol);
        if (property != null) {
            if (property.getGetter() != null) {
                return property.getGetter();
            }
            if (property.getSetter() != null) {
                return property.getSetter();
            }
        }
        return null;
    }

}