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 and inheritance. 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.

Sencha GXT 4.x

Guides
API
modern
classic
Benefits
top

GWT and Java Basics

Basic structures and functions used with Java and GWT.

Variables

Create & assign a value

  • Using Java and GWT

      // Explicit type
      String name = "Brandon";
    
      // Non typed variable
      Object name = "Brandon";
    

Default value

  • Using Java and GWT

      String name; // is null
      int y; // is 0
    

Final variables

  • Using Java and GWT

      public final class Bird {
        public final String name = "Tweety";
        public Bird() {
          this.name = "can't reassign"; // can't do on finals
        }
      }
    

Collections

Arrays & Lists

  • Using Java and GWT

      int[] a = new int[5];
      String[] ns = { "0", "1", "2", "3", "4" };
    
      int size = ns.length;
    
      // Generics
      List<Integer> a = Arrays.asList(new Integer[]{1, 2});
      List<String> d = new ArrayList<String>();
    

Custom sort

  • Using Java and GWT

      List<Double> numbers = new ArrayList<Double>();
      numbers.add(42D);
      numbers.add(2.1);
      numbers.add(5D);
      numbers.add(0.1);
      numbers.add(391D);
    
      Collections.sort(numbers);    
    
      // Or a manual sort
      Collections.sort(numbers, new Comparator<Double>() {
        @Override
        public int compare(Double a, Double b) {
          return a.compareTo(b);
        }
      });
    
      System.out.println(numbers); // is [0.1, 2.1, 5.0, 42.0, 391.0]
    

Key-value pairs

  • Using Java and GWT

      Map<String, String> periodic = new HashMap<String, String>();
    

Using keys

  • Using Java and GWT

      Map<String, String> peeps = new HashMap<String, String>();
      peeps.put("Fred", "tall");
      peeps.put("Joe", "short");
    
      // Child object uses methods equals(Object) and hashCode()
      Map<Child, String> favorites = new HashMap<Child, String>();
      favorites.put(new Child("Sam"), "Ball");
    

Sets

Unique collections.

  • Using Java and GWT

      Set<String> items = new HashSet<String>();
      items.add("one");
      items.add("two");
      items.size(); // has 2
    
      items.add("three");
      items.size(); // has 3
    

Queues (FIFO)

  • Using Java and GWT

      Queue<String> queue = new LinkedList<String>();
      queue.add("evt:1111");
      queue.add("evt:2222");
    
      System.out.println(queue.size());  // has 2
    
      String eventId = queue.remove();
    
      System.out.println(eventId == "evt:1111"); // is true
      System.out.println(queue.size()); // has 1
    

Strings

Raw strings

  • Using Java and GWT

      char[] raw = { 'G', 'X', 'T', ' ', '.', '.', '.', ' ', '\\', 't' };
    
      String string = "GXT ... \\t";
    

Interpolation

  • Using Only Java

      String name = "Brandon";
      String hello = String.format("I'm %s.", name);
    
      String helloFormatted = String.format("But you can call me, %sski.", name);
    
      int top = 13;
      String property = String.format("%spx", (top + 15));    
    

Concatenation

  • Using Java and GWT

      String message = "One line. "
                     + "Two line.";
    

Substring

  • Using Java and GWT

      "redhouses".substring(3, 8) // is 'house'
    

Replace all occurrences

  • Using Java and GWT

      "doghouses".replaceAll("s", "z") // is 'doghouzez'
    

Replace one occurrence

  • Using Java and GWT

      "fastcar".replaceFirst("fast", "space") // is 'spacecar'
    

Multiline strings

  • Using Java and GWT

      String string = "";
      string += "One line. ";
      string += "Two lines.";
    

Split into an array

  • Using Java and GWT

      String alpha = "a, b, c, d";
      String[] group = alpha.split(", "); // is ["a", "b", "c", "d"];
    

Substring test

  • Using Java and GWT

      "fastcar".startsWith("fast"); // is true
      "lowrider".startsWith("cool"); // is false
    

Booleans

If statements

  • Using Java and GWT

      int[] numbers = {1, 2, 3, 4};
      if (numbers.length > 2) {
        System.out.println("do something");
      }        
    

Ternary statements

  • Using Java and GWT

      int[] numbers = new int[] { 1, 2, 3, 4 };
      String condition = numbers.length > 2 ? "Good" : "Bad";
      System.out.println("The condition is " + condition);        
    

Empty string

  • Using Java and GWT

      String empty = "";
      if (empty.isEmpty()) {
          System.out.println("empty");
      }        
    

Zero

  • Using Java and GWT

      int zero = 0;
      if (zero == 0) {
        System.out.println("zero");
      }
    
      Integer zero2 = 0;
      if (zero2.equals(0)) {
        System.out.println("zero");
      }
    

Null

  • Using Java and GWT

      String myNull = null;
      if (myNull == null) {
        System.out.println("is null");
      }
    

NAN

  • Using Java and GWT

      Double nan = Double.NaN;
      if (Double.isNaN(nan)) {
          System.out.println("NaN");
      }
    

Equality

  • Using Java and GWT

          String letterA = "A";
          char charA = 65;
    
          letterA == charA // is false
          letterA.equals(String.valueOf(charA)) // is true
    
          int number5 = 5;
          String char5 = "5";
    
          number5 == char5 // incompatible type comparision
          Integer.toString(number5).equals(char5) // is true
    
          class User {
            String name;
            String ssn;
    
            User(String name, String ssn) {
              this.name = name;
              this.ssn = ssn;
            }
    
            @Override
            public boolean equals(Object obj) {
              User p = (User) obj;
              return ssn.equals(p.ssn);
            }
    
            @Override
            public int hashCode() {
              final int prime = 31;
              int result = 1;
              result = prime * result + ((name == null) ? 0 : name.hashCode());
              return result;
            }
          }
    
          new User("Brandon", "111").equals(new User("Robert", "111") // is true        
    

Functions

Function definition

  • Java and GWT

      // Java uses methods intead of functions like Javascript and Dart
      boolean method() {
        // ...
        return true;
      }
    
      void method2() {
        // ...
      }        
    

Return value

  • Java and GWT

      boolean isMethod() {
        return true;
      }
    
      TheType getTheTypeMethod() {
        return new TheType();
      }
    
      void method() {
        // returns nothing
      }
    

Assign a function to a variable

  • Java 1.8

      public class LambdaExample {
        interface Loudify {
          String loudify(String msg);
        }
    
        public static void main(String[] args) {
          Loudify loudify = (String msg) -> msg.toUpperCase();
    
          System.out.println(loudify.loudify("not gonna take it anymore"));
        }
      }        
    

Variable number of arguments or VarArgs

  • Java and GWT

      public void method(String... strings) {
      }
      method("a", "b", "c");
    

Iterators

For loops for lists

  • Java and GWT

      List<String> letters = new ArrayList<String>();
      letters.add("a");
      letters.add("b");
      letters.add("c");
    
      for (int i = 0; i < letters.size(); i++) {
        System.out.println(letters.get(0));
      }
    

For-in loops

  • Java and GWT

      List<String> letters = new ArrayList<String>();
      letters.add("a");
      letters.add("b");
      letters.add("c");
    
      for (String letter : letters) {
        System.out.println(letter);
      }
    

For loops with objects/maps

  • Java and GWT

      Map<String, String> letters = new HashMap<String, String>();
      letters.put("1", "a");
      letters.put("2", "b");
      letters.put("3", "c");
    
      for (String key : letters.keySet()) {
        System.out.println(key + ", " + letters.get(key));
      }
    
      Set<String> letters2 = new HashSet<String>();
      letters2.add("e");
      letters2.add("f");
      letters2.add("g");
    
      Iterator<String> iterator = letters2.iterator();
      while (iterator.hasNext()) {
        System.out.println(iterator.next());
      }
    

Closure with counters in loops

  • Java 1.8

      public class LambdaExample {
        public interface Callback {
          void callback();
        }
    
        public static void main(String[] args) {
          List<Callback> callbacks = new ArrayList<Callback>();
    
          for (int i = 0; i < 2; i++) {
            final int ii = i;
            Callback callback = () -> System.out.println(Integer.toString(ii));
            callbacks.add(callback);
          }
    
          callbacks.get(0).callback(); // is 0
          callbacks.get(1).callback(); // is 1
        }
      }
    

Classes

Structure

  • Java and GWT

      public class User {
        private String name;
    
        public String greet() {
          return String.format("Hello, %s", name);
        }
      }
    

Constructor with parameter

  • Java and GWT

      public class User {
        private String name;
    
        public User(String name) {
          this.name = name;
        }
      }
    

Instantiate

  • Java and GWT

      User User = new User();
    

Reflection

  • Java and GWT

      User User = new User("a");
      System.out.println(User.getClass().getSimpleName()); // is User
    

Type comparison

  • Java and GWT

      String name = "Brandon";
      System.out.println(name instanceof String); // is true
    

Subclass

  • Java and GWT

      public class User {
        private String name;
    
        public User(String name) {
          this.name = name;
        }
    
        public String greet() {
          return "Hello, " + name;
        }
      }
    
      public class Info extends User {
        private int salary;
    
        public Info(String name, int salary) {
          super(name);
          this.salary = salary;
        }
    
        public void raisePay(double percent) {
          percent /= 100;
          salary += (salary * percent);
        }
    
        public int getSalary() {
          return salary;
        }
      }
    

Define a library

  • Using Java and GWT

      // Package namespace declaration
      package animals;
    
      // One class per file
      public class Dog {
        public String bark() {
          return "woof!";
        }
      }
    

Use a library

  • Using Java and GWT

      // Prepending package to class instantiation
      Dog woofy = new animals.Dog();
    
      // Package import declaration
      import animals;
      Dog woofy = new Dog();
    

Math

Absolute value

  • Java and GWT

      Math.abs(-7) // is 7
    

Ceiling

  • Java and GWT

      Math.ceil(7.78); // is 7.0
    

Floor

  • Java and GWT

      Math.floor(3.89); // is 3.0
    

Random

  • Java and GWT

      Random rand = new Random();
      rand.nextDouble();
      rand.nextBoolean();
      rand.nextInt();
    

Sine and Cosine

  • Java and GWT

      Math.sin(Math.PI / 2); // is 1.0
      Math.cos(Math.PI); // is -1.0
    

Convert a String to a number

  • Java and GWT

      Integer.parseInt("2") // is 2
      Double.parseDouble("4.18") // is 4.18
    
      Integer.parseInt("2px") // is ERROR
      Integer.parseInt("two") // is ERROR
    

Sencha GXT 4.x

Ext JS
Sencha Test
Cmd
Sencha Themer
GXT
IDE Plugins
Sencha Inspector
Architect
Sencha Fiddle
Touch
Offline Documentation

Sencha Test

2.0.0 1.0.3

Cmd

Cmd

Sencha Themer

1.1.0 EA 1.0.2

GXT

5.x EA 4.x 3.x

IDE Plugins

IDE Plugins

Sencha Inspector

Sencha Inspector

Sencha Fiddle

Sencha Fiddle

Offline Documentation

Offline Documentation