Blog

Resources

Before you start this tutorial, you need to download the resources. Remember that this tutorial is part of the chapter Form, and end of the tutorial we will add our ComboBox to the form we created in the previous tutorial, but to avoid some confusion we’ll do this tutorial in a separate file.

Packaging the tutorial.

Let’s package our code before we start.

Ext.ns('com.quizzpot.tutorial');

Ext.BLANK_IMAGE_URL = '../ext-3.0/resources/images/default/s.gif';

com.quizzpot.tutorial. ComboBoxTutorial= {
	init: function(){
		//code for the tutorial goes here
       }
}
Ext.onReady(com.quizzpot.tutorial. ComboBoxTutorial.init,com.quizzpot.tutorial. ComboBoxTutorial);

Window

At this moment we’re going to create a window that will contain different types of ComboBox. This window will display the different ComboBoxes we will create in this tutorial.

var win=new Ext.Window({
	title: 'ComboBox example',
	bodyStyle:'padding: 10px',		//adding padding to the components
	width:400,
	height:360,
	layout:'form'			//organization of the components
});
win.show();

We can highlight the property “layout:’form’” from the code above, because for a window the layout by default is “auto“, so we needed to overwrite the property to display the components distributed as a form.

Local ComboBox

After creating the window, let’s create our ComboBoxes; the first thing we need is the data that will be loaded into our ComboBox, the simplest way to load data into our ComboBox is using an array.

var data=['Code Igniter','Cake Php','Symfony','Zend'];

var comboLocal =new Ext.form.ComboBox({
	fieldLabel:'Frameworks PHP',
	name:'cmb-data',
	forceSelection:true,
	store:data,
	emptyText:'Select a framework...',
	triggerAction: 'all',
	//hideTrigger:true,
	editable:false,
	//minChars:3
});

The above code creates a ComboBox with data naming some existing PHP Frameworks. Let’s see the meaning of the properties that we can use to configure our ComboBox:

forceSelection: This option forces the user to select a value from the combo, this is independent of the type of validation allowBlank, which we will discuss in the next tutorial.
store: is the data source that our combo will show, we’ve talked about this component previously.
emptyText: this is the text displayed when we haven’t selected anything in our combo.
triggerAction: this option indicates the action to execute when the trigger is clicked.
editable: the combo can not be edited, which means you can not write any value on it.
hideTrigger: setting this property to true we make the combo to be displayed without the small down arrow icon (“trigger”).
minChars: it tells us how many characters we must write before the combo starts to display information, in our case we must comment the editable property and not comment the property minChars to see its functionality.

Let’s add the ComboBox to our window:

var win=new Ext.Window({
	bodyStyle:'padding: 10px',//adding padding to the components
	width:400,
	height:360,
	items: comboLocal, //adding the combo to the window
	layout:'form'		//organization of the components
});
win.show();

Remote ComboBox

Now let’s create a combo that we will load with data remotely using Ajax. On this occasion we will use PHP, but as we know we can use any server language.

In the remote ComboBox we will use for our source of data a JSON type store, I won’t explain this component because we already talked about it in previous tutorials.

The JS code will go like this:

//se crea el store
var store= new Ext.data.JsonStore({
		url:'combo.php',
		root: 'data',
		totalProperty: 'num',
		fields: [
			{name:'name', type: 'string'},
			{name:'desc', type: 'string'},
			{name:'logo', type: 'string'},
		]
});

//creating the combo and assigning the store
var comboRemote=new Ext.form.ComboBox({
	fieldLabel:'Data Base',
	name:'cmb-DBs',
	forceSelection: true,
	store: store, //assigning the store
	emptyText:'pick one DB...',
	triggerAction: 'all',
	editable:false,
	displayField:'name',
        valueField: 'name'
});

As you can see in the properties of our combo we added the property displayField, with this property we tell the ComboBox the information to display, in this case is going to show only the data ‘name’ and using the property “valueField” we specify which field the store is going to use as a “value”, it can be a numeric ID but in this case we use the name.

Finally we need to add the combo we just created to the window, as follows:

var win=new Ext.Window({
	title: 'ComboBox example',
	bodyStyle:'padding: 10px',		//adding padding to the components
	width:400,
	height:360,
	items: [comboLocal,comboRemote],//adding the remote combo
	layout:'form'					//organization of the components
});
win.show();

With PHP code we’re going to present the information to display the combo, this information can come from a database or a Web Service, to make things simple and understandable the information is “hardcoded” in arrays.

<?php
	$dataDB = array(
				array(
					"name"=>"MySQL",
					"desc"=>"The world's most popular open source database",
					"logo"=>"mysql.png"
				),
				array(
					"name"=>"PostgreSQL",
					"desc"=>"The world's advanced open source database",
					"logo"=>"postgresql.png"
				),
				array(
					"name"=>"Oracle",
					"desc"=>"The world's largest enterprise software company",
					"logo"=>"oracle.png"
				),
	);

	$o = array(
			"num"=>count($dataDB),
			"data"=>$dataDB
		);
	echo json_encode($o);
?>

As you can see, we have defined the fields the JsonStore accepts, also with the function json_decode we are generating the JSON from a PHP array.

Formatted Data

Okay now let’s give a format to our information, we will use the information from our remote combo, so let’s get started. Let’s create a new ComboBox that will be loaded with the same data that the PHP code provides, using the same store as the previous combo.

To format our ComboBox we need a template, so we’re going to assign the template to our new combo by using one of its properties ( “tpl” of “template”). The template is written in HTML with some CSS so the information is display in detail.

var comboRemoteTpl = new Ext.form.ComboBox({
	fieldLabel:'Data Base',
	name:'cmb-Tpl',
	forceSelection:true,
	store:store,
	emptyText:'pick one DB...',
	triggerAction: 'all',
	mode:'remote',
	itemSelector: 'div.search-item',
	tpl: new Ext.XTemplate('<tpl for="."><div class="search-item" style="background-image:url({logo})"><div class="name">{name}</div><div class="desc">{desc}</div></div></tpl>'),
	displayField:'name'
});

The properties that appear now are:
tpl: assigns a template to display each data of the combo, the template created is a string of HTML and some CSS styles and classes; in future tutorials we will talk about more on the functionality of the object “Ext.XTemplate“, so for now is only worth mentioning that with a loop we go through all the records in the store and generate a list of options for the user.

itemSelector: this property tells us which property of the DOM is going to trigger the “select” event of our combo.

So far we have modified the HTML of the drop-down list of the combo, what we need to do now is set the styles needed like this:

	.search-item{
		border:1px solid #fff;
		padding:3px;
		background-position:right bottom;
		background-repeat:no-repeat;
	}
	.desc{
		padding-right:10px;
	}
	.name{
		font-size:16px !important;
		color:#000022;
	}

A variation of the ComboBox

There’s a component that ExtJS that is a variation of the ComboBox, this component is called TimeField and is useful to display values dealing with time. The majority of the properties are the same as the ComboBox.

var timeField=new Ext.form.TimeField({
       	fieldLabel: 'Time Field',
       minValue: '4:00',
       maxValue: '23:59',
       increment: 15,
       format:'H:i',
       name:'cb-time'
});

As we can see, we have created a new ComboBox that shows data in time format without any problems.
Let me explain some of its properties:
minValue: is the minimal value that will be shown in our field.
maxValue: is the maximum value that will be shown.
increment: the number of minutes between each time value in the list.
format: the format of the time we’re going to display.

Conclusions

Today we saw a very complete component called ComboBox, this component has many different types of configurations that make it a very used component in all kinds of applications with Ext JS.

To see more benefits of this component do not forget to check the ExtJS API Documentation.

If you have any questions or suggestion don’t forget to leave a comment and follow us on Twitter (@quizzpot) to be updated.