文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

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

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

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类(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 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

GXT 4.x


顶部

XMessages

XMessages 使用 GWT Messages 系统为 GXT 小部件提供本地化语言变量。XMessages 使用 GWT Messages 系统来提供本地化语言支持。

参考

提供您自己的本地化消息

有几种方法可以提供您自己的 XMessages。第一种方法是用您自己的文件替换默认文件。
第二种方法是通过延迟绑定提供自定义实现。

编译替换

通过将 XMessages(.*).properties 复制到项目中的相同源包路径来编译替换 XMessages 文件。这使得您的项目的 XMessages.properties 文件在类路径上可用。只要您的源路径在编译器进程中是最后一个,它就会将您的文件替换为默认文件。使用这种方法,您可以修改现有文件。如果缺少某种语言,只需提供带有语言环境 ID 的文件即可。

  • 在您的源路径上创建一个名为 com.sencha.gxt.messages.client 的 Java 包,并添加下图列出的文件。

使用延迟绑定 XMessages

可以通过 project.gwt.xml 延迟绑定来提供 XMessages。

  • project.gwt.xml 模块中添加类似这样的内容

      <!-- First declare the class name being using for the custom messages -->
      <replace-with class="com.sencha.gxt.test.client.xmessages.MyXMessages">
          <!-- This tells the compiler to replace XMessages with that class declared. -->
          <when-type-is class="com.sencha.gxt.messages.client.XMessages"/>
          <!-- Additional properties could be used to provide XMessages for particular permutations -->
      </replace-with>
    

提供 XMessages

有几种方法可以提供 XMessages。它们可以作为 Java 实现提供。或者可以通过属性文件提供。选择下面列出的两种方法之一来提供 XMessages。

Java XMessages

仅通过实现 XMessages 来提供简单的 XMessages 实现。

  • 仅实现 XMessages 并在 Java 中提供消息的示例。

      import com.sencha.gxt.messages.client.DefaultMessages;
      import com.sencha.gxt.messages.client.XMessages;
    
      public class MyXMessages implements XMessages {
    
        public MyXMessages() {
          // this could be used to get the default message
          XMessages xmessages = DefaultMessages.getMessages();
        }
    
        @Override
        public String updateManager_indicatorText() {
          return "custom message";
        }
    
        @Override
        public String grid_ddText(int rows) {
          return "custom message";
        }
    
        //...
    
      }
    

属性文件 XMessages

以下展示了如何从文本属性文件提供 XMessages,这些文件将每种语言分别存储在每个文件中。

  • 文件将命名为 MyXMessages.properties 和/或 MyXMessages_ca.properties,并存储在同一个 Java 包中。

  • 扩展 Messages 的示例。请记住,文本属性文件必须包含在同一个包中。

      public interface MyXMessages extends XMessages {
    
        String updateManager_indicatorText();
    
        String grid_ddText(int rows);
    
        String tabPanelItem_closeText();
    
        String tabPanelItem_closeOtherText();
    
        String field_invalidText();
    
        //... 
    
      }
    

GXT 4.x