/*
* Copyright (c) 2010-2012 Research In Motion Limited. All rights reserved.
*
* This program and the accompanying materials are made available
* under the terms of the Eclipse Public License, Version 1.0,
* which accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v10.html
*
*/
package net.rim.ejde.internal.codeassisstant;
import org.apache.log4j.Logger;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.DocumentEvent;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextViewer;
import org.eclipse.jface.text.contentassist.ICompletionProposal;
import org.eclipse.jface.text.contentassist.ICompletionProposalExtension2;
import org.eclipse.jface.text.contentassist.IContextInformation;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
/**
* This class represent a proposal for a preprocess directive.
*/
public class PreprocessDirectiveCompletionProposal implements ICompletionProposal, ICompletionProposalExtension2 {
static Logger _log = Logger.getLogger( PreprocessDirectiveCompletionProposal.class );
/** The string to be displayed in the completion proposal popup. */
private String fDisplayString;
/** The replacement string. */
private String fReplacementString;
/** The replacement offset. */
private int fReplacementOffset;
/** The replacement length. */
private int fReplacementLength;
/** The cursor position after this proposal has been applied. */
private int fCursorPosition;
/** The image to be displayed in the completion proposal popup. */
private Image fImage;
/** The context information of this proposal. */
private IContextInformation fContextInformation;
/** The additional info of this proposal. */
private String fAdditionalProposalInfo;
/**
* Creates a new completion proposal based on the provided information. The replacement string is considered being the display
* string too. All remaining fields are set to <code>null</code>.
*
* @param replacementString
* the actual string to be inserted into the document
* @param replacementOffset
* the offset of the text to be replaced
* @param replacementLength
* the length of the text to be replaced
* @param cursorPosition
* the position of the cursor following the insert relative to replacementOffset
*/
public PreprocessDirectiveCompletionProposal( String replacementString, int replacementOffset, int replacementLength,
int cursorPosition ) {
this( replacementString, replacementOffset, replacementLength, cursorPosition, null, null, null, null );
}
/**
* Creates a new completion proposal. All fields are initialized based on the provided information.
*
* @param replacementString
* the actual string to be inserted into the document
* @param replacementOffset
* the offset of the text to be replaced
* @param replacementLength
* the length of the text to be replaced
* @param cursorPosition
* the position of the cursor following the insert relative to replacementOffset
* @param image
* the image to display for this proposal
* @param displayString
* the string to be displayed for the proposal
* @param contextInformation
* the context information associated with this proposal
* @param additionalProposalInfo
* the additional information associated with this proposal
*/
public PreprocessDirectiveCompletionProposal( String replacementString, int replacementOffset, int replacementLength,
int cursorPosition, Image image, String displayString, IContextInformation contextInformation,
String additionalProposalInfo ) {
Assert.isNotNull( replacementString );
Assert.isTrue( replacementOffset >= 0 );
Assert.isTrue( replacementLength >= 0 );
Assert.isTrue( cursorPosition >= 0 );
fReplacementString = replacementString;
fReplacementOffset = replacementOffset;
fReplacementLength = replacementLength;
fCursorPosition = cursorPosition;
fImage = image;
fDisplayString = displayString;
fContextInformation = contextInformation;
fAdditionalProposalInfo = additionalProposalInfo;
}
/*
* @see ICompletionProposal#apply(IDocument)
*/
public void apply( IDocument document ) {
try {
document.replace( fReplacementOffset, fReplacementLength, fReplacementString );
} catch( BadLocationException x ) {
// ignore
}
}
/*
* @see ICompletionProposal#getSelection(IDocument)
*/
public Point getSelection( IDocument document ) {
return new Point( fReplacementOffset + fCursorPosition, 0 );
}
/*
* @see ICompletionProposal#getContextInformation()
*/
public IContextInformation getContextInformation() {
return fContextInformation;
}
/*
* @see ICompletionProposal#getImage()
*/
public Image getImage() {
return fImage;
}
/*
* @see ICompletionProposal#getDisplayString()
*/
public String getDisplayString() {
if( fDisplayString != null )
return fDisplayString;
return fReplacementString;
}
/*
* @see ICompletionProposal#getAdditionalProposalInfo()
*/
public String getAdditionalProposalInfo() {
return fAdditionalProposalInfo;
}
@Override
public void apply( ITextViewer viewer, char trigger, int stateMask, int offset ) {
IDocument document = viewer.getDocument();
try {
int replaceLength = offset > fReplacementOffset ? offset - fReplacementOffset : 0;
document.replace( fReplacementOffset, replaceLength, fDisplayString );
} catch( BadLocationException e ) {
_log.error( e.getMessage() );
}
}
@Override
public void selected( ITextViewer viewer, boolean smartToggle ) {
// TODO Auto-generated method stub
}
@Override
public void unselected( ITextViewer viewer ) {
// TODO Auto-generated method stub
}
@Override
public boolean validate( IDocument document, int offset, DocumentEvent event ) {
try {
int length = offset > fReplacementOffset ? offset - fReplacementOffset : 0;
String content = document.get( fReplacementOffset, length );
if( fDisplayString.toLowerCase().startsWith( content.toLowerCase() ) ) {
return true;
}
} catch( BadLocationException e ) {
_log.error( e.getMessage() );
}
return false;
}
@Override
public boolean equals( Object obj ) {
if( obj instanceof ICompletionProposal ) {
return ((ICompletionProposal) obj ).getDisplayString().equals( this.getDisplayString());
}
return false;
}
}