Document (クラス)
public abstract Document
パッケージ： CURL.ENGINE.APPLET
直接継承しているサブクラス: DefaultDocument, PlainDocument

インスタンス化された Curl ファイルを示します。

説明

各 Curl アプレット ファイルがロードされるときには、Document または派生クラスのオブジェクトによって表現されます。ドキュメントはフックを提供し、作成者がドキュメントの処理を制御できるようにします。たとえば、TocDocument はドキュメント内の各見出しレベルから目次を計算して、ロードされたオブジェクトと並べて配置します。
通常は Document を直接作成する必要はなく、アプレット ファイルをブラウザにロードする過程でこれを取得します。
作成するドキュメントの種類を指定するには、アプレット ファイルで document-style プロシージャを呼び出します。

コンストラクタ
default:Document を作成します。
コンストラクタ public {Document.default dg:Box}

プロパティ
destination-table:destination をマッピングするテーブルが、このドキュメントの Visual 要素に名前をつけます。
フィールド public constant Document.destination-table:{HashTable-of String, Visual} ={new {HashTable-of String, Visual}}
document-graphic:ドキュメント グラフィック。
フィールド public constant Document.document-graphic:Box
extension-table:ドキュメント データの拡張可能テーブルです。
フィールド protected Document.extension-table:{HashTable-of int, any} ={new {HashTable-of int, any}}
last-id:Document.extension-table の最後に割り当てられた拡張 id です。
フィールド protected Document.last-id:int =0
scroller:"DefaultDocument" およびその仲間用のスクローラです。
フィールド protected Document.scroller:#ScrollBox
top-level-graphic:Document のトップ レベルの Graphic です。これは、ブラウザ内部に表示されます。
アクセサ public Document.top-level-graphic:Graphic

メソッド
add-destination:
public {Document.add-destination name:String, visual:Visual}:void
add-elaborated-form:オブジェクトを現在のドキュメントに追加するため、ローダーによって呼び出されます。
public abstract {Document.add-elaborated-form val:any}:void
add-error-message:オブジェクトを現在のドキュメントに追加するため、ローダーによって呼び出されます。既定では、Document.add-elaborated-form を呼び出すだけです。
public {Document.add-error-message val:any}:void
add-target:
deprecated public {Document.add-target name:String, target:Visual}:void
create-top-level-graphic:ブラウザがこのドキュメントを表示するためのオブジェクトを作成します。Document.top-level-graphic を参照してください。
protected abstract {Document.create-top-level-graphic}:Graphic
get-page-position:
public {Document.get-page-position}:PagePosition
scroll-to-anchor:この Document に適した処理を Url から anchor で指定して行います。Url.anchor を含む URL からアプレットをロードするときに呼び出されます。
public {Document.scroll-to-anchor anchor:String}:void
set-page-position:
public {Document.set-page-position position:PagePosition}:void
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
default (コンストラクタ)
public {Document.default dg:Box}

Document を作成します。

dg: Document の内容です。これは Document.document-graphic として保存されます。

プログラミング注意事項

Document は一般的に直接作成されることはなく、アプレットをロードする時に取得されます。


プロパティ詳細
destination-table (フィールド)
public constant Document.destination-table:{HashTable-of String, Visual} ={new {HashTable-of String, Visual}}

destination をマッピングするテーブルが、このドキュメントの Visual 要素に名前をつけます。


document-graphic (フィールド)
public constant Document.document-graphic:Box

ドキュメント グラフィック。


extension-table (フィールド)
protected Document.extension-table:{HashTable-of int, any} ={new {HashTable-of int, any}}

ドキュメント データの拡張可能テーブルです。

説明

このテーブルにより、パッケージはドキュメント レベルでデータを格納できます。ドキュメントに新しいプロパティを加えるのとは違い、このメカニズムを使用するとテーブルの新しい各エントリが新しい id を取得するため、競合するライブラリ間で名前が重複することがありません。

last-id (フィールド)
protected Document.last-id:int =0

Document.extension-table の最後に割り当てられた拡張 id です。


scroller (フィールド)
protected Document.scroller:#ScrollBox

"DefaultDocument" およびその仲間用のスクローラです。


top-level-graphic (アクセサ)
アクセサ public Document.top-level-graphic:Graphic

Document のトップ レベルの Graphic です。これは、ブラウザ内部に表示されます。

説明

通常は、これは単なる Document.document-graphic または Document.document-graphic に関連する ScrollBox などのなんらかのラッパーです。

注意事項

Document.create-top-level-graphic を呼び出して lazily に作成されます。




メソッド詳細
add-destination (メソッド)
public {Document.add-destination name:String, visual:Visual}:void
この項目はサポートされていません。内部使用限定となっています。

add-elaborated-form (メソッド)
public abstract {Document.add-elaborated-form val:any}:void

オブジェクトを現在のドキュメントに追加するため、ローダーによって呼び出されます。


add-error-message (メソッド)
public {Document.add-error-message val:any}:void

オブジェクトを現在のドキュメントに追加するため、ローダーによって呼び出されます。既定では、Document.add-elaborated-form を呼び出すだけです。

オーバーライド

追加されるアイテムがエンジンからのエラーメッセージか、Document のアイテムであるかをサブクラスが確認する必要がある場合、サブクラスでこのメソッドをオーバーライドする必要があります。

add-target (メソッド)
deprecated public {Document.add-target name:String, target:Visual}:void
この項目はサポートされていません。内部使用限定となっています。

create-top-level-graphic (メソッド)
protected abstract {Document.create-top-level-graphic}:Graphic

ブラウザがこのドキュメントを表示するためのオブジェクトを作成します。Document.top-level-graphic を参照してください。


get-page-position (メソッド)
public {Document.get-page-position}:PagePosition
この項目はサポートされていません。内部使用限定となっています。

scroll-to-anchor (メソッド)
public {Document.scroll-to-anchor anchor:String}:void

この Document に適した処理を Url から anchor で指定して行います。Url.anchor を含む URL からアプレットをロードするときに呼び出されます。

anchor: 先頭が # 文字で始まる URL の、エンコードされたアンカー部を含む文字列です。

説明

DefaultDocument の実装では、anchor の URL エスケープ シーケンスをデコードし、先頭の # 文字をトリミングし、結果的に生じる文字列で指名される destination にスクロールします。

set-page-position (メソッド)
public {Document.set-page-position position:PagePosition}:void
この項目はサポートされていません。内部使用限定となっています。