TocDocument

TocDocument (クラス)

public TocDocument {inherits DefaultDocument}

table-of-contents ペインを追加した DefaultDocumentです。

説明

TocDocument に追加されたオブジェクトは、実際にはドキュメントの内容を表す TextFlowBox に追加されます。ScrollBox は、TextFlowBox の周囲に配置されます。これは、DefaultDocument と同様です。

コンテンツの周囲の ScrollBox のほかに、このスタイルでは左側にドキュメントのセクション階層を表示するペインもあります。階層内のオブジェクトを 1 つクリックすると、コンテンツペインがドキュメントのその部分にスクロールされます。セクション階層の作成方法の詳細については、heading テキスト形式を参照してください。

例

次のコードをファイルにコピーし、ブラウザにロードしてみてください。

{document-style TocDocument}
{heading Things}
{heading level=2, Flowers}
{heading level=2, Birds}
{heading Stuff}
{heading level=2, Dirt}
{heading level=2, Water}

注意事項

TocDocument は一般的に直接作成されることはなく、ビューワにファイルをロードする時に取得されます。ファイルがこのスタイルの Document として表示されるように指示するには、通常 document-style プロシージャを使用します。

ドキュメントの性質は set-document-propertiesを使用すれば変更できます。これは、ドキュメントのコンテンツを囲む TextFlowBox のオプションを設定します。これらのオプションは左側のペインには影響を与えません。

設定されるオプションには 2 つのクラスがあります。

任意のコンテナに設定されるような一般的なオプションです。値はコンテンツに継承されます (例：色、フォントサイズ)。
TocDocument 固有オプションです。ドキュメントのコンテンツを囲む TextFlowBox の性質を管理します。

TocDocument に設定するオプションをいくつか示します。

background:Background
color:FillPattern
font-family:String
font-size:any
font-style:FontStyle
font-weight:FontWeight
paragraph-after-spacing:any
paragraph-before-spacing:any
paragraph-first-line-offset:any
paragraph-justify:ParagraphJustify
paragraph-left-indent:any
paragraph-line-spacing:any
paragraph-right-indent:any
text-bottom-margin:any
text-breakable?:bool
text-left-margin:any
text-preserve-whitespace?:bool
text-right-margin:any
text-top-margin:any

プロパティ継承 Document: destination-table, document-graphic, extension-table, last-id, scroller, top-level-graphic

メソッド継承 DefaultDocument: add-elaborated-form, get-page-position, scroll-to-anchor, set-page-position

メソッド継承 Document: add-destination, add-error-message, add-target

メソッド継承 Object: object-describe, object-describe-for-debugging, object-serialize

default (コンストラクタ)

toc-root (フィールド)

create-top-level-graphic (メソッド)