Netzke 技术文档

1. 安装指南

Netzke 是一个基于 Ruby-on-Rails 的框架，可以极大地简化创建复杂 Sencha Ext JS 应用的过程。以下是安装步骤：

• 确保你的系统中已经安装了 Ruby-on-Rails。
• 使用 gem install netzke 命令安装 Netzke。
• 在 Rails 应用的 Gemfile 中添加 gem 'netzke'，然后执行 bundle install。
• 确保 Sencha Ext JS 的文件位于 YOUR_APP/public/extjs 目录中。

2. 项目的使用说明

Netzke 允许开发者利用模块化和面向对象的手段创建复杂的客户端和服务器端组件。下面是一个创建简单 Netzke 组件的示例：

• 在 YOUR_APP/components/hello_world.rb 文件中创建一个名为 HelloWorld 的类。
• 配置客户端类和动作。
• 定义一个名为 greet_the_world 的端点，用于从服务器向客户端发送消息。

class HelloWorld < Netzke::Base
  client_class do |c|
    c.title = "Hello World component"
  end

  action :ping_server

  def configure(c)
    super
    c.bbar = [:ping_server]
  end

  endpoint :greet_the_world do
    client.show_greeting("Hello World!")
  end
end

• 在 YOUR_APP/components/hello_world/client/hello_world.js 文件中定义 JavaScript 客户端类的方法。

{
  netzkeOnPingServer: function(){
    this.server.greetTheWorld();
  },

  showGreeting: function(greeting){
    this.update("Server says: " + greeting);
  }
}

• 在 Rails 视图中嵌入组件。

<%= load_netzke %>
<%= netzke :hello_world %>

3. 项目 API 使用文档

Netzke 组件由服务器端（Ruby）和客户端（JavaScript）代码组成，每部分都有相应的 API。

• 服务器端（Ruby）类的文档可以通过 RubyDoc.info 查看。
• 客户端（JavaScript）类的文档可以通过执行 rake client_doc:generate 命令生成，并在 doc/client/build 目录下查看。

4. 项目安装方式

请参考安装指南部分。

以上是关于 Netzke 框架的技术文档，希望能帮助您更好地了解和使用该框架。