<?php
/* gvHIDRA. Herramienta Integral de Desarrollo Rápido de Aplicaciones de la Generalitat Valenciana
 *
 * Copyright (C) 2006 Generalitat Valenciana.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.
 *
 * For more information, contact:
 *
 *  Direcció General Tecnologies de la Informació i les Comunicacions - Generalitat Valenciana
 *  http://www.dgtic.gva.es
 *  http://www.gvhidra.gva.es/
 */
/**
 * IgepSalto. Clase que contiene la estructura de salto que necesita
 * IGEP.
 *
 * @license	http://opensource.org/licenses/gpl-2.0.php GNU Public License v.2
 * @version	$Id: IgepSalto.php,v 1.5 2011-05-11 09:04:13 vnavarro Exp $
 * @author	<felix_ant@externos.gva.es>
 *
 * @package gvHidra
 */
class IgepSalto
{
    var $str_idSalto;
    var $str_claseOrigen;
    var $str_claseDestino;
    var $str_accionDestino;
    var $str_accionVuelta;
    var $str_panelOrigen;
    var $m_params = array();

  	/********* MODAL ***********/
  	//Definimos la propiedad del formulario
  	private $_form = null;
  	private $_modal = false;
  	private $_modalStrict = false;
  	private $_widthModal = 900;
  	private $_heightModal = 600;
  	private $_idModal;
	/*
	 * _triggerField: Booleano que indica si se trata de una acción de interfaz
	 */
  	private $_triggerField = false;
	/*
	 * _btnIdCompleto: id del botón (panel origen) que inició la acción de salto
	 */
	private $_btnIdCompleto;

  	/********* MODAL ***********/

    /**
     * Constructor del Objeto Salto.
     *
     * @param	string		$str_claseOrigen		Nombre de la clase origen del salto.
     * @param	string		$str_idSalto			Cadena identificadora delobjeto salto.
     */
	public function __construct( $str_claseOrigen, $str_idSalto='' )
	{
		$this->IgepSalto( $str_claseOrigen, $str_idSalto );
	} //Fin del constructor


	//Constructor
	public function IgepSalto( $str_claseOrigen, $str_idSalto='' )
	{
		$this->str_claseOrigen = $str_claseOrigen;
		$this->setId( $str_idSalto );
		if (isset($_REQUEST['gvhpanel']))
		{
		    $this->str_panelOrigen = $_REQUEST['gvhpanel'];
		}
	} //Fin del constructor


	/**
	 * Permite establecer el identificador de un salto.
	 *
	 * @param	string		$str_idSalto 		Id del salto.
	 */
	public function setId( $str_idSalto )
	{
		$this->str_idSalto = $str_idSalto;
	} //Fin de setId


	/**
	 * Devuelve el identificador de un salto.
	 *
	 * @return	string
	 */
	public function getId()
	{
		return $this->str_idSalto;

	} //Fin de getId


	/**
	 * Permite establecer el nombre de la clase destino del salto.
	 *
	 * @param	string		$str_nameTargetClass		Nombre de la clase destino del salto.
	 */
	public function setClase( $str_claseDestino )
	{
		$this->str_claseDestino = $str_claseDestino;
	} //Fin de setClase


	/**
	 * Permite establecer el nombre de la clase destino del salto.
	 *
	 * @param	string		$str_nameTargetClass		Nombre de la clase destino del salto.
	 */
	public function setNameTargetClass( $str_nameTargetClass )
	{
		$this->str_claseDestino = $str_nameTargetClass;

	} //Fin de setNameTargetClass


	/**
	 * Devuelve el nombre de la clase destino del salto.
	 *
	 * @return	string
	 */
	public function getNameTargetClass()
	{
		return $this->str_claseDestino;

	} //Fin de getNameTargetClass


	/**
	 * Devuelve la accion destino del salto.
	 *
	 * @return	string
	 */
	public function getTargetAction( )
	{
		return $this->str_accionDestino;

	} //Fin de setTargetAction


	/**
	 * Devuelve el nombre de la clase destino del salto.
	 *
	 * @return	string
	 */
	public function getClaseDestino()
	{
		return $this->str_claseDestino;

	} //Fin de getClaseDestino


	/**
	 * Devuelve el nombre de la clase origen.
	 *
	 * @return	string.
	 */
	public function getNameSourceClass()
	{
		return $this->str_claseOrigen;

	} //Fin de getNameSourceClass

	/**
	 * Fija el nombre de la clase origen.
	 *
	 * @return	string.
	 */
	public function setNameSourceClass($claseOrigen)
	{
		$this->str_claseOrigen = $claseOrigen;

	} //Fin de setNameSourceClass

	/**
	 * Devuelve el nombre del panel origen.
	 *
	 * @return	string
	 */
	public function getNameSourcePanel()
	{
		return $this->str_panelOrigen;

	} //Fin de getNameSourcePanel


	/**
	 * Devuelve el nombre del panel origen.
	 *
	 * @return	string
	 */
	public function setNameSourcePanel( $panel )
	{
		$this->str_panelOrigen = $panel;

	} //Fin de setNameSourcePanel

	/**
	 * Permite establecer la accion destino del salto
	 *
	 * @param	string		$str_accionDestino
	 */
	public function setAccion( $str_accionDestino )
	{
		$this->str_accionDestino = $str_accionDestino;

	} //Fin de setAccion


	/**
	 * Permite establecer la accion destino del salto.
	 *
	 * @param	string		$str_accionDestino
	 */
	public function setTargetAction( $str_accionDestino )
	{
		$this->str_accionDestino = $str_accionDestino;

	} //Fin de setTargetAction

	/**
	 * Permite establecer la accion de retorno del salto.
	 *
	 * @param	string		$str_accionVuelta
	 */
	public function setAccionRetorno( $str_accionVuelta )
	{
		$this->str_accionVuelta = $str_accionVuelta;

	} //Fin de setAccionRetorno


	/**
	 * Permite establecer la accion de retorno del salto.
	 *
	 * @param	string		$str_accionVuelta
	 */
	public function setReturnAction( $str_accionVuelta )
	{
		$this->str_accionVuelta = $str_accionVuelta;

	} //Fin de setReturnAction


	/*************** MODAL ****************/

	/**
	 * Metodo que calcula la URL de ida del salto.
	 *
	 * @return	string
	 */
	public function getDestinoIda()
	{
		$paramModal = null;
		if( $this->isModal() )
		{
			$paramModal = '&openModal=yes';
		}
		return "phrame.php?action={$this->str_claseDestino}__{$this->str_accionDestino}{$paramModal}";
	} //Fin de getDestinoIda

		/*************** FIN MODAL ****************/

	/**
	 * Metodo que calcula la URL de vuelta del salto.
	 *
	 * @return string
	 */
	public function getDestinoVuelta()
	{
		if( $this->_triggerField )
		{
		    return "phrame.php?action=gvhJSRefreshUI&gvHclass={$this->str_claseOrigen}&gvHfname={$this->_form}&gvHfrom={$this->_btnIdCompleto}&gvHvalue=X&gvHtarget=X&gvhpanel={$this->str_panelOrigen}";
		}
		return "phrame.php?action={$this->str_claseOrigen}__{$this->str_accionVuelta}";
	} //Fin de getDestinoVuelta


	/**
	 * Método que introduce un parametro al salto
	 *
	 * @param	string		$indice			Identificador del parametro.
	 * @param	string		$valor			Valor del parametro.
	 */
	public function setParam( $indice, $valor )
	{
		$this->m_params[$indice] = $valor;

	} //Fin de setParam


	/**
	 * Método que devuelve un parametro del salto.
	 *
	 * @param	string		$indice			Identificador del parametro.
	 * @return	mixed
	 */
	public function getParam( $indice )
	{
		return $this->m_params[$indice];

	} //Fin de getParam


	/**
	 * Método que fija un array de parametros al salto
	 *
	 * @param	array		$params		Array de parametros.
	 */
	public function setParams( $params )
	{
		if( is_array($params) )
		{
			$this->m_params = $params;
		}
	} //Fin de setParams


	/**
	 * Método que devuelve el array de parametros del salto.
	 *
	 * @return	array
	 */
	public function getParams()
	{
		return $this->m_params;

	} //Fin de getParams


	/*************** MODAL ****************/

	/**
	 * Metodo que fija el id del formulario de origen del salto. Se utiliza para la vuelta de un salto modal con acción de interfaz
	 *
	 * @param	mixed		$value
	 */
	public function setForm( $value )
	{
		$this->_form = $value;

	} //Fin de setForm


	/**
	 * Metodo que devuelve el id del formulario de origen del salto. Se utiliza para la vuelta de un salto modal con acción de interfaz.
	 *
	 * @return	mixed
	 */
	public function getForm()
	{
		return $this->_form;

	} //Fin de getForm


	/**
	 * Método que indica si el salto se lanza como modal o no
	 *
	 * @param	boolean		$value		True indica modal / false no modal.
	 * @param	boolean		$strict		True indica modal estricta / false no estricta.
	 */
	public function setModal( $value, $strict = true )
	{
		$this->_modal = $value;
		$this->_modalStrict = $strict;
	} //Fin de setModal


	/**
	 * Método que fija el tamaño de la ventana modal
	 *
	 * @param	integer		$width		Ancho de la ventana.
	 * @param	integer		$height		Alto de la ventana.
	 */
	public function setSizeModal( $width, $height )
	{
		$this->_widthModal = $width;
		$this->_heightModal = $height;
	} //Fin de setSizeModal

	/**
	 * Permite establecer el identificador de la ventana modal
	 *
	 * @param	string		$id			Identificador de la modal.
	 */
	public function setIdModal( $id )
	{
	    $this->_idModal = $id;

	} //Fin de setIdModal

	/**
	 * Devuelve el identificador de la ventana modal.
	 *
	 * @return	string			Identificador de la modal.
	 */
	public function getIdModal()
	{
		return (empty($this->_idModal) && $this->_modal ? "WM_{$this->str_claseDestino}" : $this->_idModal);
	}

	/**
	 * Devuelve el ancho de la ventana modal.
	 *
	 * @return	integer			Ancho de la ventana modal.
	 */
	public function getWidthModal()
	{
		return $this->_widthModal;

	} //Fin de getWidthModal


	/**
	 * Devuelve el alto de la ventana modal.
	 *
	 * @return	integer		Alto de la ventana modal.
	 */
	public function getHeightModal()
	{
		return $this->_heightModal;

	} //Fin de getHeightModal


	/**
	 * Método que indica si el salto se ha lanzado como modal o no. Util para saber si al recibir un salto estamos en modo modal o no.
	 *
	 * @return	boolean		True indica modal / false no modal.
	 */
	public function isModal()
	{
		return $this->_modal;

	} //Fin de isModal


	/**
	 * Método que indica si el salto se ha lanzado como modal en modo estricto o no.
	 *
	 * @return	boolean		True indica modal estricta / false modal no estricta.
	 */
	public function isModalStrict()
	{
		return $this->_modalStrict;

	} //Fin de isModalStrict


	/**
	 * Método que activa el retorno en forma de acción de interfaz.
	 *
	 * @param	boolean		$triggerField		True activa / false desactiva.
	 */
	public function setReturnAsTriggerEvent( $triggerField )
	{
		$this->_triggerField = $triggerField;

	} //Fin de setReturnAsTriggerEvent

	/**
	 * Método que activa el retorno en forma de acción de interfaz.
	 *
	 * @return	boolean		True accción de interfaz / false acción particular.
	 */
	public function isTriggerEvent()
	{
		return $this->_triggerField;

	} //Fin de isTriggerEvent


	/**
	 * Este metodo nos sirve para obtener el nombre del id completo. Eso nos vale para construir la llamada con el cam, ins o xxx.
	 *
	 * @param	string		$id
	 */
	public function setBtnId( $id )
	{
		$this->_btnIdCompleto = $id;
	} //Fin de setBtnId


	/**
	 * Método que devuelve el id del botón que ha lanzado la ventana.
	 *
	 * @return string
	 */
	public function getSourceId()
	{
		return $this->_btnIdCompleto;
	} //Fin de getSourceId

	/************** MODAL ************/

} //End IgepSalto