ExtJS API Documentation


Hi All, today I am going to explain how to run ExtJS API documentation (any version) on local machine.
Before I knew this, usually I used to go to refer to online ExtJS API documentation.

So there are two ways you can access ExtJS API docs :- 
1) Online ExtJS API Documentation - 

ExtJS (Extended Javascript Library) is developed by Sencha Inc. and been used by many well-known companies across the globe for powering their business applications.
Official Website : http://www.sencha.com/
As far as Online ExtJS API Documentation is concerned, Sencha Inc.’s official website provides links to online API documentations of few latest ExtJS Library versions.
Latest version ExtJS 4.0 is released and you can find its API documentation available on its official website.

ExtJS - Sencha Inc., Homepage
For API documentation of older versions of ExtJS library–
* Easiest way is to search in google.com for “ext api” or “ext 2.2.1 api” or likewise for your version of ExtJS.
E.g. For ExtJS 2.2.1 API Documentation - http://dev.geoext.org/sandbox/ahocevar/playground/ext/docs/
For ExtJS 3.2.1 API Docs - http://www123.ddo.jp/ext-3.2.1/docs/ , etc.

2) Local ExtJS API Documentation-(Ext API running on local machine) :- 

Sometimes it might not be possible to get internet connection or the Website hosting API is under maintenance/down OR its taking more time to load API docs.
In above scenarios it would be better to have ExtJS API running on Local machine (local app server),
Web/Application Servers like Tomcat, Jboss , etc.
Steps : - 
  • Download ExtJS package (of whichever version you want) from  http://www.sencha.com/ or from any other mirror location.
  • Open this library package through WinZip or Winrar or 7z or any compressor software…and extract “docs” folder to some location.
  • Download JBoss/apache tomcat (if you don’t have one) -

a)   For JBoss - http://www.jboss.org/jbossas/downloads/
b)  For apache tomcat - http://tomcat.apache.org/download-70.cgi
  • Extract these server packages to some directory according to your convenience.         
    e.g. C:\Server \jboss-4.2.2.GA…..as I am using jboss 4.2.2 GA version .                       
    OR C:\Server \apache-tomcat-7.0.12
  • Now copy above extracted “docs” folder from ExtJS library package to directory
a)   C:\Server \jboss-4.2.2.GA\server\default\deploy\jboss-web.deployer\ROOT.war\

EXTJSdocs Folder contains ExtJS API Docs


  • Your EXTJSdocs directory should look like - (internal folder structure may change as per ExtJS version)

         b)  C:\Server \apache-tomcat-7.0.12\webapps\ROOT\






Now, Start your Server,
For JBoss , bin\run.bat (for windows)
                    Bin\run.sh (for linux)
For Apache tomcat, bin\ startup.bat (for windows)
                                bin\startup.sh (for linux)

IMP –

  1. To run jboss or tomcat on your machine, first you need to have java installed on your machine.
  2. For tomcat or Jboss, you must correctly set your java home directory path and java lib path in JAVA_HOME, and CLASSPATH environment variables of your computer.
  3. make sure 8080 port not been used currently by any other application like IIS(Internet Information Server) in windows.
  4. If you want to change port number on which the server will run, goto “conf” directory in tomcat OR “jboss-4.2.2.GA\server\default\deploy\jboss-web.deployer “directory and edit server.xml file to change port number.
  5. Search for –“Connector port="8080"….” And change 8080 to some port number which is not in use…generally port numbers above 9000 are preferred..                                  e.g. in my case I have changed Jboss port to 9080
   
JBoss - server.xml and port no changed to 9080 from default 8080  



If you have any difficulty then check all IMP points, otherwise reply I will be happy to help.

Comments

Post a Comment

Popular posts from this blog

How to install / Configure Mantis For Apache-PHP-PostgreSQL combination

Image
How to install / Configure Mantis For Apache-PHP-PostgreSQL combination  → I wanted to write this blog a long back, but better late than never. Three years back I was working on a project where we had used Mantis Bug Tracker for managing our bugs list, for that, I had to install it on a server from where our teams could access it to log the software bugs and update the fixes. Important learnings - with new php versions, I faced few issues with postgresql configs, then while setting up database instance for mantis I faced few issues with postgres port configs and how to give it on mantis config files, database user grant problem. I had to set up everything from scratch so learned a lot. (Note - mantisbt  →  mantis bug tracker) Why I have written this post  →  at that time I could not find any resource on web which would give me good tutorial on how to install mantisbt on Apache and PostgreSQL. So I wanted to put it on web so others could some of thei...
Read more

Modified ExtJS LOVCombo (List of Values) ux plugin - with select all, deselect all, text filter, bubble up and bubble down of selection

Image
Here is one interesting modification to LOVCombo ux plugin in ExtJS 3.4. The original ExtJS ux Lovcombo i.e.Ext.ux.form.LovCombo plugin was developed by Jozef Sakáloš and can be still found at  http://lovcombo.extjs.eu/ . In Ext 4.x onwards, similar modifications can be applied to combo-box through plugin property. Following modification to Ext.ux.form.LovCombo, enables it to have "Select All", "Deselect All", "Text Filtering on values", "bubbling up and down of selection events". Its just a toolbar added in xtemplate of combo-box's dropdown list, and this toolbar has all these buttons, filter text-fields, etc. Here is how it looks like - It has five features - 1) Select All / Deselect All checkbox - to check/uncheck all values and its not part of your data, so selection / deselection logic is separate from user's data. 2) Text Filter - In case of long lists, this will be handy, to filter out values and select /deselec...
Read more

TriggerField with two triggers, TwinTriggerField with tooltips

Image
Twin Trigger and Twin Trigger Combobox in ExtJS,  How to give qtip / quicktip / tooltip to Twin Trigger Field In ExtJS, there is a class Ext.form.TwinTriggerField (though its an abstract class) which is used to create objects of TwinTrigger, and can be extended to form n-trigger field.  Depending upon the requirement it can be easily, modified. Basically DateField and ComboBox are the examples of single trigger Textfield. Simple TwinTriggerField  Here is sample code how to use basic TwinTriggerField (which is basically a Textfield with two triggers/buttons which can be assigned different handlers) - new Ext.form.TwinTriggerField({ id : 'twintrigger', fieldLabel : "TwinTrigger", //Custom icon-classes for triggers trigger1Class : 'x-form-clear-trigger', //trigger2Class : 'customTriggerIcon', //Enable Key events over textfield enableKeyEvents : true, //Separate Trigger handlers onTrigger1Click : function(fie...
Read more