Docs Help

Terms, Icons, and Labels

Many classes have shortcut names used when creating (instantiating) a class with a configuration object. The shortcut name is referred to as an alias (or xtype if the class extends Ext.Component). The alias/xtype is listed next to the class name of applicable classes for quick reference.

Access Levels

Framework classes or their members may be specified as private or protected. Else, the class / member is public. Public, protected, and private are access descriptors used to convey how and when the class or class member should be used.

Member Types

Member Syntax

Below is an example class member that we can disect to show the syntax of a class member (the lookupComponent method as viewed from the Ext.button.Button class in this case).

lookupComponent ( item ) : Ext.Component
protected

Called when a raw config object is added to this container either during initialization of the items config, or when new items are added), or {@link #insert inserted.

This method converts the passed object into an instanced child component.

This may be overridden in subclasses when special processing needs to be applied to child creation.

Parameters

item :  Object

The config object being added.

Returns
Ext.Component

The component to be added.

Let's look at each part of the member row:

Member Flags

The API documentation uses a number of flags to further commnicate the class member's function and intent. The label may be represented by a text label, an abbreviation, or an icon.

Class Icons

- Indicates a framework class

- A singleton framework class. *See the singleton flag for more information

- A component-type framework class (any class within the Ext JS framework that extends Ext.Component)

- Indicates that the class, member, or guide is new in the currently viewed version

Member Icons

- Indicates a class member of type config

- Indicates a class member of type property

- Indicates a class member of type method

- Indicates a class member of type event

- Indicates a class member of type theme variable

- Indicates a class member of type theme mixin

- Indicates that the class, member, or guide is new in the currently viewed version

Class Member Quick-Nav Menu

Just below the class name on an API doc page is a row of buttons corresponding to the types of members owned by the current class. Each button shows a count of members by type (this count is updated as filters are applied). Clicking the button will navigate you to that member section. Hovering over the member-type button will reveal a popup menu of all members of that type for quick navigation.

Getter and Setter Methods

Getting and setter methods that correlate to a class config option will show up in the methods section as well as in the configs section of both the API doc and the member-type menus just beneath the config they work with. The getter and setter method documentation will be found in the config row for easy reference.

History Bar

Your page history is kept in localstorage and displayed (using the available real estate) just below the top title bar. By default, the only search results shown are the pages matching the product / version you're currently viewing. You can expand what is displayed by clicking on the button on the right-hand side of the history bar and choosing the "All" radio option. This will show all recent pages in the history bar for all products / versions.

Within the history config menu you will also see a listing of your recent page visits. The results are filtered by the "Current Product / Version" and "All" radio options. Clicking on the button will clear the history bar as well as the history kept in local storage.

If "All" is selected in the history config menu the checkbox option for "Show product details in the history bar" will be enabled. When checked, the product/version for each historic page will show alongside the page name in the history bar. Hovering the cursor over the page names in the history bar will also show the product/version as a tooltip.

Search and Filters

Both API docs and guides can be searched for using the search field at the top of the page.

On API doc pages there is also a filter input field that filters the member rows using the filter string. In addition to filtering by string you can filter the class members by access level, inheritance, and read only. This is done using the checkboxes at the top of the page.

The checkbox at the bottom of the API class navigation tree filters the class list to include or exclude private classes.

Clicking on an empty search field will show your last 10 searches for quick navigation.

API Doc Class Metadata

Each API doc page (with the exception of Javascript primitives pages) has a menu view of metadata relating to that class. This metadata view will have one or more of the following:

Expanding and Collapsing Examples and Class Members

Runnable examples (Fiddles) are expanded on a page by default. You can collapse and expand example code blocks individually using the arrow on the top-left of the code block. You can also toggle the collapse state of all examples using the toggle button on the top-right of the page. The toggle-all state will be remembered between page loads.

Class members are collapsed on a page by default. You can expand and collapse members using the arrow icon on the left of the member row or globally using the expand / collapse all toggle button top-right.

Desktop -vs- Mobile View

Viewing the docs on narrower screens or browsers will result in a view optimized for a smaller form factor. The primary differences between the desktop and "mobile" view are:

Viewing the Class Source

The class source can be viewed by clicking on the class name at the top of an API doc page. The source for class members can be viewed by clicking on the "view source" link on the right-hand side of the member row.

GXT 4.x


top

Create a GWT Project in IDEA with Standard Packaging

Prerequisites

Intellij IDEA supports developing web applications based on Google Web Toolkit until Intellij 2019. After Intellij 2020 it does not support creation of web applications based on Google Web Toolkit.

Reference

Creating the GWT Project

  1. After launching Intellij IDEA select Create New Project.

  2. Project Configuration.

    • Choose the JAVA Enterprise option when creating a new project.
    • Select the appropriate Java version that you are using, e.g., Java 11.
    • Select Google Web Toolkit under Additional Libraries and Frameworks, configure the downloaded GWT SDK Download GWT SDK and extract it to an easily accessible location on your machine.
    • Click on the checkbox of Create sample application.
    • Click on Next button.

  3. Specify the application name and the location where you want the application to be created.

  4. Click on finish button and the Project layout will look like this

Running and Debugging the GWT Project

To run the project, simply click the play button. The GWT plugin will automatically configure everything.

Once you're able to run it, the terminal output look like this:

It will automatically redirect to default browser, the browser output should look like this:

For debugging, just click the debug button to start the project in debugging mode.

For Java configuration

  • Click on File and navigate to Project Structure.

  • Go to the Project section. Under Project SDK, change the version.

  • After changing the version, click the Apply button.

For Java 21

For Java 21, you might see an Unsupported class file major version 65 error. This happens when some class files are compiled with Java 21 (class file major version 65), but your runtime environment does not support this version. Consequently, Jetty and other components may not process these class files due to the incompatibility between Java 21 and Intellij IDE.

To successfully run your project, you can resolve this issue by adjusting the Java language level:

  • Go to File and open Project Structure.
  • In the Project section, select the Project language level.
  • Choose 11 - Local variable syntax for lambda parameters from the dropdown menu.
  • Click Apply, then OK.

Explanation:

Setting the project language level to Java 11 ensures greater compatibility with your runtime environment and tools like Jetty.

Note: This step is necessary due to a limitation in IntelliJ IDEA 2019, which does not fully support Java 21 on jetty server

Create GWT project with Intellij 13

  1. After loading IntelliJ IDEA select Create New Project.

  2. Select Java Module on the left, name the project and then select a project directory location.

  3. Select the GWT SDK directory location.

    • Download GWT SDK and extract it to an easily accessible location on your machine.

  4. Click finish and then the project layout will look something like this.

Installing Chrome GWT developer plugin

  1. When debugging GWT for the first time in Chrome it will ask to install the GWT Developer Plugin. Click on the download link.

  2. The download link goes to Chrome Store GWT Developer plugin. Select +Add To Chrome.

  3. Confirm and select Add.

  4. Once the plugin has completed installation hit the back button until getting back at the GWT debug link.

Debug the new GWT project

Just after creating the new project check if it works.

  1. Start debugging the application by clicking on the debug icon.

  2. A moment later the default browser will load the application.

Debugging in multiple browsers

Multiple browsers can be used to debug the application.

  1. Select Edit Configurations....

  2. In the Project's Debug Configuration find Open in browser:.

  3. Click on the Open in browser: configuration button.

  4. Change Default Web Browser to Use Firefox or one of the browsers listed below.

Project settings

  1. Select Edit Configurations...

  2. Tune the application debugging properties and behavior here.

Setting the JVM heap space

Large applications with many inherited libraries may need more heap space.

  • In the Project Settings debug configuration VM options input -Xss1024K -Xmx1024M -XX:MaxPermSize=128M. The default heap space is -Xmx512M. The above configuration solves most large application scenarios, although these are a suggestion and can be adjusted to the desired size.

GXT 4.x