PaginationState (クラス)
public PaginationState
インポート元： CURL.GUI.STANDARD. package 内で定義されています CURL.GUI.BASE.

Graphic に対するパジネーション シーケンスの状態を表すオブジェクト。

プログラミング注意事項

印刷時には、Graphic に、必要な場合にページ間で自分自身をパジネートする方法を知らせることができます。このオブジェクトは、与えられた時点での Graphic のパジネーション状態を表すために使用されます。

注意事項

PaginationState が Graphic と関連付けられているとき、つまり Graphic.pagination-state が非 NULL のときは、gui-toolkit システムにより、Graphic.draw に渡される Renderer2d のクリッピング領域が、PaginationState.start-offset と PaginationState.end-offset の間にある、この Graphic の部分のみを描画するように設定されているか確認されます。

コンストラクタ
default:PaginationState オブジェクトを作成します。
コンストラクタ public {PaginationState.default
bounds:GRect,
show-decorations-at-page-breaks?:bool = false
}

プロパティ
bounds:この PaginationState オブジェクトと関連した Graphic の境界ボックス。
フィールド public constant PaginationState.bounds:GRect
end-offset:関連する Graphic へのオフセットで、現在のページにおけるパジネーションの現在の終点を示します。
フィールド public PaginationState.end-offset:Distance
min-end-offset:関連する Graphic へのオフセットで、次のページにおけるパジネーションの始点を示します。
フィールド public PaginationState.min-end-offset:Distance
show-decorations-at-page-breaks?:true の場合は、この PaginationState オブジェクトと関連した Graphic を含む各ページにボーダーとマージンを描画します。
フィールド public PaginationState.show-decorations-at-page-breaks?:bool
start-offset:関連する Graphic へのオフセットで、現在のページにおけるパジネーションの現在の始点を示します。
フィールド public PaginationState.start-offset:Distance

メソッド
advance-pagination:パジネーション シーケンスを促進するヘルパー関数。
public {PaginationState.advance-pagination
start-offset:Distance,
end-offset:Distance,
min-end-offset:Distance = end-offset,
quality-if-not-complete:PaginationQuality = PaginationQuality.good
}:(self:PaginationState, pq:PaginationQuality)
clone:PaginationState オブジェクトのクローンを作成して返します。
public {PaginationState.clone}:PaginationState
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize



コンストラクタ詳細
default (コンストラクタ)
public {PaginationState.default
bounds:GRect,
show-decorations-at-page-breaks?:bool = false
}

PaginationState オブジェクトを作成します。

bounds: 詳細については、PaginationState.bounds を参照してください。
show-decorations-at-page-breaks?:
既定値は false です。
詳細については、PaginationState.show-decorations-at-page-breaks? を参照してください。

注意事項

コンストラクタは、関連する Graphic の内側の境界の上部を指すように、PaginationState.start-offset、PaginationState.end-offset、および PaginationState.min-end-offset を初期化します。


プロパティ詳細
bounds (フィールド)
public constant PaginationState.bounds:GRect

この PaginationState オブジェクトと関連した Graphic の境界ボックス。

注意事項

この境界ボックスは Graphic の内側の境界として参照され、Layout.get-bounds メソッドを呼び出すことで取得できます。この境界内では、レイアウト オブジェクトは、この PaginationState オブジェクトが関連付けられる Graphic のレイアウトです。

end-offset (フィールド)
public PaginationState.end-offset:Distance

関連する Graphic へのオフセットで、現在のページにおけるパジネーションの現在の終点を示します。

注意事項

既定では、これは -self.bounds.ascent に初期化されます。Graphic.paginate メソッドはこの値を変更します。

min-end-offset (フィールド)
public PaginationState.min-end-offset:Distance

関連する Graphic へのオフセットで、次のページにおけるパジネーションの始点を示します。

注意事項

既定では、これは -self.bounds.ascent に初期化されます。Graphic.paginate メソッドはこの値を変更します。

注意事項

これは通常、PaginationState.end-offset です。
HBox など一部のボックスは、ページ境界にまたがる子を持つことができます。その場合、このフィールドは、これらの子の PaginationState の終了オフセットのうち最小のものに設定されます。言い換えると、min-end-offset は次のページの開始オフセットに設定されます。
min-end-offset はまた、新しい各ページの始めにヘッダーを再描画する必要がある Graphic (RecordGrid など) をパジネートする場合にも役立ちます。SkinnableRecordGridUI.paginate メソッドはこのフィールドを、end-offset からヘッダーの高さを引いた値に設定します。このように min-end-offset を調整することで、次のページに描画されるグラフィックの部分の上にヘッダーを描画するスペースを確保することができます。

show-decorations-at-page-breaks? (フィールド)
public PaginationState.show-decorations-at-page-breaks?:bool

true の場合は、この PaginationState オブジェクトと関連した Graphic を含む各ページにボーダーとマージンを描画します。

注意事項

このフィールドの既定値は false です。この値は、Graphic.start-pagination をオーバーライドすることによって設定できます。

start-offset (フィールド)
public PaginationState.start-offset:Distance

関連する Graphic へのオフセットで、現在のページにおけるパジネーションの現在の始点を示します。

注意事項

既定では、これは -self.bounds.ascent に初期化されます。Graphic.paginate メソッドはこの値を変更します。




メソッド詳細
advance-pagination (メソッド)
public {PaginationState.advance-pagination
start-offset:Distance,
end-offset:Distance,
min-end-offset:Distance = end-offset,
quality-if-not-complete:PaginationQuality = PaginationQuality.good
}:(self:PaginationState, pq:PaginationQuality)

パジネーション シーケンスを促進するヘルパー関数。

start-offset: 関連する Graphic への新しい PaginationState.start-offset オフセット。
end-offset: 関連する Graphic への新しい PaginationState.end-offset オフセット。
min-end-offset: 関連する Graphic への新しい PaginationState.min-end-offset オフセット。その既定値は end-offset です。
quality-if-not-complete: 新しいオフセットが適用された後でパジネーション シーケンスが完了していない場合に返す PaginationQuality。その既定値は PaginationQuality.good です。

戻り値

自分自身と PaginationQuality を返します。この関数を呼び出した後でパジネーション シーケンスが完了した場合は PaginationQuality.complete が返され、完了しなかった場合は quality-if-not-complete がかえされます。

注意事項

この関数は、start-offset、end-offset、および min-end-offset を使用して、このオブジェクトの対応するフィールドを設定します。

clone (メソッド)
public {PaginationState.clone}:PaginationState

PaginationState オブジェクトのクローンを作成して返します。

オーバーライド

このメソッドをオーバーライドして、PaginationState のサブクラスが追加できる他の状態をコピーします。