<?php
/**
 * Características de uma classe capaz de validar um campo de formulário
 * FormFieldValidator.interface.php
 * @author	Ricardo <hide@address.com>
 * @since 1.0 - 19/12/2006
 * @package EasyHtml
 * @subpackage FormValidate
 */
interface FormFieldValidator {
	/**
	 * Retorna o resultado da validação
	 * @return boolean
	 */
	function getResult();
	
	/**
	 * A qual campo o validador está associado?
	 * @param HtmlFormField campo
	 * @return void
	 */
	function setField(FormField &$f);
	
	/**
	 * Retorna o campo ao qual o validador está associado
	 * @return FormField
	 */
	function getField();
	
	/**
	 * Carrega/gera o código JavaScript de validação para o campo de formulário
	 * 		- é aqui que está a inteligência para validar um campo via Java Script
	 * @return void
	 */
	function loadJavaScriptCode();
	
	/**
	 * Seta o nome de uma variável de escopo da camada view para exibição de mensagens
	 * 		. Opcional
	 * @param string nome da variável
	 * @return void
	 */
	function setErrorMessage($str);
	
	/**
	 * Retorna a mensagem de erro
	 * @return string
	 */
	function getErrorMessage();
	
	/**
	 * Seta o modo como um erro é tratado
	 * @param string modo
	 * 		modos previstos:
	 * 			alert		- simples alerta em javascript
	 * 			style		- altera a aparência do campo de formulário
	 * 			target		- a mensagem de erro aparece em um div específico
	 * 			target_spec - aparece em um div "particular" do próprio campo de formulário
	 */
	function setResponseMode($mode);
	
	/**
	 * Seta o nome do div onde serão exibidas as mensagens de erro
	 * @param HtmlElementComponent elemento html onde serão exibidas as mensagens de erro
	 */
	function setResponseTarget(HtmlElementComponent $target);
	
	/**
	 * Seta o id do div onde serão exibidas as mensagens de erro
	 * @param string id do div
	 */
	function setResponseTargetId($targetId);
	
	/**
	 * Define/Trata/manipula a forma de tratamente de um erro de validação
	 * Cria um HtmlElement JavaScript que, renderizado, contém funções que serão
	 * chamadas quando esse elemento for inválido.
	 */
	function onErrorActions();
}
?>