Documentación GVHIDRA 3.1.5
Referencia de la Clase IgepComunicaIU
Diagrama de herencias de IgepComunicaIU
IgepComunicaUsuario

Métodos públicos

 IgepComunicaIU (&$comunica, &$datosPreinsertados, &$listasPanel, $campoOrigen)
 destinosAdaptados ($nombreCampo)
 setValue ($campo, $valor, $parametroOperacion='')
 setSelected ($campo, $valor, $parametroOperacion='')
 setLista ($campo, $objListaStruc, $parametroOperacion= '')
 setChecked ($name, $check, $parametroOperacion='')
 setVisible ($campo, $valor)
 setEnable ($campo, $valor)
 setTabIndex ($name, $value)
 setBttlState ($idPanel, $nameBttl, $on)
 _setCampoDisparador ($nombreCampo)
 getTriggerField ()
 posicionarEnFicha ($indiceFila)
 getModoActivo ()
 getScript ()
 getForward ($name)

Campos de datos

 $script
 $prefijoAdaptacion
 $sufijoAdaptacion
 $_campoDisparador

Métodos privados

 getCheckName ($nombreCampo)
 getCheckHiddenName ($nombreCampo)

Descripción detallada

Definición en la línea 52 del archivo IgepComunicaIU.php.


Documentación de las funciones miembro

_setCampoDisparador ( nombreCampo)

_setCampoDisparador mtodo interno para fijar el nombre del campo que dispara la accin en las acciones de interfaz

private

Parámetros:
string$nombreCampo
Devuelve:
none

Definición en la línea 337 del archivo IgepComunicaIU.php.

                                                   {    

                $this->_campoDisparador = $nombreCampo;
        }
destinosAdaptados ( nombreCampo)

destinosAdaptados. Devuelve el nombre del campo en formato HTML

private

Parámetros:
string$nombreCampo
Devuelve:
string

Definición en la línea 120 del archivo IgepComunicaIU.php.

                                                 {

                return ($this->prefijoAdaptacion.$nombreCampo.$this->sufijoAdaptacion);
        }
getCheckHiddenName ( nombreCampo) [private]

Mtodo que devuelve el nombre del hidden de un check

private

Parámetros:
string$nombreCampoNombre del campo
Devuelve:
string devuelve el campo en formato HTML

Definición en la línea 154 del archivo IgepComunicaIU.php.

                                                          {

                //Panel fil
                if($this->prefijoAdaptacion=='')
                        return $nombreCampo;
                //Panel modo edi
                elseif($this->prefijoAdaptacion == 'cam___')
                        return 'cam___'.$nombreCampo.$this->sufijoAdaptacion;
                //Panel modo ins
                else    
                        return 'hins___'.$nombreCampo.$this->sufijoAdaptacion;
        }
getCheckName ( nombreCampo) [private]

Mtodo que devuelve el nombre de un check en HTML

private

Parámetros:
string$nombreCampoNombre del campo
Devuelve:
string devuelve el id del check en formato HTML

Definición en la línea 133 del archivo IgepComunicaIU.php.

                                                    {

                //Panel fil
                if($this->prefijoAdaptacion=='')
                        return 'chkbfil_'.$nombreCampo;
                //Panel modo edi
                elseif($this->prefijoAdaptacion == 'cam___')
                        return 'ccam___'.$nombreCampo.$this->sufijoAdaptacion;
                //Panel modo ins
                else    
                        return 'cins___'.$nombreCampo.$this->sufijoAdaptacion;
        }
getForward ( name)

getForward este mtodo permite recuperar un actionForward (un destino). Esto permite cambiar el destino de una accion.

public

Parámetros:
string$nameidentificador del actionForward que se quiere recuperar.
Devuelve:
actionForward

Reimplementado de IgepComunicaUsuario.

Definición en la línea 397 del archivo IgepComunicaIU.php.

                                         {
                
                die('Error: no se puede hacer uso de esta funcionalidad desde una accin de interfaz.');
        }
getModoActivo ( )

getModoActivo obtenemos el modo activo para una accin de interfaz dada.

Los modos posibles son

  • fil : Filtro o modo de bsqueda.
  • lis : Listado o modo de tabla.
  • edi : Edicin o modo de ficha.

public

Devuelve:
string

Definición en la línea 384 del archivo IgepComunicaIU.php.

                                        {
    
        return $this->comunica->damePanelActivo();
        }
getScript ( )

Definición en la línea 391 del archivo IgepComunicaIU.php.

                             { 
                return $this->script; 
        }
getTriggerField ( )

getTriggerField mtodo para obtener el nombre del campo que dispara la accin en las acciones de interfaz

public

Devuelve:
string

Definición en la línea 349 del archivo IgepComunicaIU.php.

                                         {

                return $this->_campoDisparador;
        }
IgepComunicaIU ( &$  comunica,
&$  datosPreinsertados,
&$  listasPanel,
campoOrigen 
)

Constructor. Recibe como parmetro una instancia viva de la clase IgepComunicacion

public

Parámetros:
object$comunica

Definición en la línea 95 del archivo IgepComunicaIU.php.

                                                                                                  {

                parent::__construct($comunica, $datosPreinsertados, $listasPanel);
                $this->script = '';

                //Almacenamos los destinosAdaptados en un array indexado por el nombre del campo                        
                $this->prefijoAdaptacion ='';
                $this->sufijoAdaptacion ='';
                
                $auxDestino = $campoOrigen;
                $v_auxDestino = explode('___',$auxDestino,3);
                if (count($v_auxDestino)>2) {
                        $this->prefijoAdaptacion = $v_auxDestino[0].'___';
                        $this->sufijoAdaptacion = '___'.$v_auxDestino[2];
                }
        }
posicionarEnFicha ( indiceFila)

posicionarEnFicha permite cambiar la ficha activa

private

Devuelve:
none

Definición en la línea 361 del archivo IgepComunicaIU.php.

                                                {        

                if($this->sufijoAdaptacion!=''){      
                        $v_auxUno = explode('___',$this->sufijoAdaptacion);
                        $v_auxDos = explode('_',$v_auxUno[1]);      
                        $this->sufijoAdaptacion = '___'.$v_auxDos[0].'_'.$indiceFila; 
                }    
                $this->comunica->posicionarEnTupla($indiceFila);    
        }
setBttlState ( idPanel,
nameBttl,
on 
)

setBttlState Establece el estado del boton Tooltip correspondiente a activado (true) o desactivado (false)

public

Parámetros:
String$panelIndica el panel sobre el que se sita el botonTooltip |||
String$nameBttlNombre del boton tooltip
Boolean$onTrue para activar, false para desahabilitar
Devuelve:
void

Definición en la línea 324 del archivo IgepComunicaIU.php.

                                                               {

                $this->script.=IgepSmarty::getJsSetBttlState($idPanel, $nameBttl, $on); 
        }
setChecked ( name,
check,
parametroOperacion = '' 
)

setChecked metodo que permite modificar el valor del un check en una accion de interfaz.

public

Parámetros:
stringname nombre del check
booleancheck Checked si o no
Devuelve:
none

Reimplementado de IgepComunicaUsuario.

Definición en la línea 238 del archivo IgepComunicaIU.php.

                                                                          {

                $idCheck = $this->getCheckName($name);
                $hiddenName = $this->getCheckHiddenName($name);
                
                //Seleccionamos el valor dependiendo si esta seleccionado
                $desc = $this->comunica->descCampoPanel[$name];
                ($check)?$value=$desc['valueChecked']:$value=$desc['valueUnchecked'];
                
                $this->script.= IgepSmarty::getJsSetCheck($idCheck, $check, $hiddenName, $value);
        }
setEnable ( campo,
valor 
)

setEneble metodo que permite modificar la accesibilidad de un componente en una accion de interfaz.

public

Parámetros:
string$namenombre del componente
boolean$valorbooleano que indica si es editable o no
Devuelve:
none

Definición en la línea 280 del archivo IgepComunicaIU.php.

        {
                //Obtenemos el tipo de widget
                $desc = $this->comunica->descCampoPanel[$campo];
                $tipoComponente = null;
                $campoDestino = $this->destinosAdaptados($campo);
                
                if ($desc['component'] == 'CheckBox')
                {
                        $tipoComponente = 'CheckBox';
                        $campoDestino = $this->getCheckName($campo);
                }
                else if ($desc['radio']==true)
                {
                        $tipoComponente = 'Radio';
                }
                $this->script.= IgepSmarty::getJsSetEnable($campoDestino, $valor, $tipoComponente);
        }
setLista ( campo,
objListaStruc,
parametroOperacion = '' 
)

setLista cambia el contenido de una lista en una accion de interfaz.

Este metodo se debe utilizar si se quiere cambiar el contenido entero de una lista. Suele venir combinado con la obtencion de la lista con el metodo getLista.

public

Parámetros:
string$camponombre del componente lista
string$objListaStrucestructura de la lista
Devuelve:
none

Reimplementado de IgepComunicaUsuario.

Definición en la línea 221 del archivo IgepComunicaIU.php.

                                                                           {

                $v_lista = $objListaStruc->getEstructuraListaIgep();
                $campoDestino = $this->destinosAdaptados($campo);       
                $this->script.= IgepSmarty::getJsLista($campoDestino, $v_lista);  
                $this->script .= IgepSmarty::getJsSetEstadoModificado($campoDestino);
        }
setSelected ( campo,
valor,
parametroOperacion = '' 
)

setSelected fija el valor de una lista en una accin de interfaz.

Este metodo se debe utilizar si se quiere cambiar el valor seleccionado de una lista.

public

Parámetros:
string$campoNombre del campo
string$valorValor del campo
Devuelve:
none

Reimplementado de IgepComunicaUsuario.

Definición en la línea 201 del archivo IgepComunicaIU.php.

                                                                            {

                $campoDestino = $this->destinosAdaptados($campo);
                $this->script.= IgepSmarty::getJsSetSelected($campoDestino, $valor);
                $this->script .= IgepSmarty::getJsSetEstadoModificado($campoDestino);
        }
setTabIndex ( name,
value 
)

setTabIndex metodo que permite modificar el tabindex de un componente de pantalla de forma dinamica.

public

Parámetros:
string$namenombre del componente
boolean$valuevalor asignado
Devuelve:
none

Definición en la línea 308 del archivo IgepComunicaIU.php.

        {
                $campoDestino = $this->destinosAdaptados($name);        
                $this->script.= IgepSmarty::getJsSetOrder($campoDestino, $value);
        }
setValue ( campo,
valor,
parametroOperacion = '' 
)

setValue mtodo que fija el valor de un campo de texto en una accion de interfaz.

public

Parámetros:
string$nombreCampoNombre del campo
string$valornuevo valor del campo
Devuelve:
none

Reimplementado de IgepComunicaUsuario.

Definición en la línea 176 del archivo IgepComunicaIU.php.

                                                                         {

                //Parche para transformar el valor
                // $this->comunica->descCampoPanel[$campo]['parteDecimal']
                //TODO TONI: considerar decimal
                /*REVISAR EL TEMA DE LA TRANSFORMACION DE DATOS*/
                $tipo = $this->comunica->descCampoPanel[$campo]['tipo'];        
                $valor = IgepComunicaUsuario::prepararPresentacion($valor, $tipo);      
                //Fin de parche
                $campoDestino = $this->destinosAdaptados($campo);       
                $this->script.= IgepSmarty::getJsSetCampoTexto($campoDestino, $valor);
                $this->script .= IgepSmarty::getJsSetEstadoModificado($campoDestino);
        }
setVisible ( campo,
valor 
)

setVisible metodo que permite modificar la visibilidad de un componente en una accion de interfaz.

public

Parámetros:
string$namenombre del componente
boolean$valorbooleano que indica si se quiere ver o no.
Devuelve:
none

Definición en la línea 259 del archivo IgepComunicaIU.php.

        {
                //Obtenemos el tipo de widget
                $desc = $this->comunica->descCampoPanel[$campo];                
                if($desc['component'] == 'CheckBox')
                        $campoDestino = $this->getCheckName($campo);
                else            
                        $campoDestino = $this->destinosAdaptados($campo);
                        
                $this->script.= IgepSmarty::getJsSetVisible($campoDestino, $valor);
        }

Documentación de los campos

$_campoDisparador

Definición en la línea 85 del archivo IgepComunicaIU.php.

$prefijoAdaptacion

Definición en la línea 68 del archivo IgepComunicaIU.php.

$script

Definición en la línea 59 del archivo IgepComunicaIU.php.

$sufijoAdaptacion

Definición en la línea 77 del archivo IgepComunicaIU.php.


La documentación para esta clase fue generada a partir del siguiente fichero: