DhHyperlink 类

优质

小牛编辑

119浏览

2023-12-01

DhHyperlink类

在文档中跳到书签或当前文档中的元件或不同的文档。

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

package com.ms.wfc.html

public class DhHyperlink

extends DhForm

说明

下面的代码示例演示了如何创建一个与其他URL的链接。

public class Class1 extends DhDocument

{
    protected void initForm ()
    {
    DhHyperlink h;
    this.add ( new DhText( "This is a link to the ") ) ;
    this.add ( new DhHyper link( "http://www.microsoft.com/visual", "VisualJ++"));
    this.add ( new DhText(Web site"));
    }
}

要链到当前页面的书签上，使用setJumpPoint方法，并将与跳转去元件关联的DhElement传递给该方法，如下面的代码所示：

public class Class1 extends DhDocument

{
    protected void initForm()
    {
      DhHyperlink h;
      add ( h = new DhHyperlink( null, "Click me") ;
      DhText t;
      for ( int I = 0; I< 100; I ++ ) newLine ();
      add ( t = new DhText("Jump here ?  ) ;
      h.setJumpPoint( t) ;
    }
}

构造器

DhHyperlink.DhHyperlink

创建一个DhHyperlink对象。

语法

public DhHyperlink ()public DhHyperlink ( String url, String text )

参数

url

当前文档要链接到的文档或目的地URL。

Text

用户看到超链接的文本。

请参阅：setURL, setJumpPoint, setText

方法

DhHyperlink.getEnabled

检取链接的使能状态。

语法

public final boolean getEnabled ()

返回值

如果超链接处于使能状态就返回true；否则，就返回false。

请参阅：setEnabled

DhHyperlink.getJumpPoint

返回跳转的本地目的地。

语法

public final DhElement getJumpPoint()

请参阅：setJumpPoint

DhHyperlink.getStockTargetWindow

返回在跳转时浏览器将文档放入那个窗口的标识符。

语法

public final int getStockTargetWindow ()

返回值

返回DhLinkTarget中接受窗口的标识符。

请参阅：setStockTargetWindow, getTargetWindow

DhHyperlink.getTargetWindow

返回在跳转时浏览器将文档放入那个窗口的名字。

语法

public final String getTargetWindow ()

返回值

目的地窗口。

请参阅：setStockTargetWindow, getStockTargetWindow

DhHyperlink.getText

检取超链接文本。

语法

public final String getText()

返回值

返回在超链接中显示的文本。

请参阅：setText

DhHyperlink.getURL

检取超链接的目的URL。

语法

public final String getURL()

返回值

返回超链接当前的URL。

请参阅：setURL

DhHyperlink.setEnabled

设置链接的使能状态。

语法

public final void setEnabled ( boolean f )

参数

如果想要超链接处于使能状态就设置为true；否则，就设置为false。

请参阅：getEnabled

DhHyperlink.setJumpPoint

将超链接的目的地设置为当前页上其他的元件。

语法

public final void setJumpPoint( DhElement target )

参数

target

在点击超链接后用户将要跳转到的本地元件。

请参阅：getJumpPoint

DhHyperlink.setStockTargetWindow

设置在跳转时浏览器将文档放入哪个窗口的标识符。

语法

public final void setStockTargetWindow ( int targetID )

参数

targetID

DhLinkTarget中接受窗口的标识符。

请参阅：setTargetWindow, getStockTargetWindow

DhHyperlink.setTargetWindow

设置在跳转时浏览器将文档放入哪个窗口的名字。

语法

public final void setTargetWindow ( String winName )

参数

winName

目的地窗口名字。

请参阅：setStockTargetWindow, getTargetWindow

DhHyperlink.setText

设置用户在超链接上所看到的文本。

语法

public final void setText( String text )

参数

text

显示给用户的文本。

请参阅：getText

DhHyperlink.setURL

设置文档指针。

语法

public final void setURL( String url )

参数

url

文档的URL。

请参阅：getURL

DhImage类

实现了一个图象对象，在文档中显示一个点位图文件。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhImage

package com.ms.wfc.html

public class DhImage

extends DhElement

说明

要在你的页面上创建DhImage对象，使用setURL方法指明要显示图象的URL地址。

构造器

DhImage.DhImage

创建一个DhImage对象。

语法

public DhImage ()

public DhImage ( String url )

参数

url

指向要显示图象的URL地址。该URL可以是HTML文档的相对地址。

方法

DhImage.addHotSpot

给图象增加一个DhHotSpot对象。

语法

final public void addHotSpot ( DhHotSpot hs )

final public void addHotSpot ( int nShape, int[] coords, String strUrl )

final public void addHotSpot( int nShape, int[] coords, EventHandlerh )

参数

要给该图象添加的新DhHotSpot。

NShape

热点的形状，是一个DhHotSpotShapes常量。

Coords

一个整数矩阵，包含了在nShape中指定形状的坐标。详细信息请参阅DhHotSpot。

StrUrl

当点击热点时要导向的String URL。

当点击热点时要触发的EventHandler。

请参阅：removeHotSpot

DhImage.addOnAbort

为about事件指定一个代理。

语法

final public void addOnAbort ( EventHandler h )

参数

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

说明

当用户取消加载图象时就触发该事件。

请参阅：removeOnAbort

DhImage.addOnError

为error事件指定一个代理。

语法

public final void addOnError ( EventHandler h )

参数

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

说明

当出现错误时就触发该事件。

请参阅：removeOnError

DhImage.addOnGotFocus

为gotFocus事件指定一个代理。

语法

public final void addOnGotFocus ( EventHandler h )

参数

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

说明

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

请参阅：removeOnGotFocus

DhImage.addOnLoad

为load事件指定一个代理。

语法

final public void addOnLoad ( EventHandler h )

参数

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

说明

当图象加载完毕时就调用代理所指定的方法。

请参阅：removeOnAbort

DhImage.addOnLostFocus

为lostFocus事件指定一个代理。

语法

public final void addOnLostFocus ( EventHandler h )

参数

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

说明

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

请参阅：removeOnLostFocus

DhImage.addOnReadyStateChange

为readyStateChange事件指定一个代理。

语法

final public void addOnReadyStateChange( ReadyStateEventHandler h )

参数

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

请参阅：removeOnReadyStateChange

DhImage.getHotSpots

检取该图象所包含的DhHotSpot对象矩阵。

语法

public DhHotSpot[] getHotSpot()

返回值

返回DhHotSpot矩阵。

DhImage.getLoadComplete

确定图象是否全部加载完毕。

语法

final public boolean getLoadComplete()

返回值

如果图象完全加载完毕就返回true；否则就返回false。

请参阅：addOnReadyStateChange, getReadyState, addOnLoad

DhImage.getReadyState

返回图象对象当前的状态。

语法

final public String getReadyState()

返回值

返回当前状态。可能返回的字符串包括"Uninitialized",指明对象还没有初始化数据。

·"Loading",指明当前正在加载对象的数据。

·"Interactive",指明即使图象数据没有全部加载完毕但可以与图象交互。

·"Complete",指明图象全部加载完毕。

DhImage.getSize

检取所显示图象的大小。

语法

final public Point getSize ()

返回值

如果图象是浏览器中的活动文档，就返回图象的实际大小（由setSize设置）。

异常

如果图象不可用（通常是因为还在加载中），就产生WFCException异常消息。

覆盖：DhElement.getSize

DhImage.getURL

检取指向图象文件的当前的URL。

语法

final public String getURL ()

返回值

返回指向所显示文件的URL地址。

请参阅：setUrl

DhImage.removeHotSpot

删除图象中的DhHotSpot对象。

语法

final public void removeHotSpot ( DhHotSpot hs )

参数

要删除的DhHotSpot。

DhImage. RemoveOnAbort

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

语法

final public void removeOnAbort ( EventHandler h )

参数

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

说明

当用户取消加载图象时就触发该事件。

请参阅：addOnAbort

DhImage. RemoveOnError

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

语法

public final void removeOnError ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnError

DhImage. RemoveOnGotFocus

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

语法

public final void removeOnGotFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

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

请参阅：addOnGotFocus

DhImage. RemoveOnLoad

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

语法

final public void removeOnLoad ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当图象加载完毕时就触发load事件。

DhImage. RemoveOnLostFocus

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

语法

public final void removeOnLostFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

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

请参阅：addOnLostFocus

DhImage. RemoveOnReadyStateChange

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

语法

final public void removeOnReadyStateChange( ReadyStateEventHandler h )

参数

要删除的ReadyStateEventHandler代理。

请参阅：addOnReadyStateChange

DhImage.setURL

设置图象文件的URL。

语法

final public void setURL ( String url)

参数

url

要显示的点位图文件的URL地址。该URL地址可以与HTML文档的相对地址有关。

请参阅：getURL

DhInlineFrame类

表示一个联编框架元件（<IFRAME>）。

Component
  |
  +-- DhStyleBase
     |
     +--DhElement
        |
        +--DhInlineFrame

package com.ms.wfc.html

public class DhInlineFrame

extends DhElement

构造器

DhInlineFrame. DhInlineFrame

创建一个框架。

语法

public DhInlineFrame ()pubilc DhInlineFrame( String url )

参数

url

框架的源。

说明

缺省构造器创建空的框架。

方法

DhInlineFrame.addOnDocumentReady

为documentReady事件指定一个代理。

语法

public final void addOnDocumentReady ( EventHandler h )

参数

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

说明

当准备好处理IFRAME文档时就调用事件处理器指定的方法。

请参阅：removeOnDocumentReady

DhInlineFrame.addOnGotFocus

为gotFocus事件指定一个代理。

语法

public final void addOnGotFocus ( EventHandler h )

参数

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

说明

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

请参阅：removeOnGotFocus

DhInlineFrame.addOnLostFocus

为lostFocus事件指定一个代理。

语法

public final void addOnLostFocus ( EventHandler h )

参数

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

说明

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

DhInlineFrame.addOnResize

为resize事件指定一个代理。

语法

public final void addOnResize ( EventHandler h )

参数

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

说明

当框架改变了大小时就调用代理指定的方法。

请参阅：removeOnResize

DhInlineFrame.getFrameDocument

检取框架中当前的文档。

语法

public DhDocument getFrameDocument()

返回值

与该框架关联的DhDocument对象。

说明

如果不能访问框架中的文档，该方法就返回null。由于浏览器安全性限制，来自不同服务器的封闭页面的文档通常都不能访问。

DhInlineFrame.getScroll

检取当前的滚动模式。

语法

public int getScroll ()

返回值

返回当前的滚动模式。可以是：

?DhScrollBars.AUTO，指明由浏览器决定滚动模式。

?DhScrollBars.YES，指明允许滚动。

?DhScrollBars.NO，指明不允许滚动。

请参阅：DhScrollBars, setScroll

DhInlineFrame.getURL

检取该框架内容位置的URL地址。

语法

public String getURL()

返回值

返回该框架的URL地址。

请参阅：setURL

DhInlineFrame.removeOnDocumentReady

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

语法

public final void removeOnDocumentReady ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当准备好处理IFRAME文档时就调用事件处理器指定的方法。

请参阅：addOnDocumentReady

DhInlineFrame. RemoveOnGotFocus

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

语法

public final void removeOnGotFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当元件收到输入焦点时就触发getFocus事件。

请参阅：addOnGotFocus

DhInlineFrame. RemoveOnLostFocus

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

语法

public final void removeOnLostFocus ( EventHandler h )

参数

要删除的EventHandler代理。

说明

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

请参阅：addOnLostFocus

DhInlineFrame. RemoveOnResize

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

语法

public final void removeOnResize ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当框架改变了大小时就触发resize事件。

请参阅：addOnResize

DhInlineFrame.setScroll

设置当前的滚动模式。

语法

public void setScroll ( int scrollMode)

参数

scrollMode

需要的模式，可以是：

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

·DhScrollBars.YES，指明允许滚动。

·DhScrollBars.NO，指明不允许滚动。

请参阅：DhScrollBars, getScroll

DhInlineFrame.setURL

设置该框架内容位置的URL地址。

语法

public void setURL( String url )

参数

url

框架的URL地址。

请参阅：getURL

DhInsertOptions类

提供将DhElement项插入容器的常量。

Enum
  |
  +-- DhInsertOptions

package com.ms.wfc.html

public class DhInsertOptions

extends Enum

说明

DhDocument.add，DhForm.add和DhTable.add方法使用该类。

字段

DhInsertOptions.AFTER

指明在列表中指定项的后面插入该项。

语法

public static final int AFTER;

DhInsertOptions.BEFORE

指明在列表中指定项的前面插入该项。

语法

public static final int BEFORE;

DhInsertOptions.BEGINNING

指明在当前列表的开头插入该项。

语法

public static final int BEGINNING;

DhInsertOptions.END

指明在当前列表的末尾插入该项。

语法

public static final int END;

方法

DhInsertOptions.valid

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

语法

public static boolean valid ( int n )

参数

要检查的值。

返回值

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

说明

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

DhJumpPoint类

表示了文档中的书签。

Component
  |
  +-- DhStyleBase
     |
     +-- DhElement
        |
        +-- DhJumpPoint

package com.ms.wfc.html

public class DhJumpPoint

extends DhElement

说明

跳转点或书签，就是HTML中NAME属性标记所界定的内容（< ANAME=..>）。

构造器

DhJumpPoint. DhJumpPoint

创建一个DhJumpPoint对象。

语法

public DhJumpPoint()public DhJumpPoint( String name )

参数

name

跳转点的名字。就是为HTML中NAME属性所指定的文本。例如，如果名字是揳nchor2?则相应的HTML标记就是 <A NAME=nchor2?>。

方法

DhJumpPoint.getName

检取当前跳转点的名字。

语法

public String getName()

返回值

返回名字，如果没有的话就返回null。这是为HTML中的NAME属性所指定的文本。例如，如果名字是揳nchor2?则相应的HTML标记就是 <A NAME=nchor2?>.

请参阅：setName

DhJumpPoint.setName

设置跳转点的名字。

语法

public void setName( String n )

参数

跳转点的名字。这是为HTML中的NAME属性所指定的文本。例如，如果名字是“anchor2”，则相应的HTML标记就是<ANAME="anchor2">。

异常

如果n是null，就产生WFCInvalidArgumentException异常消息。

请参阅：getName

DhLinkTarget类

提供设置文档目标窗口常量。

Enum
   |
   +--DhLinkTarget

package com.ms.wfc.html

public class DhLinkTarget

extends Enum

说明

DhHyperlink.setStockTargetWindow和DhHyperlink.getStockTargetWindow方法使用这些常量。

字段

DhLinkTarget.NEW_WINDOW

指示浏览器将文档放入一个新的顶层浏览器窗口。

语法

public static final int NEW_WINDOW;

DhLinkTarget.PARENT_DOC

指示浏览器将文档放入当前窗口的父窗口。

语法

public static final int PARENT_DOC;

DhLinkTarget.THIS_FRAME

指示浏览器将文档放入框架集合中当前的框架中。

语法

public static final int THIS_FRAME;

DhLinkTarget.TOP_FRAME

指示浏览器将文档放入最顶层的窗口中，替换当前的框架集合。

语法

public static final int TOP_FRAME;

方法

DhLinkTarget.valid

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

语法

pubilc static boolean valid ( int n )

参数

要检查的值。

返回值

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

说明

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

DhListBox类

实现了一个HTML列表框控件。

Component
  |
  +--DhStyleBase
     |
     +-- DhElement
        |
        +-- DhBaseContainer
           |
           +-- DhSelectBox
              |
              +-- DhListBox

package com.ms.wfc.html

public class DhListBox

extends DhSelectBox

说明

该类管理增加、删除、选择项，以及滚动。该列表框框架可用于窗体中（请参阅DhForm）传输数据。

构造器

DhListBox. DhListBox

创建一个DhListBox框架。

语法

public DhListBox()

public DhListBox ( int nRows, int selectionMode )

参数

nRows

初始化时可视行号。该数必须比1大。

SelectionMode

一个值，确定用户是否可以选择多行。可以是com.ms.wfc.ui.SelectionMode中的任何值。

说明

缺省构造器创建的列表框框架有两个可视行，允许选择其中的一个。

方法

DhListBox.getAlignment

检取该列表框中当前的对齐方式。

语法

public int getAlignment()

说明

返回DhAlignment中的对齐常量值。

DhListBox.getSelectionMode

检取列表框当前的选择模式。

语法

public int getSelectionMode ()

返回值

返回选择模式。可能的值有：

·SelectionMode.ONE，指明一次只能选择一项。

·SelectionMode.MULTI_EXTENDED，指明一次可以选择多项，在进行选择时可以借助于SHIFT和CTRL键的帮助。

请参阅：com.ms.wfc.ui.SelectionMode, setSelectionMode

DhListBox.getVisibleRows

检取当前可视行的数量。

语法

public int getVisibleRows()

返回值

返回行数。

请参阅：setVisibleRows

DhListBox.setAlignment

设置该列表框与周围文本的对齐方式。

语法

public void setAlignment( int nAlignment )

参数

nAlignment

新的对齐格式，可以是DhAlignment中的一个对齐常量。

请参阅：getAlignment

DhListBox.setSelectionMode

确定用户一次可在列表框中选择多少行。

语法

public void setSelectionMode ( int value )

参数

value

新的选择模式。可能的值有：

·SelectionMode.ONE指明一次只能选择一项。

·SelectionMode.MULTI_EXTENDED指明一次可以选择多项，在进行选择时可以借助于SHIFT和CTRL键的帮助。

注意：NONE和MULTI_SIMPLE对于DhListBox来说是无效的。

异常

如果该值是ONE或MULTI_EXTENDED，则就产生WFCInvalidArgumentExcep- tion异常消息。

请参阅：getSelectionMode

DhListBox.setVisibleRows

设置列表框中可视行的数量。

语法

public void setVisibleRows( int nRows )

参数

nRows

行数。必须比1大。

异常

如果nRows比2小，就产生WFCInvalidArgumentException异常消息。

请参阅：getVisibleRows

DhListType类

为DhBulletedList框架提供常量并支持其中的列表类型。

Enum
   |
   +-- DhListType

package com.ms.wfc.html

public class DhListType

extends Enum

字段

DhListType.BULLETED

表示每项都有一个小符号的列表。

语法

public final static int BULLETED;

DhListType.DIR

表示每项都有一个大符号的列表。

语法

public final static int DIR;

DhListType.LARGE_LETTER

表示每项都有一个指定大写字母的列表。

语法

public final static int LARGE_LETTER;

DhListType.LARGE_ROMAN

表示每项都有一个指定大写罗马数字的列表。

语法

public final static int LARGE_ROMAN;

DhListType.MENU

表示每项都有一个大符号的列表。

语法

public final static int MENU;

DhListType.NUMBERED

表示每项都有一个指定数字的列表。

语法

public final static int NUMBERED;

DhListType.SMALL_LETTER

表示每项都有一个指定小写字母的列表。

语法

public final static int SMALL_LETTER;

DhListType.SMALL_ROMAN

表示每项都有一个指定的小写人们数字的列表。

语法

public final static int SMALL_ROMAN;

方法

DhListType.valid

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

语法

public static boolean valid ( int n )

参数

要检查的值。

返回值

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

说明

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

DhMargins类

为边缘空白风格操纵提供常量定义。

Enum
  |
  +-- DhMargins

package com.ms.wfc.html

public class DhMargins

extends Enum

说明

可以用位操作符OR将多个常量组合在一起来指明多个边缘空白。

字段

DhMargins.ALL

指明所有常量的组合。这就等于(TOP | RIGHT | BOTTOM | LEFT )。

语法

public static final int ALL;

DhMargins.BOTTOM

指明底边缘空白。

语法

public static final int BOTTOM;

DhMargins.LEFT

指明左边的边缘空白。

语法

public static final int LEFT;

DhMargins.RIGHT

指明右边的边缘空白。

语法

public static final int RIGHT;

DhMargins.TOP

指明顶部的边缘空白。

语法

public static final int TOP;

方法

DhMargins.valid

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

语法

public static boolean valid ( int n )

参数

要检查的值。

返回值

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

说明

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

DhMarginWidthInfo类

提供有关元件边缘空白设置的结构性知识。

package com.ms.wfc.html

public class DhMarginWidthInfo

说明

DhStyleBase类及其扩展类使用该类。

请参阅：DhUnits

字段

DhMarginWidthInfo.bottomUnit

使用一个DhUnits常量来指明底边缘空白的宽度单位。

语法

public int bottomUnit；

DhMarginWidthInfo.bottomWidth

使用bottomUnit指定的单位来指明底边缘空白的宽度。

语法

public int bottomWidth；

DhMarginWidthInfo.leftUnit

使用一个DhUnits常量指明左边缘空白的宽度单位。

语法

public int leftUnit；

DhMarginWidthInfo.leftWidth

使用leftUnit指定的单位指明左边缘空白的宽度。

语法

public int leftWidth；

DhMarginWidthInfo.rightUnit

使用一个DhUnits常量指明右边缘空白的宽度单位。

语法

public int rightUnit；

DhMarginWidthInfo.rightWidth

使用rightUnit指定的单位指明右边缘空白的宽度。

语法

public int rightWidth；

DhMarginWidthInfo.topUnit

使用一个DhUnits常量指明上边缘空白的宽度单位。

语法

public int topUnit；

DhMarginWidthInfo.topWidth

使用leftUnit指定的单位指明上边缘空白的宽度。

语法

public int topWidth；

构造器

DhMarginWidthInfo. DhMarginWidthInfo

创建一个DhMarginWidthInfo对象。

语法

public DhMarginWidthInfo ()

public DhMarginWidthInfo (DhMarginWidthInfo mwi )

参数

mwi

用于初始化当前设置的对象。

说明

有参数的构造器取现有的DhMarginWidthInfo对象来进行初始化。

DhModule类

提供com.ms.wfc.html包的放置服务（siting service）。

package com.ms.wfc.html

public class DhModule

extends com.ms.wfc.core.Component

implements IObjectWithSite, IPersistPropertyBag, DhStringIDs,ISiteable

说明

你不应该创建DhModule对象；在客户HTML页面上放置OBJECT标记时或从服务器上的ASP文件激活它时将自动创建该对象。

方法

DhModule.addOnBeforeUnload

为beforeUnload事件指定一个代理。

语法

public final void addOnBeforeUnload ( EventHandler h )

参数

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

说明

当文档要卸载时就调用该代理指定的方法。该事件自动路由给onDocument-Unload。

请参阅：removeOnBeforeUnload

DhModule.addOnError

为error事件指定一个代理。

语法

public final void addOnError( EventHandler h )

参数

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

说明

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

请参阅：removeOnError

DhModule.addOnGotFocus

为gotFocus事件指定一个代理。

语法

final pubilc void addOnGotFocus ( EventHandler h )

参数

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

说明

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

请参阅：removeOnGotFocus

DhModule.addOnHelp

为help事件指定一个代理。

语法

public final void addOnHelp ( EventHandler h )

参数

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

说明

当用户请求帮助时就调用代理所指定的方法。

请参阅：removeOnHelp

DhModule.addOnLoad

为load事件指定一个代理。

语法

final public void addOnLoad ( EventHandler h )

参数

事件处理器回调方法。

说明

当文档加载完毕时就调用代理所指定的方法。缺省地，该事件将自动路由给onDocumentLoad。

请参阅：removeOnLoad

DhModule.addOnLostFocus

为lostFocus事件指定一个代理。

语法

final public void addOnLostFocus ( EventHandler h )

参数

事件处理器的回调方法。

说明

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

请参阅：removeOnLostFocus

DhModule.addOnResize

为resize事件指定一个代理。

语法

public final void addOnResize( EventHandler h )

参数

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

说明

当窗口改变大小时就调用代理所指定的方法。

请参阅：removeOnResize

DhModule.addOnScroll

为scroll事件指定一个代理。

语法

public final void addOnScroll ( ScrollEventHandler h )

参数

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

说明

当滚动元件时就调用代理所指定的方法。DhModule.addOnUnload为unload事件指定一个代理。

语法

final public void addOnUnload ( EventHandler h )

参数

事件处理器的回调方法。

说明

当文档准备好卸载时就调用代理所指定的方法。缺省地，该事件将自动路由给onDocumentUnload。

请参阅：removeOnUnload

DhModule.appendEventHandlers

将给定模块的事件处理器附加到给模块事件处理器列表中。

语法

public void appendEventHandlers (DhModule m )

参数

要添加到该元件的包含事件处理器列表的模块。

DhModule.doMain

初始化从控制台（通常是JView）激活的DhModule。

语法

final public void doMain ( String args[] )

参数

args

最初传递给main的参数表。

说明

在你的静态函数中才调用该方法。

DhModule.getCodeClass

检取该模块文档类的名字（应该是一个扩展DhDocument的类）。

语法

final public String getCodeClass ()

返回值

返回文档类的名字。

说明

在DhModule派生类的构造器中并没有设置该属性值，框架使用HTML 标记的__CODECLASS属性设置该值。

DhModule.getDocument

检取当前与该模块关联的DhDocument对象。

语法

public final DhDocument getDocument ()

返回值

返回当前的DhDocument，或者，如果页面还没有加载完毕就返回null。

说明

只有在文档加载完毕时调用该方法才是有效的。当加载完毕时将调用DhDocument.onDocumentLoad。

DhModule.getDocumentObject

检取当前与该模块关联的文档，是用于脚本目的的一个Object。

语法

public Object getDocumentObject ()

返回值

返回当前的文档对象，或者，如果页面还没有加载完毕就返回null。

DhModule.getModuleHost

检取一个字符串，指明模块如何存放。

语法

public String getModuleHost()

返回值

返回一个字符串，指明模块的存放方式。目前，可能的返回值有：

·"IIS"，指明是一个Internet服务器。

·"IE",指明是一个该Internet浏览器（客户端）。

·"CONSOLE“，指明是控制台（通常使用）jview.exe）。

·"NONE“，指明不知道存放环境。

·"Other"。

说明

你可以在initForm方法中调用getModuleHost并调整自己模块的行为。例如，如果存放方式是 "IIS",HTML元件中创建事件处理器就没有说明效果。

DhModule.getPeer

检取该类对等的HTML元件。

语法

public IUnknown getPeer()

返回值

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

说明

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

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

DhModule.getQueryParameter

检取查询参数。

语法

public String getQueryParameter ( String strParamName )

参数

strParamName

要检取的参数名。

返回值

从Request对象中返回参数值。如果参数不存在，就返回空字符串。

请参阅：getServerMode, getRequest

DhModule.getRequest

活动服务器Request对象，如果存在的话（例如，如果模块运行在服

务器上）。

语法

public IRequest getRequest ()

返回值

返回用于操作IIS请求的IRequest界面。这是在IIS中使用的Request对象界面。

说明

Request检取到的值是客户浏览器在HTTP请求中传递给服务器的值。有关Request对象的详细信息，请参阅随机文档中的ASP文档。

请参阅：getServerMode, getResponse

DhModule.getResponse

获得Response对象，如果有的话（例如，如果模块运行在服务器上）。

语法

public IResponse getResponse ()

返回值

返回可用于操作IIS响应的IResponse界面。这是在IIS中使用的Response对象界面。

说明

Response对象用于给客户发送输出消息。有关Response对象的详细信息，请参阅随机文档中的ASP文档。

请参阅：getServerMode, getRequest

DhModule.getServerMode

确定该DhModule对象是否位于IIS上。

语法

public boolean getServerMode()

返回值

如果该DhModule位于Web服务器上，就返回true；否则，如果位于客户或其他容器中就返回false。

DhModule.LoadParameters

这是第一次也是最后一次机会，让模块查看要写入宿主HTML文档PARAM标记中的参数。

语法

public void LoadParameters ( DhPropertyBag pb )

参数

PARAM标记集合。

DhModule.removeOnBeforeUnload

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

语法

public final void removeOnBeforeUnload ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnBeforeUnload

DhModule. RemoveOnError

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

语法

public final void removeOnEvent( EventHandler h )

参数

要删除的EventHander代理。

请参阅：addOnError

DhModule. RemoveOnGotFocus

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

语法

pubilc void removeOnGotFocus ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnGotFocus

DhModule. RemoveOnHelp

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

语法

public final void removeOnHelp ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnHelp

DhModule. RemoveOnLoad

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

语法

public void removeOnLoad ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnLoad

DhModule. RemoveOnLostFocus

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

语法

public void removeOnLostFocus ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnLostFocus

DhModule. RemoveOnResize

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

语法

public final void removeOnResize( EventHandler h )

参数

要删除的EventHandler代理。

说明

当窗口改变大小时就触发resize事件。

请参阅：addOnResize

DhModule. RemoveOnScroll

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

语法

public final void removeOnScroll ( ScrollEventHandler h )

参数

要删除的ScrollEventHandler代理。

请参阅：addOnScroll

DhModule. RemoveOnUnload

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

语法

public void removeOnUnload ( EventHandler h )

参数

要删除的EventHandler代理。

请参阅：addOnUnload

DhModule.setCodeClass

设置为包含该模块而创建的HTML文档类的名字。

语法

final public void setCodeClass ( String strCodeClass )

参数

strCodeClass

要使用的DhDocument派生类的类名。

说明

如果在DhModule派生类的构造器中没有设置该属性值，则当在Internet Explorer中运行时，框架将使用HTML 标记的__CODECLASS属性设置该值。

请参阅：getCodeClass

DhModule.setHTMLDocument

设置服务器端选项中输入文档的文件名。

语法

final public void setHTMLDocument ( String fileName )

final public void setHTMLDocument ( IDataStream inputStream )

参数

fileName

HTML模板的全路径，如果没有使用模板，就是空字符串（摂）。

inputStream

指向HTML模板的输入文档流（com.ms.wfc.io.IDataStream）。

说明

并不是说在绑定到浏览器时要调用该方法，只在调用了setCodeClass方法之后才能调用该方法。如果没有使用模板，调用该方法时就使用空字符串作为参数；否则，使用setBoundElements将DhElements项与模板中的HTML关联起来。

请参阅：com.ms.wfc.io.File

DhModule.write

将特定的HTML字符串写入当前的站点。

语法

public void write ( String strHTML )

public void write ( DhElement element )

public void write ( Throwable exception, boolean stackTrace )

参数

strHTML

要写入的HTML字符串。

Element

要写的元件。

exception

要写的异常或错误。

StackTrace

如果要写栈跟踪消息就设置为true；否则就设置为false。如果指明stackTrace，则也写入栈跟踪消息。

说明

如果运行在服务器模式，则字符串或元件就写入输出流；否则，就追加到当前文档主体的末尾。

DhObjectFactory类

从现有的ActiveX/COM或Java对象中创建一个对象，并将该对象添加到文档中。

Component
  |
  +-- DhStyleBase
     |
     +--DhElement
        |
        +--DhBaseContainer
           |
           +-- DhObjecFactory

package com.ms.wfc.html

public class DhObjectFactory

extends DhBaseContainer

说明

要使用该类，需要创建一个DhObjectFactory对象，并指明对象类的标识符（CLASSID）。这跟在HTML中使用OBJECT标记是一样的。

构造器

DhObjectFactory. DhObjectFactory

语法

public DhObjectFactory()

public DhObjectFactory( String classid )

public DhObjectFactory( _Guid iid )

参数

classid

现有对象的类标识符（CLSID）。

iid

要实化的_Guid对象。

说明

你可以将Java moniker名字（如 Java:myapplet"）作为CLASSID参数值来实化Java小应用程序的OBJECT标记。

请参阅：com.ms.com._Guid

方法

DhObjectFactory.add

为对象标记增加一个孩子。

语法

protected void add ( DhElement h )

参数

要添加的DhElement对象。

DhObjectFactory.addOnError

为error事件指定一个代理。

语法

public final void addOnError ( EventHandler h )

参数

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

说明

当该元件产生一个错误时就调用代理所指定的方法。

请参阅：removeOnError

DhObjectFactory.addOnReadyStateChange

为readyStateChange事件指定一个代理。

语法

public final void addOnReadyStateChange( ReadyStateEventHandler h )

参数

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

请参阅：removeOnReadyStateChange

DhObjectFactory.addParam

给对象增加一个新的参数。

语法

public void addParam ( String param, String value )

参数

param

参数的名字。可以是HTML中OBJECT标记支持的任何参数。

value

参数的值。

请参阅：removeParam

DhObjectFactory.getClassid

检取对象的类标识符，这与HTML中OBJECT标记的CLASSID参数相同。

语法

public String getClassid ()

返回值

返回对象的类标识符。

请参阅：setClassid

DhObjectFactory.getClsid

检取对象当前的类标识符，与HTML中OBJECT标记的CLASSID参数相同。

语法

public _Guid getClsid()

返回值

返回对象的类标识符。

请参阅：setClsid

DhObjectFactory.getCodeBase

检取对象当前的代码基，与HTML中OBJECT标记的CODEBASE参数相同。

语法

public String getCodeBase()

返回值

返回对象的代码基。

请参阅：setCodeBase

DhObjectFactory.getCodeClassName

检取对象的Java类名，与HTML中OBJECT标记的CODE参数相同。

语法

public String getCodeClassName ()

返回值

返回对象的Java类名。

请参阅：setCodeClassName

DhObjectFactory.getContent

检取代表HTML内容的字符串。

语法

protected StringBuffer getContent ( StringBuffer sb )

参数

HTML内容字符串。

返回值

返回代表HTML内容的StringBuffer。

DhObjectFactory.getDispatchPeer

检取当前实化对象所实现的IDispatch界面。

语法

public Object getDispatchPeer()

返回值

返回表示该对象IDispatch界面的对象。

说明

该对象可以与com.ms.com.Dispatch类一起使用来激活控件的IDispatch界面所输出的方法。

DhObjectFactory.getObjectPeer

检取代表实化了的HTML OBJECT 的对象。

语法

public Object getObjectPeer()

返回值

返回代表实化的HTML OBJECT的对象。

DhObjectFactory.getProgid

检取对象当前的程序标识符（ProgID），与OBJECT标记的PROGID参数是相同的。

语法

public String getProgid ()

返回值

返回代表该对象的ProgID。ProgID是人可以读懂的类标识符表示方法。

请参阅：setProgid

DhObjectFactory.getValue

检取参数的值。

语法

public String getValue ( String param )

参数

param

参数的名字。

DhObjectFactory.initFromPeer

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

语法

protected void initFormPeer (IHTMLElement peer )

参数

peer

现有的对等元件。

说明

当从现有的HTML元件创建实例时，可以覆盖该方法来指向特定的

初始化操作。

DhObjectFactory.removeOnError

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

语法

public final void removeOnError ( EventHandler h )

参数

要删除的EventHandler代理。

说明

当该元件产生一个错误时就触发error事件。

请参阅：addOnError

DhObjectFactory. RemoveOnReadyStateChange

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

语法

public final void removeOnReadyStateChange( ReadyStateEventHandler h )

参数

要删除的ReadyStateEventHandler代理。

请参阅：addOnReadyStateChange

DhObjectFactory. RemoveParam

删除OBJECT参数列表中的一个参数。

语法

public void removeParam ( String param )

参数

param

要删除参数的名字。

异常

如果对象当前正处于界定状态，就产生WFCInvalidStateException异常消息。

请参阅：addParam

DhObjectFactory.setClassid

设置对象的类标识符，这与HTML中OBJECT标记的CLASSID参

数相同。

语法

public void setClassid ( String classid )

参数

classid

对象的类标识符。

请参阅：com.ms.com._Guid, getClassid

DhObjectFactory.setClsid

设置对象当前的类标识符，与HTML中OBJECT标记的CLASSID参数相同。

语法

public void setClsid( _Guid guid )

参数

guid

代表该对象的全局唯一标识符（GUID）。

请参阅：getClsid

DhObjectFactory.setCodeBase

设置对象当前的代码基，与HTML中OBJECT标记的CODEBASE参数相同。

语法

public void setCodeBase( String url )

参数

url

指明引用的URL，据此可以找到对象的实现返回对象的代码基。

请参阅：getCodeBase

DhObjectFactory.setCodeClassName

设置对象的Java类名，与HTML中OBJECT标记的CODE参数相同。

语法

public void setCodeClassName ( String className)

参数

className

包含编译过的Java类的文件名。

请参阅：getCodeClassName

DhObjectFactory.setProgid

设置对象当前的程序标识符（ProgID），与OBJECT标记的PROGID参数是相同的。

语法

public void setProgid ( String progid )

参数

progid

代表该对象的ProgID。ProgID是人可以读懂的类标识符表示方法，用于标识COM/ActiveX对象。

请参阅：getProgid

DhPaddings类

为填充（padding）风格的操作提供常量定义。

Enum
    |
    +-- DhPaddings

package com.ms.wfc.html

public class DhPaddings

extends com.ms.wfc.core.Enum

说明

DhStyleBase.setPaddingWidth方法使用该类来指明哪一边使用填充宽度。可以使用位操作符OR组合多个填充常量来指明多个填充边。

字段

DhPaddings.ALL

指明所有填充常量的组合。

语法

public static final int ALL;

说明

这与（TOP | RIGHT | BOTTOM | LEFT）相同。

DhPaddings.BOTTOM

指明填充底边。

语法

public static final int BOTTOM;

DhPaddings.LEFT

指明填充左边。

语法

public static final int LEFT;

DhPaddings.RIGHT

指明填充右边。

语法

public static final int RIGHT;

DhPaddings.TOP

指明填充上边。

语法

public static final int TOP;

方法

DhPaddings.valid

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

语法

public static boolean valid ( int n )

参数

要检查的值。

返回值

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

说明

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

DhPaddingWidthInfo类

提供有关元件填充宽度设置的信息。

package com.ms.wfc.html

public class DhPaddingWidthInfo

说明

DhStyleBase.getPaddingWidthInfo和DhStyleBase.setPaddingWidthInfo使用这些常量。

字段

DhPaddingWidthInfo.bottomUnit

使用DhUnits常量指明底边填充宽度单位。

语法

public int bottomUnit；

DhPaddingWidthInfo.bottomWidth

使用bottomUnit为单位指明底边填充宽度。

语法

public int bottomWidth；

DhPaddingWidthInfo.leftUnit

使用DhUnits常量指明左边填充宽度单位。

语法

public int leftUnit；

DhPaddingWidthInfo.leftWidth

使用leftUnit为单位指明左边填充宽度。

语法

public int leftWidth；

DhPaddingWidthInfo.rightUnit

使用DhUnits常量指明右边填充宽度单位。

语法

public int rightUnit；

DhPaddingWidthInfo.rightWidth

使用rightUnit为单位指明右边填充宽度。

语法

public int rightWidth；

DhPaddingWidthInfo.topUnit

使用DhUnits常量指明顶边填充宽度单位。

语法

public int topUnit；

DhPaddingWidthInfo.topWidth

使用topUnit为单位指明顶边填充宽度。

语法

public int topWidth；

构造器

DhPaddingWidthInfo. DhPaddingWidthInfo

创建一个DhPaddingWidthInfo对象。

语法

public DhPaddingWidthInfo ()

public DhPaddingWidthInfo(DhPaddingWidthInfo mwi )

参数

mwi

现有DhPaddingWidthInfo对象中用于初始化设置的值。

DhPropertyBag类

检取模块PARAM标记的属性值。

package com.ms.wfc.html

public class DhPropertyBag

说明

你从不需要真正创建该类；相反，而是将该类的实例传递给DhModule.Load-Parameters。

方法

DhPropertyBag.getInt

根据给定的名字检取PARAM标记中VALUE属性。

语法

public int getInt ( String name )

参数

name

PARAM标记的NAME属性。

返回值

返回同一PARAM标记相应的数字VALUE属性。

说明

例如，对于结构<PARAM NAME = fee VALUE=33>，在调用getInt("fee")时将检取到33。

DhPropertyBag.getString

根据给定的NAME属性检取PARAM标记的VALUE属性。

语法

public String getString ( String name )

参数

name

PARAM标记的NAME属性。

返回值

返回同一PARAM标记相应的VALUE属性。

说明

例如，对于结构<PARAM NAME=weekday VALUE=monday>，当调用getString("weekday")方法时将检取到字符串“monday”。