Aprendiendo Ext JS 3

¿Que es un panel, para que sirve y cómo se crean? Más videos

Descripción del tema

El panel es un componente básico dentro del Framework de Ext JS ya que muchos componentes heredan de éste, es por eso que conocer su funcionamiento es fundamental.

Material de apoyo

Antes de continuar es necesario descargar el material de apoyo, descomprimirlo y copiar los archivos al servidor Web que instalamos en el primer capitulo de este curso, dentro de la carpeta “curso”, en la cual hemos estado trabajando; vamos a crear una carpeta que se llame “panels” y pegamos el material de apoyo.

¿Qué es un panel?

Un panel es un contenedor con funcionalidades específicas que nos permiten construir perfectamente interfaces de usuario, entre algunas características podemos agregarle barras de herramientas superiores e inferiores, botones en la parte inferior o hacer que pueda colapsarse. Los paneles pueden ser fácilmente asignados a cualquier otro contenedor.

Crear un primer panel

Para crear un panel es muy sencillo, basta con hacer lo siguiente:
var main = new Ext.Panel({
	title: 'My first panel', //el título del panel
	width:250, //la anchura del panel
	height:300, //la altura que tendrá
	renderTo: 'frame', //el elemento donde será insertado
	html: 'Nothing important just dummy text' //el contenido del panel
});
El código anterior crea un panel con el título de “My first panel”, con dimensiones de 250 por 300 píxeles y lo colocará dentro del elemento “frame” que se encuentra en el HTML, el contenido es solamente el texto “Nothing important just dummy text”.
My first panel

Ejemplo básico de un panel

Lo más importante en el código anterior es notar la propiedad “renderTo”, esta propiedad acepta el “id” del nodo en el DOM en el cual será insertado el panel que estamos creando. En el siguiente ejemplo se muestra otra alternativa por si necesitamos “renderizar” el panel en algún otro momento.
var main = new Ext.Panel({
	title: 'My first panel',
	width:250,
	height:300,
	html: 'Nothing important just dummy text'
});
//usamos el método “render” para imprimir el panel en la pantalla
main.render('frame');  
Como se puede observar el objeto “Panel” cuenta con un método capaz de “renderizar” o insertar el HTML necesario para que el usuario pueda mirar el panel en la pantalla, este método se llama “render” y acepta como parámetro el “id” del nodo en el DOM donde será insertado.

El contenido del panel

El contenido de un panel puede ser asignado de cuatro maneras diferentes, hemos visto una de ellas en los códigos anteriores, usando la propiedad “html” se le puede especificar el contenido que se necesite agregar. Una segunda opción es definir mediante la propiedad “contentEl” el “id” del elemento que necesitemos meter al panel, es necesario que este elemento ya se encuentre en el DOM para que pueda ser insertado en el panel, vamos a descomentar el código HTML que viene en el material de apoyo y luego escribimos el siguiente código.
var main = new Ext.Panel({
	title: 'My first panel',
	width:250,
	height:300,
	contentEl: 'content' //usamos un elemento del DOM como contenido
});
main.render('frame'); 
My first panel

Contenido cargado de un elemento del DOM

La tercera opción consiste en realizar una llamada Ajax para solicitar el contenido al servidor e insertar dentro del panel la respuesta obtenida, es importante mencionar que el servidor debe enviar código HTML para que sea “renderizado” correctamente en el navegador.
var main = new Ext.Panel({
	title: 'My first panel',
	width:250,
	height:300
});
main.render('frame'); 
//usando Ajax para insertar el contenido
main.load('panel.php'); 
Ajax call

Contenido cargado mediante Ajax

También podemos utilizar la propiedad “autoLoad”, de esta manera cuando creamos la instancia automáticamente se solicitará el contenido mediante una llamada Ajax.
var main = new Ext.Panel({
	title: 'Mi primer panel',
	width:250,
	height:300,
	autoLoad: 'panel.php' //<--- El contenido será sacado de aquí automáticamente
});
main.render('frame'); 
La cuarta opción es insertar otros componentes de Ext JS, pueden ser Paneles, Tabs o pestañas, árboles, acordeones, formularios, etc. Para hacer esto primero necesitamos crear el componente que necesitemos agregar y después asignárselo mediante la propiedad “items” que es un arreglo de componentes.
//creamos el panel interior
var panel1 = new Ext.Panel({
	title: 'Users',
	html: "The content",
	bodyStyle: 'padding:10px;', //podemos asignarle estilos al div contenedor
	height:200,
	border: false //le podemos quitar el borde al panel
});
	
//el panel principal que contendrá otros paneles dentro de si	
var main = new Ext.Panel({
	title: 'My first panel',
	width:250,
	height:600,
	items: [panel1] //aqui se le asignan componentes que contendrá
});
//se renderizan todos los paneles creados
main.render('frame'); 
En el código anterior se creo un panel y después se insertó dentro de otro, esto es muy común cuando desarrollamos layouts con Ext JS, es importante mencionar que al llamar el método “render” del panel principal, automáticamente “renderiza” todos los componentes que contenga.
Panels

Componentes dentro del un panel

Colapsar los paneles

Una de las características que tiene los paneles es que pueden ser colapsados mediante un botón en la parte superior derecha del panel, para realizarlo simplemente se le asigna “true” a la propiedad “collapsible”.
//creamos el panel interior
var panel1 = new Ext.Panel({
	title: 'Users',
	html: 'The content',
	bodyStyle: 'padding:10px;',
	height:200,
	border: false,
	collapsible: true //mediante esta propiedad el panel se colapsa
});
	
//… no se muestra el resto del código por cuestiones de aprendizaje
Panels

Panel colapsable

También es posible que al dar clic sobre cualquier parte del titulo el panel se colapse, esto lo logramos asignando “true” a la propiedad “titleCollapse” de la siguiente manera:
//creamos el panel interior
var panel1 = new Ext.Panel({
	title: 'Users',
	html: 'The content,
	bodyStyle: 'padding:10px;',
	height:200,
	border: false,
	collapsible: true,
	titleCollapse: true  //ahora se colapsará dando clic sobre el título
});
	
//… no se muestra el resto del código por cuestiones de aprendizaje

Agregar un icono en el título del panel

Es común que alguna vez necesitemos agregar iconos en la barra de título para realizar un buen “look and feel”, para hacerlo solo se necesita definir una clase de CSS la cual pondrá como “background” la imagen que usaremos como icono.
.users{
	background: url(/2009/04/icons/users.png) 0px 0px no-repeat !important;
}
Una vez definida la clase CSS se le debe asignar al panel mediante la propiedad “iconCls” de la siguiente manera:
//creamos el panel interior
var panel1 = new Ext.Panel({
	title: 'Users',
	html: 'The content',
	bodyStyle: 'padding:10px;',
	height:200,
	border: false,
	collapsible: true,
	titleCollapse: true, 
	iconCls: 'users'  //con esto se le agregará el icono deseado
});
	
//... no se muestra el resto del código por cuestiones de aprendizaje
Panels

Panel con ícono personalizado

La propiedad “defaults”

Vamos a crear otros dos paneles exactamente iguales al anterior, solo que le vamos a cambiar el título y el icono que tendrán.
var panel1 = new Ext.Panel({
	title: 'Users',
	iconCls: 'users',
collapsible:true,
	border: false,
	bodyStyle: 'padding:10px;',
	titleCollapse: true,
	height:200
});

var panel2 = new Ext.Panel({
	title: 'Reports',
	iconCls: 'reports',
collapsible:true,
	border: false,
	bodyStyle: 'padding:10px;',
	titleCollapse: true,
	height:200
});

var panel3 = new Ext.Panel({
	title: 'Documents',
	iconCls: 'documents',
collapsible:true,
	border: false,
	bodyStyle: 'padding:10px;',
	titleCollapse: true,
	height:200
});

var main = new Ext.Panel({
	title: 'My first panel',
	width:250,
	height:600,
	items: [panel1,panel2,panel3]
});
main.render('frame');	
Si has notado hay mucho código que se repite cuando creamos los primeros tres paneles, exactamente cinco propiedades que no varían en lo absoluto, Ext JS nos permite definir propiedades por defecto para los componentes que utilizan las mismas propiedades, de esta manera evitamos escribir código de más; mediante la propiedad “defaults” podemos definir las propiedades que queramos que sean aplicadas a los componentes que contiene el componente padre.
var panel1 = new Ext.Panel({
	title: 'Users',
	iconCls: 'users'
});
var panel2 = new Ext.Panel({
	title: 'Reports',
	iconCls: 'reports'
});
var panel3 = new Ext.Panel({
	title: 'Documents',
	iconCls: 'documents'
});
		
var main = new Ext.Panel({
	title: 'My first panel',
	width:250,
	height:600,
	defaults: { // con esto evitamos...
		collapsible:true, //duplicar código...
		border: false, // y todas estas...
		bodyStyle: 'padding:10px;', // propiedades ...
		titleCollapse: true, // son agregadas a...
		height:200 //todos los paneles internos
	},
	items: [panel1,panel2,panel3]
});
main.render('frame');
My first panel

Varios panels dentro de un panel principal

Cargar la información

Hemos visto como cargar el contenido de los paneles utilizando Ajax, lo que vamos a realizar en este momento es pasarle parámetros para que nos regrese la información correcta, para esto en el método “load” del panel le pasamos un objeto a la “url”, el método a usar y los parámetros que necesitemos.
panel1.load({
	url: 'panel.php',
	method: 'GET',
	params: {data:'users'}
});
panel2.load({
	url: 'panel.php',
	method: 'GET',
	params: {data:'report'}
});
panel3.load({
	url: 'panel.php',
	method: 'GET',
	params: {data:'documents'}
});
Todas las peticiones son realizadas al mismo archivo de PHP el cual recibe un parámetro y dependiendo de su contenido nos regresa la información adecuada.
My first panel

Producto final

Conclusiones

En este tema vimos como utilizar el Panel, vimos también algunas propiedades y métodos de los más comunes así que te recomiendo mirar el API y jugar un poco con este componente. En el siguiente capitulo voy a mostrar como realizar diferentes layouts para generar diferentes interfaces, por ahora hemos realizado una especie de acordeón muy semejante a la que utiliza el Microsoft Outlook en la parte izquierda. Si tienes algún comentario, sugerencia o duda puedes realizarla utilizando el formulario que se encuentra en la parte inferior de esta página.

Te gustaría recibir más tutoriales como este en tu correo?

Este tutorial pertenece al curso Aprendiendo Ext JS 3, te recomiendo revises el resto de los tutoriales ya que están en secuencia de menor a mayor complejidad.

Si deseas recibir más tutoriales como este en tu correo te recomiendo registrarte al curso, si ya eres miembro solo identifícate y registrate al curso, si no eres miembro te puedes registrar gratuitamente!

Instructor del curso

Crysfel3

Autor: Crysfel Villa

Es ingeniero de software con más de 7 años de experiencia en desarrollo web.

Ver Demostración