/*
 This file belongs to the Servoy development and deployment environment, Copyright (C) 1997-2010 Servoy BV

 This program is free software; you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License as published by the Free
 Software Foundation; either version 3 of the License, or (at your option) any
 later version.

 This program 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 Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License along
 with this program; if not, see http://www.gnu.org/licenses or write to the Free
 Software Foundation,Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 */
package com.servoy.j2db.ui.runtime;

import org.mozilla.javascript.annotations.JSFunction;
import org.mozilla.javascript.annotations.JSGetter;
import org.mozilla.javascript.annotations.JSSetter;


/**
 * Interface for components with text-input support
 * 
 * @author jcompagner
 * @since 6.1
 */
public interface HasRuntimeTextInput
{
	/**
	 * Gets or sets the number value (position) of the text caret (text "I" bar) in a field.
	 *  
	 * NOTE: This does not work in Web Client.
	 *  
	 * @sample
	 * //get the current caretposition
	 * var caretPos = %%prefix%%%%elementName%%.caretPosition;
	 * //add one and set it
	 * %%prefix%%%%elementName%%.caretPosition = caretPos+1;
	 */
	@JSGetter
	public int getCaretPosition();

	@JSSetter
	public void setCaretPosition(int pos);

	/**
	 * Returns the currently selected text in the specified text field or text area. 
	 * 
	 * NOTE: This does not work for text fields in the Web Client.
	 *
	 * @sample var my_text = %%prefix%%%%elementName%%.getSelectedText();
	 * 
	 * @return The selected text from the component.
	 */
	@JSFunction
	public String getSelectedText();

	/**
	 * Selects all the contents of a field.
	 *
	 * @sample %%prefix%%%%elementName%%.selectAll();
	 */
	@JSFunction
	public void selectAll();

	/**
	 * Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
	 * 
	 * NOTE: replaceSelectedText applies to text fields and all XXX_AREA displayType text - RTF_AREA, HTML_AREA, or TEXT_AREA.
	 *
	 * @sample 
	 * //returns the current selected text
	 * var my_text = %%prefix%%%%elementName%%.getSelectedText();
	 * 
	 * //replaces the current selected text
	 * %%prefix%%%%elementName%%.replaceSelectedText('John');
	 * 
	 * @param s The replacement text.
	 */
	@JSFunction
	public void replaceSelectedText(String s);
}