DhComponentWrapper 类

优质

小牛编辑

135浏览

2023-12-01

DhComponentWrapper类

封装了Java的Windows基础类（WFC）以便从HTML中进行访问。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhBaseContainer
           |
           +-- DhObjectFactory
              |
              +-- DhComponentWrapper

package com.ms.wfc.html

public class DhComponentWrapper

extends DhObjectFactory

构造器

DhComponentWrapper.DhComponentWrapper

创建一个DhComponentWrapper对象。

语法

public DhComponentWrapper ()

public DhComponentWrapper ( Control c, boolean fEmbed )

参数

要添加到文档中的WFC控件。

fEmbed

设置为true将把控件嵌入到文档中；如果要在顶层窗口中激活该控件，就设置为false。

方法

DhComponentWrapper.getControl

检取该元件所包装的控件。

语法

public Control getControl ()

返回值

返回该元件所包装的控件。

请参阅：setControl

DhComponentWrapper.setControl

设置HTML文档中要包装为元件的控件。

语法

public void setControl ( Control c, boolean fEmbed )

参数

要添加到文档中的WFC控件。

fEmbed

设置为true将把控件嵌入到文档中；如果要在顶层窗口中激活该控件，就设置为false。

请参阅：getControl

DhCursor类

定义控制元件鼠标光标风格的常量。

Enum
  |
  +-- DhCursor

package com.ms.wfc.html

public class DhCursor

extends Enum

说明

有关设置鼠标光标风格更详细的信息，请参阅DhStyleBase.setCursor。

字段

DhCursor.AUTO

指明有浏览器根据当前的上下文决定要显示的鼠标光标。

语法

public static final int AUTO;

DhCursor.CROSSHAIR

指明鼠标光标是简单的十字光标。

语法

public static final int CROSSHAIR;

DhCursor.DEFAULT

指明与平台有关的缺省光标（通常是一个箭头）。

语法

public static final int DEFAULT;

DhCursor.E_RESIZE

指明将向东移动边框的箭头光标。

语法

public static final int E_RESIZE;

DhCursor.HAND

指明为手形的指针光标。

语法

public static final int HAND;

DhCursor.HELP

指明是带Help请求的问号加上箭头光标。

语法

public static final int HELP;

DhCursor.MOVE

指明是要移动某些东西的交叉箭头。

语法

public static final int MOVE;

DhCursor.N_RESIZE

指明向北方向移动边框的箭头光标。

语法

public static final int N_RESIZE;

DhCursor.NE_RESIZE

指明向东北方向移动边框的箭头光标。

语法

public static final int NE_RESIZE;

DhCursor.NW_RESIZE

指明向西北方向移动边框的箭头光标。

语法

public static final int NW_RESIZE;

DhCursor.S_RESIZE

指明向南方向移动边框的箭头光标。

语法

public static final int S_RESIZE;

DhCursor.SE_RESIZE

指明向东南方向移动边框的箭头光标。

语法

public static final int SE_RESIZE;

DhCursor.SW_RESIZE

指明向西南方向移动边框的箭头光标。

语法

public static final int SW_RESIZE;

DhCursor.TEXT

指明为编辑文本光标（通常是插入光标）。

语法

public static final int TEXT;

DhCursor.W_RESIZE

指明向西方向移动边框的箭头光标。

语法

public static final int W_RESIZE;

DhCursor.WAIT

指明沙漏光标或等待光标，指明应用程序忙，用户应该等待。

语法

public static final int WAIT;

方法

DhCursor.valid

确定所指定的值是否是该枚举类型中的有效值。

语法

public static boolean valid ( int n )

参数

要检查的值。

返回值

如果该值是有效值，就返回true；否则，就返回false。

说明

你应该在自己的枚举类中覆盖该方法。

DhDialogInfo类

代表对话框的信息类。

Component
  |
  +-- DhStyleBase
     |
     +-- DhDialogInfo

package com.ms.wfc.html

public class DhDialogInfo

extends DhStyleBase

说明

DhWindow.showModalDialog使用该类。

字段

DhDialogInfo.showCentered

在桌面的中央显示对话框。

语法

public boolean showCentered;

DhDialogInfo.showHelpButton

在对话框的标题栏中增加或删除帮助按钮。

语法

public boolean showHelpButton;

DhDialogInfo.showMaximizeButton

在对话框的标题栏中增加或删除最大化按钮。

语法

public boolean showMaximizeButton;

DhDialogInfo.showMinimizeButton

在对话框的标题栏中增加或删除最小化按钮。

语法

public boolean showMinimizeButton;

构造器

DhDialogInfo.DhDialogInfo

创建一个DhDialogInfo对象。

语法

public DhDialogInfo ()

方法

DhDialogInfo.toString

检取代表该对象的字符串表达式。

语法

public String toString ()

返回值

返回每个对话框属性“是”或“否”的字符串。例如，缺省的DhDialogInfo字符串将返回下面的字符串：

“help:no;minimize:no;maximize:no;center:yes”。

DhDocument类

代表了HTML文档。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhBaseContainer
           |
           +-- DhDocument

package com.ms.wfc.html

public class DhDocument

extends DhBaseContainer

说明

使用该类绑定到现有的HTML页面并遍历页面上的元件。另外，你也可以通过该类创建新元件并添加到页面上。不能直接创建该类中的对象；相反，你必须在自己的Visual J++工程中扩展该类。

请参阅：DhStyle, DhModule, DhText, DhForm

方法

DhDocument.add

给容器添加一个元件。

语法

public void add (DhDocument element )

public void add (DhDocument element, int insertFlag )

public void add (DhDocument element, DhElement relativeTo, intinsertFlag )

public void add (DhStyle newStyle )

参数

element

要添加到该容器流末尾的元件。insertFlagDhInsertOptions中的可使用的插入常量。insertFlag的有效值是END, BEGINNING, BEFORE和AFTER。

relativeTo

insertFlag参数相对的元件（有可能是null，这得看insertFlag参数的值）。

newStyle

要添加到该文档中的DhStyle对象。通常，你并不需要调用这种格式的DhDocument.add方法；当你调用DhElement.setStyle方法时，就自动设置了文档的风格。

说明

不带insertFlag参数的add方法将元件添加到所有其他元件的后面。带有insertFlag参数的add方法用于在容器的开头或末尾添加元件。使用带relativeTo参数的add方法将元件添加到其他元件的前面或后面。

有关该方法的信息以及其他的add方法，请参阅DhForm.add。

DhDocument.addOnReadyStateChange

为readyStateChange事件指定一个代理。

语法

public final void addOnReadyStateChange( ReadyStateEventHandler h )

参数

当事件发生时要通知的ReadyStateEventHandler代理。

说明

每当文档的准备完备状态发生变化时就触发readyStateChange事件。DhDocument可能的状态值是未初始化、正在加载、交互式和完成。更多的信息，请参阅ReadyStateEvent。

请参阅：removeOnReadyStateChange

DhDocument.addText

给当前的文档追加文本字符串。

语法

public void addText ( String text )

参数

text

文本字符串。

DhDocument.createElement

如果可能的话，就从HTML标记名字中创建一个元件。包内部使用该方法。

语法

public DhElement createElement ( String tagTypes, String tagID )

参数

tagTypes

要创建的HTML元件类型（例如 <br>）。

tagID

分配给新创建元件的标识符。

返回值

如果该包不识别tagTypes标记名字，就返回DhRawHTML类的一个实例。

说明

调用该方法需要较高的技巧。通常，你并不需要直接使用该方法。

DhDocument.dispose

释放与该元件关联的所有资源。

语法

public void dispose ()

说明

在运行时一般不能调用该方法。在垃圾回收过程中，所有与该元件关联的资源都将被释放。继承类中应该总是调用super.dispose方法。

DhDocument.dumpDHTML

提供DHTML代码的诊断快照转储。

语法

public void dumpDHTML ( Object sender, Event e )

参数

sender

事件源。

Event对象。

说明

当你想象文档宿主所看到的那样转储DHTML代码的诊断快照时，就可以在方便的地方使用该方法路由click事件。

请参阅：dumpHTML

DhDocument.dumpHTML

显示文档宿主所看到的DHTML代码的诊断快照转储。

语法

public void dumpHTML

说明

该方法将打开一个新的浏览器窗口，并显示生成当前正在运行的DHTML代码的源代码。

这是开发人员使用的诊断工具，并不是最终用户特征。

DhDocument.enumerate

返回代表元件集合的enumerator。

语法

public DhEnumeration enumerate ( int type )

参数

type

DhEnumeration类中的一个枚举类型。

返回值

返回代表type参数所定义元件类型集合的DhEnumeration枚举器。可以是下列之一：

· ELEMENTS，包括所有的元件（包括HEAD和BODY标记）。

· IMAGES，只包括图像（比如IMG标记）。

· HLINKS，只包括链接（比如A标记）。

DhDocument.findElement

在文档中搜索一个元件。

语法

public DhElement findElement ( String id )

参数

要搜索元件的HTML ID属性。例如，要搜索一个标记为ID="Caption1"的元件，id参数就应该设置为"Caption1"。

返回值

返回代表文档中元件的 DhElement。然后该元件就可以转换为真正的元件类型（比如DhText）。

说明

可以使用该方法通过HTML ID属性查找文档中的元件。

DhDocument.findStyle

检取该文档命名风格的DhStyle对象。

语法

public DhStyle findStyle ( String style )

参数

style

要查找风格的名字字符串（比如".myClass")。

返回值

返回与style参数相对应的风格对象，如果文档中没有该风格，就返回null。

说明

在该包标准的编程过程中并不使用该方法。

DhDocument.getAllElements

循环检取所有的子元件以及它们的子元件。

语法

public DhElement[] getAllElements ()

返回值

返回文档中所有子元件的矩阵。

覆盖：DhBaseContainer.getAllElements

DhDocument.getDocumentURL

检取当前文档的URL地址。

语法

public String getDocumentURL ()

返回值

返回URL字符串，如果得不到，就返回null。

DhDocument.getDomain

检取该页面所来自的服务器主机名字。

语法

pubilc String getDomain ()

返回值

返回当前主机服务器域，如果得不到，就返回null。

请参阅：setDomain

DhDocument.getElement

根据给定的底层HTML对等元件，检取相应的派生DhElement。

语法

public DhElement getElement ( IHTMLElement peer )

参数

peer

底层HTML对等元件。可以使用DhForm.getPeer获得该对等元件。

返回值

返回与对等参数相对应的特定派生对象。

说明

调用该方法需要很高的技巧。通常，你并不需要直接使用该方法。

DhDocument.getElements

检取该元件的子元件。

语法

public DhElement[] getElements ()

返回值

返回直接子元件矩阵。

覆盖：DhBaseContainer.getElements

DhDocument.getHandle

检取浏览器文档的窗口句柄。

语法

public int getHandle

返回值

返回窗口句柄，如果不能返回（通常运行在服务器上时），就返回-1。该句柄可以充当Control所派生对象的父亲。

请参阅：com.ms.wfc.ui.Form

DhDocument.getHTML

检取该文档的HTML表示形式（通常也称为页面）。

语法

public String getHTML ()

返回值

返回所生成或绑定的HTML文本。

DhDocument.getLastModified

检取当前文档最后的修改日期。

语法

public String getLastModified ()

返回值

以MM/DD/YY HH:MM:SS格式返回文档最后的修改日期，否则得不到，就返回null字符串。

DhDocument.getLocation

检取文档当前的位置。

语法

public Point getLocation ()

返回值

返回一个Point对象，所包含的文档位置是相对应浏览器左上角的偏移量。

DhDocument.getModule

检取与该文件关联的DhModule。

语法

public DhModule getModule ()

返回值

返回与该文档关联的DhModule。

DhDocument.getPeer

检取该类底层HTML对等元件。

语法

public IUnknown getPeer ()

返回值

返回该类底层HTML对等元件。

说明

如果文档没有绑定到该类上，就返回null。运行在信任环境中Java代码可以任意将结果引用转换为特定的元件对等类型。如果代码运行在Web服务器环境，则该方法总是返回null。

调用该方法需要很高的技巧。通常，你并不需要直接使用该方法。

DhDocument.getProtocol

检取协议的长名。

语法

public String getProtocol ()

返回值

返回协议的名字，例如“Hypertext Transfer Protocol”或“FileProtocol”。

DhDocument.getReferrer

检取所引用的文档。

语法

public String getReferrer ()

返回值

返回所引用文档的URL地址，如果得不到，就返回null。

说明

这是包含与当前文档的超链接的文档。

DhDocument.getScroll

检取当前的滚动模式。

语法

public int getScroll ()

返回值

返回当前的滚动模式。可以是下列DhScrollBars值之一：

·AUTO，指明由浏览器来决定滚动模式。

·YES，指明使能滚动操作。

·NO，指明禁止滚动操作。

注意：AUTO和YES是等价的。

请参阅：com.ms.wfc.html.DhScrollBars, setScroll

DhDocument.getServerMode

确定该文档是位于服务器上还是客户端。

语法

public boolean getServerMode ()

返回值

如果该文档位于服务器上，就返回true；否则，就返回false。

DhDocument.getSize

检取文档可看见的大小。

语法

public Point getSize ()

返回值

返回一个Point对象，包含了文档的大小，宽度是Point.x，高度是Point.y。

DhDocument.getStyle

检取文档中所有的风格。

语法

public DhStyle[] getStyles ()

返回值

返回文档中所能找到的DhStyle对象矩阵。

说明

可以使用setStyle方法设置任何元件的风格。

DhDocument.getTitle

检取文档的标题。

语法

public String getTitle ()

返回值

返回文档的标题。

说明

对于浏览器而言，标题出现在浏览器窗口的标题栏中。

请参阅：setTitle

DhDocument.getWindow

检取该文档的Window对象。

语法

final public DhWindow getWindow ()

返回值

返回文档的Window对象。

DhDocument.getWindowPeer

检取该文档对等窗口对象。

语法

protected IHTML Window2 getWindowPeer ()

返回值

返回相对应该文档的WindowPeer对象。

说明

调用该方法需要很高的技巧。通常，你并不需要直接使用该方法。

DhDocument.importHTML

将HTML输入到文档中。

语法

public DhForm importHTML ( String html )

public DhForm importHTMLFromStream ( IDataStreaminputDataStream )

参数

html

包含要输入HTML的字符串。

inputDataStream

读取HTML的com.ms.wfc.io.IDataStream数据流。

返回值

返回一个DhForm对象。

说明

该HTML将替换当前任何文档内容。

DhDocument.messageBox

显示模式用户消息框。

语法

final public void messageBox ( String s )

参数

要显示的消息字符串。

DhDocument.moveElement

将元件移动到布局流中新的次序位置上。

语法

public void moveElement (DhElement element, int newOrder )

参数

element

要移动的元件。

newOrder

容器流中新的次序位置。

DhDocument.newLine

给当前文档追加一新行。

语法

public void newLine ()

说明

在调用该方法之后所添加的元件都出现在新行上。这跟调用add( newDhBreak() )是等价的。

DhDocument.onDocumentBeforeUnload

实现beforeUnload事件的事件处理器。

语法

protected void onDocumentBeforeUnload ( Object sender, Eventevent )

参数

sender

激活该事件的对象。

event

Event对象。

DhDocument.onDocumentLoad

实现load事件的事件处理器。

语法

protected void onDocumentLoad ( Object sender, Event event )

参数

sender

激活该事件的对象。

event

Event对象。

DhDocument.onDocumentUnload

实现unload事件的事件处理器。

语法

protected void onDocumentUnload (Object sender, Event event )

参数

sender

激活该事件的对象。

event

Event对象。

说明

如果DhDocument的子类在每次卸载文档时都想执行一些操作，就应该覆盖该方法。DhDocument类所实现的该方法不做任何事情。

DhDocument.recreateElements

反序列化getHTML所生成的HTML文本。

语法

public DhElement[] recreateElements ( String html )

public DhElement[] recreateElements ( String html, booleanfHonorIDs )

参数

html

对指定DhElement调用getHTML所得到的文本。

fHonorIDs

设置为true以防止破坏ID属性。

返回值

返回最初创建html参数中文本的DhElement派生类的结构树。

说明

调用该方法的缺省情况下将忽略HTML的ID属性并覆盖文档中标识符唯一的属性。要控制这种行为，使用recreateElements ( String,boolean)。

将fHonorID设置为true指明将不覆盖html参数中HTML标记的ID属性。使用该方法需要极高的技巧。如果ID属性与页面上已有的元件冲突，则所导致的行为对于页面其他部分而言是未定义的。

DhDocument.removeOnReadyStateChange

删除为readyStateChange事件指定的代理。

语法

public final void removeOnReadyStateChange( ReadyStateEventHandler h )

参数

要删除的ReadyStateEventHandler代理。

请参阅：addOnReadyStateChange

DhDocument.setBoundElements

将指定的元件矩阵绑定到它们的对等元件上。

语法

public void setBoundElements ( DhElement[] elems )

参数

elems

要绑定到对等元件上的元件矩阵。

异常

如果满足下列条件就产生com.ms.wfc.core.WFCException异常：

·ID与HTML内容不匹配。

·元件已经绑定到其他对象（通过findElement）。

·对等元件类的类型与指定的Java对象不匹配。

DhDocument.setDomain

设置该页面的主机域。

语法

public void setDomain ( String strDomain )

参数

strDomain

要设置的域。

说明

不同框架上的页面可以将它们的域设置为同一主机以便框架之间进行通信。

请参阅：setDomain

DhDocument.setGenerateTags

确定getHTML方法是否生成HEAD和TITLE标记。

语法

public void setGenerateTags ( boolean fGenerate )

参数

fGenerate

设置为true以便在getHTML中生成<HEAD>和<TITLE>标记；否则，就设置为false。

DhDocument.setScroll

设置当前的滚动模式。

语法

public void setScroll ( int scrollMode )

参数

scrollMode

需要的滚动模式。可以是下列DhScrollBars值之一：

·AUTO，指明由浏览器来决定滚动模式。

·YES，指明使能滚动操作。

·NO，指明禁止滚动操作。

注意：AUTO和YES是等价的。

请参阅：DhScrollBars, getScroll

DhDocument.setTitle

设置文档的标题。

语法

public void setTitle (String newTitle )

参数

newTitle

显示在主机标题中的文本。

说明

对于浏览器而言，标题将显示在浏览器窗口的标题栏中。

请参阅：getTitle

DhDocument.writeHTML

将DHTML代码的诊断快照转储到文件中，如文档宿主所看到的那样。

语法

public void writeHTML ( IDataStream stream )

参数

stream

转储内容的IDataStream对象。

说明

该方法将生成正在运行的DHTML代码的源代码写入stream参数所指定的数据流中。这是开发人员使用的诊断工具，并不是终端用户特征，需要代码运行在完全信任环境中。

DhEdit类

实现一个HTML编辑框控件。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhEdit

package com.ms.wfc.html

public class DhEdit

extends DhElement

说明

编辑框可以是多行的，也可以是单行的，或是单行密码风格的。密码编辑框的行为就跟单行编辑框类似。然而，在运行时，其输入内容都由星号(*)屏蔽，并不在HTML表单中显示出来。

构造器

DhEdit.DhEdit

创建一个编辑框。

语法

public DhEdit ()

public DhEdit ( String strText )

public DhEdit ( String strText, boolean multiline )

参数

strTextDhEdit

初始化的文本内容。

multiline

如果编辑框有多行，就设置为true；否则，就设置为false。

说明

该构造器创建了一个单行的DhEdit编辑框。缺省的构造器（不带参数）创建的编辑框不带初始化文本。

方法

DhEdit.addOnChange

为change事件分配一个代理。

语法

public final void addOnChange ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

在当前元件的内容发生改变时就调用代理所指明的方法。

请参阅：removeOnChange

DhEdit.addOnGotFocus

为gotFocus事件分配一个代理。

语法

public final void addOnGotFocus ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

在当前元件收到输入焦点时就调用代理所指明的方法。

请参阅：removeOnGotFocus

DhEdit.addOnLostFocus

为lostFocus事件分配一个代理。

语法

public final void addOnLostFocus ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

在当前元件失去输入焦点时就调用代理所指明的方法。

请参阅：removeOnLostFocus

DhEdit.addOnResize

为resize事件分配一个代理。

语法

public final void addOnResize ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

在当前元件改变大小时就调用代理所指明的方法。

请参阅：removeOnResize

DhEdit.addOnScroll

为scroll事件分配一个代理。

语法

public final void addOnScroll ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

在当前元件滚动时就调用代理所指明的方法。

请参阅：removeOnScroll

DhEdit.addOnSelect

为select事件分配一个代理。

语法

public final void addOnSelect ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当事件发生时就调用代理所指明的方法。

请参阅：removeOnSelect

DhEdit.clear

清除编辑框中的文本。

语法

public void clear ()

DhEdit.focus

将输入焦点设置给该编辑框。

语法

public void focus ()

DhEdit.getCols

检取编辑框的宽度，以字符数来表示。

语法

public int getCols ()

返回值

返回编辑框的字符宽度。

请参阅：setCols

DhEdit.getEnabled

检取编辑框的使能状态。

语法

public boolean getEnabled ()

返回值

如果该编辑框使能，就返回true；否则就返回false。

请参阅：setEnabled

DhEdit.getMaxLength

检取编辑框当前最大输入长度。

语法

public int getMaxLength ()

返回值

返回最大输入长度，以字符数计算。该值最大可达Integer.MAX_VALUE。

请参阅：setMaxLength

DhEdit.getMultiline

指明编辑框控件是否允许多行编辑。

语法

public boolean getMultiline ()

返回值

如果编辑框控件允许多行编辑，就返回true；否则，就返回false。

说明

缺省地，只允许单行编辑，ENTER字符被忽略掉。

请参阅：setMultiline

DhEdit.getPassword

指明编辑框控件是否作为密码输入框而必须隐藏输入信息。

语法

public boolean getPassword ()

说明

密码编辑框跟单行编辑框一样。然而，在运行时，输入内容都用星号(*)屏蔽掉，不显示。

请参阅：setPassword

DhEdit.getReadOnly

检取当前只读模式。

语法

public boolean getReadOnly ()

返回值

如果该控件只读，就返回true；否则，就返回false。

请参阅：setReadOnly

DhEdit.getRows

检取多行编辑框当前的行数。

语法

public int getRows ()

返回值

返回行数。

说明

如果编辑框风格不是多行的，则总是返回1。

请参阅：setRows

DhEdit.getSubmitName

检取编辑框的名字。

语法

public String getSubmitName ()

返回值

返回编辑框的名字。

说明

该名字就是在HTTP表单提交时所表示的HTML NAME属性值。

请参阅：setSubmitName

DhEdit.getText

检取编辑框当前的文本。

语法

public String getText ()

返回值

返回编辑框中当前显示的文本。

说明

对于密码风格的编辑框，返回真正的字符串，而不是星号。

请参阅：setText

DhEdit.getWordWrap

检取当前的换行模式。

语法

public boolean getWordWrap ()

返回值

如果可以换行，就返回true；否则就返回false。

请参阅：setWordWrap

DhEdit.removeOnChange

删除为change事件分配的代理。

语法

public final void removeOnChange ( EventHandler h )

参数

要删除的EventHandler代理。

说明

在当前元件的内容发生改变时就调用代理所指明的方法。

请参阅：addOnChange

DhEdit. removeOnGotFocus

删除为Focus事件分配的代理。

语法

public final void removeOnGotFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

在当前元件收到输入焦点时就调用代理所指明的方法。

请参阅：addOnGotFocus

DhEdit. removeOnLostFocus

删除为lostFocus事件分配的代理。

语法

public final void removeOnLostFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

在当前元件失去输入焦点时就调用代理所指明的方法。

请参阅：addOnLostFocus

DhEdit. removeOnResize

删除为resize事件分配的代理。

语法

public final void removeOnResize ( EventHandler h )

参数

要删除的EventHandler代理。

说明

在当前元件改变大小时就调用代理所指明的方法。

请参阅：addOnResize

DhEdit. removeOnScroll

删除为scroll事件分配的代理。

语法

public final void removeOnScroll ( EventHandler h )

参数

要删除的EventHandler代理。

说明

在当前元件滚动时就调用代理所指明的方法。

请参阅：addOnScroll

DhEdit. removeOnSelect

删除为select事件分配的代理。

语法

public final void removeOnSelect ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当事件发生时就调用代理所指明的方法。

请参阅：addOnSelect

DhEdit.setCols

设置编辑框的宽度，以字符数来表示。

语法

public void setCols ( int value )

参数

value

编辑框的字符宽度，该数值必须比0大。

请参阅：getCols

DhEdit.setEnabled

设置编辑框的使能状态。

语法

public void setEnabled ( boolean f )

参数

如果想让该编辑框使能，就设置为true；否则就设置为false。

请参阅：getEnabled

DhEdit.setMaxLength

设置编辑框当前最大输入长度，以字符数来表示。

语法

public void setMaxLength ( int nMaxLength )

参数

nMaxLength

设置最大输入长度，以字符数计算。该值最大可达Integet.MAX_VALUE。

请参阅：getMaxLength

DhEdit.setMultiline

指明编辑框控件是否允许多行编辑。

语法

public void setMultiline ( boolean multiline )

参数

multiline

如果编辑框控件允许多行编辑，就设置为true；否则，就设置为false。

说明

缺省地，只允许单行编辑，ENTER字符被忽略掉。

请参阅：getMultiline

DhEdit.setPassword

指明编辑框控件是否作为密码输入框而必须隐藏输入信息。

语法

public void setPassword ( boolean value )

参数

value

如果该控件用于输入密码，就设置为true；否则就设置为false。

说明

密码编辑框跟单行编辑框一样。如果设置为true，则Multiline属性就为false。

请参阅：getPassword

DhEdit.setReadOnly

设置编辑框控件为只读模式。

语法

public void setReadOnly ( boolean fReadOnly)

参数

fReadOnly

如果该控件只读，就设置为true；否则，就设置为false。

请参阅：getReadOnly

DhEdit.setRows

设置多行编辑框的行数。

语法

public void setRows ( int rows )

参数

rows

行数。

异常

如果rows参数小于或等于0 或者rows参数大于1而编辑框控件风格不是多行的，就产生WFCInvalidArgumentException异常消息。

请参阅：getRows

DhEdit.setSubmitName

设置编辑框的名字。

语法

public void setSubmitName ( String strName)

参数

strName

分配给控件的名字。在窗体中该名字应该是唯一的。

异常

如果strName是null字符串，就产生WFCInvalidArgumentException异常消息。

说明

该名字就是HTML NAME属性值。当通过HTML表单提交编辑框内容时该方法就很有用了。

请参阅：getSubmitName

DhEdit.setText

设置编辑框当前显示的文本。

语法

public void setText ( String strText)

参数

strText

要显示的文本。

请参阅：getText

DhEdit.setWordWrap

设置多行编辑框的换行模式。

语法

public void setWordWrap ( boolean wrap )

参数

wrap

设置为true将导致文本输入到编辑框的边时就开始换行；设置为false将使得文本继续通过控件的可见区域。

请参阅：getWordWrap

DhEdit.shouldPersistText

指明文本是否与缺省值不一样。

语法

public boolean shouldPersistText ()

返回值

如果设置了新的文本信息就返回true；否则就返回false。

DhElement类

表示该包中所有用户界面（UI）的超类。

DhStyleBase
   |
   +-- DhElement

package com.ms.wfc.ui

public class DhElement

extends DhStyleBase

说明

该类的一个实例应该被看成是HTML文档中指定用户界面元件的Java表示。DhElement对象从来都不是直接创建的。相反，你实化该类所派生的类并将该实例添加到文档中（目的容器或文档中已经存在的容器）。或者，你调用DhDocument.findElement方法来寻找并与现有的元件绑定，并将返回值转换为相应的派生类。

请参阅：DhStyle, DhText, DhDocument , DhForm

方法

DhElement.addOnAfterUpdate

为afterUpdate事件指定一个代理。

语法

public final void addOnAfterUpdate (EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当元件将数据传递给数据提供者之后就触发afterUpdate事件。

请参阅：removeOnAfterUpdate

DhElement.addOnBeforeUpdate

为beforeUpdate事件指定一个代理。

语法

public final void addOnBeforeUpdate ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

在元件将数据传递给数据提供者之前就触发beforeUpdate事件。

请参阅：removeOnBeforeUpdate

DhElement.addOnClick

为click事件指定一个代理。

语法

public final void addOnClick ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnClick

DhElement.addOnDataAvailable

为dataAvailable事件指定一个代理。

语法

public final void addOnDataAvailable ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

该处理器触发的频率跟事件源对象有关。

请参阅：removeOnDataAvailable

DhElement.addOnDataSetChanged

为dataSetChanged事件指定一个代理。

语法

public final void addOnDataSetChanged ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当可以从事件源对象中获得初始数据时也触发该事件。

请参阅：removeOnDataSetChanged

DhElement.addOnDataSetComplete

为dataSetComplete事件指定一个代理。

语法

public final void addOnDataSetComplete ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

请参阅：removeOnDataSetComplete

DhElement.addOnDoubleClick

为doubleClick事件指定一个代理。

语法

public final void addOnDoubleClick ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnDoubleClick

DhElement.addOnDragStart

为dragStart事件指定一个代理。

语法

public final void addOnDragStart ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

该代理指明了在拖放操作开始时要调用的方法。并非所有的元件都支持DhElement中的事件。

请参阅：removeOnDragStart

DhElement.addOnErrorUpdate

为errorUpdate事件指定一个代理。

语法

public final void addOnErrorUpdate ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当数据传输被取消时就触发errorUpdate事件而不是afterUpdate事件。使用beforeUdpate事件处理器执行取消操作。

请参阅：removeOnErrorUpdate

DhElement.addOnFilterChange

为filterChange事件指定一个代理。

语法

public final void addOnFilterChange ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

请参阅：removeOnFilterChange

DhElement.addOnHelp

为help事件指定一个代理。

语法

public final void addOnHelp ( HelpEventHandler h )

参数

当事件发生时要通知的HelpEventHandler代理。

说明

在元件将数据传递给数据提供者之前就触发beforeUpdate事件。

请参阅：removeOnHelp

DhElement.addOnKeyDown

为KeyDown事件指定一个代理。

语法

public final void addOnKeyDown ( KeyEventHandler h )

参数

当事件发生时要通知的KeyEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnKeyDown

DhElement.addOnKeyPress

为keyPress事件指定一个代理。

语法

public final void addOnKeyPress ( KeyPressEventHandler h )

参数

当事件发生时要通知的KeyPressEventHandler代理。

说明

在元件将数据传递给数据提供者之前就触发beforeUpdate事件。

请参阅：removeOnKeyPress

DhElement.addOnKeyUp

为keyUp事件指定一个代理。

语法

public final void addOnKeyUp ( KeyEventHandler h )

参数

当事件发生时要通知的KeyEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnKeyUp

DhElement.addOnMouseDown

为mouseDown事件指定一个代理。

语法

public final void addOnMouseDown ( MouseEventHandler h )

参数

当事件发生时要通知的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnMouseDown

DhElement.addOnMouseEnter

为mouseEnter事件指定一个代理。

语法

public final void addOnMouseEnter ( MouseEventHandler h )

参数

当事件发生时要通知的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnMouseEnter

DhElement.addOnMosueLeave

为mouseLeave事件指定一个代理。

语法

public final void addOnMouseLeave ( MouseEventHandler h )

参数

当事件发生时要通知的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnMouseLeave

DhElement.addOnMouseMove

为mouseMove事件指定一个代理。

语法

public final void addOnMouseMove ( MouseEventHandler h )

参数

当事件发生时要通知的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnMouseMove

DhElement.addOnMouseUp

为mouseUp事件指定一个代理。

语法

public final void addOnMouseUp (MouseEventHandler h )

参数

当事件发生时要通知的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：removeOnMouseUp

DhElement.addOnRowEnter

为rowEnter事件指定一个代理。

语法

public final void addOnRowEnter ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

请参阅：removeOnRowEnter

DhElement.addOnRowExit

为rowExit事件指定一个代理。

语法

public final void addOnRowExit( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

请参阅：removeOnRowExit

DhElement.addOnSelectStart

为selectStart事件指定一个代理。

语法

protected void addOnSelectStart ( EventHandler h )

参数

当对该元件设置了父亲时要通知的EventHandler代理。

请参阅：removeOnSelectStart

DhElement.addOnSetParent

为setParent事件指定一个代理。

语法

protected void addOnSetParent ( EventHandler h )

参数

当对该元件设置了父亲时要通知的EventHandler代理。

请参阅：removeOnSetParent

DhElement.dispose

释放该元件所有相关的资源。

语法

public void dispose()

说明

在运行时或许不应该调用该方法。当元件释放后进行垃圾回收时该元件使用的任何资源都将被释放。继承类应该总是调用super.dispose方法。

DhElement.getAlign

返回元件的对齐方式。

语法

public int getAlign ()

返回值

返回由DhAlignment常量所指明的对齐格式，或者如果没有设置对齐格式就返回－1。

Dhelement.getDocument

检取与该元件关联的文档对象。

语法

public final DhDocument getDocument ()

返回值

返回与该元件关联的DhDocument对象。

DhElement.getDOMAttributeInt

根据动态HTML的DOM（Document Object Model，文档对象模型）属性的名字，检取整数属性。

语法

public int getDOMAttributeInt (String strAttr )

参数

strAttr

指明要检取属性的字符串表达式。

返回值

返回该属性的整数值。

说明

使用该包时，直接调用该方法属于非正常操作。你可以直接对该元件调用相应的属性方法。

请参阅：setDOMAttributeInt

DhElement.getDOMAttributeString

根据动态HTML的DOM（Document Object Model，文档对象模型）属性的名字，检取字符串属性。

语法

public String getDOMAttributeString (String strAttr )

参数

strAttr

指明要检取属性的字符串表达式。

返回值

返回该属性值。

说明

使用该包时，直接调用该方法属于非正常操作。你可以直接对该元件调用相应的属性方法。

DhElement.getElementCount

检取该元件所包含的元件数。

语法

public int getElementCount()

返回值

该实现将返回0。

DhElement.getElements

检取该元件包含的所有元件的矩阵。

语法

public DhElement[] getElements ()

返回值

该实现将返回null。

DhElement.getEvents

检取该元件的事件对象。

语法

public final DhEvents getEvents ()

返回值

返回该元件的com.ms.wfc.html.event.DhEvents对象。

说明

虽然该方法在该类中是public类型的，但大多数派生类都隐藏了该方法。

DhElement.getHTML

检取包含该元件以及其子元件的HTML表示文本的字符串。

语法

public String getHTML()

返回值

返回表示该元件及其子元件的HTML字符串。

DhElement.getHTMLGenerator

检取该元件当前的HTML生成器。

语法

public DhHTMLGenerator getHTMLGenerator ()

返回值

返回当前的DhHTMLGenerator对象。

请参阅：setHTMLGenerator

DhElement.getID

检取该类底层HTML元件的ID属性值。

语法

public final String getID ()

返回值

返回表示该元件ID属性的字符串。

说明

该ID与getHTML方法一起存储。

调用该方法并不是使用该包的正常操作。如果没有直接调用该方法，包将自动为所有的DhElement对象生成一个ID。

请参阅：setID

DhElement.getLocation

检取该元件的位置。

语法

public Point getLocation ()

返回值

返回该元件的位置。

覆盖：DhStyleBase.getLocation

DhElement.getModule

检取与该元件关联的模块对象。

语法

public DhModule getModule ()

返回值

返回与该元件关联的DhModule。

DhElement.getParent

检取包含该元件的父亲元件。

语法

public final DhElement getParent ()

返回值

返回与该元件关联的父亲元件。

请参阅：DhDocument.add,

DhForm.addDhElement.getPeer

检取该类底层的HTML对等元件。

语法

public IUnknown getPeer ()

返回值

返回该类底层HTML对等元件。

说明

如果该元件或其父亲没有添加到文档中，该方法就返回null。在信任环境中运行的Java代码可以任意地将结果引用转换为特定的元件对等类型（例如，com.ms.wfc.html.om.IHTMLElement）。如果代码运行在Web服务器环境，该方法则总是返回null。

只有在高级技巧中才调用该方法。通常，你不需要调用该方法。

DhElement.getSize

检取元件的大小。

语法

public Point getSize ()

返回值

返回元件的大小。

覆盖：DhStyleBase.getSize

请参阅：setSize

DhElement.getStyle

检取与该元件关联的DhStyle风格对象。

语法

public final DhStyle getStyle ()

返回值

返回与该元件关联的DhStyle风格对象。

异常

如果元件或与该元件关联的DhDocument对象没有风格，就产生IllegalState-Exception异常消息。

请参阅：DhStyle, setStyle

DhElement.getTagName

根据当前状态来检取包含与该元件相对应的标记名字的字符串。

语法

public String getTagName ()

说明

在实例的生命周期中，该值可以改变。在大多数情况下，该值与该类的派生类特有的属性设置值有关。

DhElement.getTagNameID

检取在调用getHTML方法时所生成的字符串标识符。

语法

protected int getTagNameID ()

返回值

返回该元件标记名字的字符串标识符（基类返回－1，是无效的ID）。

DhElement.getToolTip

检取当鼠标指针滑过该元件时所出现的ToolTip字符串表示式。

语法

public final String getToolTip ()

返回值

返回ToolTip字符串。

请参阅：setToolTip

DhElement.hasPeer

返回该类底层的HTML对等元件。

语法

public final IUnknown hasPeer()

返回值

返回该类底层对等的HTML元件，假定可以得到的话。

说明

即使该元件或其父亲添加到文档中，该方法也返回null，但对于绑定到对等元件就不一样。在信任环境中运行的Java代码可以任意地将结果引用转换为特定的元件对等类型（例如，com.ms.wfc.html.om.IHTMLElement）。如果代码运行在Web服务器环境，该方法则总是返回null。

即使元件还没有机会绑定到文档，调用getPeer方法也将检取到对等元件。

调用该方法需要很高的技巧。通常，你并不需要使用该方法。

DhElement.initFromPeer

当从现有的HTML元件中创建实例时就调用该方法。

语法

protected void initFromPeer ( IHTMLElement peer )

参数

peer

现有的对等元件。

说明

当从现有的HTML元件中创建实例时，可以覆盖该方法来执行特殊的初始化操作。

DhElement.onPeerAvailable

当该元件的HTML添加到正在运行的浏览器文档时就调用该方法。

语法

protected void onPeerAvailable ()

说明

当对等对象存在时要注意覆盖该方法。例如，此时，就有可能检取可被该元件操作的DOM对等对象。

DhElement.onSetParent

当设置了该元件由DhElement派生的父亲或其父亲发生了变化时就调用该方法。

语法

protected void onSetParent( DhElement newParent )

参数

newParent

新的父亲引用。

DhElement.onSetPeer

当设置或重新设置该元件的IHTMLElement DOM对等对象时就调用该方法。

语法

protected void onSetPeer ( IHTMLElement newPeer )

参数

newPeer

新的IHTMLElement对等项。

说明

由于某些操作原因，在该元件的生命周期中，与该元件关联的对等项可以发生多次改变。

DhElement.removeAttribute

删除属性。

语法

public void removeAttribute ( String strAttr )

参数

strAttr

要删除的自定义属性的名字。

说明

直接调用该方法并不是使用该包的正常操作。你应该直接调用该元件的属性方法。

DhElement. removeOnAfterUpdate

删除为afterUpdate事件指定的代理。

语法

public final void removeOnAfterUpdate (EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnAfterUpdate

DhElement. removeOnBeforeUpdate

删除为beforeUpdate事件指定的代理。

语法

public final void removeOnBeforeUpdate ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnBeforeUpdate

DhElement. removeOnClick

删除为click事件指定的代理。

语法

public final void removeOnClick ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnClick

DhElement. removeOnDataAvailable

删除为dataAvailable事件指定的代理。

语法

public final void removeOnDataAvailable ( EventHandler h )

参数

要删除的EventHandler代理。

说明

该处理器触发的频率跟事件源对象有关。

请参阅：addOnDataAvailable

DhElement. removeOnDataSetChanged

删除为dataSetChanged事件指定的代理。

语法

public final void removeOnDataSetChanged ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnDataSetChanged

DhElement. removeOnDataSetComplete

删除为dataSetComplete事件指定的代理。

语法

public final void removeOnDataSetComplete ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnDataSetComplete

DhElement. removeOnDoubleClick

删除为doubleClick事件指定的代理。

语法

public final void removeOnDoubleClick ( EventHandler h )

参数

要删除的EventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnDoubleClick

DhElement. removeOnDragStart

删除为dragStart事件指定的代理。

语法

public final void removeOnDragStart ( EventHandler h )

参数

要删除的EventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnDragStart

DhElement. removeOnErrorUpdate

删除为errorUpdate事件指定的代理。

语法

public final void removeOnErrorUpdate ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当数据传输被取消时就触发errorUpdate事件而不是afterUpdate事件。使用beforeUdpate事件处理器执行取消操作。

请参阅：addOnErrorUpdate

DhElement. removeOnFilterChange

删除为filterChange事件指定的代理。

语法

public final void removeOnFilterChange ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnFilterChange

DhElement. removeOnHelp

删除为help事件指定的代理。

语法

public final void removeOnHelp ( HelpEventHandler h )

参数

要删除的HelpEventHandler代理。

请参阅：addOnHelp

DhElement. removeOnKeyDown

删除为KeyDown事件指定的代理。

语法

public final void removeOnKeyDown ( KeyEventHandler h )

参数

要删除的KeyEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnKeyDown

DhElement. removeOnKeyPress

删除为keyPress事件指定的代理。

语法

public final void removeOnKeyPress ( KeyEventHandler h )

参数

要删除的KeyPressEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnKeyPress

DhElement. removeOnKeyUp

删除为keyUp事件指定的代理。

语法

public final void removeOnKeyUp ( KeyEventHandler h )

参数

要删除的KeyEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnKeyUp

DhElement. removeOnMouseDown

删除为mouseDown事件指定的代理。

语法

public final void removeOnMouseDown ( MouseEventHandler h )

参数

要删除的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnMouse

DownDhElement. removeOnMouseEnter

删除为mouseEnter事件指定的代理。

语法

public final void removeOnMouseEnter ( MouseEventHandler h )

参数

要删除的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnMouseEnter。

DhElement. removeOnMouseLeave

删除为mouseLeave事件指定的代理。

语法

public final void removeOnMouseLeave ( MouseEventHandler h )

参数

要删除的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnMouseLeave

DhElement. removeOnMouseMove

删除为mouseMove事件指定的代理。

语法

public final void removeOnMouseMove ( MouseEventHandler h )

参数

要删除的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnMouseMove

DhElement. removeOnMouseUp

删除为mouseUp事件指定的代理。

语法

public final void removeOnMouseUp (MouseEventHandler h )

参数

要删除的MouseEventHandler代理。

说明

并非所有的元件都支持DhElement中的事件。

请参阅：addOnMouseUp

DhElement. removeOnRowEnter

删除为rowEnter事件指定的代理。

语法

public final void removeOnRowEnter ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnRowEnter

DhElement. removeOnRowExit

删除为rowExit事件指定的代理。

语法

public final void removeOnRowExit( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnRowExit

DhElement. removeOnSelectStart

删除为selectStart事件指定的代理。

语法

protected void removeOnSelectStart ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnSelectStart

DhElement. removeOnSetParent

删除为setParent事件指定的代理。

语法

protected void removeOnSetParent ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnSetParent

DhElement.resetAlign

清除任何的对齐属性。

语法

public final void resetAlign ()

请参阅：getAlign

DhElement.resetID

创建该元件新的缺省ID。

语法

public final void resetID ()

请参阅：getID

DhElement.resetStyle

使用setStyle清除任何的类设置。

语法

public final void resetStyle ()

请参阅：getStyle

DhElement.resetToolTip

将ToolTip重新设置为缺省值。

语法

public final void resetToolTip ()

请参阅：getToolTip

DhElement.setAlign

设置元件的对齐格式。

语法

public void setAlign ( int nAlign )

参数

nAlign

所需要的对齐格式，由DhAlignment常量来表示。

说明

如果该元件是一个容器，则该对齐属性通常影响到子元件；否则就影响毗邻的文本对齐格式。元件与文档的中间对齐、左对齐或右对齐格式，都由DhForm容器对齐进行包装。

请参阅：getAlign

DhElement.setBindID

设置该元件的绑定ID。

语法

public final DhElement setBindID (String id )

参数

用于表示该元件ID的字符串。

返回值

返回带ID属性集合的DhElement对象。

DhElement.setDOMAttribute

根据动态HTML的DOM（Document Object Model，文档对象模型）属性的名字，设置字符串属性。

语法

public void setDOMAttribute (String strAttr , String value)

参数

strAttr

自定义属性的名字。

value

字符串值。

说明

使用该包时，直接调用该方法属于非正常操作。你可以直接对该元件调用相应的属性方法，例如，DhImage.setURL。

DhElement.setDOMAttributeInt

根据动态HTML的DOM（Document Object Model，文档对象模型）属性的名字，设置字符串属性。

语法

public void setDOMAttributeInt (String strAttr, int value )

参数

strAttr

自定义属性的名字。

Value

一个整数值。

说明

使用该包时，直接调用该方法属于非正常操作。你可以直接对该元件调用相应的属性方法，例如，DhImage.setURL。

请参阅：getDOMAttributeInt

DhElement.setElementPeer

设置HTML文档中该元件的对等元件。

语法

protected void setElementPeer ( IHTMLElement peer )

protected void setElementPeer ( IHTMLElement peer, Booleantransition )

参数

peer

现有的对等元件。

Transition

对绑定的同等元素设定为true；否则，设定为false。

说明

调用该方法需要很高的技巧。通常，你不必使用该方法。

DhElement.setHeightUnit

使用表示度量单位的DhUnits常量设置元件的高度。

语法

public void setHeightUnit ( int h, int unit )

参数

高度值。

Unit

表示度量单位的一个DhUnits常量。

请参阅：DhStyleBase.getBounds

DhElement.setHTMLGenerator

设置该元件使用的HTML生成器。

语法

public void setHTMLGenerator ( DhHTMLGenerator htmlGen )

参数

htmlGen

分配给该元件的DhHTMLGenerator对象。

说明

这允许你覆盖库中生成表示元件的HTML语法的缺省方法。

请参阅：getHTMLGenerator

DhElement.setID

设置该类底层HTML元件的ID属性。

语法

public final void setID ( String id )

参数

该元件ID属性的字符串。

说明

该ID与getHTML方法一起存储。

使用该包时，直接调用该方法属于非正常操作。即使没有直接调用该方法，该包也将自动为所有的DhElement对象生成ID。

请参阅：getID

DhElement.setSize

设置元件的大小。

语法

public void setSize ( int w, int h )

参数

元件新的宽度。

元件新的高度。

请参阅：setWidthUnit, setHeightUnit, getSize

DhElement.setStyle

设置与该元件关联的style对象。

语法

public final void setStyle (DhStyle style )

参数

style

与该元件关联的风格对象。

请参阅：getStyle

DhElement.setToolTip

设置在用户鼠标指针滑过该元件时所显示的ToolTip。

语法

public final void setToolTip ( String string )

参数

string

ToolTip使用的字符串。

请参阅：getToolTip

DhElement.setWidthUnit

使用表示度量单位的DhUnits常量设置元件的宽度。

语法

public void setWidthUnit ( int w, int unit )

参数

宽度值。

Unit

表示度量单位的DhUnits常量。

请参阅：DhStyleBase.getBounds

DhElementExistsInDocumentException类

指示指定的元件已经添加到文档中。元件只能添加一次。

RuntimeException
  |
  +-- WFCException
     |
     +-- DhElementExistsInDocumentException

package com.ms.wfc.html

public class DhElementExistsInDocumentException

extends WFCException

构造器

DhElementExistsInDocumentException.

DhElementExistsInDocumentException

创建一个DhElementExistsInDocumentException对象。

语法

public DhElementExistsInDocumentException()

public DhElementExistsInDocumentException ( String s )

参数

异常消息的详细信息。

说明

缺省构造器创建的异常没有详细信息。

DhElementNotFoundException类

指出由于给定的元件名字不存在所以对特定元件的请求失败了。

RuntimeException
  |
  +-- WFCException
     |
     +-- DhElementNotFoundException

package com.ms.wfc.html

public class DhElementNotFoundException

extends WFCException

构造器

DhElementNotFoundException.

DhElementNotFoundException

创建一个DhElementNotFoundException对象。

语法

public DhElementNotFoundException ()

public DhElementNotFoundException ( String s )

参数

异常的详细信息。

说明

缺省构造器创建的异常没有详细信息。

DhEnumeration类

代表HTML文档中的元件集合。

package com.ms.wfc.html

public class DhEnumeration

implements IEnumerator

说明

你可以直接创建一个DhEnumeration对象（使用new方法）或者调用DhDocument. enumerate方法来获取该集合。

许多HTML标记并非与该包中的Java类一一对应。当使用next返回语句枚举时，务必调用instanceof检查一下结果。

字段

DhEnumeration.ELEMENTS

用于DhDocument.enumerate或DhEnumeration构造器来指出页面上所有元件的集合。

语法

pubilc static final int ELEMENTS;

DhEnumeration.HLINKS

用于DhDocument.enumerate或DhEnumeration构造器来指出页面上所有链接元件（HREF）的集合。

语法

pubilc static final int HLINKS;

DhEnumeration.IMAGES

用于DhDocument.enumerate或DhEnumeration构造器来指出页面上所有图象元件（IMG）的集合。

语法

pubilc static final int IMAGES;

构造器

DhEnumeration. DhEnumeration

创建一个DhEnumeration对象。

语法

public DhEnumeration ( DhDocument document, int enumType )

参数

document

对DhDocument的引用。

EnumType

一种有效的集合类型，可以是如下之一：

·ELEMENTS，包括所有的元件（包括HEAD和BODY等标记）。

·IMAGES，只包括图象（比如IMG标记）。

·HLINKS，只包括链接（比如A 标记）。

说明

你可以使用该构造器或调用DhDocument.enumerate来获取该集合。

方法

DhEnumeration.hasMoreItems

测试该枚举集合是否包含多个元件。

语法

public boolean hasMoreItems ()

返回值

如果该枚举集合包含多个元件，就返回true；否则，就返回false。

DhEnumeration.next

返回该枚举集合中下一个元件。

语法

public DhElement next ( )

返回值

返回枚举集合中下一个元件或者没有的话就返回null。

说明

该方法返回一个DhElement对象，所以没有必要将结果转换为DhElement对象。可以根据枚举集合的类型对返回结果做进一步的转换（比如转换为DhImage）。

许多HTML标记并非与该包中的Java类一一对应。当使用next返回语句枚举时，务必调用instanceof检查一下结果。

DhEnumeration.nextItem

返回该枚举集合下一个元件。

语法

public Object nextItem ()

返回值

返回该枚举集合下一个元件。

异常

如果没有其他元件存在，就产生WFCException异常消息。

请参阅：next

DhEnumeration.reset

将枚举集合重新设置到开头。

语法

public void reset ()

DhEventInfo类

将事件源中的事件消息传递给事件槽（event sink）。

package com.ms.wfc.html

public class DhEventInfo

说明

当HTML元件中触发事件时，Event对象的extendedInfo field就包含了一个DhEventInfo对象。

你可以使用DhEventInfo来控制事件的后续操作（比如冒泡,bubbling棗指不断重复产生同一事件——译者注）并可以找出有关该事件所发生环境更多的信息。

下面的例子演示了如何设置显示mouseEvent事件的DhEventInfo对象值的基本事件处理器。

import com.ms.wfc.html.* ;

import com.ms.wfc.html.event.*;

public class DumpEvent extends DhDocument

{
	DhText text ;
	public void initForm( )
	{
		text = new DhText ( ) ;
		this.add( text.DhInsertOptions.BEGINNING) ;
		this.addOnMouseMove( new MouseEventHandler ( this.onMouseMove ) ) ;
	}
	public void onMouseMove ( Object sender, Event event )
{

text.setText ( event.toString () ) ;

/* if you want to use more advanced feature of HTML eventing model,

or get more information about HTML events, use the DhEventInfo as

show below. */

DhEventInfo eventInfo = (DhEventInfo)event.getExtendedInfo ();

eventInfo.CancelBubble () ;

}

字段

DhEventInfo.EVT_LEFTBUTTON

指明左鼠标键被按下。

语法

public static final int EVT_LEFTBUTTON ;

DhEventInfo.EVT_MIDDLEBUTTON

指明中间的鼠标键被按下。

语法

public static final int EVT_MIDDLEBUTTON;

DhEventInfo.EVT_NOBUTTON

指明没有按下鼠标键。

语法

public static final int EVT_NOBUTTON;

DhEventInfo.EVT_RIGHTBUTTON

指明按下了右边的鼠标键。

语法

public static final int EVT_RIGHTBUTTON;

方法

DhEventInfo.cancelBubble

HTML中所有事件源触发的同一事件都传递给整个的容器体系。调用该方法将告诉HTML文档停止产生事件泡。

语法

final public void cancelBubble ()

DhEventInfo.getChar

测试键盘上是否有键被按下并返回该按键。

语法

final public int getChar()

返回值

返回当前所按下键的键盘码（如果没有键被按下，就返回0）。

DhEventInfo.getClientPoint

检取鼠标与父元件客户区域当前的相对位置。

语法

final public Point getClientPoint()

返回值

返回鼠标与父元件客户区域当前的相对位置。

请参阅：toString

DhEventInfo.getDocument

检取触发该事件的文档对象。

语法

final public DhDocument getDocument ()

返回值

返回该触发该事件的文档对象。

DhEventInfo.getFromElement

检取在mouseEnter或mouseLeave事件产生之前鼠标所在的元件。

语法

final public DhElement getFromElement ()

返回值

返回鼠标所移动过的DhElement，或者如果不是mouseEnter和mouseLeave事件，就返回null。这可以是标准的元件，包含DhDocument对象，如果鼠标是从浏览器外移动到浏览器内，则就返回null。

说明

只有在mouseEnter或mouseLeave事件之后调用该方法才是有效的。

请参阅：getToElement

DhEventInfo.getMouseButton

测试鼠标按键事件。

语法

final public int getMouseButton ()

返回值

返回一个鼠标按键常量，可能是EVT_NOBUTTON,EVT_LEFTBUTTON，EVT_RIGHTBUTTON或EVT_MIDDLEBUTTON。

DhEventInfo.getOffsetPoint

检取鼠标与元件客户区域当前的相对位置。

语法

final public Point getOffsetPoint ()

返回值

返回鼠标当前的相对位置。

请参阅：toString

DhEventInfo.getPeer

检取该类底层的HTML对等元件。

语法

final public IUnknown getPeer()

返回值

返回该类底层的对等HTML元件。

说明

如果元件没有绑定到文档则该方法就返回null。在信任环境中运行的Java代码可以任意地将结果引用转换为特定的元件对等类型（例如，com.ms.wfc.html.om. IHTMLEventObj）。如果代码运行在Web服务器环境，该方法则总是返回null。

只有在高级技巧中才调用该方法。通常，你不需要调用该方法。

DhEventInfo.getPoint

检取鼠标与文档客户区域当前的相对位置。

语法

final public Point getPoint ()

返回值

返回鼠标当前的相对位置。

请参阅：toString

DhEventInfo.getReturnValue

确定是否设置了返回值。

语法

final public Variant getReturnValue ()

说明

某些事件需要响应值。使用该方法就可以确定另一个处理器是否将返回数据设置给了事件源。

DhEventInfo.getScreenPoint

检取鼠标与桌面当前的相对位置。

语法

final public Point getScreenPoint()

返回值

返回鼠标的当前位置。

请参阅：toString

DhEventInfo.getSource

检取事件产生的初始源。

语法

final public DhElement getSource ()

返回值

返回第一次触发该事件的element。

DhEventInfo.getToElement

检取mouseEnter或mouseLeave事件之后鼠标所在的元件。

语法

final public DhElement getToElement ()

返回值

返回事件发生后鼠标所移到的DhElement。或者如果事件不是mouseEnter或mouseLeave，则就返回null。这可以是标准元件，包容DhDocument对象，或者如果是鼠标从浏览器外移到浏览器内，就返回null。

请参阅：getFromElement

DhEventInfo.isAltKey

测试ALT按键状态。

语法

final public boolean isAltKey()

返回值

如果按下了ALT键就返回true。

DhEventInfo.isCtrlKey

测试CTRL按键的状态。

语法

final public boolean isCtrlKey()

返回值

如果按下了Ctrl键就返回true。

DhEventInfo.isShiftKey

测试SHIFT按键的状态。

语法

final public boolean isShiftKey()

返回值

如果按下了SHIFT键，就返回true。

DhEventInfo.setChar

设置当前的按键。

语法

final public void setChar ( int c )

参数

将由getChar返回的按键字符。

请参阅：getChar

DhEventInfo.setReturnValue

设置事件的返回数据。

语法

final public void setReturnValue( boolean b)

final public void setReturnValue( String s)

final public void setReturnValue ( int i )

final public void setReturnValue ( Varint v)

参数

要返回事件的boolean值。

要返回事件的String值。

要返回事件的int值。

要返回事件的Variant值。

说明

某些事件需要响应值。使用该方法将数据返回给事件源。

DhEventInfo.toString

将事件对象转换为一个字符串。

语法

public String toString ()

说明

当调试代码时可以使用该方法。

DhForm类

表示使用传统HTML一维流布局的元件容器。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhBaseContainer
           |
           +-- DhForm

package com.ms.wfc.html

public class DhForm

extends DhBaseContainer

说明

该类代表了一个FORM或DIV HTML元件。使用getAsHTTPForm方法来确定元件的类型。如果增加了DhResetButton或DhSubmitButton按钮，则该元件将自动成为FORM。如果是FORM元件，则可以增加事件处理器来处理reset和formSubmit事件。缺省地，给该类容器添加的元件不是由x-y坐标来表示位置的，而是每个元件周围的 "flow(流)"。

字段

DhForm.METHOD_GET

指明希望在提交了表单之后服务器能有所响应。当表单包含DhSubmitButton控件时使用该字段。

语法

public static final int METHOD_GET;

DhForm.METHOD_POST

指明在提交了表单之后不希望服务器有所响应。当表单包含DhSubmitButton控件时使用该字段。

语法

public static final int METHOD_POST;

构造器

DhForm.DhForm

创建一个DhForm会话容器。

语法

public DhForm ()

方法

DhForm.add

给容器中所有元件后面添加一个元件。

语法

public void add ( DhElement element )

public void add ( DhElement element , int insertFlag )

public void add ( DhElement element , DhElement relativeTo, intinsertFlag )

参数

element

要在容器的流末尾增加的DhElement。

InsertFlag

有效且可用的DhInsertOptions插入常量。有效值有：

·End在流末尾插入或插入到容器中。relativeTo参数必须是null，如果使用的话。

BEGINNING在流的开头插入或插入到容器中。relativeTo参数必须是null，如果使用的话。

·BEFORE在relativeTo参数指定的元件之前插入该元件。relativeTo参数必须非null。

·AFTER在relativeTo参数指定的元件之后插入该元件。relativeTo参数必须非null。RelativeTo

当insertFlag参数使用BEFORE或AFTER常量时所指定的DhElement。

请参阅：remove

DhForm.addOnChange

为change事件指定一个代理。

语法

final public void addOnChange ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当用户修改表单或将输入焦点切换到不同的窗口时就触发该事件。

请参阅：removeOnChange

DhForm.addOnFormReset

为formReset事件指定一个代理。

语法

public void addOnFormReset ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当用户按下表单上的reset按钮时就触发该事件。

DhForm.addOnFormSubmit

为formSubmit事件指定一个代理。

语法

public void addOnFormSubmit ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当用户按下表单上的提交按钮时就触发该事件。

请参阅：removeOnFormSubmit

DhForm.addOnGotFocus

为gotFocus事件指定一个代理。

语法

public final void addOnGotFocus ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当元件收到输入焦点时就调用该代理所指定的方法。

请参阅：removeOnGotFocus

DhForm.addOnLostFocus

为lostFocus事件指定一个代理。

语法

public final void addOnLostFocus ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当元件失去输入焦点时就调用该代理所指定的方法。

请参阅：removeOnLostFocus

DhForm.addOnResize

为resize事件指定一个代理。

语法

public final void addOnResize ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当重新设置元件的大小时就调用该代理所指定的方法。

请参阅：removeOnResize

DhForm.addOnScroll

为scroll事件指定一个代理。

语法

public final void addOnScroll ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当元件滚动时就调用该代理所指定的方法。

请参阅：removeOnScroll

DhForm.addOnSelect

为select事件指定一个代理。

语法

public final void addOnSelect ( EventHandler h )

参数

当事件发生时要通知的EventHandler代理。

说明

当用户设置或修改所选择的表单区域时就触发该事件。

请参阅：removeOnSelect

DhForm.addText

为当前选择内容追加一个文本字符串。

语法

public void addText ( String text )

参数

text

要追加的文本字符串。

DhForm.getAsHTTPForm

检取当前的FORM/DIV状态。

语法

public boolean getAxHTTPForm ()

返回值

如果设置为FORM就返回true；如果设置为DIV，就返回false。

说明

使用setAxHTTPForm方法或为DhForm添加DhSubmitButton来设置FORM。

请参阅：setAxHTTPForm

DhForm.getSubmitMethod

检取当前的HTTP submit方法。

语法

public int getSubmitMethod ( )

返回值

返回当前的HTTP submit方法。可以是METHOD_GET也可以是METHOD_POST。

请参阅：setSubmitMethod

DhForm.getSubmitURL

检取在按下表单的Submit按钮时所要调用的当前URL地址。

语法

public String getSubmitURL ()

返回值

返回在表单提交时所要调用的URL。

请参阅：setSubmitURL

DhForm.moveElement

将元件移到流中新的次序。

语法

public void moveElement ( DhElement element, int newOrder )

参数

element

要移到的DhElement。

NewOrder

该容器流中的新次序。

DhForm.newLine

给当前选择内容追加一新行。

语法

public void newLine ()

说明

调用该方法之后所有增加的元件都出现在新行上。

DhForm.remove

从容器中删除一个元件。

语法

public int remove ( DhElement element )

参数

element

要从容器中删除的DhElement。

返回值

返回所删除元件初始位置的次序。

异常

如果该元件不是该容器的子元件，就产生WFCInvalidArgumentException异常消息。

说明

要删除的元件必须是该容器的直接子元件。如果你没有要删除元件父亲的直接句柄，可以调用元件的getParent方法，然后删除该元件。

如果在调用该方法之前元件是可见的，则调用该方法之后元件就不可见了。

请参阅：add

DhForm.removeAll

删除该容器所有的子元件。

语法

public void removeAll ()

说明

如果元件是在调用该方法之前加入的，则这些元件都将不可见。

DhForm.removeOnChange

删除为change事件指定的代理。

语法

final public void removeOnChange ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当用户修改表单或将输入焦点切换到不同的窗口或控件时就触发该事件。

请参阅：addOnChange

DhForm. RemoveOnFormReset

删除为formReset事件指定的代理。

语法

public void removeOnFormReset ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当用户按下表单上的reset按钮时就触发formReset事件。

DhForm. RemoveOnFormSubmit

删除为formSubmit事件指定的代理。

语法

public void removeOnFormSubmit ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当用户按下表单上的提交按钮时就触发该事件。

请参阅：addOnFormSubmit

DhForm. RemoveOnGotFocus

删除为gotFocus事件指定的代理。

语法

public final void removeOnGotFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当容器收到输入焦点时就触发gotFocus事件。

DhForm. RemoveOnLostFocus

删除为lostFocus事件指定的代理。

语法

public final void removeOnLostFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当元件失去输入焦点时就触发lostFocus事件。

DhForm. RemoveOnResize

删除为resize事件指定的代理。

语法

public final void removeOnResize ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当重新设置元件的大小时就触发该事件。

请参阅：addOnResize

DhForm. RemoveOnScroll

删除为scroll事件指定的代理。

语法

public final void removeOnScroll ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当元件滚动时就触发该事件。

请参阅：addOnScroll

DhForm. RemoveOnSelect

删除为select事件指定的代理。

语法

public final void removeOnSelect ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当用户设置或修改所选择的表单区域时就触发select事件。

请参阅：addOnSelect

DhForm.setAsHTTPForm

强制该DhForm生成HTML FORM或DIV段。

语法

public void setAsHTTPForm ( boolean fAsForm)

参数

fAsForm

如果想将DhForm设置为FORM就设置为true；如果想将DhForm设置为DIV，就设置为false。

请参阅：getAsHTTPForm

DhForm.setSubmitMethod

设置提交表单数据的方法。

语法

public void setSubmitMethod ( int newMethod )

参数

newMethod

新的HTTP 提交方法。可以是METHOD_GET也可以是METHOD_POST。

说明

HTTP命令可以作为POST提交给服务器，意思是说在发送数据之后并不期望有回答；也可以作为GET提交给服务器，意思是说在发送数据之后希望服务器回答。大多数表单使用GET。当作为GET提交表单时，提交字符串就附加在URL的后面，如果返回字符串是新的地址就打开该

地址。

请参阅：getSubmitMethod

DhForm.setSubmitURL

设置在点击表单的DhSubmit按钮时所要调用的URL地址。

语法

public void setSubmitURL ( String strActionURL )

参数

strActionURL

在点击提交按钮时要调用的URL。

说明

字段参数附加在URL的后面。

请参阅：getSubmitURL

DhHorizontalRule类

表示了一个HTML水平规则（<HR>）元件，将在页面中创建一个水平分割线。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhHorizontalRule

package com.ms.wfc.html

public class DhHorizontalRule

extends DhElement

构造器

DhHorizontalRule. DhHorizontalRule

创建一个DhHorizontalRule对象（水平规则元件）。

语法

public DhHorizontalRule ()

DhHotSpot类

实现了图象地图中表示热点的对象。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhHotSpot

package com.ms.wfc.html

public class DhHotSpot

extends DhElement

说明

热点就是图象地图中用户可以点击而直接跳到一个URL的区域。将来，DhHotSpot对象将添加到DhImage对象中。

构造器

DhHotSpot.DhHotSpot

创建一个DhHotSpot对象。

语法

public DhHotSpot ( )

public DhHotSpot ( int nShape, int[] coords )

public DhHotSpot ( int nShape, int[] coords, String strUrl )

public DhHotSpot ( Rectangle r )

参数

nShape

热点的形状，可以是DhHotSpotShapes中定义的常量。

Coords

包含该形状坐标的整数矩阵。

StrUrl

当点击热点时所导向的URL地址。

包含热点矩形太小的Rectangle对象。

说明

缺省构造器所创建的DhHotSpot是矩形外观，高度和宽度都是0。

方法

DhHotSpot.addOnGotFocus

为gotFocus事件分配一个代理。

语法

public final void addOnGotFocus ( EventHandler h )

参数

当事件触发时要通知的EventHandler代理。

说明

在元件收到输入焦点就调用代理指定的方法。

请参阅：removeOnGotFocus

DhHotSpot.addOnLostFocus

为lostFocus事件指定一个代理。

语法

public final void addOnLostFocus ( EventHandler h )

参数

当事件触发时要通知的EventHandler代理。

说明

当元件失去输入焦点时就调用代理所指明的方法。

DhHotSpot.getAltText

在浏览器不能显示图象时，检取当前可替代图象的文本字符串。

语法

public String getAltText ()

返回值

返回HTML替换文本字符串。

请参阅：setAltText

DhHotSpot.getCoordsIntArray

检取代表当前坐标字符串的整数矩阵。

语法

public Point[] getCoordsIntArray ()

返回值

返回一个整数矩阵。

请参阅：setCoords

DhHotSpot.getCoordsString

检取当前坐标字符串。

语法

public String getCoordsString ()

返回值

返回包含当前坐标的字符串。

请参阅：setCoords

DhHotSpot.getShape

检取当前的形状常量。

语法

public int getShape ()

返回值

返回形状。

请参阅：setShape,

DhHotSpotShapesDhHotSpot.getTargetWindow

检取该对象的目的窗口。

语法

public String getTargetWindow()

返回值

返回目的窗口的名字。

请参阅：setTargetWindow

DhHotSpot.getURL

检取在用户点击该热点时要导去的URL地址。

语法

public String getURL()

返回值

返回当前的URL。

DhHotSpot.removeOnGotFocus

删除为gotFocus事件分配的代理。

语法

public final void removeOnGotFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

在元件收到输入焦点就触发gotFocus事件。

请参阅：addOnGotFocus

DhHotSpot. RemoveOnLostFocus

删除为lostFocus事件指定的代理。

语法

public final void removeOnLostFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当元件失去输入焦点时就触发lostFocus事件。

请参阅：addOnLostFocus

DhHotSpot.setAltText

在浏览器不能显示图象时，设置可替代图象的文本字符串。

语法

public void setAltText ( String strAltText )

参数

strAltText

设置新的可替换文本字符串。

请参阅：getAltText

DhHotSpot.setCoords

使用整数、字符串或矩形来设置DhHotSpot的坐标字符串。

语法

public void setCoords ( int[] nCoordArray )

public void setCoords ( String strCoords )

public void setCoords ( Rectangle r )

参数

nCoordArray

包含坐标的整数矩阵。例如，四边形的坐标分别由上、左、宽度、高度来表示（如{5,5,10,20}）。

StrCoords

该形状类型坐标的字符串。例如，四边形的坐标分别由上、左、宽度、高度来表示（如?,5,10,20）

包含热点矩形大小的Rectangle对象。

异常

如果坐标与当前的形状不匹配，就产生WFCException异常消息。

请参阅：getCoordsString, getCoordsIntArray

DhHotSpot.setShape

设置热点的形状。

语法

public void setShape ( int nShape)

参数

nShape

在DhHotSpotShapes中定义的形状常量。

请参阅：getShape

DhHotSpot.setTargetWindow

设置该热点的目的窗口。

语法

public void setTargetWindow( String strTargetWnd)

参数

strTargetWnd

目的窗口的名字。

请参阅：getTargetWindow

DhHotSpot.setURL

设置在用户点击该热点时要导去的URL地址。

语法

public void setURL( String strUrl )

参数

strUrl

该DhHotSpot对象的URL。

请参阅：getURL

DhHotSpotShapes类

为DhHotSpot形状提供常量。

Enum
  |
  +-- DhHotSpotShapes

package com.ms.wfc.html

public class DhHotSpotShapes

extends Enum

字段

DhHotSpotShapes.CIRCLE

指明热点具有圆圈形状。

语法

public static final int CIRCLE;

说明

坐标以揷enter x, center y, radius數母袷嚼幢硎荆焕纾旅娴淖昃痛唇酥行牡闶莤=12, y=19半径为7的圆圈。

setCoords( new int[] { 12, 19, 7 } )

DhHotSpotShapes.POLYGON

指明热点具有多边形形状。

语法

public static final int POLYGON;

说明

坐标以三个或更多的坐标对来表示；例如，下面的坐标就创建了一个三角形。

setCoords( new int[] { 10,10,15,15,5,15 } )

DhHotSpotShapes.RECTANGLE

指明热点具有矩形形状。

语法

public static final int RECTANGLE;

说明

坐标以“上、左、宽度、高度”的形式表示；例如，下面的坐标就创建一个矩形：

setCoords ( new int[] { 5,5,10,20 } )

方法

DhHotSpotShapes.valid

确定所指定的值是否是该枚举类型中的有效常量。

语法

public static boolean valid ( int n )

参数

要检查的值。

返回值

如果该值有效，就返回true；否则，就返回false。

说明

你应该在自己的枚举类中覆盖该方法。

DhHTMLGenerator类

代表了生成HTML的基类。

package com.ms.wfc.html

public class DhHTMLGenerator

说明

覆盖该方法来创建与该包中不同的生成HTML的方法。使用你覆盖方法的实例调用DhElement.setHTMLGenerator来使你的方法生效。对每个标记、风格、属性都调用相应的函数，你可以任何你想要的方式来操纵这些元件。

下面的例子演示了另一个简单的HTML生成器，将级联风格的表单映射为格式标记，并将<div>标记改为<p>标记。

public class MyHTMLGenerator 
{
    public final static STYLE_FONT_WEIGHT = 0;
    public final static STYLE_FONT_STYLE = 1 ;
    public final static TAG_DIV = 2 ;
    public MyHTMLGenerator () {
        registerName ( "font-weight" STYLE_FONT_WEIGHT);
        registerName ( "font-style" STYLE_FONT_STYLE ) ;
        registerName( "DIV" TAG_DIV );
    }
    //Override this method to replace tags.
    public boolean onTagGenerator ( int Key, String strTagName ) {
        switch ( key ) {
            case TAG_DIV:
                setTagName ("P")
                // Return false to cancel the default behavior.
            return false ;
            break ;
        }
    //Return true to proceed with the default behavior.
    return true ;
}

// Override this method to manipulate style output.

public boolean onStyleGenerator ( int Key, String styleName, StringstyleValue ) 
{
    swith ( key ) {
        case STYLE_FONT_WEIGHT:
            if ( styleValue.indexOf ( "BOLD" )!= -1 ) {
              addEnclosingTag ( "B" null, true ) ;
              return false ;
            }
            break;
        case STYLE_FONT_STYLE:
            if (styleValue.equalsIgnoreCase ( "ITALIC" )) {
              addEnclosingTag ( "I" null, true ) ;
              return false ;
            }
            break ;
        }
        return true ;
    }
}

字段

DhHTMLGenerator.UNKNOWN_KEY

如果名字没有注册，getNameKey就返回该值。

语法

public static final int UNKNOWN_KEY;

方法

DhHTMLGenerator.addAttrString

在当前的小于(<)和大于(>)字符之间添加属性。

语法

protected final void addAttrString ( String strAttr, String strValue )

参数

strAttr

要添加属性的名字。

StrValue

新属性的字符串值。

DhHTMLGenerator.addEnclosingTag

给当前的标记增加封闭标记。

语法

protected final void addEnclosingTag ( String strTag, String strAttrs,boolean fClose )

参数

strTag

新封闭标记的名字。

StrAttrs

新封闭标记的字符串。

FClose

为该标记增加额外的封闭标记，就设置true。

说明

该标记也将封闭任何现有的封闭标记。

假如下面一段HTML内容，下面演示一下使用该方法：

Hello!

在调用了addEnclosingTag("B", "id=theBold" true )，HTML将显示为：

Hello!

DhHTMLGenerator.addInnerTag

在当前标记内部增加标记，但封闭其内容。

语法

protected final void addInnerTag( String strTag, String strAttrs,

boolean fClose )

参数

strTag

新内部标记的名字。

StrAttrs

新内部标记的属性字符串。

FClose

为该标记增加关闭标记，就设置true；否则就设置为false。

说明

该标记也出现在内容和现有的内部标记之间。

例如，考虑下面一段HTML内容：

Hello!

在调用了addInnerTag("B", "id=theBold" true )，HTML将显示为：

Hello!

DhHTMLGenerator.addStyleString

在当前标记的STYLE属性内部添加属性。

语法

protected final void addStyleString ( String strStyle, String strValue )

参数

strStyle

要添加的风格名字。

StrValue

新风格的字符串值。

说明

只有supportsCSS值为true时才能添加这些风格。

请参阅：getSupportsCSS, setSupportsCSS

DhHTMLGenerator.generateHTML

为指定的DhElement生成浏览器HTML。

语法

public StringBuffer generateHTML ( DhElement e )

参数

生成基于DhHTMLGenerator对象的代码的DhElement。

返回值

返回所生成HTML的StringBuffer。

DhHTMLGenerator.getAttributeValue

检取指定的属性值。

语法

protected final String getAttributeValue ( String strAttrName )

参数

strAttrName

属性的名字。

返回值

返回该属性的值，如果没有该属性，就返回null。

DhHTMLGenerator.getContent

检取当前的内容字符串，即位于HTML开始和结束标记之间的字符串。

语法

protected final String getContent ()

返回值

返回当前的内容字符串。

请参阅：setContent

DhHTMLGenerator.getNameKey

检取与指定名字关联的整数键值。

语法

protected int getNameKey ( String strName )

参数

strName

要检取键值的标记、属性或风格的名字。

返回值

返回名字的键值，如果所指定的属性不存在，就返回UNKNOWN_KEY。

说明

该函数对大小写不敏感。

请参阅：registerName, UNKNOWN_KEY

DhHTMLGenerator.getStyleValue

检取指定风格的值。

语法

protected final String getStyleValue ( String strStyleName )

参数

strStyleName

风格的名字。

返回值

返回风格的值，如果没有就返回null。

DhHTMLGenerator.getSupportsCSS

检取目标支持级联风格表单的能力。

语法

public final boolean getSupportsCSS ()

返回值

如果支持级联风格表单，就返回true。

请参阅：setSupportsCSS

DhHTMLGenerator.getSupportsOM

检取目标支持文档对象模型的能力。

语法

public final boolean getSupportsOM()

返回值

如果支持文档对象模型，就返回true（目前，只有微软的IE4.0或更高版本才支持）。

请参阅：setSupportsOM

DhHTMLGenerator.getTagName

检取当前生成内容的标记名字。

语法

protected final String getTagName ()

返回值

返回当前标记名字字符串。

请参阅：setTagName

DhHTMLGenerator.onAttrGenerate

激活每个属性的回调函数。

语法

public boolean onAttrGeneration ( String strName, String strValue )

public boolean onAttrGeneration( int key, String strName, StringstrValue )

参数

key

该风格的键值，如果注册的话；否则就是－1。

StrName

属性的缺省名字。

StrValue

属性的缺省值。

返回值

返回true生成缺省标记，或者返回false跳过。

说明

你可以对指定的属性追加任何想追加的东西或进行操纵。下面的例子将WIDTH属性移入风格文本。

if ( strName.equalsIgnoreCase (揥IDTH? ) 
{
	addStyleString ( ?width? strValue ) ;
	return false ;
}

请参阅：addEnclosingTag, addInnerTag, addStyleString, addAttrString

DhHTMLGenerator.onStyleGenerate

激活每个风格-属性对的回调函数。

语法

public boolean onStyleGenerate ( int key, String strName, StringstrValue )

public boolean onStyleGenerate ( String strName, String strValue )

参数

key

该风格的键值，如果注册过的话；否则就是-1。

StrName

该属性的缺省名字。

StrValue

该属性的缺省值。

返回值

返回true生成缺省标记；返回false则跳过。

说明

要对指定的风格追加任何属性或进行操纵，可以覆盖该方法。下面的例子由于字体颜色的原因与级联风格的表单不兼容。

if ( strName.equalsIgnoreCase ( "Color") ) 
{
    ("FONT" "COLOR =" + strValue ) ;
    return false ;
}

请参阅：addEnclosingTag, addInnerTag, addStyleString, addAttrString

DhHTMLGenerator.onTagGenerate

激活当前标记缺省名字的回调函数。

语法

public boolean onTagGenerate( int key, String strTagName )

public boolean onTagGenerate ( String strTagName )

参数

key

该标记的键值，如果注册过的话；否则就是－1。

StrTagName

当前标记的缺省名字。

7返回值

使用缺省标记就返回true。

说明

在覆盖函数中你可以执行任何需要的操纵。下面的例子将<STRONG>替换为<BOLD>：

if (strName.equalsIgnoreCase ( "STRONG" ) 
{
    setTagName ( "BOLD");
    return false ;
}

请参阅：setTagName, getTagName

DhHTMLGenerator.registerName

将风格或属性名或标记与一个整数关联起来。

语法

protected boolean registerName ( String strName , int key )

参数

strName

标记、属性名字或风格名字。

key

与数值关联的键值。不能是-1，因为在键值没有注册时传递给函数的参数值是-1。

返回值

如果名字注册成功就返回true；如果已经使用了-1或者键值已经分配给另外的名字，就返回false。

说明

如果注册成功，在调用onTagGenerate, onAttrGenerate和onStyleGenerate时就会使用名字检取到该数值。注册键值将允许你在处理器函数中进行字符串的比较。

下面的例子演示了如何使用该方法。

public class MyHTMLGenerator 
{
    public final static TAG_BR = 0;
    public final static TAG_DIV = 1;
    public MyHTMLGenerator () {
        registerName ( "BR" TAG_BR ) ;
        registerName ( "DIV",TAG_DIV ) ;
        }
    // ...
    public boolean onTagGenerator ( int key , String strTagName )  {
        switch ( key ) {
          case TAG_BR:
          case TAG_DIV:
              setTagName ( "P");
              return false ;
              break;
        }
        return true ;
      }
}

DhHTMLGenerator.setContent

替换当前的内容字符串，撤消任何现有内容。

语法

protected final void setContent ( String strNewContent )

参数

strNewContent

新的内容字符串。

请参阅：getContent

DhHTMLGenerator.setFormatItems

设置定界符项。

语法

public final void setFormatItems ( char cAttrAssign, charcAttrSeparator, char cAttrQuote, char cStyleAssign, char cStyleSeparator,char cStyleQuote )

参数

cAttrAssign

属性分配符（缺省是 ?挘

AttrSeparator

属性间的分割符（缺省是 ??）。

cAttrQuote

属性值的定界符（缺省是 ??挘

StyleAssign

风格分配符（缺省是 ?挘

StyleSeparator

风格之间的分割符（缺省是 ?挘

StyleQuote

风格值的定界符（缺省是 ?憿拻）。

DhHTMLGenerator.setSupportsCSS

指明目标浏览器是否支持级联风格表单。

语法

public final void setSupportsCSS ( boolean supportsCSS )

参数

supportsCSS

如果支持级联风格表单，就设置为true；否则就设置为false。

说明

缺省值为false。

请参阅：getSupportedCSS

DhHTMLGenerator.setSupportsOM

指明目标浏览器是否支持文档对象模型。

语法

public final void setSupportsOM( boolean supportsOM )

参数

supportsOM

如果目标支持文档对象模型，就设置为true；否则就设置为false。

说明

缺省值为false。

请参阅：getSupportsOM

DhHTMLGenerator.setTagName

使用新值替换当前的标记名字。

语法

protected final void setTagName ( String strNewName )

参数

strNewName

标记名字的替换值，可以是null。