ヘッダーとフッターのクラス

> > > > >

ページ・ヘッダーおよびページ・フッターを管理するために、印刷フレームワークには IlvPrintableObject の 2 つの追加のサブクラス ( IlvHeader および IlvFooter) も含まれます。この 2 つのクラスは IlvPrintableObject のサブクラスですが、他の印刷可能オブジェクトのようにページには追加しません。ヘッダーとフッターは、ドキュメントの全ページに共通するため、IlvDocument クラスのインスタンスに設定されます。

以下は、ヘッダーやフッターを設定するための IlvPrintableDocument クラスのメソッドです。

public void setFooter(IlvFooter footer)
public IlvFooter getFooter()

public void setHeader(IlvHeader header)
public IlvHeader getHeader()

IlvHeader クラスおよび IlvFooter クラスは非常に似ています。ヘッダーとフッターは、3 つのテキスト・セクションで定義されます。各セクションには指定したフォントがあります。

ヘッダーの例を以下に示します。

ヘッダーの例

ヘッダーまたはフッターの 3 つのセクションにはそれぞれ、ユーザーがオブジェクトのコンストラクターで指定したテキストが含まれます。ヘッダーの例に示したヘッダーでは、以下のようになります。

new IlvHeader("7/12/02", "Printing demo", "Page 1");

ヘッダーとフッターはドキュメントで定義されるため、前述の例のようにページ番号を指定する必要はありません。 IlvHeader クラスおよび IlvFooter クラスでは、ドキュメントの印刷時にドキュメントから値に変換される特定数のキーを提供します。

以下は、使用可能なキーの一覧です。

static String AuthorKey: 作成者用のキー
static String DateKey: 日付用のキー
static String FileKey: ファイル名用のキー
static String PageKey: ページ番号 (単ページ) 用のキー
static String PagesKey: ドキュメントのページ番号用 (複数ページ) のキー
static String TimeKey: 印刷時刻用のキー

ヘッダーの例でヘッダーを作成するには、次の new ステートメントを使用します。

new IlvHeader(IlvHeader.DateKey, "Printing demo", "Page " + IlvHeader.PageKey)

メモ

印刷フレームワークには、ドキュメントのヘッダーとフッターを変更するためのページ・ダイアログ・ボックスも用意されています。

現在のセクション

印刷フレームワーク