LazyERBCompletionProposal.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain Eclipse Public Licensed code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.editor.erb.contentassist;

import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.jface.text.contentassist.IContextInformation;
import org.eclipse.swt.graphics.Image;
import org.rubypeople.rdt.core.IMember;
import org.rubypeople.rdt.core.IRubyElement;
import org.rubypeople.rdt.internal.ui.text.ruby.ProposalInfo;

import com.aptana.ide.editors.unified.IUnifiedViewer;

/**
 * @author Chris Williams (cwilliams@aptana.com)
 */
public class LazyERBCompletionProposal extends ERBCompletionProposal
{
	public LazyERBCompletionProposal(IRubyElement element, String replacementString, int replacementOffset,
			int replacementLength, int cursorPosition, Image image, String displayString,
			IContextInformation contextInformation, String additionalProposalInfo, int objectType,
			IUnifiedViewer unifiedViewer, Image[] userAgentImages, String location)
	{
		super(replacementString, replacementOffset, replacementLength, cursorPosition, image, displayString,
				contextInformation, additionalProposalInfo, objectType, unifiedViewer, userAgentImages, location);
		this.element = element;
	}

	private boolean fProposalInfoComputed;
	private IRubyElement element;

	public String getAdditionalProposalInfo()
	{
		if (!fProposalInfoComputed)
			setProposalInfo(computeProposalInfo());
		return super.getAdditionalProposalInfo();
	}

	protected ProposalInfo computeProposalInfo()
	{
		return new ProposalInfo((IMember) element);
	}

	/**
	 * Sets the proposal info.
	 * 
	 * @param proposalInfo
	 *            The additional information associated with this proposal or <code>null</code>
	 */
	public final void setProposalInfo(ProposalInfo proposalInfo)
	{
		fProposalInfoComputed = true;
		additionalProposalInfo = proposalInfo.getInfo(new NullProgressMonitor());
	}
}