MenuEntry.java

// This file is part of AceWiki.
// Copyright 2008-2013, AceWiki developers.
// 
// AceWiki is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License as published by the Free Software Foundation, either version 3 of
// the License, or (at your option) any later version.
// 
// AceWiki is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License along with AceWiki. If
// not, see http://www.gnu.org/licenses/.

package ch.uzh.ifi.attempto.preditor;

import nextapp.echo.app.Extent;
import nextapp.echo.app.Font;
import ch.uzh.ifi.attempto.base.ConcreteOption;
import ch.uzh.ifi.attempto.base.TextElement;
import ch.uzh.ifi.attempto.echocomp.Style;

/**
 * This class represents a menu item that contains a text element. The text element is added to
 * the partial sentence when the user clicks on a menu entry in the predictive editor.
 * 
 * @author Tobias Kuhn
 */
public class MenuEntry extends MenuItem {

	private static final long serialVersionUID = -4231372412315340523L;
	
	private TextElement textElement;
	
	/**
	 * Creates a new menu entry for the given word.
	 * 
	 * @param word The word.
	 * @param menuGroup The menu group to which this entry should be assigned.
	 */
	public MenuEntry(String word, String menuGroup) {
		this(new TextElement(word), menuGroup);
	}
	
	/**
	 * Creates a new menu entry on the basis of the given text element.
	 * 
	 * @param textElement The text element.
	 * @param menuGroup The menu group to which this entry should be assigned.
	 */
	public MenuEntry(TextElement textElement, String menuGroup) {
		super(menuGroup);
        this.textElement = textElement;
		setText(textElement.getText());
		setFont(new Font(Style.fontTypeface, Font.PLAIN, new Extent(12)));
    }
	
	/**
	 * Creates a new menu entry on the basis of the given concrete option.
	 * 
	 * @param cOption The concrete option.
	 * @param menuGroup The menu group to which this entry should be assigned.
	 */
	public MenuEntry(ConcreteOption cOption, String menuGroup) {
		this(cOption.getWord(), menuGroup);
	}
    
	/**
	 * Returns the text element.
	 * 
	 * @return The text element.
	 */
    public TextElement getTextElement() {
    	return textElement;
    }
	
	protected String[] getContent() {
		return new String[] {"entry", getText(), getMenuGroup()};
	}
    
}