文档帮助

术语、图标和标签

许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias(如果类扩展了 Ext.Component,则称为 xtype)。别名/xtype 列在适用类的类名旁边,以便快速参考。

访问级别

框架类或其成员可以指定为 privateprotected。否则,该类/成员是 publicPublicprotectedprivate 是访问描述符,用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析,以展示类成员的语法(在本例中是从 Ext.button.Button 类查看的 lookupComponent 方法)。

lookupComponent ( item ) : Ext.Component
受保护的

当原始配置对象添加到此容器时调用,无论是在 items 配置的初始化期间,还是在添加新项目时,或 {@link #insert 插入}。

此方法将传递的对象转换为实例化的子组件。

当需要对子创建应用特殊处理时,可以在子类中重写此方法。

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

让我们看一下成员行的每个部分

成员标志

API 文档使用许多标志来进一步沟通类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

类图标

- 表示框架类

- Singleton 框架类。*有关更多信息,请参阅 singleton 标志

- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)

- 表示类、成员或指南在当前查看的版本中是新的

成员图标

- 表示 config 类型的类成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

- 表示类、成员或指南在当前查看的版本中是新的

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分,就在它们所使用的配置下方。Getter 和 setter 方法文档将在配置行中找到,以便于参考。

历史记录栏

您的页面历史记录保存在本地存储中,并显示在顶部标题栏的正下方(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。

在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择“全部”,则“在历史记录栏中显示产品详细信息”的复选框选项将启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,用于使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原始页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例和类成员

可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠所有切换按钮来展开和折叠成员。

桌面与移动视图

在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面和“移动”视图之间的主要区别在于

查看类源代码

可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

GXT 4.x


顶部

手势

GXT 触摸支持是使用 GestureRecognizers 实现的,GestureRecognizers 将触摸事件转换为逻辑手势,例如点击、双击和长按。所有 GestureRecognizers 的基类是 com.sencha.gxt.core.client.gestures.AbstractGestureRecognizer,它处理原始触摸事件并控制事件流到 GestureRecognizer 实现。

使用 GestureRecognizers

GXT 4 提供了三种辅助方法,用于将 GestureRecognizer 添加到小部件或单元格。这些方法是

这些方法处理触摸事件转发到 GestureRecognizer 所需的所有管道,因此您不必这样做。这包括

  1. 接收触摸事件
  2. 在 AbstractGestureRecognizer 中附加识别器
  3. 将通过 onBrowserEvent() 接收的触摸事件转发到每个附加的识别器

以下部分展示了如何将 GestureRecognizer 正确添加到您的 Widget 或 Cell。您通常在要处理手势的 Widget 或 Cell 的构造函数中调用上述辅助方法之一。

在组件内

在扩展 com.sencha.gxt.widget.core.client.Component 的小部件中,使用 Component.addGestureRecognizer()。例如,要在扩展 Component 的自定义小部件中处理长按,请将以下内容添加到您的小部件构造函数中

public MyCustomComponent() {
    ...
    longPressOrTapGestureRecognizer = new LongPressOrTapGestureRecognizer() {
        @Override
        protected void onLongPress(TouchData touchData) {
        super.onLongPress(touchData);
        doSomething();
    }
    addGestureRecognizer(longPressOrTapGestureRecognizer);
    ...
}

有关 GXT 本身的示例,请参阅 com.sencha.gxt.widget.core.client.DatePicker 构造函数的源代码。

在单元格内

在扩展 com.sencha.gxt.cell.core.client.AbstractEventCellcom.sencha.gxt.cell.core.client.AbstractEventInputCell 的单元格中,使用 AbstractEventCell.addCellGestureAdapter()。例如,要在自定义 Cell 中处理点击,请扩展 AbstractEventCell 并在构造函数中添加以下内容

public MyCustomCell() {
    ...
    addCellGestureAdapter(new TapGestureRecognizer.CellTapGestureRecognizer<C>() {
        @Override
        protected void onTap(TouchData tap, Context context, Element parent, C value, ValueUpdater<C> valueUpdater) {
          doSomething();
        }
    }
    ...
}

有关 GXT 本身的示例,请参阅 com.sencha.gxt.cell.core.client.ButtonCell 构造函数。

在小部件内

GXT 提供了一个适配器,允许您将 GestureRecognizer 添加到任何 com.google.gwt.user.client.ui.Widget。只需构造一个新的 com.sencha.gxt.core.client.gestures.TouchEventToGestureAdapter 实例,并将 Widget 和 GestureRecognizer 传递给它。例如,要在自定义 Widget 中处理双击,请在 widget 的构造函数中添加以下内容

public MyCustomWidget() {
    ...
    doubleTapGestureRecognizer = new DoubleTapGestureRecognizer() {
        @Override
        protected void onDoubleTap(TouchData touchData) {
          super.onDoubleTap(touchData);
          doSomething();
        }
    }
    new TouchEventToGestureAdapter(this, doubleTapGestureRecognizer);
    ...
}

有关 GXT 本身的示例,请参阅 com.sencha.gxt.widget.core.client.tips.ToolTip 构造函数。

同样,上述三种 GXT 方法处理所有事件管道,因此您只需在 Widget 或 Cell 中实现 GestureRecognizer 的处理程序方法即可。

参考

手势

GXT 提供了以下 GestureRecognizers。

手势 描述
com.sencha.gxt.core.client.gestures.AbstractGestureRecognizer 基本触摸手势类
com.sencha.gxt.core.client.gestures.AbstractTwoTouchGestureRecognizer 基本多点触摸手势类
com.sencha.gxt.core.client.gestures.CellGestureAdapter 基本 Cell 手势类
com.sencha.gxt.core.client.gestures.DragGestureRecognizer 拖动手势
com.sencha.gxt.core.client.gestures.DoubleTapGestureRecognizer 双击手势
com.sencha.gxt.core.client.gestures.GestureChain 多手势链接
com.sencha.gxt.core.client.gestures.LongPressOrTapGestureRecognizer 长按手势
com.sencha.gxt.core.client.gestures.PinchAndRotateGestureRecognizer 捏合和旋转手势
com.sencha.gxt.core.client.gestures.ScrollGestureRecognizer 滚动条手势
com.sencha.gxt.core.client.gestures.TapGestureRecognizer 点击手势

示例

以下示例展示了如何在扩展 com.sencha.gxt.widget.core.client.Component 的自定义小部件中使用每个 GestureRecognizer。要将 GestureRecognizer 连接到 Cell 或其他 Widget,请使用上面的相应辅助方法。

DragGestureRecognizer

这是一个低级别连接拖动的示例。使用 GXT com.sencha.gxt.fx.client.Draggable 系统要简单得多。您可以在 Explorer 示例中找到使用 GXT Draggable 的示例。

dragGestureRecognizer = new DragGestureRecognizer() {
  @Override
  protected boolean onStart(TouchData startedTouch) {
    super.onStart(startedTouch);
    return onTouchStart(startedTouch);
  }

  @Override
  protected void onMove(List<TouchData> touches) {
    super.onMove(touches);
    onTouchMove(touches);
  }

  @Override
  protected void onCancel(List<TouchData> touches) {
    super.onCancel(touches);
    onTouchEnd(touches);
  }

  @Override
  protected void onEnd(List<TouchData> touches) {
    super.onEnd(touches);
    onTouchEnd(touches);
  }
};

// wire it up
addGestureRecognizer(dragGestureRecognizer);

DoubleTapGestureRecognizer

doubleTapGestureRecognizer = new DoubleTapGestureRecognizer() {
    @Override
    protected void onTap(TouchData touchData) { 
      super.onTap(touchData);
      onTap(touchData);
    }

    @Override
    protected void onDoubleTap(TouchData touchData) {
      super.onDoubleTap(touchData);
      onDoubleTap(touchData);
    }
}
// wire it up
addGestureRecognizer(doubleTapGestureRecognizer);

LongPressOrTapGestureRecognizer

longPressOrTapGestureRecognizer = new LongPressOrTapGestureRecognizer() {
  @Override
  protected void onLongPress(TouchData touchData) {
    super.onLongPress(touchData);
    onLongPress(touchData);
  }
};

// wire it up
addGestureRecognizer(longPressOrTapGestureRecognizer);

PinchAndRotateGestureRecognizer

pinchAndRotateGestureRecognizer = new PinchAndRotateGestureRecognizer();

// wire it up
addGestureRecognizer(pinchAndRotateGestureRecognizer);

ScrollGestureRecognizer

ScrollGestureRecognizer 与其他识别器略有不同。要使用它,您需要将要滚动的 DOM 元素传递给它,并且 ScrollGestureRecognizer 通过设置元素的 scrollTop 属性来创建滚动效果。因此,没有必要实现任何 onScroll() 方法。

scrollGestureRecognizer = new ScrollGestureRecognizer(scrollElement, ScrollDirection.BOTH);

// wire it up
addGestureRecognizer(scrollGestureRecognizer);

在某些情况下,可能需要根据涉及的特定 DOM 元素自定义 ScrollGestureRecognizer 的行为。以下是 GXT 的 com.sencha.gxt.widget.core.client.grid.LiveGridView 类中的一个示例

@Override
    protected void onAfterRenderView() {
    super.onAfterRenderView();

    if (scrollGestureRecognizer == null) {
        scrollGestureRecognizer = new ScrollGestureRecognizer(getScroller(), ScrollDirection.BOTH) {
            @Override
            protected void onScrollMoveHorizontal(Element scrollElement, TouchData touch) {
                // use the scroll container scroller for horz
                // use the live view scroller for vert
                super.onScrollMoveHorizontal(LiveGridView.this.scroller, touch);
            }
        };
        grid.addGestureRecognizer(scrollGestureRecognizer);
    }
}

TapGestureRecognizer

tapGestureRecognizer = new TapGestureRecognizer() {
    @Override
    protected void onTap(List<TouchData> touches) {
      super.onTap(touches);
      onTap();
    }
};

// wire it up
addGestureRecognizer(tapGestureRecognizer);

手势实用程序

实用程序和数据 描述
com.sencha.gxt.core.client.gestures.TouchData 在触摸事件中触发的数据
com.sencha.gxt.core.client.gestures.TouchEventToGestureAdapter 接收并观察带有识别器的触摸事件
com.sencha.gxt.widget.core.client.event.XEvent 鼠标和触摸 NativeEvent 的基本事件
com.sencha.gxt.core.client.GXT.isDesktop() 已检测到桌面
com.sencha.gxt.core.client.GXT.isTouch() 已检测到触摸

GXT 4.x