java.awt
クラス BasicStroke

java.lang.Object
  |
  +--java.awt.BasicStroke

すべての実装インタフェース:

Stroke

public class BasicStroke

extends Object

implements Stroke

BasicStroke クラスは、グラフィックスのプリミティブの輪郭に対する描画属性の基本セットを定義します。これらの属性は、Shape オブジェクトの輪郭に沿って描画されたペンによるマークの形状や、Shape オブジェクトの輪郭線セグメントの両端や接合部に適用される装飾を記述します。これらの属性には、次のものがあります。

幅

ペンの軌跡に対して垂直方向のペンの幅

エンドキャップ

閉じられていない部分輪郭線または破線セグメントの両端に適用される装飾

ラインジョイン

2 つの輪郭線セグメントの接合部に適用される装飾

破線属性

不透明部分と透明部分とが交互になるようにして破線を作成する方法の定義

フィールドの概要

static int	CAP_BUTT 装飾を付けずに、閉じられていない部分輪郭線および破線セグメントを終了します。
static int	CAP_ROUND ペン幅の半分の長さを半径とした丸い装飾を付けて、閉じられていない部分輪郭線および破線セグメントを終了します。
static int	CAP_SQUARE 線幅の半分の長さに等しい距離だけセグメントの端を延長する正方形を付けて、閉じられていない部分輪郭線および破線セグメントを終了します。
static int	JOIN_BEVEL 幅の広い輪郭線の外側の角を直線セグメントに接合するようにして輪郭線セグメントを接合します。
static int	JOIN_MITER ラインセグメントの外側の端が重なるまで延長して輪郭線セグメントを接合します。
static int	JOIN_ROUND 線幅の半分の長さを半径として、角を丸く切り落として輪郭線セグメントを接合します。

コンストラクタの概要

BasicStroke()
すべての属性に既定値を使って新しい BasicStroke を構築します。

BasicStroke(float width)
指定された線幅と、エンドキャップおよびラインジョインのスタイルの既定値を使って、実線で BasicStroke を構築します。

BasicStroke(float width, int cap, int join)
指定された属性を持つ新しい BasicStroke を実線で構築します。

BasicStroke(float width, int cap, int join, float miterlimit)
指定された属性を持つ新しい BasicStroke を実線で構築します。

BasicStroke(float width, int cap, int join, float miterlimit, float[] dash, float dash_phase)
指定された属性を持つ新しい BasicStroke を構築します。

メソッドの概要

Shape	createStrokedShape(Shape s) 内部が、指定された Shape をストロークで描画した輪郭を表す Shape を返します。
boolean	equals(Object obj) 指定されたオブジェクトがこの BasicStroke と等しいかどうかを判定します。
float[]	getDashArray() 破線セグメントの長さを表す配列を返します。
float	getDashPhase() 現在の破線フェーズを返します。
int	getEndCap() エンドキャップのスタイルを返します。
int	getLineJoin() ラインジョインのスタイルを返します。
float	getLineWidth() 線幅を返します。
float	getMiterLimit() マイタージョインのリミットを返します。
int	hashCode() このストロークのハッシュコードを返します。

クラス java.lang.Object から継承したメソッド

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

JOIN_MITER

public static final int JOIN_MITER

ラインセグメントの外側の端が重なるまで延長して輪郭線セグメントを接合します。

JOIN_ROUND

public static final int JOIN_ROUND

線幅の半分の長さを半径として、角を丸く切り落として輪郭線セグメントを接合します。

JOIN_BEVEL

public static final int JOIN_BEVEL

幅の広い輪郭線の外側の角を直線セグメントに接合するようにして輪郭線セグメントを接合します。

CAP_BUTT

public static final int CAP_BUTT

装飾を付けずに、閉じられていない部分輪郭線および破線セグメントを終了します。

CAP_ROUND

public static final int CAP_ROUND

ペン幅の半分の長さを半径とした丸い装飾を付けて、閉じられていない部分輪郭線および破線セグメントを終了します。

CAP_SQUARE

public static final int CAP_SQUARE

線幅の半分の長さに等しい距離だけセグメントの端を延長する正方形を付けて、閉じられていない部分輪郭線および破線セグメントを終了します。

コンストラクタの詳細

BasicStroke

public BasicStroke(float width,
                   int cap,
                   int join,
                   float miterlimit,
                   float[] dash,
                   float dash_phase)

指定された属性を持つ新しい BasicStroke を構築します。

パラメータ:

width - BasicStroke の幅

cap - BasicStroke の両端の装飾

join - 輪郭線セグメントの接合部に適用する装飾

miterlimit - マイタージョインを切り取るリミット

dash - 破線パターンを表す配列

dash_phase - 破線パターンが始まるオフセット

例外:

IllegalArgumentException - width が負の値の場合

IllegalArgumentException - cap が CAP_BUTT, CAP_ROUND と CAP_SQUARE のどちらでもない場合

IllegalArgumentException - miterlimit が 1 より小さく、join が JOIN_MITER の場合

IllegalArgumentException - join が JOIN_ROUND、JOIN_BEVEL、JOIN_MITER のどちらでもない場合

IllegalArgumentException - dash_phase が負の値で、dash が null でない場合

IllegalArgumentException - dash の長さがゼロの場合

IllegalArgumentException - 破線の長さがすべてゼロの場合

BasicStroke

public BasicStroke(float width,
                   int cap,
                   int join,
                   float miterlimit)

指定された属性を持つ新しい BasicStroke を実線で構築します。

パラメータ:

width - BasicStroke の幅

cap - BasicStroke の両端の装飾

join - 輪郭線セグメントの接合部に適用する装飾

miterlimit - マイタージョインを切り取るリミット

例外:

IllegalArgumentException - width が負の値の場合

IllegalArgumentException - cap が CAP_BUTT, CAP_ROUND と CAP_SQUARE のどちらでもない場合

IllegalArgumentException - miterlimit が 1 より小さく、join が JOIN_MITER の場合

IllegalArgumentException - join が JOIN_ROUND、JOIN_BEVEL、JOIN_MITER のいずれでもない場合

BasicStroke

public BasicStroke(float width,
                   int cap,
                   int join)

指定された属性を持つ新しい BasicStroke を実線で構築します。既定値でかまわない場合や、ラインジョインが JOIN_MITER に指定されていない場合は、miterlimit パラメータは不要です。

パラメータ:

width - BasicStroke の幅

cap - BasicStroke の両端の装飾

join - 輪郭線セグメントの接合部に適用する装飾

例外:

IllegalArgumentException - width が負の値の場合

IllegalArgumentException - cap が CAP_BUTT, CAP_ROUND と CAP_SQUARE のどちらでもない場合

IllegalArgumentException - join が JOIN_ROUND、JOIN_BEVEL、JOIN_MITER のいずれでもない場合

BasicStroke

public BasicStroke(float width)

指定された線幅と、エンドキャップおよびラインジョインのスタイルの既定値を使って、実線で BasicStroke を構築します。

パラメータ:

width - BasicStroke の幅

例外:

IllegalArgumentException - width が負の値の場合

BasicStroke

public BasicStroke()

すべての属性に既定値を使って新しい BasicStroke を構築します。デフォルトの属性は、実線の幅 1.0、CAP_SQUARE、JOIN_MITER、マイターリミット 10.0 です。

メソッドの詳細

createStrokedShape

public Shape createStrokedShape(Shape s)

内部が、指定された Shape をストロークで描画した輪郭を表す Shape を返します。

定義:

インタフェース Stroke 内の createStrokedShape

パラメータ:

s - ストロークで描画される Shape の境界

戻り値:

ストロークで描画された輪郭を表す Shape

getLineWidth

public float getLineWidth()

線幅を返します。線幅はユーザ空間で表されます。

戻り値:

この BasicStroke の線幅

getEndCap

public int getEndCap()

エンドキャップのスタイルを返します。

戻り値:

この BasicStroke のエンドキャップのスタイル。エンドキャップのスタイルを定義する static int 値として返される

getLineJoin

public int getLineJoin()

ラインジョインのスタイルを返します。

戻り値:

BasicStroke のラインジョインのスタイル。ラインジョインのスタイルを定義する static int 値として返される

getMiterLimit

public float getMiterLimit()

マイタージョインのリミットを返します。

戻り値:

BasicStroke のマイタージョインのリミット

getDashArray

public float[] getDashArray()

破線セグメントの長さを表す配列を返します。配列内のエントリが、破線の不透明セグメントと透明セグメントのユーザ空間での長さを交互に表します。ストロークで描画される Shape の輪郭に沿ってペンが移動するにつれて、ペンが移動するユーザ空間の距離が累積されます。距離の値は、破線配列のインデックスに使用されます。現在の累積距離が破線配列の偶数の要素にマッピングされる場合、ペンは不透明になり、そうでない場合は透明になります。

戻り値:

破線配列

getDashPhase

public float getDashPhase()

現在の破線フェーズを返します。破線フェーズは、破線パターン内でのオフセットを表すユーザ空間で指定された距離です。つまり、破線フェーズは、ストロークの先頭に対応する破線パターン内の点を定義します。

戻り値:

float 値の破線フェーズ

hashCode

public int hashCode()

このストロークのハッシュコードを返します。

オーバーライド:

クラス Object 内の hashCode

戻り値:

このストロークのハッシュコード

equals

public boolean equals(Object obj)

指定されたオブジェクトがこの BasicStroke と等しいかどうかを判定します。そのために、最初にオブジェクトが BasicStroke であるかを判定し、次に それぞれの BasicStroke オブジェクトの幅、接合、端、マイターリミット、破線、および破線フェーズを比較します。

オーバーライド:

クラス Object 内の equals

パラメータ:

obj - この BasicStroke と比較するオブジェクト

戻り値:

2 つのオブジェクトの幅、接合、端、マイターリミット、破線、および破線フェーズが同じ場合は true、そうでない場合は false