org.eclipse.jface.fieldassist.ContentProposal.java Source code

Introduction

Here is the source code for org.eclipse.jface.fieldassist.ContentProposal.java

Source

/*******************************************************************************
 * Copyright (c) 2009, 2015 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 ******************************************************************************/

package org.eclipse.jface.fieldassist;

import org.eclipse.core.runtime.Assert;

/**
 * A default implementation of {@link IContentProposal} that allows clients to
 * specify a content proposal using simple constructors.
 *
 * @since 3.6
 *
 */
public class ContentProposal implements IContentProposal {
    private static final String EMPTY = ""; //$NON-NLS-1$

    private String content = EMPTY;
    private String label = EMPTY;
    private String description = EMPTY;
    private int cursorPosition = 0;

    /**
     * Create a content proposal whose label and content are the specified
     * String. The cursor position will be located at the end of the content.
     *
     * @param content
     *            the String representing the content. Should not be
     *            <code>null</code>.
     */
    public ContentProposal(String content) {
        this(content, content, null);
    }

    /**
     * Create a content proposal whose content and description are as specified
     * in the parameters. The cursor position will be located at the end of the
     * content.
     *
     * @param content
     *            the String representing the content. Should not be
     *            <code>null</code>. This string will also be used as the label.
     * @param description
     *            the String representing the description, or <code>null</code>
     *            if there should be no description.
     */
    public ContentProposal(String content, String description) {
        this(content, content, description);
    }

    /**
     * Create a content proposal whose content, label, and description are as
     * specified in the parameters. The cursor position will be located at the
     * end of the content.
     *
     * @param content
     *            the String representing the content. Should not be
     *            <code>null</code>.
     * @param label
     *            the String representing the label. Should not be
     *            <code>null</code>.
     *
     * @param description
     *            the String representing the description, or <code>null</code>
     *            if there should be no description.
     */
    public ContentProposal(String content, String label, String description) {
        this(content, label, description, content.length());
    }

    /**
     * Create a content proposal whose content, label, description, and cursor
     * position are as specified in the parameters.
     *
     * @param content
     *            the String representing the content. Should not be
     *            <code>null</code>.
     * @param label
     *            the String representing the label. Should not be
     *            <code>null</code>.
     *
     * @param description
     *            the String representing the description, or <code>null</code>
     *            if there should be no description.
     *
     * @param cursorPosition
     *            the zero-based index position within the contents where the
     *            cursor should be placed after the proposal is accepted. The
     *            range of the cursor position is from 0..N where N is the
     *            number of characters in the content.
     *
     * @exception IllegalArgumentException
     *                if the index is not between 0 and the number of characters
     *                in the content.
     */
    public ContentProposal(String content, String label, String description, int cursorPosition) {
        Assert.isNotNull(content);
        Assert.isNotNull(label);
        Assert.isLegal(cursorPosition >= 0 && cursorPosition <= content.length());
        this.content = content;
        this.label = label;
        this.description = description;
        this.cursorPosition = cursorPosition;
    }

    @Override
    public String getContent() {
        return content;
    }

    @Override
    public int getCursorPosition() {
        return cursorPosition;
    }

    @Override
    public String getDescription() {
        return description;
    }

    @Override
    public String getLabel() {
        return label;
    }
}