%!
%%Title: j2dapi.html
%%DocumentFonts: NewCenturySchlbk-Roman NewCenturySchlbk-Bold NewCenturySchlbk-Italic NewCenturySchlbk-BoldItalic Courier Courier-Bold Courier-Oblique Courier-BoldOblique
%%Creator: html2ps 0.2 alpha, written by Jan Karrman, jan@tdb.uu.se
%%EndComments
save
1000 dict begin
/D {def} def
/t {true} D
/f {false} D
/RF {/NewCenturySchlbk-Roman} D
/BF {/NewCenturySchlbk-Bold} D
/IF {/NewCenturySchlbk-Italic} D
/IB {/NewCenturySchlbk-BoldItalic} D
/FF {/Courier} D
/FB {/Courier-Bold} D
/FI {/Courier-Oblique} D
/FT {/Courier-BoldOblique} D
/F 1 D
/W {453 F div} D
/LE {651 F div} D
/PS 1 D
/HS [19 17 15 13 12 11] D
/HT [2 2 2 2 2 2] D
/MK 7 D
/NO f D
/ZL f D
/ZR f D
/Zl () D
/Zr () D
/TU f D
/AU t D
/SN 0 D
/LA {TU PM 1 eq and {W 56 F div add 0 translate}
{70 756 translate F dup scale} ie} D
/FP 0 D
/SG [0.80000000000000004441 1 1] D
statusdict /setduplexmode known
{statusdict begin false setduplexmode end} if
%-- End of variable part --
/ie {ifelse} D
/E {exch} D
/M {moveto} D
/S {show} D
/R {rmoveto} D
/L {lineto} D
/RL {rlineto} D
/CP {currentpoint} D
/SW {stringwidth} D
/GI {getinterval} D
/PI {putinterval} D
/U {gsave CP currentfont /FontInfo get /UnderlinePosition get
0 E currentfont /FontMatrix get dtransform E pop add newpath M
dup SW RL stroke grestore} D
/B {-10 3 R gsave CP newpath 2.5 0 360 arc closepath
UI 2 mod 0 eq {stroke} {fill} ie grestore 10 -3 R} D
/NP {/PM PN SN sub 2 mod D PN SN gt TU not PM 0 eq or and {showpage} if
0.6 setlinewidth LA /BP t D /PN PN 1 add D
/OF currentfont D RF findfont 10 scalefont setfont
/YO {LE neg 60 F div dup 40 gt {pop 40} if sub} D
NO {W 2 div YO M PN ST cvs S} if
ZL {0 YO M Zl S} if
ZR {W YO M Zr dup stringwidth pop neg 0 R S} if
OF setfont
XO SZ SL get neg M /CI 0 D} D
/SF {/CS E D CS SZ SL 3 2 roll put /YI CS -1.2 mul D dup ST cvs C1 E join
( NF ) join /C1 E D NF /BW ( ) SW pop D} D
/NF {FL E get findfont CS scalefont setfont} D
/FS {CF MK PF {1 or} if and or /CF E D FR SL CF put CF E SF} D
/FL [RF FF BF FB IF FI IB FT] D
/reencodeISO {
dup dup findfont dup length dict begin
{ 1 index /FID ne { def }{ pop pop } ie } forall
/Encoding ISOLatin1Encoding D
currentdict end definefont
} D
/ISOLatin1Encoding [
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/space/exclam/quotedbl/numbersign/dollar/percent/ampersand/quoteright
/parenleft/parenright/asterisk/plus/comma/minus/period/slash
/zero/one/two/three/four/five/six/seven/eight/nine/colon/semicolon
/less/equal/greater/question/at/A/B/C/D/E/F/G/H/I/J/K/L/M/N
/O/P/Q/R/S/T/U/V/W/X/Y/Z/bracketleft/backslash/bracketright
/asciicircum/underscore/quoteleft/a/b/c/d/e/f/g/h/i/j/k/l/m
/n/o/p/q/r/s/t/u/v/w/x/y/z/braceleft/bar/braceright/asciitilde
/.notdef/backslash/parenleft/parenright/.notdef/.notdef/.notdef/.notdef
/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef/.notdef
/.notdef/dotlessi/grave/acute/circumflex/tilde/macron/breve
/dotaccent/dieresis/.notdef/ring/cedilla/.notdef/hungarumlaut
/ogonek/caron/space/exclamdown/cent/sterling/currency/yen/brokenbar
/section/dieresis/copyright/ordfeminine/guillemotleft/logicalnot
/hyphen/registered/macron/degree/plusminus/twosuperior/threesuperior
/acute/mu/paragraph/periodcentered/cedilla/onesuperior/ordmasculine
/guillemotright/onequarter/onehalf/threequarters/questiondown
/Agrave/Aacute/Acircumflex/Atilde/Adieresis/Aring/AE/Ccedilla
/Egrave/Eacute/Ecircumflex/Edieresis/Igrave/Iacute/Icircumflex
/Idieresis/Eth/Ntilde/Ograve/Oacute/Ocircumflex/Otilde/Odieresis
/multiply/Oslash/Ugrave/Uacute/Ucircumflex/Udieresis/Yacute
/Thorn/germandbls/agrave/aacute/acircumflex/atilde/adieresis
/aring/ae/ccedilla/egrave/eacute/ecircumflex/edieresis/igrave
/iacute/icircumflex/idieresis/eth/ntilde/ograve/oacute/ocircumflex
/otilde/odieresis/divide/oslash/ugrave/uacute/ucircumflex/udieresis
/yacute/thorn/ydieresis
] D
FL {reencodeISO D} forall
/BS {/PC E D /TX E D /fin f D /CW 0 D /LK 0 D /SC 0 D
/RT TX D {RT ( ) search {/NW E D pop /RT E D /WH NW SW pop D CW WH add LL gt
{TX SC LK SC sub GI PC /SC LK D /CW WH BW add D}
{/CW CW WH add BW add D} ie
/LK LK NW length add 1 add D} {pop exit} ie} loop
/fin t D /LC TX length D /WH RT SW pop D CW WH add LL gt
{TX SC LK SC sub GI PC NL RT dup () ne {PC} {pop} ie}
{TX SC LC SC sub GI PC} ie} D
/BT {RS dup dup () ne E ( ) ne and
{/LS LL D /LL W L1 sub XO sub D {/CI 0 D SH /BP f D fin not {NL} if
/HM t D /LL LS D} BS} {BG {pop} {SH /BP f D} ie} ie} D
/BL {HM not {CP E pop XO E M} if} D
/NL {BL W XO sub L1 sub TB {BW add} if AT mul 2 div YA neg dup 0 lt {3 sub} if
R F0 CF ne {F0 NF} if C1 cvx exec /C1 () D /L1 0 D /F0 CF D
BP not {0 YB NN neg R} if /YA 0 D /YB 0 D CP /YC E D pop XO YC M YC LE neg gt
{YI CI sub dup 0 lt BP not and {dup 0 E R CI add /CI E D} {pop} ie}
{NP} ie /T t D} D
/RS {/TM E D /CN 0 D TM
{dup 9 eq E 10 eq or {TM CN ( ) PI} if
/CN CN 1 add D} forall /CN 0 D /BK HM EN and {0} {1} ie D TM
{dup 32 ne {TM CN 3 2 roll put /CN CN 1 add D /BK 0 D}
{pop BK 0 eq {TM CN 32 put /CN CN 1 add D} if /BK 1 D} ie}
forall TM 0 CN GI dup dup () ne E ( ) ne and
{dup CN 1 sub get 32 eq {/EN f D} {/EN t D} ie} if} D
/join {2 copy length E length add string dup 4 2 roll 2 index 0 3 index
PI E length E PI} bind D
/EG {dup 0 E dup () eq {E pop} {E get} ifelse 10 ne {(\n) E join} if} D
/WR {PB {EG /PB f D} if PP {EG /PP f D} if (\n) search
{dup () ne BP not or {TR /CI 0 D /NC 0 D NL pop WR}{pop pop WR} ie} {TR} ie} D
/TR {(\t) search {dup length /NC E NC add D SH MS 0 8 NC 8 mod sub dup
/NC E NC add D GI SH pop TR} {dup length /NC E NC add D SH} ie
/BP f D} D
/SH {CP E pop LE neg lt {NP} if dup SW pop L1 add /L1 E D
C1 (\() join T not {( ) join} if E join (\)) join
AU AF and UF or {( U ) join} if ( S ) join /C1 E D /T t D /TB EN not D} D
/BG {CP pop XO sub abs 0.01 lt} D
/ON {AR AI NN get 1 add dup AR AI 3 -1 roll put ST cvs length dup ST E (. ) PI
ST 0 3 -1 roll 2 add GI dup SW pop neg 0 R S} D
/SP {YI E /YI E D NL /YI E D} D
/BR {BN} D
/BN {PF {WR} {BT NL} ie /HM f D} D
/AB {CH E 0 E put CH join WB} D
/NN {dup 0 lt {pop 0} if} D
/H {1 sub /HL E D E BN /AT E D CP E pop LE neg WW add lt {NP} if
BH SP /SL SL 1 add D HS HL get HT HL get FS} D
/EH {BN /AT 0 D AH SP /SL SL 1 sub NN D /CF 0 D SZ SL get FR SL get FS} D
/P {E PF {WR /PP t D} {BN AE not {AH SP} if} ie /AT E D} D
/HR {BN 0 CP E pop M gsave PF {0 YI R} if W 0 RL stroke grestore /CI 0 D
/BP f D NL} D
/AD {BN /AE t D AH SP 4 11 SF} D
/DA {BN /AE f D AH SP 0 11 SF} D
/PR {BN /AT 0 D /CF 0 D 9 PS mul 1 FS /PF t D /PB t D /NC 0 D} D
/PW {pop PR} D
/RP {PF {dup () ne {dup dup length 1 sub get 10 ne {(\n) join} if} if
WR AH SP /CF 0 D 11 0 FS /PF f D} {BT} ie} D
/SI {/XO AI LG add NN IN mul BC NN BI mul add D /LL W XO sub D} D
/DT {BN /LG LG 1 sub D SI /LG LG 1 add D BL} D
/DD {BN SI BL} D
/DL {BN XO 0 eq {AH SP} if /LG LG 1 add D BL} D
/LD {BN LG 0 gt {/LG LG 1 sub D} if SI XO 0 eq {AH SP} if BL} D
/UL {BN XO 0 eq {AH SP} {NL} ie NR AI NN 0 put /UI UI 1 add D
/AI AI 1 add D SI BL} D
/LU {BN /UI UI 1 sub D /AI AI 1 sub D SI XO 0 eq {AH SP} {NL} ie BL} D
/OL {BN XO 0 eq {AH SP} {NL} ie NR AI NN 1 put /AI AI 1 add D SI BL} D
/LO {BN AR AI NN 0 put /AI AI 1 sub D SI XO 0 eq {AH SP} {NL} ie BL} D
/LI {BN /BP f D /CI 0 D CP E pop LE neg lt {NP} if
/C1 C1 NR AI 1 sub NN get 1 eq {( ON )} {( B )} ie join D BL} D
/BQ {BN AH SP /BC BC 1 add D SI BL} D
/QB {BN AH SP /BC BC 1 sub D SI BL} D
/WB {PF {WR} {BT} ie} D
/A {WB /AF t D} D
/EA {WB /AF f D} D
/SS {SZ SL get /SL SL 1 add D} D
/I {WB SS 4 FS} D
/BD {WB SS 2 FS} D
/TT {WB SS 1 FS} D
/KB {WB SS /CF 0 D 3 FS} D
/CT {WB SS /CF 0 D 4 FS} D
/SM {WB SS /CF 0 D 1 FS} D
/ES {WB /SL SL 1 sub NN D /CF 0 D SZ SL get FR SL get FS} D
/UN {WB /UF t D} D
/NU {WB /UF f D} D
/SB {0 1 NI {/N E D /K WS N get D /NY AY N get FC N get mul D /BV NY array D
0 1 NY 1 sub {/TM K string D currentfile TM readhexstring pop pop BV E TM put}
for BM N BV put} for} D
/colorimage where {pop} {
/colorimage {
pop pop /Bp E D /Gp E D /Rp E D
{/Re Rp D /Gr Gp D /Bl Bp D
0 1 Re length 1 sub {
/i E D Gr i Re i get 0.299 mul Gr i get 0.587 mul add Bl i get 0.114 mul add
cvi put
} for Gr} image
} D
} ie
/IP {BV N get /N N 1 add D} D
/II {/K E D /TY E D /XW AX K get D /YW AY K get D /IS SG IT K get get D
/XS XW IS mul D /YS YW IS mul D YS CS sub TY 2 eq {/MB E D /MA 0 D}
{TY 2 mod 1 eq {2 div /MA E 2 sub D /MB MA 4 add D}{/MA E D /MB 0 D} ie} ie} D
/IM {II /ty TY D /xs XS D /ys YS D /ya YA D /yb YB D /ma MA D /mb MB D /k K D
/CI 0 D WB L1 xs add dup /L1 E D XO add W gt
{NL /YA ma D /YB mb D /YS ys D /L1 xs D}
{ma YA gt {/YA ma D} if mb YB gt {/YB mb D} if} ie CP E pop YS sub LE neg lt
{NP /YA ma D /YB mb D /L1 xs D} if /BP f D ty ST cvs ( ) join k ST cvs join
C1 E join ( DI ) join FP 2 eq FP 1 eq AF and or {( FM ) join} if /C1 E D
/HM t D /EN f D /T TY 3 eq D} D
/DI {II /YN YW neg D /HM t D /CI 0 D /K2 IX K get D gsave CP MB sub translate
K2 0 ge {/DP AZ K2 get D /BV BM K2 get D XS YS scale /N 0 D XW YW DP
[XW 0 0 YN 0 YW] {IP} FC K2 get 1 eq {image} {{IP} {IP} t 3 colorimage} ie}
{PV K2 neg 1 sub get exec} ie grestore XS 0 R} D
/FM {gsave CP MB sub translate XS neg 0 M 0 YS RL XS 0 RL 0 YS neg RL XS neg
0 RL stroke grestore} D
/BH -35 D
/AH -28 D
/LL W D
/XO 0 D
/YI 0 D
/CI 0 D
/LG 0 D
/AI 0 D
/UI 0 D
/IN 30 D
/BI 12 D
/WW 50 D
/AR [0 0 0 0 0 0 0 0 0 0] D
/NR [0 0 0 0 0 0 0 0 0 0] D
/FR [0 0 0 0 0 0 0 0 0 0] D
/SZ [0 0 0 0 0 0 0 0 0 0] D
/SL 0 D
/CF 0 D
/BC 0 D
/YA 0 D
/YB 0 D
/F0 0 D
/N 0 D
/AT 0 D
/C1 () D
/C2 () D
/L1 0 D
/L2 0 D
/PN SN D
/MS ( ) D
/CH 1 string D
/ST 6 string D
/HM f D
/PF f D
/EN f D
/TB f D
/UF f D
/PP f D
/AE f D
/AF f D
/BP t D
/T t D
0 11 SF
0 LE neg 20 sub M
(
)EA(
)PR()A(All Packages)EA( )A(Class Hierarchy)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Package java.awt
)EH(
)0 2 H(
Interface Index )WB(
)EH(
)UL(
)LI( )A(Composite)EA(
)LI( )A(CompositeContext)EA(
)LI( )A(Paint)EA(
)LI( )A(PaintContext)EA(
)LI( )A(Shape)EA(
)LI( )A(Stroke)EA(
)LI( )A(Transparency)EA(
)LU(
)0 2 H(
Class Index )WB(
)EH(
)UL(
)LI( )A(AlphaComposite)EA(
)LI( )A(BasicStroke)EA(
)LI( )A(Color)EA(
)LI( )A(Font)EA(
)LI( )A(GradientPaint)EA(
)LI( )A(Graphics2D)EA(
)LI( )A(GraphicsConfiguration)EA(
)LI( )A(GraphicsDevice)EA(
)LI( )A(GraphicsEnvironment)EA(
)LI( )A(Rectangle)EA(
)LI( )A(TexturePaint)EA(
)LU(
)WB NL NP(
Package java.awt.color
)EA(
)PR()A(All Packages)EA( )A(Class Hierarchy)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Package java.awt.color
)EH(
)0 2 H(
Class Index )WB(
)EH(
)UL(
)LI( )A(ColorSpace)EA(
)LI( )A(ICC_ColorSpace)EA(
)LI( )A(ICC_Profile)EA(
)LI( )A(ICC_ProfileGray)EA(
)LI( )A(ICC_ProfileRGB)EA(
)LU(
)0 2 H(
Exception Index )WB(
)EH(
)UL(
)LI( )A(NoSuchProfileDataException)EA(
)LU(
)WB NL NP(
Package java.awt.font
)EA(
)PR()A(All Packages)EA( )A(Class Hierarchy)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Package java.awt.font
)EH(
)0 2 H(
Interface Index )WB(
)EH(
)UL(
)LI( )A(MultipleMaster)EA(
)LI( )A(OpenType)EA(
)LU(
)0 2 H(
Class Index )WB(
)EH(
)UL(
)LI( )A(GlyphMetrics)EA(
)LI( )A(GlyphSet)EA(
)LI( )A(StyledString)EA(
)LI( )A(TextAttributeSet)EA(
)LI( )A(TextHitInfo)EA(
)LI( )A(TextLayout)EA(
)LU(
)WB NL NP(
Package java.awt.geom
)EA(
)PR()A(All Packages)EA( )A(Class Hierarchy)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Package java.awt.geom
)EH(
)0 2 H(
Interface Index )WB(
)EH(
)UL(
)LI( )A(PathIterator)EA(
)LU(
)0 2 H(
Class Index )WB(
)EH(
)UL(
)LI( )A(AffineTransform)EA(
)LI( )A(Arc2D)EA(
)LI( )A(Arc2D.Float)EA(
)LI( )A(Area)EA(
)LI( )A(CubicCurve2D)EA(
)LI( )A(CubicCurve2D.Float)EA(
)LI( )A(Dimension2D)EA(
)LI( )A(Ellipse2D)EA(
)LI( )A(Ellipse2D.Float)EA(
)LI( )A(FlatteningPathIterator)EA(
)LI( )A(GeneralPath)EA(
)LI( )A(GeneralPathIterator)EA(
)LI( )A(Line2D)EA(
)LI( )A(Line2D.Float)EA(
)LI( )A(Point2D)EA(
)LI( )A(Point2D.Double)EA(
)LI( )A(Point2D.Float)EA(
)LI( )A(QuadCurve2D)EA(
)LI( )A(QuadCurve2D.Float)EA(
)LI( )A(Rectangle2D)EA(
)LI( )A(Rectangle2D.Double)EA(
)LI( )A(Rectangle2D.Float)EA(
)LI( )A(RectangularShape)EA(
)LI( )A(RoundRectangle2D)EA(
)LI( )A(RoundRectangle2D.Float)EA(
)LU(
)0 2 H(
Exception Index )WB(
)EH(
)UL(
)LI( )A(IncompatibleTransformException)EA(
)LI( )A(NoninvertibleTransformException)EA(
)LU(
)WB NL NP(
Package java.awt.image
)EA(
)PR()A(All Packages)EA( )A(Class Hierarchy)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Package java.awt.image
)EH(
)0 2 H(
Interface Index )WB(
)EH(
)UL(
)LI( )A(BufferedImageOp)EA(
)LI( )A(TileImageConsumer)EA(
)LI( )A(TileOp)EA(
)LU(
)0 2 H(
Class Index )WB(
)EH(
)UL(
)LI( )A(AffineTransformOp)EA(
)LI( )A(BandCombineOp)EA(
)LI( )A(BilinearAffineTransformOp)EA(
)LI( )A(BufferedImage)EA(
)LI( )A(BufferedImageFilter)EA(
)LI( )A(ByteBandedTile)EA(
)LI( )A(ByteComponentTile)EA(
)LI( )A(ByteLookupTable)EA(
)LI( )A(BytePackedTile)EA(
)LI( )A(ColorConvertOp)EA(
)LI( )A(ColorModel)EA(
)LI( )A(ComponentColorModel)EA(
)LI( )A(ConvolveOp)EA(
)LI( )A(DirectColorModel)EA(
)LI( )A(IndexColorModel)EA(
)LI( )A(IntegerComponentTile)EA(
)LI( )A(Kernel)EA(
)LI( )A(LookupOp)EA(
)LI( )A(LookupTable)EA(
)LI( )A(NearestNeighborAffineTransformOp)EA(
)LI( )A(PackedColorModel)EA(
)LI( )A(RescaleOp)EA(
)LI( )A(ShortBandedTile)EA(
)LI( )A(ShortComponentTile)EA(
)LI( )A(ShortLookupTable)EA(
)LI( )A(ThresholdOp)EA(
)LI( )A(Tile)EA(
)LU(
)0 2 H(
Exception Index )WB(
)EH(
)UL(
)LI( )A(TileFormatException)EA(
)LU(
)WB NL NP(
Class Hierarchy
)EA(
)PR()A(All Packages)EA( )A(Index)EA()RP()HR(
)0 1 H(
Class Hierarchy
)EH(
)UL(
)LI( class java.lang.Object
)UL(
)LI( class java.awt.geom.)A(AffineTransform)EA( \201implements java.lang.Cloneable\202
)LI( class java.awt.image.)A(AffineTransformOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)UL(
)LI( class java.awt.image.)A(BilinearAffineTransformOp)EA(
)LI( class java.awt.image.)A(NearestNeighborAffineTransformOp)EA(
)LU(
)LI( class java.awt.)A(AlphaComposite)EA( \201implements java.awt.)A(Composite)EA(\202
)LI( class sun.awt.Albert.Area \201implements java.awt.)A(Shape)EA(\202
)UL(
)LI( class java.awt.geom.)A(Area)EA(
)LU(
)LI( class java.awt.image.)A(BandCombineOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)LI( class java.awt.)A(BasicStroke)EA( \201implements java.awt.)A(Stroke)EA(\202
)LI( interface java.awt.image.)A(BufferedImageOp)EA(
)LI( class java.awt.)A(Color)EA( \201implements java.awt.)A(Paint)EA(, java.io.Serializable\202
)LI( class java.awt.image.)A(ColorConvertOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)LI( class java.awt.image.)A(ColorModel)EA( \201implements java.awt.)A(Transparency)EA(\202
)UL(
)LI( class java.awt.image.)A(ComponentColorModel)EA(
)LI( class java.awt.image.)A(IndexColorModel)EA(
)LI( class java.awt.image.)A(PackedColorModel)EA(
)UL(
)LI( class java.awt.image.)A(DirectColorModel)EA(
)LU(
)LU(
)LI( class java.awt.color.)A(ColorSpace)EA(
)UL(
)LI( class java.awt.color.)A(ICC_ColorSpace)EA(
)LU(
)LI( interface java.awt.)A(Composite)EA(
)LI( interface java.awt.)A(CompositeContext)EA(
)LI( class java.awt.image.)A(ConvolveOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)LI( class java.awt.geom.)A(CubicCurve2D)EA( \201implements java.awt.)A(Shape)EA(\202
)UL(
)LI( class java.awt.geom.)A(CubicCurve2D.Float)EA(
)LU(
)LI( class java.awt.geom.)A(Dimension2D)EA(
)LI( class java.awt.geom.)A(FlatteningPathIterator)EA( \201implements java.awt.geom.)A(PathIterator)EA(\202
)LI( class java.awt.)A(Font)EA( \201implements java.io.Serializable\202
)LI( class java.awt.geom.)A(GeneralPath)EA( \201implements java.awt.)A(Shape)EA(\202
)LI( class java.awt.geom.)A(GeneralPathIterator)EA( \201implements java.awt.geom.)A(PathIterator)EA(\202
)LI( class java.awt.font.)A(GlyphMetrics)EA(
)LI( class java.awt.font.)A(GlyphSet)EA(
)LI( class java.awt.)A(GradientPaint)EA( \201implements java.awt.)A(Paint)EA(\202
)LI( class java.awt.Graphics
)UL(
)LI( class java.awt.)A(Graphics2D)EA(
)LU(
)LI( class java.awt.)A(GraphicsConfiguration)EA(
)LI( class java.awt.)A(GraphicsDevice)EA(
)LI( class java.awt.)A(GraphicsEnvironment)EA(
)LI( class java.awt.color.)A(ICC_Profile)EA(
)UL(
)LI( class java.awt.color.)A(ICC_ProfileGray)EA(
)LI( class java.awt.color.)A(ICC_ProfileRGB)EA(
)LU(
)LI( class java.awt.Image
)UL(
)LI( class java.awt.image.)A(BufferedImage)EA(
)LU(
)LI( class java.awt.image.ImageFilter \201implements java.awt.image.ImageConsumer, java.lang.Cloneable\202
)UL(
)LI( class java.awt.image.)A(BufferedImageFilter)EA( \201implements java.awt.image.)A(TileImageConsumer)EA(, java.lang.Cloneable\202
)LU(
)LI( class java.awt.image.)A(Kernel)EA(
)LI( class java.awt.geom.)A(Line2D)EA( \201implements java.awt.)A(Shape)EA(\202
)UL(
)LI( class java.awt.geom.)A(Line2D.Float)EA(
)LU(
)LI( class java.awt.image.)A(LookupOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)LI( class java.awt.image.)A(LookupTable)EA(
)UL(
)LI( class java.awt.image.)A(ByteLookupTable)EA(
)LI( class java.awt.image.)A(ShortLookupTable)EA(
)LU(
)LI( interface java.awt.font.)A(MultipleMaster)EA(
)LI( interface java.awt.font.)A(OpenType)EA(
)LI( interface java.awt.)A(Paint)EA( \201extends java.awt.)A(Transparency)EA(\202
)LI( interface java.awt.)A(PaintContext)EA(
)LI( interface java.awt.geom.)A(PathIterator)EA(
)LI( class java.awt.geom.)A(Point2D)EA(
)UL(
)LI( class java.awt.geom.)A(Point2D.Double)EA(
)LI( class java.awt.geom.)A(Point2D.Float)EA(
)LU(
)LI( class java.awt.geom.)A(QuadCurve2D)EA( \201implements java.awt.)A(Shape)EA(\202
)UL(
)LI( class java.awt.geom.)A(QuadCurve2D.Float)EA(
)LU(
)LI( class java.awt.geom.)A(RectangularShape)EA( \201implements java.awt.)A(Shape)EA(\202
)UL(
)LI( class java.awt.geom.)A(Arc2D)EA(
)UL(
)LI( class java.awt.geom.)A(Arc2D.Float)EA(
)LU(
)LI( class java.awt.geom.)A(Ellipse2D)EA(
)UL(
)LI( class java.awt.geom.)A(Ellipse2D.Float)EA(
)LU(
)LI( class java.awt.geom.)A(Rectangle2D)EA(
)UL(
)LI( class java.awt.)A(Rectangle)EA( \201implements java.awt.)A(Shape)EA(, java.io.Serializable\202
)LI( class java.awt.geom.)A(Rectangle2D.Double)EA(
)LI( class java.awt.geom.)A(Rectangle2D.Float)EA(
)LU(
)LI( class java.awt.geom.)A(RoundRectangle2D)EA(
)UL(
)LI( class java.awt.geom.)A(RoundRectangle2D.Float)EA(
)LU(
)LU(
)LI( class java.awt.image.)A(RescaleOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)LI( interface java.awt.)A(Shape)EA(
)LI( interface java.awt.)A(Stroke)EA(
)LI( class java.awt.font.)A(StyledString)EA(
)LI( class java.awt.font.)A(TextAttributeSet)EA( \201implements java.text.MutableAttributeSet\202
)LI( class java.awt.font.)A(TextHitInfo)EA(
)LI( class java.awt.font.)A(TextLayout)EA( \201implements java.lang.Cloneable\202
)LI( class java.awt.)A(TexturePaint)EA( \201implements java.awt.)A(Paint)EA(\202
)LI( class java.awt.image.)A(ThresholdOp)EA( \201implements java.awt.image.)A(BufferedImageOp)EA(, java.awt.image.)A(TileOp)EA(\202
)LI( class java.lang.Throwable \201implements java.io.Serializable\202
)UL(
)LI( class java.lang.Exception
)UL(
)LI( class java.awt.geom.)A(NoninvertibleTransformException)EA(
)LI( class java.lang.RuntimeException
)UL(
)LI( class java.awt.geom.)A(IncompatibleTransformException)EA(
)LI( class java.awt.color.)A(NoSuchProfileDataException)EA(
)LI( class java.awt.image.)A(TileFormatException)EA(
)LU(
)LU(
)LU(
)LI( class java.awt.image.)A(Tile)EA(
)UL(
)LI( class java.awt.image.)A(ByteBandedTile)EA(
)LI( class java.awt.image.)A(ByteComponentTile)EA(
)LI( class java.awt.image.)A(BytePackedTile)EA(
)LI( class java.awt.image.)A(IntegerComponentTile)EA(
)LI( class java.awt.image.)A(ShortBandedTile)EA(
)LI( class java.awt.image.)A(ShortComponentTile)EA(
)LU(
)LI( interface java.awt.image.)A(TileImageConsumer)EA( \201extends java.awt.image.ImageConsumer\202
)LI( interface java.awt.image.)A(TileOp)EA(
)LI( interface java.awt.)A(Transparency)EA(
)LU(
)LU(
)WB NL NP(
Interface java.awt.Composite
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.Composite
)EH(
)DL(
)DT( public interface )BD(Composite)ES(
)LD(
This interface, together with CompositeContext, defines the methods
to compose a draw primitive with the
underlying graphics area.
The Composite is set in the Graphics2D and thereafter,
whenever a shape, text, or an image is drawn, the Composite will
combine the source with the colors that have already been drawn,
according to pre-defined rules. The classes implementing this
interface will provide the rules and a method to create the context for
a particular operation.
CompositeContext is an environment used by the compositing
operation that a Graphics2D object must create prior to the start of the
operation.
CompositeContext contains various private information and resources
needed for a compositing operation. When the CompositeContext
is no longer needed it will be disposed by the Graphics2D object to reclaim
resources allocated for the operation.
)0 P(
Instances of classes implementing Composite must be immutable
\201i.e. read-only\202 because the Graphics2D does not clone
these objects when they are set as an attribute with the setComposite
method or when the Graphics2D object is itself cloned.
This is to avoid undefined behavior of Graphics2D rendering
which would result if the Composite object were modified after
being set in the Graphics2D state.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(AlphaComposite)EA(, )A(CompositeContext)EA(, )A(setComposite)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createContext)ES()EA(\201ColorModel, ColorModel\202
)DD( Create a context for the compositing operation.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(createContext)ES()EA(
)PR(
public abstract )A(CompositeContext)EA( createContext\201)A(ColorModel)EA( srcColorModel,
)A(ColorModel)EA( dstColorModel\202
)RP(
)DL(
)DD( Create a context for the compositing operation.
The context contains state that is used to perform
the compositing operation. In a multi-threaded environment
several contexts may exist simultaneously for a single
Composite object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( srcColorModel - The ColorModel of the source.
)DD( dstColorModel - The ColorModel of the destination.
)DT( )BD(Returns:)ES(
)DD( The CompositeContext object to perform the
compositing operation.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.CompositeContext
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.CompositeContext
)EH(
)DL(
)DT( public interface )BD(CompositeContext)ES(
)LD(
This interface defines the encapsulated and optimized environment for
a compositing operation. CompositeContext objects maintain state for
compositing operations. In a multi-threaded environment, several
contexts may exist simultaneously for a single Composite object.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(Composite)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(compose)ES()EA(\201Tile, Tile, Tile\202
)DD( This method composes the two source tiles
and places the result in the destination tile.
)DT( o )WB(
)A()BD(dispose)ES()EA(\201\202
)DD( Release resources allocated for context.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(dispose)ES()EA(
)PR(
public abstract void dispose\201\202
)RP(
)DL(
)DD( Release resources allocated for context.
)0 P(
)LD(
o )WB()EA(
)BD(compose)ES()EA(
)PR(
public abstract void compose\201)A(Tile)EA( src1,
)A(Tile)EA( src2,
)A(Tile)EA( dst\202
)RP(
)DL(
)DD( This method composes the two source tiles
and places the result in the destination tile. Note that
the destination can be the same object as either
the first or second source.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src1 - The first source tile for the compositing operation.
)DD( src2 - The second source tile for the compositing operation.
)DD( dst - The tile where the result of the operation is stored.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.Paint
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.Paint
)EH(
)DL(
)DT( public interface )BD(Paint)ES(
)DT( extends )A(Transparency)EA(
)LD(
This interface defines how color patterns
can be generated for Graphics2D operations.
Paint is set in the Graphics2D and
thereafter the stroke and fill methods will use the color
pattern generated by the implementing Paint class.
)0 P(
Instances of classes implementing Paint must be immutable
\201i.e. read-only\202 because the Graphics2D does not clone
these objects when they are set as an attribute with the setPaint
method or when the Graphics2D object is itself cloned.
This is to avoid undefined behavior of Graphics2D rendering
which would result if the Paint object were modified after
being set in the Graphics2D state.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(PaintContext)EA(, )A(Color)EA(, )A(GradientPaint)EA(, )A(TexturePaint)EA(, )A(setPaint)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createContext)ES()EA(\201ColorModel, Rectangle, Rectangle2D, AffineTransform\202
)DD( Create and return a context used to generate the color pattern.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(createContext)ES()EA(
)PR(
public abstract )A(PaintContext)EA( createContext\201)A(ColorModel)EA( cm,
)A(Rectangle)EA( deviceBounds,
)A(Rectangle2D)EA( userBounds,
)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Create and return a context used to generate the color pattern.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( cm - ColorModel in which the caller wishes to receive the
paint data. This is used only as a hint.
)DD( deviceBounds - The Rectangle describing the bounding box
in device space of the graphics primitive being rendered.
)DD( userBounds - The Rectangle2D describing the bounding box in
user space of the graphics primitive being rendered.
)DD( xform - The Transform from user space into device space.
)DT( )BD(Returns:)ES(
)DD( The PaintContext for generating color patterns.
)DT( )BD(See Also:)ES(
)DD( )A(PaintContext)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.PaintContext
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.PaintContext
)EH(
)DL(
)DT( public interface )BD(PaintContext)ES(
)LD(
This interface defines the encapsulated and optimized environment for
a paint operation, i.e. generating color patterns in device space for
a fill or stroke operation on a Graphics2D. The PaintContext provides the
necessary colors for Graphics2D operations in the form of a Tile
associated with a ColorModel. The PaintContext maintains state for
a particular paint operation. In a multi-threaded environment, several
contexts may exist simultaneously for a single Paint object.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(Paint)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(dispose)ES()EA(\201\202
)DD( Release the resources allocated for the operation.
)DT( o )WB(
)A()BD(getColorModel)ES()EA(\201\202
)DD( Return the ColorModel of the output.
)DT( o )WB(
)A()BD(getTile)ES()EA(\201int, int, int, int\202
)DD( Return a Tile containing the colors generated for the graphics
operation.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(dispose)ES()EA(
)PR(
public abstract void dispose\201\202
)RP(
)DL(
)DD( Release the resources allocated for the operation.
)0 P(
)LD(
o )WB()EA(
)BD(getColorModel)ES()EA(
)PR(
public abstract )A(ColorModel)EA( getColorModel\201\202
)RP(
)DL(
)DD( Return the ColorModel of the output.
)0 P(
)LD(
o )WB()EA(
)BD(getTile)ES()EA(
)PR(
public abstract )A(Tile)EA( getTile\201int x,
int y,
int w,
int h\202
)RP(
)DL(
)DD( Return a Tile containing the colors generated for the graphics
operation.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x,y,w,h - The area in device space for which colors are
generated.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.Shape
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.Shape
)EH(
)DL(
)DT( public interface )BD(Shape)ES(
)LD(
The interface for objects which represent some form of geometric
shape.
)0 P(
This interface will be revised in the upcoming Java2D project.
It is meant to provide a common interface for various existing
geometric AWT classes and methods which operate on them. Since
it may be superseded or expanded in the future, developers should
avoid implementing this interface in their own classes until it
is completed in a later release.
)0 P(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to the geometry of the outline
of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to a flattened view of the
geometry of the outline of the shape.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public abstract )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public abstract )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public abstract boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public abstract boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public abstract boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public abstract boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public abstract boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public abstract boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public abstract )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to the geometry of the outline
of the shape.
An optional affine transform can be specified in which case
the coordinates returned in the iteration will be transformed
accordingly.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( at - an optional AffineTransform to be applied to the
coordinates as they are returned in the iteration, or null
if the untransformed coordinates are desired.
)LD(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public abstract )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to a flattened view of the
geometry of the outline of the shape.
Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types will
be returned by the iterator.
The amount of subdivision of the curved segments is controlled
by the )SM(flatness)ES( parameter which specifies ?REMIND?.
An optional affine transform can be specified in which case
the coordinates returned in the iteration will be transformed
accordingly.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( at - an optional AffineTransform to be applied to the
coordinates as they are returned in the iteration, or null
if the untransformed coordinates are desired.
)DD( flatness - the maximum amount that the control points
for a given curve can vary from colinear before a subdivided
curve is replaced by a straight line connecting the endpoints.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.Stroke
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.Stroke
)EH(
)DL(
)DT( public interface )BD(Stroke)ES(
)LD(
This interface allows a Graphics2D object to get a Path representation
of the boundaries of a stroking primitive from the path to be stroked.
The effect of stroking a path can be compared to drawing a logical
pen of an appropriate size and shape along the trajectory of the path.
The area where the pen would place ink is the area enclosed by the
stroked path.
)0 P(
The stroking primitives of the Graphics2D interface include the
drawPath method and any other methods that are implemented in terms
of that method such as drawLine, drawRect, drawRoundRect, drawOval,
drawArc, drawPolyline, and drawPolygon.
)0 P(
The objects of the classes implementing Stroke must be immutable
\201i.e. read-only\202 because the Graphics2D will not clone these objects
either when they are set as an attribute with the setStroke method
or when the Graphics2D object is itself cloned.
If a Stroke object were modified after it was set in the state of
the Graphics2D then the behavior of subsequent rendering would be
undefined.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(BasicStroke)EA(, )A(setStroke)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createStrokedShape)ES()EA(\201Shape\202
)DD( Returns a path which encloses the area that should be painted
when the path is stroked according to the rules defined by the
object implementing the Stroke interface.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(createStrokedShape)ES()EA(
)PR(
public abstract )A(Shape)EA( createStrokedShape\201)A(Shape)EA( p\202
)RP(
)DL(
)DD( Returns a path which encloses the area that should be painted
when the path is stroked according to the rules defined by the
object implementing the Stroke interface.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - The path that should be stroked.
)DT( )BD(Returns:)ES(
)DD( The stroked path.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.Transparency
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.Transparency
)EH(
)DL(
)DT( public interface )BD(Transparency)ES(
)LD(
This interface defines the common transparency modes for implementing
classes.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BITMASK)ES()EA(
)DD( The transparency object represents image data that is
guaranteed to be either completely opaque \201alpha
value of 1.0\202 or completely transparent \201alpha value of
0.0\202.
)DT( o )WB(
)A()BD(OPAQUE)ES()EA(
)DD( The transparency object represents image data that is
guaranteed to be completely opaque \201all pixels have
an alpha value of 1.0\202.
)DT( o )WB(
)A()BD(TRANSLUCENT)ES()EA(
)DD( The transparency object represents image data that
contains or may contain arbitrary alpha values.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getTransparency)ES()EA(\201\202
)DD( Returns the transparency type.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(OPAQUE)ES(
)PR(
public static final int OPAQUE
)RP(
)DL(
)DD( The transparency object represents image data that is
guaranteed to be completely opaque \201all pixels have
an alpha value of 1.0\202.)0 P(
)LD(
o )WB()EA(
)BD(BITMASK)ES(
)PR(
public static final int BITMASK
)RP(
)DL(
)DD( The transparency object represents image data that is
guaranteed to be either completely opaque \201alpha
value of 1.0\202 or completely transparent \201alpha value of
0.0\202.)0 P(
)LD(
o )WB()EA(
)BD(TRANSLUCENT)ES(
)PR(
public static final int TRANSLUCENT
)RP(
)DL(
)DD( The transparency object represents image data that
contains or may contain arbitrary alpha values.)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getTransparency)ES()EA(
)PR(
public abstract int getTransparency\201\202
)RP(
)DL(
)DD( Returns the transparency type.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.AlphaComposite
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.AlphaComposite
)EH(
)PR(
java.lang.Object
|
+----java.awt.AlphaComposite
)RP(
)HR(
)DL(
)DT( public final class )BD(AlphaComposite)ES(
)DT( extends Object
)DT( implements )A(Composite)EA(
)LD(
This class implements the basic alpha compositing rules for combining
source and destination pixels to achieve blending and transparency
effects with graphics and images.
The rules implemented by this class are a subset of the Porter-Duff
rules described in
T. Porter and T. Duff, "Compositing Digital Images", SIGGRAPH 84,
253-259.
)0 P(
If any input does not have an alpha channel,
an alpha value of 1.0 \201completely opaque\202 is assumed for all pixels.
)0 P(
A constant alpha value can also be specified to be
multiplied with the alpha value of the source pixels.
)0 P(
The following abbreviations are used in the description of the rules:
)LI(Cs = one of the Color components of the Source Pixel.
)LI(Cd = one of the Color components of the Destination Pixel.
)LI(As = Alpha component of the Source Pixel.
)LI(Ad = Alpha component of the Destination Pixel.
)LI(Fs = fraction of the Source Pixel which contributes to the output.
)LI(Fd = fraction of the input Destination Pixel which contributes to the output.
)0 P(
The color and alpha components produced by the compositing operation are
calculated as follows:
)PR(
Cd = Cs*Fs + Cd*Fd
Ad = As*Fs + Ad*Fd
)RP(
where Fs and Fd are specified by each rule. The above equations assume
that both source and destination pixels have the color components
premultiplied by the alpha component. Similarly, the equations expressed
in the definitions of compositing rules below assume premultiplied alpha.
)0 P(
For performance reasons, it is
preferable that Tiles passed to the compose method of a CompositeContext
object created by the AlphaComposite class have premultiplied data.
However, if either source or destination Tiles are not premultiplied,
appropriate conversions will be performed before and after the compositing
operation.
)0 P(
The resulting alpha of the compositing operation is stored in
the destination if the destination has an alpha channel.
Otherwise, the resulting color is divided by the resulting
alpha before being stored in the destination and the alpha is discarded
\201if the alpha value is 0.0, the color values are set to 0.0\202.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(Composite)EA(, )A(CompositeContext)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CLEAR)ES()EA(
)DD( Porter-Duff Clear rule.
)DT( o )WB(
)A()BD(DST_IN)ES()EA(
)DD( Porter-Duff Destination In Source rule.
)DT( o )WB(
)A()BD(DST_OUT)ES()EA(
)DD( Porter-Duff Destination Held Out By Source rule.
)DT( o )WB(
)A()BD(DST_OVER)ES()EA(
)DD( Porter-Duff Destination Over Source rule.
)DT( o )WB(
)A()BD(SRC)ES()EA(
)DD( Porter-Duff Source rule.
)DT( o )WB(
)A()BD(SRC_IN)ES()EA(
)DD( Porter-Duff Source In Destination rule.
)DT( o )WB(
)A()BD(SRC_OUT)ES()EA(
)DD( Porter-Duff Source Held Out By Destination rule.
)DT( o )WB(
)A()BD(SRC_OVER)ES()EA(
)DD( Porter-Duff Source Over Destination rule.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createContext)ES()EA(\201ColorModel, ColorModel\202
)DD( Creates a context for the compositing operation.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201\202
)DD( Returns the additional alpha value that was given when this
AlphaComposiste instance was created.
)DT( o )WB(
)A()BD(getInstance)ES()EA(\201int\202
)DD( Creates an AlphaComposite object with the given rule.
)DT( o )WB(
)A()BD(getInstance)ES()EA(\201int, float\202
)DD( Creates an AlphaComposite object with the given rule and
the constant alpha to multiply with the alpha of the source.
)DT( o )WB(
)A()BD(getRule)ES()EA(\201\202
)DD( Returns the compositing rule that was specified when this
AlphaComposiste instance was created.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(CLEAR)ES(
)PR(
public static final int CLEAR
)RP(
)DL(
)DD( Porter-Duff Clear rule.
Both the color and the alpha of destination are cleared.
Neither the source nor the destination is used as input.
)0 P(
Fs = 0 and Fd = 0, thus:
)PR(
Cd = 0
Ad = 0
)RP()0 P(
)LD(
o )WB()EA(
)BD(SRC)ES(
)PR(
public static final int SRC
)RP(
)DL(
)DD( Porter-Duff Source rule.
The source is copied to the destination.
The destination is not used as input.
)0 P(
Fs = 1 and Fd = 0, thus:
)PR(
Cd = Cs
Ad = As
)RP()0 P(
)LD(
o )WB()EA(
)BD(SRC_OVER)ES(
)PR(
public static final int SRC_OVER
)RP(
)DL(
)DD( Porter-Duff Source Over Destination rule.
The source is composited over the destination.
)0 P(
Fs = 1 and Fd = \2011-As\202, thus:
)PR(
Cd = Cs + Cd*\2011-As\202
Ad = As + Ad*\2011-As\202
)RP()0 P(
)LD(
o )WB()EA(
)BD(DST_OVER)ES(
)PR(
public static final int DST_OVER
)RP(
)DL(
)DD( Porter-Duff Destination Over Source rule.
The destination is composited over the source and
the result replaces the destination.
)0 P(
Fs = \2011-Ad\202 and Fd = 1, thus:
)PR(
Cd = Cs*\2011-Ad\202 + Cd
Ad = As*\2011-Ad\202 + Ad
)RP()0 P(
)LD(
o )WB()EA(
)BD(SRC_IN)ES(
)PR(
public static final int SRC_IN
)RP(
)DL(
)DD( Porter-Duff Source In Destination rule.
The part of the source lying inside of the destination replaces
the destination.
)0 P(
Fs = Ad and Fd = 0, thus:
)PR(
Cd = Cs*Ad
Ad = As*Ad
)RP()0 P(
)LD(
o )WB()EA(
)BD(DST_IN)ES(
)PR(
public static final int DST_IN
)RP(
)DL(
)DD( Porter-Duff Destination In Source rule.
The part of the destination lying inside of the source
replaces the destination.
)0 P(
Fs = 0 and Fd = As, thus:
)PR(
Cd = Cd*As
Ad = Ad*As
)RP()0 P(
)LD(
o )WB()EA(
)BD(SRC_OUT)ES(
)PR(
public static final int SRC_OUT
)RP(
)DL(
)DD( Porter-Duff Source Held Out By Destination rule.
The part of the source lying outside of the destination
replaces the destination.
)0 P(
Fs = \2011-Ad\202 and Fd = 0, thus:
)PR(
Cd = Cs*\2011-Ad\202
Ad = As*\2011-Ad\202
)RP()0 P(
)LD(
o )WB()EA(
)BD(DST_OUT)ES(
)PR(
public static final int DST_OUT
)RP(
)DL(
)DD( Porter-Duff Destination Held Out By Source rule.
The part of the destination lying outside of the source
replaces the destination.
)0 P(
Fs = 0 and Fd = \2011-As\202, thus:
)PR(
Cd = Cd*\2011-As\202
Ad = Ad*\2011-As\202
)RP()0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getInstance)ES()EA(
)PR(
public static )A(AlphaComposite)EA( getInstance\201int rule\202
)RP(
)DL(
)DD( Creates an AlphaComposite object with the given rule.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rule - Rule for the composition.
)LD(
)LD(
o )WB()EA(
)BD(getInstance)ES()EA(
)PR(
public static )A(AlphaComposite)EA( getInstance\201int rule,
float alpha\202
)RP(
)DL(
)DD( Creates an AlphaComposite object with the given rule and
the constant alpha to multiply with the alpha of the source.
The source is multiplied with the given alpha before being composited
with the destination.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rule - Rule for the composition.
)DD( alpha - The constant alpha to be multiplied with the alpha of
the source. Alpha must be a floating point number in the range
0.0 - 1.0.
)LD(
)LD(
o )WB()EA(
)BD(createContext)ES()EA(
)PR(
public )A(CompositeContext)EA( createContext\201)A(ColorModel)EA( srcColorModel,
)A(ColorModel)EA( dstColorModel\202
)RP(
)DL(
)DD( Creates a context for the compositing operation.
The context contains state that is used in performing
the compositing operation.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( srcColorModel - The ColorModel of the source.
)DD( dstColorModel - The ColorModel of the destination.
)DT( )BD(Returns:)ES(
)DD( The CompositeContext object to be used to perform
compositing operations.
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public float getAlpha\201\202
)RP(
)DL(
)DD( Returns the additional alpha value that was given when this
AlphaComposiste instance was created. If this instance was
created without the addtional alpha value, the value
1.0 is returned.
)0 P(
)LD(
o )WB()EA(
)BD(getRule)ES()EA(
)PR(
public int getRule\201\202
)RP(
)DL(
)DD( Returns the compositing rule that was specified when this
AlphaComposiste instance was created.
)0 P(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.BasicStroke
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.BasicStroke
)EH(
)PR(
java.lang.Object
|
+----java.awt.BasicStroke
)RP(
)HR(
)DL(
)DT( public class )BD(BasicStroke)ES(
)DT( extends Object
)DT( implements )A(Stroke)EA(
)LD(
Defines a basic set of rendering attributes for stroked graphics
primitives.
These attributes describe the shape of a pen drawn along the
trajectory of the path and the decorations applied where path
segments are joined and where they begin and end.
These attributes include:
)DL(
)DT()I(width)ES(
)DD(The width of the pen measured perpendicular to its trajectory.
)DT()I(end caps)ES(
)DD(The decoration of the path where line segments begin and end.
)DT()I(line joins)ES(
)DD(The decoration of the path between connected line segments.
)DT()I(dash attributes)ES(
)DD(The definition of how to make a dash pattern along the
trajectory of the path by creating new segments which alternate
between opaque and transparent sections.
)LD(
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CAP_BUTT)ES()EA(
)DD( End unclosed subpaths and dash segments with no added
decoration.
)DT( o )WB(
)A()BD(CAP_ROUND)ES()EA(
)DD( End unclosed subpaths and dash segments with a round
decoration with radius equal to half of the line width.
)DT( o )WB(
)A()BD(CAP_SQUARE)ES()EA(
)DD( End unclosed subpaths and dash segments with a square
projection that extends beyond the end of the segment
to a distance equal to half of the line width.
)DT( o )WB(
)A()BD(JOIN_BEVEL)ES()EA(
)DD( Join line segments by connecting the outer corners of their
wide outlines with a straight segment.
)DT( o )WB(
)A()BD(JOIN_MITER)ES()EA(
)DD( Join line segments by extending their outside edges until
they meet.
)DT( o )WB(
)A()BD(JOIN_ROUND)ES()EA(
)DD( Join line segments by rounding off the corner at a radius
of half the line width.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BasicStroke)ES()EA(\201\202
)DD( Construct a new stroke with defaults for all attributes.
)DT( o )WB(
)A()BD(BasicStroke)ES()EA(\201float, int, int\202
)DD( Construct a new stroke with the specified attributes, but
no dashing.
)DT( o )WB(
)A()BD(BasicStroke)ES()EA(\201float, int, int, float\202
)DD( Construct a new stroke with the specified attributes, but
no dashing.
)DT( o )WB(
)A()BD(BasicStroke)ES()EA(\201float, int, int, float, float[], float\202
)DD( Construct a new stroke with the specified attributes.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createStrokedShape)ES()EA(\201Shape\202
)DD( Returns the stroked path of a given path.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(getDashArray)ES()EA(\201\202
)DD( Return the array representing the lengths of the dash segments.
)DT( o )WB(
)A()BD(getDashPhase)ES()EA(\201\202
)DD( Returns the dash phase.
)DT( o )WB(
)A()BD(getEndCap)ES()EA(\201\202
)DD( Returns the end cap style.
)DT( o )WB(
)A()BD(getLineJoin)ES()EA(\201\202
)DD( Returns the line join style.
)DT( o )WB(
)A()BD(getLineWidth)ES()EA(\201\202
)DD( Returns the line width.
)DT( o )WB(
)A()BD(getMiterLimit)ES()EA(\201\202
)DD( Returns the limit of miter joins.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(JOIN_MITER)ES(
)PR(
public static final int JOIN_MITER
)RP(
)DL(
)DD( Join line segments by extending their outside edges until
they meet.)0 P(
)LD(
o )WB()EA(
)BD(JOIN_ROUND)ES(
)PR(
public static final int JOIN_ROUND
)RP(
)DL(
)DD( Join line segments by rounding off the corner at a radius
of half the line width.)0 P(
)LD(
o )WB()EA(
)BD(JOIN_BEVEL)ES(
)PR(
public static final int JOIN_BEVEL
)RP(
)DL(
)DD( Join line segments by connecting the outer corners of their
wide outlines with a straight segment.)0 P(
)LD(
o )WB()EA(
)BD(CAP_BUTT)ES(
)PR(
public static final int CAP_BUTT
)RP(
)DL(
)DD( End unclosed subpaths and dash segments with no added
decoration.)0 P(
)LD(
o )WB()EA(
)BD(CAP_ROUND)ES(
)PR(
public static final int CAP_ROUND
)RP(
)DL(
)DD( End unclosed subpaths and dash segments with a round
decoration with radius equal to half of the line width.)0 P(
)LD(
o )WB()EA(
)BD(CAP_SQUARE)ES(
)PR(
public static final int CAP_SQUARE
)RP(
)DL(
)DD( End unclosed subpaths and dash segments with a square
projection that extends beyond the end of the segment
to a distance equal to half of the line width.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(BasicStroke)ES(
)PR(
public BasicStroke\201float width,
int cap,
int join,
float miterlimit,
float dash[],
float dash_phase\202
)RP(
)DL(
)DD( Construct a new stroke with the specified attributes.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - The width of the stroke.
)DD( cap - The style of the ends of a stroke.
)DD( join - The style to join strokes together.
)DD( miterlimit - The limit to trim the miter join.
)DD( dash - The array representing the dashing pattern.
)DD( dash_phase - The offset to start the dashing pattern.
)LD(
)LD(
o )WB()EA(
)BD(BasicStroke)ES(
)PR(
public BasicStroke\201float width,
int cap,
int join,
float miterlimit\202
)RP(
)DL(
)DD( Construct a new stroke with the specified attributes, but
no dashing.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - The width of the stroke.
)DD( cap - The style of the ends of a stroke.
)DD( join - The style to join strokes together.
)DD( miterlimit - The limit to trim the miter join.
)LD(
)LD(
o )WB()EA(
)BD(BasicStroke)ES(
)PR(
public BasicStroke\201float width,
int cap,
int join\202
)RP(
)DL(
)DD( Construct a new stroke with the specified attributes, but
no dashing. The miter limit parameter is unnecessary in
cases where the default is allowable or the line joins
are not specified as JOIN_MITER.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - The width of the stroke.
)DD( cap - The style of the ends of a stroke.
)DD( join - The style to join strokes together.
)LD(
)LD(
o )WB()EA(
)BD(BasicStroke)ES(
)PR(
public BasicStroke\201\202
)RP(
)DL(
)DD( Construct a new stroke with defaults for all attributes.
The default attributes are a line width of 1.0, CAP_SQUARE,
JOIN_MITER, a miter limit of 10.0, and no dashing.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(createStrokedShape)ES()EA(
)PR(
public )A(Shape)EA( createStrokedShape\201)A(Shape)EA( p\202
)RP(
)DL(
)DD( Returns the stroked path of a given path.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - The path that should be stroked.
)DT( )BD(Returns:)ES(
)DD( The stroked path.
)DT( )BD(See Also:)ES(
)DD( )A(createStrokedShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getLineWidth)ES()EA(
)PR(
public float getLineWidth\201\202
)RP(
)DL(
)DD( Returns the line width. Line width is represented in user space.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( The line width of the stroke.
)LD(
)LD(
o )WB()EA(
)BD(getEndCap)ES()EA(
)PR(
public int getEndCap\201\202
)RP(
)DL(
)DD( Returns the end cap style.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( The end cap style of the stroke.
)LD(
)LD(
o )WB()EA(
)BD(getLineJoin)ES()EA(
)PR(
public int getLineJoin\201\202
)RP(
)DL(
)DD( Returns the line join style.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( The line join style of the stroke.
)LD(
)LD(
o )WB()EA(
)BD(getMiterLimit)ES()EA(
)PR(
public float getMiterLimit\201\202
)RP(
)DL(
)DD( Returns the limit of miter joins.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( The limit of miter joins.
)LD(
)LD(
o )WB()EA(
)BD(getDashArray)ES()EA(
)PR(
public float[] getDashArray\201\202
)RP(
)DL(
)DD( Return the array representing the lengths of the dash segments.
Alternate entries in the array represent the user space lengths
of the opaque and transparent segments of the dashes.
As the pen moves along the path to be stroked, the user space
distance that the pen travels will be accumulated to index
into the dash array.
The pen will be opaque when its current cumulative distance maps
to an odd element of the dash array and transparent otherwise.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( The dash array.
)LD(
)LD(
o )WB()EA(
)BD(getDashPhase)ES()EA(
)PR(
public float getDashPhase\201\202
)RP(
)DL(
)DD( Returns the dash phase.
The dash phase is a user space distance that is used to initialize
the path distance accumulation variable before the first segment
of the first subpath is stroked.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the dash phase.
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.Color
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.Color
)EH(
)PR(
java.lang.Object
|
+----java.awt.Color
)RP(
)HR(
)DL(
)DT( public class )BD(Color)ES(
)DT( extends Object
)DT( implements )A(Paint)EA(, Serializable
)LD(
A class to encapsulate colors in the default sRGB color space
or colors in arbitrary color spaces identified by a ColorSpace.
Every color has an implicit alpha value of 1.0 or an explicit one
provided in the constructor. When constructing a Color with an
explicit alpha or getting the color/alpha components of a
Color, the color components are never premultiplied by the alpha
component.
)0 P(The default color space for the Java 2D API is sRGB, a proposed standard
RGB color space. For further information on sRGB,
see )A(
http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html
)EA(.
)0 P(Eventually this class should supersede java.awt.Color, but for now it
is defined to be part of the java.java2d package, so we can
generate documentation for a single package for review.
)0 P(
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorSpace)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(black)ES()EA(
)DD( The color black.
)DT( o )WB(
)A()BD(blue)ES()EA(
)DD( The color blue.
)DT( o )WB(
)A()BD(cyan)ES()EA(
)DD( The color cyan.
)DT( o )WB(
)A()BD(darkGray)ES()EA(
)DD( The color dark gray.
)DT( o )WB(
)A()BD(gray)ES()EA(
)DD( The color gray.
)DT( o )WB(
)A()BD(green)ES()EA(
)DD( The color green.
)DT( o )WB(
)A()BD(lightGray)ES()EA(
)DD( The color light gray.
)DT( o )WB(
)A()BD(magenta)ES()EA(
)DD( The color magenta.
)DT( o )WB(
)A()BD(orange)ES()EA(
)DD( The color orange.
)DT( o )WB(
)A()BD(pink)ES()EA(
)DD( The color pink.
)DT( o )WB(
)A()BD(red)ES()EA(
)DD( The color red.
)DT( o )WB(
)A()BD(white)ES()EA(
)DD( The color white.
)DT( o )WB(
)A()BD(yellow)ES()EA(
)DD( The color yellow.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Color)ES()EA(\201ColorSpace, float[], float\202
)DD( Creates a color in the color space of the supplied ColorSpace
with the color components specified in the float array and the
specified alpha.
)DT( o )WB(
)A()BD(Color)ES()EA(\201float, float, float\202
)DD( Creates an opaque sRGB color with the specified red, green, and blue
values
in the range \2010.0 - 1.0\202.
)DT( o )WB(
)A()BD(Color)ES()EA(\201float, float, float, float\202
)DD( Creates an sRGB color with the specified red, green, blue, and
alpha values in the range \2010.0 - 1.0\202.
)DT( o )WB(
)A()BD(Color)ES()EA(\201int\202
)DD( Creates an opaque sRGB color with the specified combined RGB value
consisting
of the red component in bits 16-23, the green component in bits 8-15,
and the blue component in bits 0-7.
)DT( o )WB(
)A()BD(Color)ES()EA(\201int, boolean\202
)DD( Creates an sRGB color with the specified combined RGBA value consisting
of the alpha component in bits 24-31, the red component in bits 16-23,
the green component in bits 8-15, and the blue component in bits 0-7.
)DT( o )WB(
)A()BD(Color)ES()EA(\201int, int, int\202
)DD( Creates an opaque sRGB color with the specified red, green, and blue
values in
the range \2010 - 255\202.
)DT( o )WB(
)A()BD(Color)ES()EA(\201int, int, int, int\202
)DD( Creates an sRGB color with the specified red, green, blue, and alpha
values in the range \2010 - 255\202.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(brighter)ES()EA(\201\202
)DD( Creates a brighter version of this color.
)DT( o )WB(
)A()BD(createContext)ES()EA(\201ColorModel, Rectangle, Rectangle2D, AffineTransform\202
)DD( Create and return a PaintContext used to generate a solid color
pattern.
)DT( o )WB(
)A()BD(darker)ES()EA(\201\202
)DD( Creates a darker version of this color.
)DT( o )WB(
)A()BD(decode)ES()EA(\201String\202
)DD( Converts a string to an integer and returns the
specified color.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Determines whether another object is equal to this color.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201\202
)DD( Returns the alpha component.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201\202
)DD( Returns the blue component.
)DT( o )WB(
)A()BD(getColor)ES()EA(\201String\202
)DD( Finds a color in the system properties.
)DT( o )WB(
)A()BD(getColor)ES()EA(\201String, Color\202
)DD( Finds a color in the system properties.
)DT( o )WB(
)A()BD(getColor)ES()EA(\201String, int\202
)DD( Finds a color in the system properties.
)DT( o )WB(
)A()BD(getColorComponents)ES()EA(\201ColorSpace, float[]\202
)DD( Returns a float array containing the color components \201no alpha\202
of the Color, in the ColorSpace specified by the cspace parameter.
)DT( o )WB(
)A()BD(getColorComponents)ES()EA(\201float[]\202
)DD( Returns a float array containing the color components \201no alpha\202
of the Color, in the ColorSpace of the color.
)DT( o )WB(
)A()BD(getColorSpace)ES()EA(\201\202
)DD( Returns the ColorSpace of the Color.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201ColorSpace, float[]\202
)DD( Returns a float array containing the color and alpha components
of the Color, in the ColorSpace specified by the cspace parameter.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201float[]\202
)DD( Returns a float array containing the color and alpha components
of the Color, in the ColorSpace of the Color.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201\202
)DD( Returns the green component.
)DT( o )WB(
)A()BD(getHSBColor)ES()EA(\201float, float, float\202
)DD( A static Color factory for generating a Color object from HSB
values.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201\202
)DD( Returns the red component.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201\202
)DD( Returns the RGB value representing the color in the default sRGB
ColorModel.
)DT( o )WB(
)A()BD(getRGBA)ES()EA(\201\202
)DD( Returns the RGBA value representing the color in the default sRGB
ColorModel.
)DT( o )WB(
)A()BD(getRGBColorComponents)ES()EA(\201float[]\202
)DD( Returns a float array containing the color components \201no alpha\202
of the Color, in the default sRGB color space.
)DT( o )WB(
)A()BD(getRGBComponents)ES()EA(\201float[]\202
)DD( Returns a float array containing the color and alpha components
of the Color, as represented in the default sRGB color space.
)DT( o )WB(
)A()BD(getTransparency)ES()EA(\201\202
)DD( Return the transparency mode for this Color.
)DT( o )WB(
)A()BD(hashCode)ES()EA(\201\202
)DD( Computes the hash code for this color.
)DT( o )WB(
)A()BD(HSBtoRGB)ES()EA(\201float, float, float\202
)DD( Returns the RGB value defined by the default sRGB ColorModel, of
the color corresponding to the given HSB color components.
)DT( o )WB(
)A()BD(RGBtoHSB)ES()EA(\201int, int, int, float[]\202
)DD( Returns the HSB values corresponding to the color defined by the
red, green, and blue components, assumed to be in the default sRGB
color space.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns the String representation of this Color.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(white)ES(
)PR(
public static final )A(Color)EA( white
)RP(
)DL(
)DD( The color white. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(lightGray)ES(
)PR(
public static final )A(Color)EA( lightGray
)RP(
)DL(
)DD( The color light gray. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(gray)ES(
)PR(
public static final )A(Color)EA( gray
)RP(
)DL(
)DD( The color gray. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(darkGray)ES(
)PR(
public static final )A(Color)EA( darkGray
)RP(
)DL(
)DD( The color dark gray. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(black)ES(
)PR(
public static final )A(Color)EA( black
)RP(
)DL(
)DD( The color black. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(red)ES(
)PR(
public static final )A(Color)EA( red
)RP(
)DL(
)DD( The color red. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(pink)ES(
)PR(
public static final )A(Color)EA( pink
)RP(
)DL(
)DD( The color pink. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(orange)ES(
)PR(
public static final )A(Color)EA( orange
)RP(
)DL(
)DD( The color orange. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(yellow)ES(
)PR(
public static final )A(Color)EA( yellow
)RP(
)DL(
)DD( The color yellow. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(green)ES(
)PR(
public static final )A(Color)EA( green
)RP(
)DL(
)DD( The color green. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(magenta)ES(
)PR(
public static final )A(Color)EA( magenta
)RP(
)DL(
)DD( The color magenta. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(cyan)ES(
)PR(
public static final )A(Color)EA( cyan
)RP(
)DL(
)DD( The color cyan. In the default sRGB space.)0 P(
)LD(
o )WB()EA(
)BD(blue)ES(
)PR(
public static final )A(Color)EA( blue
)RP(
)DL(
)DD( The color blue. In the default sRGB space.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201int r,
int g,
int b\202
)RP(
)DL(
)DD( Creates an opaque sRGB color with the specified red, green, and blue
values in
the range \2010 - 255\202. The actual color used in rendering will depend
on finding the best match given the color space available for a
given output device. Alpha is defaulted to 255.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - the red component
)DD( g - the green component
)DD( b - the blue component
)DT( )BD(See Also:)ES(
)DD( )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201int r,
int g,
int b,
int a\202
)RP(
)DL(
)DD( Creates an sRGB color with the specified red, green, blue, and alpha
values in the range \2010 - 255\202.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - the red component
)DD( g - the green component
)DD( b - the blue component
)DD( a - the alpha component
)DT( )BD(See Also:)ES(
)DD( )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getAlpha)EA(, )A(getRGBA)EA(
)LD(
)LD(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201int rgb\202
)RP(
)DL(
)DD( Creates an opaque sRGB color with the specified combined RGB value
consisting
of the red component in bits 16-23, the green component in bits 8-15,
and the blue component in bits 0-7. The actual color used in
rendering will depend on finding the best match given the color space
available for a given output device. Alpha is defaulted to 255.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rgb - the combined RGB components
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(, )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201int rgba,
boolean hasalpha\202
)RP(
)DL(
)DD( Creates an sRGB color with the specified combined RGBA value consisting
of the alpha component in bits 24-31, the red component in bits 16-23,
the green component in bits 8-15, and the blue component in bits 0-7.
If the hasalpha argument is False, alpha is defaulted to 255.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rgba - the combined RGBA components
)DD( hasalpha - true if the alpha bits are valid, false otherwise
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(, )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getAlpha)EA(, )A(getRGBA)EA(
)LD(
)LD(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201float r,
float g,
float b\202
)RP(
)DL(
)DD( Creates an opaque sRGB color with the specified red, green, and blue
values
in the range \2010.0 - 1.0\202. Alpha is defaulted to 1.0. The actual color
used in rendering will depend on finding the best match given the
color space available for a given output device.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - the red component
)DD( g - the green component
)DD( b - the blue component
)DT( )BD(See Also:)ES(
)DD( )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201float r,
float g,
float b,
float a\202
)RP(
)DL(
)DD( Creates an sRGB color with the specified red, green, blue, and
alpha values in the range \2010.0 - 1.0\202. The actual color
used in rendering will depend on finding the best match given the
color space available for a given output device.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - the red component
)DD( g - the green component
)DD( b - the blue component
)DD( a - the alpha component
)DT( )BD(See Also:)ES(
)DD( )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getAlpha)EA(, )A(getRGBA)EA(
)LD(
)LD(
o )WB()EA(
)BD(Color)ES(
)PR(
public Color\201)A(ColorSpace)EA( cspace,
float components[],
float alpha\202
)RP(
)DL(
)DD( Creates a color in the color space of the supplied ColorSpace
with the color components specified in the float array and the
specified alpha. The number of components is determined by the
color space type of the ColorSpace \201e.g. RGB requires 3
components, CMYK requires 4, etc.\202.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( cspace - The ColorSpace to be used to interpret the
components
)DD( components - An arbitrary number of color components
that is compatible with the ColorSpace
)DD( alpha - Alpha value
)DT( )BD(See Also:)ES(
)DD( )A(getComponents)EA(, )A(getColorComponents)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public int getRed\201\202
)RP(
)DL(
)DD( Returns the red component. In the range 0-255 in the default sRGB space.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public int getGreen\201\202
)RP(
)DL(
)DD( Returns the green component. In the range 0-255 in the default sRGB
space.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public int getBlue\201\202
)RP(
)DL(
)DD( Returns the blue component. In the range 0-255 in the default sRGB
space.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public int getAlpha\201\202
)RP(
)DL(
)DD( Returns the alpha component. In the range 0-255.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBA)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201\202
)RP(
)DL(
)DD( Returns the RGB value representing the color in the default sRGB
ColorModel.
\201Bits 24-31 are 0xff, 16-23 are red, 8-15 are green, 0-7 are blue\202.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(, )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGBA)ES()EA(
)PR(
public int getRGBA\201\202
)RP(
)DL(
)DD( Returns the RGBA value representing the color in the default sRGB
ColorModel.
\201Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue\202.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(, )A(getRed)EA(, )A(getGreen)EA(, )A(getBlue)EA(, )A(getAlpha)EA(
)LD(
)LD(
o )WB()EA(
)BD(brighter)ES()EA(
)PR(
public )A(Color)EA( brighter\201\202
)RP(
)DL(
)DD( Creates a brighter version of this color.
)0 P(
This method applies an arbitrary scale factor to each of the three RGB
components of the color to create a brighter version of the same
color. Although )SM(brighter)ES( and )SM(darker)ES( are
inverse operations, the results of a series of invocations of
these two methods may be inconsistent because of rounding errors.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a new )SM(Color)ES( object,
a brighter version of this color.
)DT( )BD(See Also:)ES(
)DD( )A(darker)EA(
)LD(
)LD(
o )WB()EA(
)BD(darker)ES()EA(
)PR(
public )A(Color)EA( darker\201\202
)RP(
)DL(
)DD( Creates a darker version of this color.
)0 P(
This method applies an arbitrary scale factor to each of the three RGB
components of the color to create a darker version of the same
color. Although )SM(brighter)ES( and )SM(darker)ES( are
inverse operations, the results of a series of invocations of
these two methods may be inconsistent because of rounding errors.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a new )SM(Color)ES( object,
a darker version of this color.
)DT( )BD(See Also:)ES(
)DD( )A(brighter)EA(
)LD(
)LD(
o )WB()EA(
)BD(hashCode)ES()EA(
)PR(
public int hashCode\201\202
)RP(
)DL(
)DD( Computes the hash code for this color.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a hash code value for this object.
)DT( )BD(Overrides:)ES(
)DD( )A(hashCode)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD( Determines whether another object is equal to this color.
)0 P(
The result is )SM(true)ES( if and only if the argument is not
)SM(null)ES( and is a )SM(Color)ES( object that has the same
red, green, and blue values as this object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( obj - the object to compare with.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the objects are the same;
)SM(false)ES( otherwise.
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns the String representation of this Color.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(decode)ES()EA(
)PR(
public static )A(Color)EA( decode\201String nm\202 throws NumberFormatException
)RP(
)DL(
)DD( Converts a string to an integer and returns the
specified color. This method handles string formats that
are used to represent octal and hexidecimal numbers.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( nm - a string that represents
a color as a 24-bit integer.
)DT( )BD(Returns:)ES(
)DD( the new color
)DT( )BD(Throws:)ES( NumberFormatException
)DD( if the specified string cannot
be interpreted as a decimal,
octal, or hexidecimal integer.
)DT( )BD(See Also:)ES(
)DD( decode
)LD(
)LD(
o )WB()EA(
)BD(getColor)ES()EA(
)PR(
public static )A(Color)EA( getColor\201String nm\202
)RP(
)DL(
)DD( Finds a color in the system properties.
)0 P(
The argument is treated as the name of a system property to
be obtained. The string value of this property is then interpreted
as an integer which is then converted to a color.
)0 P(
If the specified property is not found, or could not be parsed as
an integer, then )SM(null)ES( is returned.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( nm - the name of the color property
)DT( )BD(Returns:)ES(
)DD( the color value of the property.
)DT( )BD(See Also:)ES(
)DD( getProperty, getInteger, )A(Color)EA(
)LD(
)LD(
o )WB()EA(
)BD(getColor)ES()EA(
)PR(
public static )A(Color)EA( getColor\201String nm,
)A(Color)EA( v\202
)RP(
)DL(
)DD( Finds a color in the system properties.
)0 P(
The first argument is treated as the name of a system property to
be obtained. The string value of this property is then interpreted
as an integer which is then converted to a color.
)0 P(
If the specified property is not found, or cannot be parsed as
an integer, then the color specified by the second argument is
returned instead.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( nm - the name of the color property
)DD( v - the default color value.
)DT( )BD(Returns:)ES(
)DD( the color value of the property.
)DT( )BD(See Also:)ES(
)DD( getProperty, getInteger, )A(Color)EA(
)LD(
)LD(
o )WB()EA(
)BD(getColor)ES()EA(
)PR(
public static )A(Color)EA( getColor\201String nm,
int v\202
)RP(
)DL(
)DD( Finds a color in the system properties.
)0 P(
The first argument is treated as the name of a system property to
be obtained. The string value of this property is then interpreted
as an integer which is then converted to a color.
)0 P(
If the specified property is not found, or could not be parsed as
an integer, then the integer value )SM(v)ES( is used instead,
and is converted to a color.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( nm - the name of the color property.
)DD( v - the default color value, as an integer.
)DT( )BD(Returns:)ES(
)DD( the color value of the property.
)DT( )BD(See Also:)ES(
)DD( getProperty, getInteger, )A(Color)EA(
)LD(
)LD(
o )WB()EA(
)BD(HSBtoRGB)ES()EA(
)PR(
public static int HSBtoRGB\201float hue,
float saturation,
float brightness\202
)RP(
)DL(
)DD( Returns the RGB value defined by the default sRGB ColorModel, of
the color corresponding to the given HSB color components.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hue - the hue component of the color
)DD( saturation - the saturation of the color
)DD( brightness - the brightness of the color
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(, )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(RGBtoHSB)ES()EA(
)PR(
public static float[] RGBtoHSB\201int r,
int g,
int b,
float hsbvals[]\202
)RP(
)DL(
)DD( Returns the HSB values corresponding to the color defined by the
red, green, and blue components, assumed to be in the default sRGB
color space.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - the red component of the color
)DD( g - the green component of the color
)DD( b - the blue component of the color
)DD( hsbvals - the array to be used to return the 3 HSB values, or null
)DT( )BD(Returns:)ES(
)DD( the array used to store the results [hue, saturation, brightness]
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(, )A(getRGB)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHSBColor)ES()EA(
)PR(
public static )A(Color)EA( getHSBColor\201float h,
float s,
float b\202
)RP(
)DL(
)DD( A static Color factory for generating a Color object from HSB
values.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( h - the hue component
)DD( s - the saturation of the color
)DD( b - the brightness of the color
)DT( )BD(Returns:)ES(
)DD( the Color object for the corresponding RGB color in the
default sRGB space.
)LD(
)LD(
o )WB()EA(
)BD(getRGBComponents)ES()EA(
)PR(
public float[] getRGBComponents\201float componentarray[]\202
)RP(
)DL(
)DD( Returns a float array containing the color and alpha components
of the Color, as represented in the default sRGB color space.
If componentarray is null, an array of length 4 is created for the
return value. Otherwise, componentarray must have length 4 or greater,
and it will be filled in with the components and returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the RGBA components in a float array
)LD(
)LD(
o )WB()EA(
)BD(getRGBColorComponents)ES()EA(
)PR(
public float[] getRGBColorComponents\201float componentarray[]\202
)RP(
)DL(
)DD( Returns a float array containing the color components \201no alpha\202
of the Color, in the default sRGB color space.
If componentarray is null, an array of length 3 is created for the
return value. Otherwise, componentarray must have length 3 or greater,
and it will be filled in with the components and returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the RGB components in a float array
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public float[] getComponents\201float componentarray[]\202
)RP(
)DL(
)DD( Returns a float array containing the color and alpha components
of the Color, in the ColorSpace of the Color.
If componentarray is null, an array with length equal to the number of
components in the associated ColorSpace plus one is created for
the return value. Otherwise, componentarray must have at least this
length, and it will be filled in with the components and returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the color and alpha components in a float array
)LD(
)LD(
o )WB()EA(
)BD(getColorComponents)ES()EA(
)PR(
public float[] getColorComponents\201float componentarray[]\202
)RP(
)DL(
)DD( Returns a float array containing the color components \201no alpha\202
of the Color, in the ColorSpace of the color.
If componentarray is null, an array with length equal to the number of
components in the associated ColorSpace is created for
the return value. Otherwise, componentarray must have at least this
length, and it will be filled in with the components and returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the color components in a float array
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public float[] getComponents\201)A(ColorSpace)EA( cspace,
float componentarray[]\202
)RP(
)DL(
)DD( Returns a float array containing the color and alpha components
of the Color, in the ColorSpace specified by the cspace parameter.
If componentarray is null, an array with length equal to the number of
components in cspace plus one is created for
the return value. Otherwise, componentarray must have at least this
length, and it will be filled in with the components and returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the color and alpha components in a float array
)LD(
)LD(
o )WB()EA(
)BD(getColorComponents)ES()EA(
)PR(
public float[] getColorComponents\201)A(ColorSpace)EA( cspace,
float componentarray[]\202
)RP(
)DL(
)DD( Returns a float array containing the color components \201no alpha\202
of the Color, in the ColorSpace specified by the cspace parameter.
If componentarray is null, an array with length equal to the number of
components in cspace is created for
the return value. Otherwise, componentarray must have at least this
length, and it will be filled in with the components and returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the color components in a float array
)LD(
)LD(
o )WB()EA(
)BD(getColorSpace)ES()EA(
)PR(
public )A(ColorSpace)EA( getColorSpace\201\202
)RP(
)DL(
)DD( Returns the ColorSpace of the Color.
)0 P(
)LD(
o )WB()EA(
)BD(createContext)ES()EA(
)PR(
public synchronized )A(PaintContext)EA( createContext\201)A(ColorModel)EA( cm,
)A(Rectangle)EA( r,
)A(Rectangle2D)EA( r2d,
)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Create and return a PaintContext used to generate a solid color
pattern. This enables a Color object to be used as an argument to
any method requiring an object implementing the Paint interface.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Paint)EA(, )A(PaintContext)EA(, )A(setPaint)EA(
)LD(
)LD(
o )WB()EA(
)BD(getTransparency)ES()EA(
)PR(
public int getTransparency\201\202
)RP(
)DL(
)DD( Return the transparency mode for this Color. This is required in
to implement the Paint interface.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Paint)EA(, )A(Transparency)EA(, )A(createContext)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.Font
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.Font
)EH(
)PR(
java.lang.Object
|
+----java.awt.Font
)RP(
)HR(
)DL(
)DT( public class )BD(Font)ES(
)DT( extends Object
)DT( implements Serializable
)LD(
This class represents fonts. The capabilities of this class have been
extended over the java.awt.Font class in JDK 1.1 and earlier releases
to provide developers the ability to utilize more sophisticated
typographic features.
)0 P(
It is important to present the concepts behind using the words
character and glyph separately. A )BD(character)ES( is a symbol that
represents items like letters and numbers in a given writing system,
for example )I(lowercase-g)ES(. When a given character is drawn, a shape
now represents this character. This shape is called a )BD(glyph)ES(.
)0 P(
Chararcter encoding is a conversion table that maps character codes
to glyph codes in the font. The character encoding used in the Java 2D
API is Unicode. For more information on Unicode you may visit the site
)A(http://www.unicode.org)EA(.
)0 P(
Characters and glyphs do not have one-to-one correspondence. As an example
)I(lowercase-a acute)ES( can be represented by two glyphs: )I(lowercase-a)ES(
and )I(acute)ES(.
Another example is ligatures such as )I(ligature -fi)ES( which is a
single glyph representing two characters: )I(f)ES( and )I(i)ES(.
)0 P(
A font is a collection of glyphs. A font may have many faces, e.g.
heavy, medium, oblique, gothic and regular. All of these faces have
similar typographic design.
)0 P(
There are three different names that you can get from a Font object.
The )I(logical font name)ES(is the same as used by java.awt.Font in
JDK 1.1 and earlier releases. The java.awt.Toolkit.getFontList\201\202 method
returns a short list of these logical names which are mapped onto specific
fonts available on specific platforms. The )I(font face name)ES(,
or just )I(font name)ES( for short, is the name of a particular font
face, like Helvetica Bold. The )I(family name)ES( is the name
of the font family that determines the typographic design across several
faces, like Helvetica. The font face name
is the one that should be used to specify fonts. This name signifies
actual fonts in the host system, and does not identify font
names with shape of font characters as the logical font name does.
)0 P(
The Font class represents an instance of a font face from a
collection of font faces that are present in the system resources
of the host system. As examples, Helvetica Bold and Courier Bold Italic
are font faces. There can be several Font objects associated with
a font face, each differing in size, style, transform and font features.
GraphicsEnvironment.getAllFonts\201\202 returns an array of all font faces
available in the system. These font faces are returned as Font objects
with a size of 1, identity transform and default font features. These
base fonts can then be used to derive new Font objects with varying
sizes, styles, transforms and font features via the deriveFont methods
in this class.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( getFontList, )A(getFonts)EA(, )A(getAllFonts)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BOLD)ES()EA(
)DD( The bold style constant.
)DT( o )WB(
)A()BD(CENTER_BASELINE)ES()EA(
)DD(
)DT( o )WB(
)A()BD(DEFAULT)ES()EA(
)DD(
)DT( o )WB(
)A()BD(HANGING_BASELINE)ES()EA(
)DD(
)DT( o )WB(
)A()BD(ITALIC)ES()EA(
)DD( The italicized style constant.
)DT( o )WB(
)A()BD(name)ES()EA(
)DD(
The logical name of this font.
)DT( o )WB(
)A()BD(PLAIN)ES()EA(
)DD( The plain style constant.
)DT( o )WB(
)A()BD(ROMAN_BASELINE)ES()EA(
)DD(
)DT( o )WB(
)A()BD(size)ES()EA(
)DD(
The point size of this font, rounded to integer.
)DT( o )WB(
)A()BD(style)ES()EA(
)DD(
The style of the font, as passed to the constructor.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Font)ES()EA(\201AttributeSet\202
)DD( Create a new font with the specified attributes
)DT( o )WB(
)A()BD(Font)ES()EA(\201FontObject\202
)DD(
)DT( o )WB(
)A()BD(Font)ES()EA(\201String, int, int\202
)DD( Creates a new font from the specified name, style and point size.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(canDisplay)ES()EA(\201char\202
)DD( Checks if this font has a glyph for the specified character.
)DT( o )WB(
)A()BD(canDisplayUpTo)ES()EA(\201CharacterIterator\202
)DD( Indicates whether a string is displayable by this Font.
)DT( o )WB(
)A()BD(canDisplayUpTo)ES()EA(\201String\202
)DD( Indicates whether a string is displayable by this Font.
)DT( o )WB(
)A()BD(decode)ES()EA(\201String\202
)DD( Returns the specified font using the name passed in.
)DT( o )WB(
)A()BD(deriveFont)ES()EA(\201AffineTransform\202
)DD( Creates a new Font object by replicating the current Font object
with a new transform associated with it.
)DT( o )WB(
)A()BD(deriveFont)ES()EA(\201float\202
)DD( Creates a new Font object by replicating the current Font object
with a new size associated with it.
)DT( o )WB(
)A()BD(deriveFont)ES()EA(\201int\202
)DD( Creates a new Font object by replicating the current Font object
with a new style associated with it.
)DT( o )WB(
)A()BD(deriveFont)ES()EA(\201int, AffineTransform\202
)DD( Creates a new Font object by replicating the current Font object
with a new style, transform and font attributes associated with it.
)DT( o )WB(
)A()BD(deriveFont)ES()EA(\201int, float\202
)DD( Creates a new Font object by replicating the current Font object
with a new style, size and font attributes associated with it.
)DT( o )WB(
)A()BD(deriveFont)ES()EA(\201TextAttributeSet\202
)DD( Creates a new Font object by replicating the current Font object
with a new set of font attributes associated with it.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Compares this object to the specified object.
)DT( o )WB(
)A()BD(finalize)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(getActualAttributes)ES()EA(\201\202
)DD( Returns the requested attributes that this font is actually using.
)DT( o )WB(
)A()BD(getAscent)ES()EA(\201\202
)DD( Returns the ascent of the font above the roman baseline.
)DT( o )WB(
)A()BD(getAttributes)ES()EA(\201\202
)DD( Returns an array of font attributes available in this font.
)DT( o )WB(
)A()BD(getAvailableAttributes)ES()EA(\201\202
)DD( Returns the names of all the attributes supported by this font.
)DT( o )WB(
)A()BD(getBaselineFor)ES()EA(\201char\202
)DD(
)DT( o )WB(
)A()BD(getBaselineOffset)ES()EA(\201byte\202
)DD( Returns the offset from the roman baseline of the font to the specified
baseline.
)DT( o )WB(
)A()BD(getBaselineOffsetsFor)ES()EA(\201char\202
)DD( Return a list of relative offsets for the different baselines.
)DT( o )WB(
)A()BD(getBestFontFor)ES()EA(\201AttributedCharacterIterator\202
)DD(
)DT( o )WB(
)A()BD(getCapHeight)ES()EA(\201\202
)DD( Returns the cap height of this font.
)DT( o )WB(
)A()BD(getDescent)ES()EA(\201\202
)DD( Returns the descent of the font above the roman baseline.
)DT( o )WB(
)A()BD(getFamily)ES()EA(\201\202
)DD( Returns the family name of the font \201for example, Helvetica\202.
)DT( o )WB(
)A()BD(getFamily)ES()EA(\201Locale\202
)DD( Returns the family name of the font \201for example, Helvetica\202, localized
for the given Locale.
)DT( o )WB(
)A()BD(getFont)ES()EA(\201String\202
)DD( Returns a font from the system properties list.
)DT( o )WB(
)A()BD(getFont)ES()EA(\201String, Font\202
)DD( Returns the specified font from the system properties list.
)DT( o )WB(
)A()BD(getFontName)ES()EA(\201\202
)DD( Returns the font face name of the font \201for example, Helvetica Bold\202.
)DT( o )WB(
)A()BD(getFontName)ES()EA(\201Locale\202
)DD( Returns the font face name of the font \201for example, Helvetica Fett\202
localized for the specified locale.
)DT( o )WB(
)A()BD(getGlyphJustificationInfo)ES()EA(\201int\202
)DD( Return justification info for the glyph specified by glyphCode.
)DT( o )WB(
)A()BD(getGlyphMetrics)ES()EA(\201int\202
)DD(
Returns the metrics information for a glyph specified by a glyph code.
)DT( o )WB(
)A()BD(getGlyphOutline)ES()EA(\201int, float, float\202
)DD( Returns the outline description of a glyph specified by a glyph code.
)DT( o )WB(
)A()BD(getGlyphSet)ES()EA(\201AttributedCharacterIterator, int, int, byte, int[], byte[]\202
)DD(
)DT( o )WB(
)A()BD(getGlyphSet)ES()EA(\201CharacterIterator, byte, int[], byte[]\202
)DD( Converts characters in the charArray to font glyph codes.
)DT( o )WB(
)A()BD(getGlyphSet)ES()EA(\201String\202
)DD( Converts all characters in the String Object to font glyph codes.
)DT( o )WB(
)A()BD(getItalicAngle)ES()EA(\201\202
)DD( Returns the italic angle of this font.
)DT( o )WB(
)A()BD(getLeading)ES()EA(\201\202
)DD( Returns the leading for this font;
)DT( o )WB(
)A()BD(getMaxAdvance)ES()EA(\201\202
)DD( Returns the maximum advance of any glyph in this font.
)DT( o )WB(
)A()BD(getMaxBounds2D)ES()EA(\201\202
)DD( Returns the maximum bounding box of this font.
)DT( o )WB(
)A()BD(getMaxLSB)ES()EA(\201\202
)DD( Returns the maximum left side bearing of any glyph in this font.
)DT( o )WB(
)A()BD(getMaxRSB)ES()EA(\201\202
)DD( Returns the maximum right side bearing of any glyph in this font.
)DT( o )WB(
)A()BD(getMetrics)ES()EA(\201GlyphSet, AffineTransform\202
)DD(
)DT( o )WB(
)A()BD(getMissingGlyphCode)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(getName)ES()EA(\201\202
)DD( Returns the logical name of the font.
)DT( o )WB(
)A()BD(getNumGlyphs)ES()EA(\201\202
)DD( Returns number of glyphs in the font.
)DT( o )WB(
)A()BD(getOutline)ES()EA(\201GlyphSet, AffineTransform, float, float\202
)DD(
)DT( o )WB(
)A()BD(getPeer)ES()EA(\201\202
)DD( Gets the peer of the font.
)DT( o )WB(
)A()BD(getPSName)ES()EA(\201\202
)DD( Returns the postscript name of the font.
)DT( o )WB(
)A()BD(getRequestedAttributes)ES()EA(\201\202
)DD( Returns the attribute set used to create this font.
)DT( o )WB(
)A()BD(getSize)ES()EA(\201\202
)DD( Returns the point size of the font, rounded to integer.
)DT( o )WB(
)A()BD(getSize2D)ES()EA(\201\202
)DD( Returns the point size of the font in float.
)DT( o )WB(
)A()BD(getStyle)ES()EA(\201\202
)DD( Returns the style of the font.
)DT( o )WB(
)A()BD(getTransform)ES()EA(\201\202
)DD( Returns the transform associated with this font.
)DT( o )WB(
)A()BD(getXHeight)ES()EA(\201\202
)DD( Returns the x-height for this font.
)DT( o )WB(
)A()BD(handleApplyJustification)ES()EA(\201GlyphSet, float[], int, boolean[]\202
)DD( Return a new glyphset after applying justification.
)DT( o )WB(
)A()BD(hashCode)ES()EA(\201\202
)DD( Returns a hashcode for this font.
)DT( o )WB(
)A()BD(isBold)ES()EA(\201\202
)DD( Indicates whether the font's style is bold.
)DT( o )WB(
)A()BD(isItalic)ES()EA(\201\202
)DD( Indicates whether the font's style is italic.
)DT( o )WB(
)A()BD(isPlain)ES()EA(\201\202
)DD( Returns true if the font is plain.
)DT( o )WB(
)A()BD(isVerticalLine)ES()EA(\201\202
)DD( Return true if the font lays out glyphs along a vertical baseline.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
Converts this object to a String representation.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(DEFAULT)ES(
)PR(
public static final )A(Font)EA( DEFAULT
)RP(
o )WB()EA(
)BD(PLAIN)ES(
)PR(
public static final int PLAIN
)RP(
)DL(
)DD( The plain style constant.)0 P(
)LD(
o )WB()EA(
)BD(BOLD)ES(
)PR(
public static final int BOLD
)RP(
)DL(
)DD( The bold style constant. This can be combined with the other style
constants \201except PLAIN\202 for mixed styles.)0 P(
)LD(
o )WB()EA(
)BD(ITALIC)ES(
)PR(
public static final int ITALIC
)RP(
)DL(
)DD( The italicized style constant. This can be combined with the other
style constants \201except PLAIN\202 for mixed styles.)0 P(
)LD(
o )WB()EA(
)BD(ROMAN_BASELINE)ES(
)PR(
public static final byte ROMAN_BASELINE
)RP(
o )WB()EA(
)BD(CENTER_BASELINE)ES(
)PR(
public static final byte CENTER_BASELINE
)RP(
o )WB()EA(
)BD(HANGING_BASELINE)ES(
)PR(
public static final byte HANGING_BASELINE
)RP(
o )WB()EA(
)BD(name)ES(
)PR(
protected String name
)RP(
)DL(
)DD( The logical name of this font.)0 P(
)LD(
o )WB()EA(
)BD(style)ES(
)PR(
protected int style
)RP(
)DL(
)DD( The style of the font, as passed to the constructor. This may be
PLAIN, BOLD, ITALIC, or BOLD+ITALIC.)0 P(
)LD(
o )WB()EA(
)BD(size)ES(
)PR(
protected int size
)RP(
)DL(
)DD( The point size of this font, rounded to integer.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Font)ES(
)PR(
public Font\201String name,
int style,
int size\202
)RP(
)DL(
)DD( Creates a new font from the specified name, style and point size.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( name - the font name. This can be a logical font name or a
font face name.
)DD( style - the style constant for the font.
)DD( size - the point size of the font.
)DT( )BD(See Also:)ES(
)DD( getFontList, )A(getFonts)EA(, )A(getAllFonts)EA(
)LD(
)LD(
o )WB()EA(
)BD(Font)ES(
)PR(
public Font\201FontObject fontObject\202
)RP(
o )WB()EA(
)BD(Font)ES(
)PR(
public Font\201AttributeSet attributes\202
)RP(
)DL(
)DD( Create a new font with the specified attributes
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getPeer)ES()EA(
)PR(
public FontPeer getPeer\201\202
)RP(
)DL(
)DD( Gets the peer of the font.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the peer of the font.
)LD(
)LD(
o )WB()EA(
)BD(getTransform)ES()EA(
)PR(
public )A(AffineTransform)EA( getTransform\201\202
)RP(
)DL(
)DD( Returns the transform associated with this font.
)0 P(
)LD(
o )WB()EA(
)BD(getFamily)ES()EA(
)PR(
public String getFamily\201\202
)RP(
)DL(
)DD( Returns the family name of the font \201for example, Helvetica\202.
Use getName to get the logical name of the font.
Use getFontName to get the font face name of the font.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getName)EA(, )A(getFontName)EA(
)LD(
)LD(
o )WB()EA(
)BD(getFamily)ES()EA(
)PR(
public String getFamily\201Locale l\202
)RP(
)DL(
)DD( Returns the family name of the font \201for example, Helvetica\202, localized
for the given Locale.
Use getFontName to get the font face name of the font.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( l - Locale for which to get the family name.
)DT( )BD(See Also:)ES(
)DD( )A(getFontName)EA(, Locale
)LD(
)LD(
o )WB()EA(
)BD(getPSName)ES()EA(
)PR(
public String getPSName\201\202
)RP(
)DL(
)DD( Returns the postscript name of the font.
Use getFamily to get the family name of the font.
Use getFontName to get the font face name of the font.
)0 P(
)LD(
o )WB()EA(
)BD(getName)ES()EA(
)PR(
public String getName\201\202
)RP(
)DL(
)DD( Returns the logical name of the font.
Use getFamily to get the family name of the font.
Use getFontName to get the font face name of the font.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getFamily)EA(, )A(getFontName)EA(
)LD(
)LD(
o )WB()EA(
)BD(getFontName)ES()EA(
)PR(
public String getFontName\201\202
)RP(
)DL(
)DD( Returns the font face name of the font \201for example, Helvetica Bold\202.
Use getFamily to get the family name of the font.
Use getName to get the logical name of the font.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getFamily)EA(, )A(getName)EA(
)LD(
)LD(
o )WB()EA(
)BD(getFontName)ES()EA(
)PR(
public String getFontName\201Locale l\202
)RP(
)DL(
)DD( Returns the font face name of the font \201for example, Helvetica Fett\202
localized for the specified locale.
Use getFamily to get the family name of the font.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( l - Get the localized font face name for this locale.
)DT( )BD(See Also:)ES(
)DD( )A(getFamily)EA(, Locale
)LD(
)LD(
o )WB()EA(
)BD(getStyle)ES()EA(
)PR(
public int getStyle\201\202
)RP(
)DL(
)DD( Returns the style of the font. This may be
PLAIN, BOLD, ITALIC, or BOLD+ITALIC.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(isPlain)EA(, )A(isBold)EA(, )A(isItalic)EA(
)LD(
)LD(
o )WB()EA(
)BD(getSize)ES()EA(
)PR(
public int getSize\201\202
)RP(
)DL(
)DD( Returns the point size of the font, rounded to integer.
Most users are familiar with the idea of using )I(point size)ES( to
specify the size of glyphs in a font. This point size defines a
measurement between the baseline of one line to the baseline of the
following line in a single spaced text document. The point size is
based on )I(typographic points)ES(, approximately 1/72 of an inch.
)0 P(
The Java2D API adopts the convention that one point is equivalent
to one unit in user coordinates. When using a normalized transform
for converting user space coordinates to device space coordinates
\201see GraphicsConfiguration.getDefaultTransform\201\202 and
GraphicsConfiguration.getNormalizingTransform\201\202\202, 72 user space units
equal 1 inch in device space. In this case one point is 1/72 of an
inch.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getSize2D)EA(, )A(getDefaultTransform)EA(, )A(getNormalizingTransform)EA(
)LD(
)LD(
o )WB()EA(
)BD(getSize2D)ES()EA(
)PR(
public float getSize2D\201\202
)RP(
)DL(
)DD( Returns the point size of the font in float.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getSize)EA(
)LD(
)LD(
o )WB()EA(
)BD(isPlain)ES()EA(
)PR(
public boolean isPlain\201\202
)RP(
)DL(
)DD( Returns true if the font is plain.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getStyle)EA(
)LD(
)LD(
o )WB()EA(
)BD(isBold)ES()EA(
)PR(
public boolean isBold\201\202
)RP(
)DL(
)DD( Indicates whether the font's style is bold.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the font is bold;
)SM(false)ES( otherwise.
)DT( )BD(See Also:)ES(
)DD( )A(getStyle)EA(
)LD(
)LD(
o )WB()EA(
)BD(isItalic)ES()EA(
)PR(
public boolean isItalic\201\202
)RP(
)DL(
)DD( Indicates whether the font's style is italic.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the font is italic;
)SM(false)ES( otherwise.
)DT( )BD(See Also:)ES(
)DD( )A(getStyle)EA(
)LD(
)LD(
o )WB()EA(
)BD(getFont)ES()EA(
)PR(
public static )A(Font)EA( getFont\201String nm\202
)RP(
)DL(
)DD( Returns a font from the system properties list.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( nm - the property name.
)LD(
)LD(
o )WB()EA(
)BD(decode)ES()EA(
)PR(
public static )A(Font)EA( decode\201String str\202
)RP(
)DL(
)DD( Returns the specified font using the name passed in.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( str - the name.
)LD(
)LD(
o )WB()EA(
)BD(getFont)ES()EA(
)PR(
public static )A(Font)EA( getFont\201String nm,
)A(Font)EA( font\202
)RP(
)DL(
)DD( Returns the specified font from the system properties list.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( nm - the property name.
)DD( font - a default font to return if property 'nm' is not defined.
)LD(
)LD(
o )WB()EA(
)BD(hashCode)ES()EA(
)PR(
public int hashCode\201\202
)RP(
)DL(
)DD( Returns a hashcode for this font.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a hashcode value for this font.
)DT( )BD(Overrides:)ES(
)DD( )A(hashCode)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD( Compares this object to the specified object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( obj - the object to compare with.
)DT( )BD(Returns:)ES(
)DD( true if the objects are the same; false otherwise.
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Converts this object to a String representation.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a string representation of this object
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(getNumGlyphs)ES()EA(
)PR(
public int getNumGlyphs\201\202
)RP(
)DL(
)DD( Returns number of glyphs in the font. Glyph codes for the font
will range from 0 to getNumGlyphs\201\202 - 1.
)0 P(
)LD(
o )WB()EA(
)BD(getMissingGlyphCode)ES()EA(
)PR(
public int getMissingGlyphCode\201\202
)RP(
o )WB()EA(
)BD(getGlyphMetrics)ES()EA(
)PR(
public )A(GlyphMetrics)EA( getGlyphMetrics\201int glyphCode\202
)RP(
)DL(
)DD( Returns the metrics information for a glyph specified by a glyph code.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( glyphCode - the glyph to get metrics for.
)DT( )BD(Returns:)ES(
)DD( a GlyphMetrics object with metric information for the glyph.
)LD(
)LD(
o )WB()EA(
)BD(getBaselineFor)ES()EA(
)PR(
public byte getBaselineFor\201char c\202
)RP(
o )WB()EA(
)BD(getBaselineOffsetsFor)ES()EA(
)PR(
public float[] getBaselineOffsetsFor\201char c\202
)RP(
)DL(
)DD( Return a list of relative offsets for the different baselines.
)0 P(
Large fonts can support different writing systems, and each system can
have its own set of preferred baseline offsets. The character argument
determines the writing system to use.
)0 P(
These all are relative to the most common baseline used with this font
\201the one from which ascent and descent are measured\202. Negative values
are up on horizontal lines, and right on vertical lines.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( c - a character used to identify the writing system
)DT( )BD(See Also:)ES(
)DD( )A(getBaselineFor)EA(, )A(ROMAN_BASELINE)EA(, )A(CENTER_BASELINE)EA(, )A(HANGING_BASELINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGlyphOutline)ES()EA(
)PR(
public )A(Shape)EA( getGlyphOutline\201int glyphCode,
float x,
float y\202
)RP(
)DL(
)DD( Returns the outline description of a glyph specified by a glyph code.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( glyphCode - the glyph for which to get the outline.
)DT( )BD(Returns:)ES(
)DD( a Shape object representing the outline of the glyph.
)LD(
)LD(
o )WB()EA(
)BD(getMetrics)ES()EA(
)PR(
public float[] getMetrics\201)A(GlyphSet)EA( glyphs,
)A(AffineTransform)EA( tx\202
)RP(
o )WB()EA(
)BD(getOutline)ES()EA(
)PR(
public )A(Shape)EA( getOutline\201)A(GlyphSet)EA( glyphs,
)A(AffineTransform)EA( tx,
float x,
float y\202
)RP(
o )WB()EA(
)BD(getAttributes)ES()EA(
)PR(
public AttributeSet getAttributes\201\202
)RP(
)DL(
)DD( Returns an array of font attributes available in this font.
Attributes include things like ligatures and glyph substitution.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a FontAttribute array.
)LD(
)LD(
o )WB()EA(
)BD(getAvailableAttributes)ES()EA(
)PR(
public String[] getAvailableAttributes\201\202
)RP(
)DL(
)DD( Returns the names of all the attributes supported by this font.
These attributes may be used to derive other fonts.
)0 P(
)LD(
o )WB()EA(
)BD(getGlyphJustificationInfo)ES()EA(
)PR(
public GlyphJustificationInfo getGlyphJustificationInfo\201int glyphCode\202
)RP(
)DL(
)DD( Return justification info for the glyph specified by glyphCode.
If left is true, return info for the left side of the glyph, otherwise
for the right.
If grow is true, return info for growing a line, otherwise for
shrinking it.
!!! unify into one set of information per glyph?
Then it's the accessing code's problem...
)0 P(
)LD(
o )WB()EA(
)BD(getRequestedAttributes)ES()EA(
)PR(
public AttributeSet getRequestedAttributes\201\202
)RP(
)DL(
)DD( Returns the attribute set used to create this font.
NOTE: This method may be moved into another class.
)0 P(
)LD(
o )WB()EA(
)BD(getActualAttributes)ES()EA(
)PR(
public )A(TextAttributeSet)EA( getActualAttributes\201\202
)RP(
)DL(
)DD( Returns the requested attributes that this font is actually using.
NOTE: This method may be moved into another class;
)0 P(
)LD(
o )WB()EA(
)BD(deriveFont)ES()EA(
)PR(
public )A(Font)EA( deriveFont\201int style,
float size\202
)RP(
)DL(
)DD( Creates a new Font object by replicating the current Font object
with a new style, size and font attributes associated with it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( style - the style for the new Font.
)DD( size - the size in float for the new Font.
)DD( attributes - an array of AttributeSets enabled for the new Font.
)DT( )BD(Returns:)ES(
)DD( a new Font object.
)LD(
)LD(
o )WB()EA(
)BD(deriveFont)ES()EA(
)PR(
public )A(Font)EA( deriveFont\201int style,
)A(AffineTransform)EA( trans\202
)RP(
)DL(
)DD( Creates a new Font object by replicating the current Font object
with a new style, transform and font attributes associated with it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( style - the style for the new Font.
)DD( trans - the AffineTransform associated with the new Font.
)DD( attributes - an array of AttributeSets enabled for the new Font.
)DT( )BD(Returns:)ES(
)DD( a new Font object.
)LD(
)LD(
o )WB()EA(
)BD(deriveFont)ES()EA(
)PR(
public )A(Font)EA( deriveFont\201float size\202
)RP(
)DL(
)DD( Creates a new Font object by replicating the current Font object
with a new size associated with it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( size - the size in float for the new Font.
)DT( )BD(Returns:)ES(
)DD( a new Font object.
)LD(
)LD(
o )WB()EA(
)BD(deriveFont)ES()EA(
)PR(
public )A(Font)EA( deriveFont\201)A(AffineTransform)EA( trans\202
)RP(
)DL(
)DD( Creates a new Font object by replicating the current Font object
with a new transform associated with it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( trans - the AffineTransform associated with the new Font.
)DT( )BD(Returns:)ES(
)DD( a new Font object.
)LD(
)LD(
o )WB()EA(
)BD(deriveFont)ES()EA(
)PR(
public )A(Font)EA( deriveFont\201int style\202
)RP(
)DL(
)DD( Creates a new Font object by replicating the current Font object
with a new style associated with it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( style - the style for the new Font.
)DT( )BD(Returns:)ES(
)DD( a new Font object.
)LD(
)LD(
o )WB()EA(
)BD(deriveFont)ES()EA(
)PR(
public )A(Font)EA( deriveFont\201)A(TextAttributeSet)EA( attributes\202
)RP(
)DL(
)DD( Creates a new Font object by replicating the current Font object
with a new set of font attributes associated with it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( attributes - an array of AttributeSets enabled for the new Font.
)DT( )BD(Returns:)ES(
)DD( a new Font object.
)LD(
)LD(
o )WB()EA(
)BD(isVerticalLine)ES()EA(
)PR(
public boolean isVerticalLine\201\202
)RP(
)DL(
)DD( Return true if the font lays out glyphs along a vertical baseline.
The default is false.
)0 P(
)LD(
o )WB()EA(
)BD(handleApplyJustification)ES()EA(
)PR(
public )A(GlyphSet)EA( handleApplyJustification\201)A(GlyphSet)EA( gs,
float deltas[],
int index,
boolean flags[]\202
)RP(
)DL(
)DD( Return a new glyphset after applying justification.
)0 P(
This is called by GlyphSet.
)0 P(
Subclassers can override this to build a new glyphset in any way
appropriate to the requested assignment of space. The original
glyphset may not be modified. In particular changing the values
in the arrays of the glyphset will cause incorrect results.
A new glyphset should be created if any modification occurs.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( gs - the original glyphset
)DD( deltas - an array of amounts by which to change the left
and right sides of each glyph, in visual order.
)DD( index - the starting position in the deltas array, it corresponds to
the left side of the leftmost glyph.
)DD( flags - on entry, indicates whether the returned glyphset is
allowed to cause rejustification, e.g. if a ligature can be formed
or broken. On exit, indicates whether the returned glyphset will
require rejustification.
)DT( )BD(Returns:)ES(
)DD( a new glyphset.
)LD(
)LD(
o )WB()EA(
)BD(getGlyphSet)ES()EA(
)PR(
public )A(GlyphSet)EA( getGlyphSet\201AttributedCharacterIterator context,
int start,
int limit,
byte baseline,
int order[],
byte levels[]\202
)RP(
o )WB()EA(
)BD(getGlyphSet)ES()EA(
)PR(
public )A(GlyphSet)EA( getGlyphSet\201CharacterIterator textLine,
byte baseline,
int visualOrder[],
byte levels[]\202
)RP(
)DL(
)DD( Converts characters in the charArray to font glyph codes.
Glyph substitution may be performed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( text - an CharacterIterator.
)DT( )BD(Returns:)ES(
)DD( a GlyphSet containing a collection of glyphs and glyph positions.
)DT( )BD(See Also:)ES(
)DD( CharacterIterator
)LD(
)LD(
o )WB()EA(
)BD(getGlyphSet)ES()EA(
)PR(
public )A(GlyphSet)EA( getGlyphSet\201String str\202
)RP(
)DL(
)DD( Converts all characters in the String Object to font glyph codes.
Glyph substitution may be performed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( str - a String object.
)DT( )BD(Returns:)ES(
)DD( a GlyphSet containing a collection of glyphs and glyph positions.
)LD(
)LD(
o )WB()EA(
)BD(canDisplay)ES()EA(
)PR(
public boolean canDisplay\201char c\202
)RP(
)DL(
)DD( Checks if this font has a glyph for the specified character.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( c - a unicode character code.
)DT( )BD(Returns:)ES(
)DD( true if the font can display the character.
)LD(
)LD(
o )WB()EA(
)BD(canDisplayUpTo)ES()EA(
)PR(
public int canDisplayUpTo\201String str\202
)RP(
)DL(
)DD( Indicates whether a string is displayable by this Font.
For strings with Unicode encoding, it is important to know if a given
Font can display the string. This method returns an offset
into the String str which is the first character the Font
cannot display without using the missing glyph code. If the Font can
display all characters, -1 is returned.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( str - a String object.
)DT( )BD(Returns:)ES(
)DD( an offset into the String object that can be displayed by this
font.
)LD(
)LD(
o )WB()EA(
)BD(canDisplayUpTo)ES()EA(
)PR(
public int canDisplayUpTo\201CharacterIterator iter\202
)RP(
)DL(
)DD( Indicates whether a string is displayable by this Font.
For strings with Unicode encoding, it is important to know if a given
Font can display the string. This method returns an offset
into the String str which is the first character the Font
cannot display without using the missing glyph code . If the Font can
display all characters, -1 is returned.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( text - a CharacterIterator object.
)DT( )BD(Returns:)ES(
)DD( an offset into the String object that can be displayed by this
font.
)LD(
)LD(
o )WB()EA(
)BD(getBaselineOffset)ES()EA(
)PR(
public float getBaselineOffset\201byte baselineType\202
)RP(
)DL(
)DD( Returns the offset from the roman baseline of the font to the specified
baseline.
)0 P(
)LD(
o )WB()EA(
)BD(getAscent)ES()EA(
)PR(
public float getAscent\201\202
)RP(
)DL(
)DD( Returns the ascent of the font above the roman baseline.
)0 P(
)LD(
o )WB()EA(
)BD(getDescent)ES()EA(
)PR(
public float getDescent\201\202
)RP(
)DL(
)DD( Returns the descent of the font above the roman baseline.
)0 P(
)LD(
o )WB()EA(
)BD(getLeading)ES()EA(
)PR(
public float getLeading\201\202
)RP(
)DL(
)DD( Returns the leading for this font;
)0 P(
)LD(
o )WB()EA(
)BD(getMaxAdvance)ES()EA(
)PR(
public float getMaxAdvance\201\202
)RP(
)DL(
)DD( Returns the maximum advance of any glyph in this font.
)0 P(
)LD(
o )WB()EA(
)BD(getMaxLSB)ES()EA(
)PR(
public float getMaxLSB\201\202
)RP(
)DL(
)DD( Returns the maximum left side bearing of any glyph in this font.
)0 P(
)LD(
o )WB()EA(
)BD(getMaxRSB)ES()EA(
)PR(
public float getMaxRSB\201\202
)RP(
)DL(
)DD( Returns the maximum right side bearing of any glyph in this font.
)0 P(
)LD(
o )WB()EA(
)BD(getXHeight)ES()EA(
)PR(
public float getXHeight\201\202
)RP(
)DL(
)DD( Returns the x-height for this font.
)0 P(
)LD(
o )WB()EA(
)BD(getCapHeight)ES()EA(
)PR(
public float getCapHeight\201\202
)RP(
)DL(
)DD( Returns the cap height of this font.
)0 P(
)LD(
o )WB()EA(
)BD(getMaxBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getMaxBounds2D\201\202
)RP(
)DL(
)DD( Returns the maximum bounding box of this font.
)0 P(
)LD(
o )WB()EA(
)BD(getItalicAngle)ES()EA(
)PR(
public float getItalicAngle\201\202
)RP(
)DL(
)DD( Returns the italic angle of this font.
)0 P(
)LD(
o )WB()EA(
)BD(getBestFontFor)ES()EA(
)PR(
public static )A(Font)EA( getBestFontFor\201AttributedCharacterIterator text\202
)RP(
o )WB()EA(
)BD(finalize)ES()EA(
)PR(
protected void finalize\201\202 throws Throwable
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(finalize)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.GradientPaint
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.GradientPaint
)EH(
)PR(
java.lang.Object
|
+----java.awt.GradientPaint
)RP(
)HR(
)DL(
)DT( public class )BD(GradientPaint)ES(
)DT( extends Object
)DT( implements )A(Paint)EA(
)LD(
This class provides a way to fill a shape with a linear color gradient
pattern.
Given two points in user space, P1 with the color C1 and P2 with the
color C2, the color
on the P1, P2 connecting line is changed from C1 to C2 proportionally to
the distance to P1. All the points on the extended line on the P1 side
have the color C1 and on the P2 side have the color C2. Any point P not
on the extended P1, P2 connecting line has the color of the point P' that
is the perpendicular projection of P on the extended P1, P2 connecting line.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(Paint)EA(, )A(setPaint)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GradientPaint)ES()EA(\201float, float, Color, float, float, Color\202
)DD( Constructs a GradientPaint object.
)DT( o )WB(
)A()BD(GradientPaint)ES()EA(\201Point2D, Color, Point2D, Color\202
)DD( Constructs a GradientPaint object.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createContext)ES()EA(\201ColorModel, Rectangle, Rectangle2D, AffineTransform\202
)DD( Creates and returns a context used to generate the color pattern.
)DT( o )WB(
)A()BD(getTransparency)ES()EA(\201\202
)DD( Return the transparency mode for this GradientPaint.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GradientPaint)ES(
)PR(
public GradientPaint\201float x1,
float y1,
)A(Color)EA( color1,
float x2,
float y2,
)A(Color)EA( color2\202
)RP(
)DL(
)DD( Constructs a GradientPaint object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x1,y1 - Coordinates of the 1st point in user space.
)DD( color1 - Color at the 1st point.
)DD( x2,y2 - Coordinates of the 2nd point in user space.
)DD( color2 - Color at the 2nd point.
)LD(
)LD(
o )WB()EA(
)BD(GradientPaint)ES(
)PR(
public GradientPaint\201)A(Point2D)EA( pt1,
)A(Color)EA( color1,
)A(Point2D)EA( pt2,
)A(Color)EA( color2\202
)RP(
)DL(
)DD( Constructs a GradientPaint object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( pt1 - Coordinates of the 1st point in user space.
)DD( color1 - Color at the 1st point.
)DD( pt2 - Coordinates of the 2nd point in user space.
)DD( color2 - Color at the 2nd point.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(createContext)ES()EA(
)PR(
public )A(PaintContext)EA( createContext\201)A(ColorModel)EA( cm,
)A(Rectangle)EA( deviceBounds,
)A(Rectangle2D)EA( userBounds,
)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Creates and returns a context used to generate the color pattern.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( cm - ColorModel in which the caller wishes to receive the
paint data. This is used only as a hint.
)DD( deviceBounds - The rectangle describing the bounding box in
device space of the graphics primitive being rendered.
)DD( userBounds - The rectangle describing the bounding box in
user space of the graphics primitive being rendered.
)DD( xform - The Transform from user space into device space.
)DT( )BD(Returns:)ES(
)DD( The PaintContext for generating color patterns.
)DT( )BD(See Also:)ES(
)DD( )A(PaintContext)EA(
)LD(
)LD(
o )WB()EA(
)BD(getTransparency)ES()EA(
)PR(
public int getTransparency\201\202
)RP(
)DL(
)DD( Return the transparency mode for this GradientPaint.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Transparency)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.Graphics2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.Graphics2D
)EH(
)PR(
java.lang.Object
|
+----java.awt.Graphics
|
+----java.awt.Graphics2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Graphics2D)ES(
)DT( extends Graphics
)LD(
This is the fundamental class for 2D rendering in Java. This
class extends the original java.awt.Graphics class to provide
more sophisticated control over geometry, coordinate
transformation, color management, and text layout.
)0 2 H(Coordinate Spaces)EH(
All coordinates that are given to a Graphics2D object are treated
as being in a virtual coordinate system which is called the User
Coordinate Space, or User Space. The Graphics2D object contains
a Transform object as part of its rendering state that defines
how to convert coordinates from this user space to coordinates
in the Device Coordinate Space, or Device Space.
)0 P(
Coordinates in device space usually refer to individual device pixels
and are aligned in the infinitely thin gaps between these pixels.
Some Graphics2D objects may be used to capture rendering operations
for storage into a graphics metafile for playback on a concrete
device of unknown physical resolution at a later time. Since the
resolution may not be known when the rendering operations are
captured, the Transform will be set up to transform user coordinates
to a virtual device space that typically approximates the expected
resolution of the target device, though further transformation may
need to be applied at playback time if the estimate is incorrect.
)0 P(
Some of the operations performed by the rendering attribute objects
may operate in the device space, but all methods that are defined
on the Graphics2D object work with user space coordinates.
)0 P(
The default transform)EA( when a Graphics2D
object is created will be specified by the GraphicsConfiguration for
the target of the Graphics2D \201a Component or Image\202.
This default transform will map the user space coordinate system
to screen and printer device coordinates such that the origin
maps to the upper left hand corner of the
target region of the device with increasing X coordinates extending
to the right and increasing Y coordinates extending downward.
The scaling of the default transform for screen devices will be set
to identity for screen devices.
The scaling of the default transform for printers and other high
resolution devices will be set to approximate 72 user space coordinates
per device inch.
For image buffers, the default transform will be the Identity transform.
)0 2 H(Rendering Outline)EH(
Rendering in the Java 2D API can be described by a 4-step conceptual process
controlled by the various rendering attributes in the Graphics2D object.
The renderer may optimize many of these steps, either by caching the
results for future calls, by collapsing multiple virtual steps into
a single operation, or by recognizing various attributes as common
simple cases that can be eliminated by modifying other parts of the
operation.
)0 P(
As a behavioral reference, the steps can be described in the following
way:
)OL(
)LI(
Determine where to render. This step can be further broken down
according to the type of rendering operation as follows:
)BR(
)BD(Shape operations)EA()ES(
)OL(
)LI(
If the operation is a draw\201Shape\202 operation, then the shape is converted
into a shape to fill using the
)A(createStrokedShape\201\202)EA(
method on the current )A(Stroke)EA(.
)LI(
The shape is transformed from user space to device space using the
current )A(Transform)EA(.
)LI(
The outline of the Shape is extracted using a
)A(PathIterator)EA( using the
)A(Shape.getPathIterator\201\202)EA(
method.
)LI(
If the Graphics2D object is not able to handle the curved segments
that a PathIterator object can return, then it may call the alternat
getPathIterator\201\202 method which flattens the shape.
)LO(
)BD(Text operations)EA()ES(
)OL(
)LI(
The set of glyphs required to render the indicated string
are determined as follows:
)UL(
)LI(
If the argument is a String, then the current
)A(Font)EA( is asked to convert the
Unicode characters in the String into a GlyphSet with whatever
basic layout algorithm the font implements.
)LI(
If the argument is a
)A(StyledString)EA(,
the StyledString is asked to convert itself to a GlyphSet
according to its embedded font attributes. The StyledString
may implement more sophisticated glyph layout algorithms that
perform Unicode bi-directional layout adjustments automatically
for multiple fonts of differing writing directions.
)LI(
If the argument is a
)A(GlyphSet)EA(, then the GlyphSet
object already contains the appropriate font-specific glyph codes
with explicit coordinates for the position of each glyph.
)LU(
)LI(
The current Font is queried to obtain outlines for the indicated
glyphs. These outlines are treated as shapes in user space relative
to the position of each glyph that was determined in step 1.
)LI(
The outline of the characters are filled as indicated above
under )A(Shape operations)EA(
)LO(
)BD(Image operations)EA()ES(
)OL(
)LI(
The bounding box of the source image defines the region of interest
in a coordinate system local to the Image object, called Image Space.
)LI(
If an optional transform is supplied to the
)A(drawImage\201\202)EA(
method call, then this transform is used to transform the bounding
box from image space to user space, otherwise the bounding box is
treated as if it already was in user space.
)LI(
The bounding box of the source image is then transformed from user
space into device space using the current transform of the Graphics2D.
Note that the result of transforming the bounding box will not
necessarily result in a rectangular region in device space and
for some custom transforms may not even result in a quadrilateral
region.
)LO(
)LI(
Constrain the rendering operation to the current Clip. The clip
was originally specified by a shape in user space and was converted
into device space by the Transform in effect at the time it was
modified.
)LI(
Determine what colors to render as the renderer scan converts the
associated shape in device space.
)UL(
)LI(
For image operations, the colors are determined from the Image
object itself sampled according to the source to destination
coordinate mapping specified by the current transform and the
optional image transform.
)LI(
For all other operations, the current
)A(Paint)EA( or
)A(Color)EA( object is queried for a
)A(PaintContext)EA( which specifies
what colors are to be rendered in device space.
)LU(
)LI(
Apply the colors to the destination drawing surface using the current
)A(Composite)EA( object.
)LO(
)0 2 H(Default values)EH(
The default values for the various rendering attributes are:
)DL(
)DT()I(Color)ES(
)DD(The color of the Component.
)DT()I(Font)ES(
)DD(The font of the Component.
)DT()I(Stroke)ES(
)DD(A square pen with a linewidth of 1, no dashing, miter segment joins
and non-projecting end caps.
)DT()I(Transform)ES(
)DD(The )A(default)EA( for the
GraphicsConfiguration of the Component.
)DT()I(Composite)ES(
)DD(The Porter-Duff
)A(Source Over
Destination)EA( rule.
)DT()I(Clip)ES(
)DD(No rendering clip, output is clipped to the Component
)LD(
)0 2 H(Rendering compatibility issue)EH(
The rendering model presented by the pre-Java 2D API Graphics class
was based on a pixelization model that specified that coordinates
were infinitely thin, lying between the pixels, and that drawing
operations were performed by dragging a one-pixel square Pen along
the path hanging down and to the right of the anchor point on the
path.
)0 P(
The behavior of these operations given the model presented here is
unclear if the current Stroke specifies a wide pen, or if there
is a non-identity Transform being applied.
)0 P(
That rendering model was consistent with the capabilities of most
of the existing class of platform renderers that needed to resolve
integer coordinates to a discrete pen that must fall completely on
a given number of pixels. Since the Java 2D API is capable of driving an
antialiasing renderer it no longer makes sense to choose a bias
direction for a wide pen since sub-pixel positioning of the pen
can be made visible to the user via the blending that occurs along
the edges of the traversal of the pen. It is thus, no longer true
that a 1-pixel wide pen must choose to fall on pixel N as opposed
to pixel N+1; it can now fall partially on both pixels.
)0 P(
When antialiasing is turned off with the ANTIALIAS_OFF hint, the
underlying renderer may still need to apply a bias in order to
resolve the conflict of which pixel to modify when the pen is
exactly straddling a pixel boundary \201such as when it is drawn
along an integer coordinate in device space\202. But when
antialiasing is enabled, no biasing of the pen needs to occur
and so no bias should be explicitly specified by the rendering
model.
)0 P(
Thus, there remains the problem of how to define the operation of
the legacy rendering operations inherited from the Graphics class
to be compatible with existing rendering behavior and to be
predictable and unsurprising under all possible settings of the
latest rendering attributes.
)0 P(
To provide predictability we will define operations for all of the
legacy methods that map onto the more general draw\201Shape\202 and fill\201Shape\202
methods. Such a specification will thus be clear how it extends
based on various settings of Stroke and Transform attributes,
and rendering hints.
)0 P(
To provide compatibility with previous rendering behavior it is
important to specify a definition that performs identically under
the default attribute settings. In particular, the default Stroke
is a )A(BasicStroke)EA(
with a width of 1 and no dashing, and the default
Transform for screen drawing is an Identity transform. Unfortunately,
the default antialiasing rendering hint is ANTIALIAS_DEFAULT which
may be enabled on some implementations and not on others. This
means that the definition of these operations needs to be invariant
under antialiasing.
)0 P(
We now define the following generalizations of the various legacy
methods which can be shown to be identical to the previously
specified behavior under the default attributes:
)UL(
)LI(
For fill operations, which include fillRect, fillRoundRect, fillOval,
fillArc, fillPolygon, and clearRect, we could create a GeneralPath, gp,
that traverses the same integer coordinates and call:
)PR(
fill\201gp\202;
)RP(
)LI(
For draw operations, which include drawLine, drawRect, drawRoundRect,
drawOval, drawArc, drawPolyline, and drawPolygon, we could create a
GeneralPath, gp, that traverses the same integer coordinates and call:
)PR(
AffineTransform at = new AffineTransform\2011f,0f,0f,1f,0.5f,0.5f\202;
draw\201at.createTransformedShape\201bp\202\202;
)RP(
)LI(
The draw3DRect and fill3DRect methods were implemented in terms
of the drawLine and fillRect methods and their behavior is thus
extended as well.
)LU(
The existing Graphics class defined only the single setColor
method to control the color to be painted. Since the Java 2D API extends
the Color object to implement the new Paint interface, the existing
setColor method is now a convenience method for setting the current
Paint to a Color object. )TT(setColor\201c\202)ES( is thus equivalent to
)TT(setPaint\201c\202)ES(.
)0 P(
The existing Graphics class defined two methods for controlling
how colors were applied to the destination.
The setPaintMode\201\202 method will now be implemented as a convenience
method to set the default Composite, equivalent to
)TT(setComposite\201new AlphaComposite\201SRC_OVER\202\202)ES(.
The setXORMode\201Color xorcolor\202 method will now be implemented
as a convenience method to set a special Composite object which
ignores the Alpha components of source colors and sets the
destination color to the value:
)PR(
dstpixel = \201PixelOf\201srccolor\202 ^ PixelOf\201xorcolor\202 ^ dstpixel\202;
)RP(
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ANTIALIAS_DEFAULT)ES()EA(
)DD( Rendering is done with the platform default antialiasing mode.
)DT( o )WB(
)A()BD(ANTIALIAS_OFF)ES()EA(
)DD( Rendering is done without antialiasing.
)DT( o )WB(
)A()BD(ANTIALIAS_ON)ES()EA(
)DD( Rendering is done with antialiasing.
)DT( o )WB(
)A()BD(ANTIALIASING)ES()EA(
)DD( Antialiasing hint category.
)DT( o )WB(
)A()BD(RENDER_DEFAULT)ES()EA(
)DD( The platform default algorithms are chosen for rendering.
)DT( o )WB(
)A()BD(RENDER_QUALITY)ES()EA(
)DD( Appropriate rendering algorithms are chosen with a preference
for output quality.
)DT( o )WB(
)A()BD(RENDER_SPEED)ES()EA(
)DD( Appropriate rendering algorithms are chosen with a preference
for output speed.
)DT( o )WB(
)A()BD(RENDERING)ES()EA(
)DD( Rendering hint category.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Graphics2D)ES()EA(\201\202
)DD( Constructs a new Graphics2D object.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(clip)ES()EA(\201Shape\202
)DD( Intersects the current clip with the interior of the specified Shape
and sets the current clip to the resulting intersection.
)DT( o )WB(
)A()BD(draw)ES()EA(\201Shape\202
)DD( Strokes the outline of a Shape using the settings of the current
graphics state.
)DT( o )WB(
)A()BD(drawImage)ES()EA(\201BufferedImage, BufferedImageOp, int, int\202
)DD( Draws a BufferedImage that is filtered with a BufferedImageOp.
)DT( o )WB(
)A()BD(drawImage)ES()EA(\201Image, AffineTransform, ImageObserver\202
)DD( Draws an image, applying a transform from image space into user space
before drawing.
)DT( o )WB(
)A()BD(drawString)ES()EA(\201GlyphSet, float, float\202
)DD( Draws a GlyphSet.
)DT( o )WB(
)A()BD(drawString)ES()EA(\201String, float, float\202
)DD( Draws a string of text.
)DT( o )WB(
)A()BD(drawString)ES()EA(\201StyledString, float, float\202
)DD( Draws a StyledString.
)DT( o )WB(
)A()BD(drawString)ES()EA(\201TextLayout, float, float\202
)DD(
)DT( o )WB(
)A()BD(fill)ES()EA(\201Shape\202
)DD( Fills the interior of a Shape using the settings of the current
graphics state.
)DT( o )WB(
)A()BD(getBackground)ES()EA(\201\202
)DD( Returns the background color used for clearing a region.
)DT( o )WB(
)A()BD(getComposite)ES()EA(\201\202
)DD( Returns the current Composite in the Graphics2D state.
)DT( o )WB(
)A()BD(getDeviceConfiguration)ES()EA(\201\202
)DD( Returns the device configuration associated with this Graphics2D.
)DT( o )WB(
)A()BD(getPaint)ES()EA(\201\202
)DD( Returns the current Paint in the Graphics2D state.
)DT( o )WB(
)A()BD(getRenderingHints)ES()EA(\201int\202
)DD( Returns the preferences for the rendering algorithms.
)DT( o )WB(
)A()BD(getStroke)ES()EA(\201\202
)DD( Returns the current Stroke in the Graphics2D state.
)DT( o )WB(
)A()BD(getTransform)ES()EA(\201\202
)DD( Returns the current Transform in the Graphics2D state.
)DT( o )WB(
)A()BD(hit)ES()EA(\201Rectangle, Shape, boolean\202
)DD( Checks to see if the outline of a Shape intersects the specified
Rectangle in device space.
)DT( o )WB(
)A()BD(hitString)ES()EA(\201Rectangle, StyledString, float, float\202
)DD( Checks to see if the StyledString intersects the specified Rectangle
in device space.
)DT( o )WB(
)A()BD(setBackground)ES()EA(\201Color\202
)DD( Sets the background color in this context used for clearing a region.
)DT( o )WB(
)A()BD(setComposite)ES()EA(\201Composite\202
)DD( Sets the Composite in the current graphics state.
)DT( o )WB(
)A()BD(setPaint)ES()EA(\201Paint\202
)DD( Sets the Paint in the current graphics state.
)DT( o )WB(
)A()BD(setRenderingHints)ES()EA(\201int, int\202
)DD( Sets the preferences for the rendering algorithms.
)DT( o )WB(
)A()BD(setStroke)ES()EA(\201Stroke\202
)DD( Sets the Stroke in the current graphics state.
)DT( o )WB(
)A()BD(setTransform)ES()EA(\201AffineTransform\202
)DD( Sets the Transform in the current graphics state.
)DT( o )WB(
)A()BD(transform)ES()EA(\201AffineTransform\202
)DD( Composes a Transform object with the transform in this
Graphics2D according to the rule last-specified-first-applied.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(ANTIALIASING)ES(
)PR(
public static final int ANTIALIASING
)RP(
)DL(
)DD( Antialiasing hint category.)0 P(
)LD(
o )WB()EA(
)BD(ANTIALIAS_ON)ES(
)PR(
public static final int ANTIALIAS_ON
)RP(
)DL(
)DD( Rendering is done with antialiasing.)0 P(
)LD(
o )WB()EA(
)BD(ANTIALIAS_OFF)ES(
)PR(
public static final int ANTIALIAS_OFF
)RP(
)DL(
)DD( Rendering is done without antialiasing.)0 P(
)LD(
o )WB()EA(
)BD(ANTIALIAS_DEFAULT)ES(
)PR(
public static final int ANTIALIAS_DEFAULT
)RP(
)DL(
)DD( Rendering is done with the platform default antialiasing mode.)0 P(
)LD(
o )WB()EA(
)BD(RENDERING)ES(
)PR(
public static final int RENDERING
)RP(
)DL(
)DD( Rendering hint category.)0 P(
)LD(
o )WB()EA(
)BD(RENDER_SPEED)ES(
)PR(
public static final int RENDER_SPEED
)RP(
)DL(
)DD( Appropriate rendering algorithms are chosen with a preference
for output speed.)0 P(
)LD(
o )WB()EA(
)BD(RENDER_QUALITY)ES(
)PR(
public static final int RENDER_QUALITY
)RP(
)DL(
)DD( Appropriate rendering algorithms are chosen with a preference
for output quality.)0 P(
)LD(
o )WB()EA(
)BD(RENDER_DEFAULT)ES(
)PR(
public static final int RENDER_DEFAULT
)RP(
)DL(
)DD( The platform default algorithms are chosen for rendering.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Graphics2D)ES(
)PR(
protected Graphics2D\201\202
)RP(
)DL(
)DD( Constructs a new Graphics2D object. Since Graphics2D is an abstract
class, and since it must be customized by subclasses for different
output devices, Graphics2D objects cannot be created directly.
Instead, Graphics2D objects must be obtained from another Graphics2D
object or created by a Component.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( getGraphics, create
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(draw)ES()EA(
)PR(
public abstract void draw\201)A(Shape)EA( s\202
)RP(
)DL(
)DD( Strokes the outline of a Shape using the settings of the current
graphics state. The rendering attributes applied include the
clip, transform, paint or color, composite and stroke attributes.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - The shape to be drawn.
)DT( )BD(See Also:)ES(
)DD( )A(setStroke)EA(, )A(setPaint)EA(, setColor, )A(transform)EA(, )A(setTransform)EA(, )A(clip)EA(, setClip, )A(setComposite)EA(
)LD(
)LD(
o )WB()EA(
)BD(drawImage)ES()EA(
)PR(
public abstract void drawImage\201Image img,
)A(AffineTransform)EA( xform,
ImageObserver obs\202
)RP(
)DL(
)DD( Draws an image, applying a transform from image space into user space
before drawing.
The transformation from user space into device space is done with
the current transform in the Graphics2D.
The given transformation is applied to the image before the
transform attribute in the Graphics2D state is applied.
The rendering attributes applied include the clip, transform,
and composite attributes. Note that the result is
undefined, if the given transform is noninvertible.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( img - The image to be drawn.
)DD( xform - The transformation from image space into user space.
)DD( obs - The image observer to be notified as more of the image
is converted.
)DT( )BD(See Also:)ES(
)DD( )A(transform)EA(, )A(setTransform)EA(, )A(setComposite)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(drawImage)ES()EA(
)PR(
public abstract void drawImage\201)A(BufferedImage)EA( img,
)A(BufferedImageOp)EA( op,
int x,
int y\202
)RP(
)DL(
)DD( Draws a BufferedImage that is filtered with a BufferedImageOp.
The rendering attributes applied include the clip, transform
and composite attributes. This is equivalent to:
)PR(
img1 = op.filter\201img, null\202;
drawImage\201img1, new AffineTransform\2011f,0f,0f,1f,x,y\202, null\202;
)RP(
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( op - The filter to be applied to the image before drawing.
)DD( img - The BufferedImage to be drawn.
)DD( x,y - The location in user space where the image should be drawn.
)DT( )BD(See Also:)ES(
)DD( )A(transform)EA(, )A(setTransform)EA(, )A(setComposite)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(drawString)ES()EA(
)PR(
public abstract void drawString\201String s,
float x,
float y\202
)RP(
)DL(
)DD( Draws a string of text.
The rendering attributes applied include the clip, transform,
paint or color, font and composite attributes.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - The string to be drawn.
)DD( x,y - The coordinates where the string should be drawn.
)DT( )BD(See Also:)ES(
)DD( )A(setPaint)EA(, setColor, setFont, )A(transform)EA(, )A(setTransform)EA(, )A(setComposite)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(drawString)ES()EA(
)PR(
public abstract void drawString\201)A(StyledString)EA( s,
float x,
float y\202
)RP(
)DL(
)DD( Draws a StyledString.
The rendering attributes applied include the clip, transform,
paint or color, and composite attributes. A Font is associated
with each character in the StyledString.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - The StyledString to be drawn.
)DD( x,y - The coordinates where the StyledString should be drawn.
)DT( )BD(See Also:)ES(
)DD( )A(setPaint)EA(, setColor, )A(transform)EA(, )A(setTransform)EA(, )A(setComposite)EA(, )A(clip)EA(, setClip, )A(Font)EA(
)LD(
)LD(
o )WB()EA(
)BD(drawString)ES()EA(
)PR(
public abstract void drawString\201)A(GlyphSet)EA( g,
float x,
float y\202
)RP(
)DL(
)DD( Draws a GlyphSet.
The rendering attributes applied include the clip, transform,
paint or color, and composite attributes. The glyphSet specifies
individual glyphs from a Font.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( g - The GlyphSet to be drawn.
)DD( x,y - The coordinates where the glyphs should be drawn.
)DT( )BD(See Also:)ES(
)DD( )A(setPaint)EA(, setColor, )A(transform)EA(, )A(setTransform)EA(, )A(setComposite)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(drawString)ES()EA(
)PR(
public abstract void drawString\201)A(TextLayout)EA( text,
float x,
float y\202
)RP(
o )WB()EA(
)BD(fill)ES()EA(
)PR(
public abstract void fill\201)A(Shape)EA( s\202
)RP(
)DL(
)DD( Fills the interior of a Shape using the settings of the current
graphics state. The rendering attributes applied include the
clip, transform, paint or color, and composite.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(setPaint)EA(, setColor, )A(transform)EA(, )A(setTransform)EA(, )A(setComposite)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(hit)ES()EA(
)PR(
public abstract boolean hit\201)A(Rectangle)EA( rect,
)A(Shape)EA( s,
boolean onStroke\202
)RP(
)DL(
)DD( Checks to see if the outline of a Shape intersects the specified
Rectangle in device space.
The rendering attributes taken into account include the
clip, transform, and stroke attributes.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rect - The area in device space to check for a hit.
)DD( s - The shape to check for a hit.
)DD( onStroke - Flag to choose between testing the stroked or
the filled shape.
)DT( )BD(Returns:)ES(
)DD( True if there is a hit, false otherwise.
)DT( )BD(See Also:)ES(
)DD( )A(setStroke)EA(, )A(fill)EA(, )A(draw)EA(, )A(transform)EA(, )A(setTransform)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(hitString)ES()EA(
)PR(
public abstract boolean hitString\201)A(Rectangle)EA( rect,
)A(StyledString)EA( s,
float x,
float y\202
)RP(
)DL(
)DD( Checks to see if the StyledString intersects the specified Rectangle
in device space.
The rendering attributes taken into account include the clip
and transform.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rect - The area in device space to check for a hit.
)DD( s - The StyledString to check for a hit.
)DD( x,y - The coordinates where the StyledString should be
hit tested.
)DT( )BD(Returns:)ES(
)DD( True if there is a hit, false otherwise.
)DT( )BD(See Also:)ES(
)DD( )A(drawString)EA(, )A(transform)EA(, )A(setTransform)EA(, )A(clip)EA(, setClip
)LD(
)LD(
o )WB()EA(
)BD(getDeviceConfiguration)ES()EA(
)PR(
public abstract )A(GraphicsConfiguration)EA( getDeviceConfiguration\201\202
)RP(
)DL(
)DD( Returns the device configuration associated with this Graphics2D.
)0 P(
)LD(
o )WB()EA(
)BD(setComposite)ES()EA(
)PR(
public abstract void setComposite\201)A(Composite)EA( comp\202
)RP(
)DL(
)DD( Sets the Composite in the current graphics state. Composite is used
in all drawing methods such as drawImage, drawString, draw,
and fill. It specifies how new pixels are to be combined with
the existing pixels on the graphics device in the rendering process.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( comp - The Composite object to be used for drawing.
)DT( )BD(See Also:)ES(
)DD( setXORMode, setPaintMode, )A(AlphaComposite)EA(
)LD(
)LD(
o )WB()EA(
)BD(setPaint)ES()EA(
)PR(
public abstract void setPaint\201)A(Paint)EA( paint\202
)RP(
)DL(
)DD( Sets the Paint in the current graphics state.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( paint - The Paint object to be used to generate color in
the rendering process.
)DT( )BD(See Also:)ES(
)DD( setColor, )A(GradientPaint)EA(, )A(TexturePaint)EA(
)LD(
)LD(
o )WB()EA(
)BD(setStroke)ES()EA(
)PR(
public abstract void setStroke\201)A(Stroke)EA( s\202
)RP(
)DL(
)DD( Sets the Stroke in the current graphics state.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - The Stroke object to be used to stroke a Shape in
the rendering process.
)DT( )BD(See Also:)ES(
)DD( )A(BasicStroke)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRenderingHints)ES()EA(
)PR(
public abstract void setRenderingHints\201int hintCategory,
int hintValue\202
)RP(
)DL(
)DD( Sets the preferences for the rendering algorithms.
Hint categories include controls for rendering quality and
overall time/quality trade-off in the rendering process.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hintCategory - The category of hint to be set. Possible values
are ANTIALIASING and RENDERING.
)DD( hintValue - The value indicating preferences for the specified
hint category. Possible values for the ANTIALIASING category are
ANTIALIAS_ON, ANTIALIAS_OFF, ANTIALIAS_DEFAULT. Possible values for
the RENDERING hint are RENDER_SPEED, RENDER_QUALITY, RENDER_DEFAULT.
)DT( )BD(See Also:)ES(
)DD( )A(ANTIALIASING)EA(, )A(RENDERING)EA(, )A(ANTIALIAS_ON)EA(, )A(ANTIALIAS_OFF)EA(, )A(ANTIALIAS_DEFAULT)EA(, )A(RENDER_SPEED)EA(, )A(RENDER_QUALITY)EA(, )A(RENDER_DEFAULT)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRenderingHints)ES()EA(
)PR(
public abstract int getRenderingHints\201int hintCategory\202
)RP(
)DL(
)DD( Returns the preferences for the rendering algorithms.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hintCategory - The category of hint to be set. Possible values
are ANTIALIASING and RENDERING.
)DT( )BD(Returns:)ES(
)DD( The preferences for rendering algorithms. Possible values for
the ANTIALIASING category are ANTIALIAS_ON, ANTIALIAS_OFF,
ANTIALIAS_DEFAULT. Possible values for the RENDERING hint are
RENDER_SPEED, RENDER_QUALITY, RENDER_DEFAULT.
)DT( )BD(See Also:)ES(
)DD( )A(ANTIALIASING)EA(, )A(RENDERING)EA(, )A(ANTIALIAS_ON)EA(, )A(ANTIALIAS_OFF)EA(, )A(ANTIALIAS_DEFAULT)EA(, )A(RENDER_SPEED)EA(, )A(RENDER_QUALITY)EA(, )A(RENDER_DEFAULT)EA(
)LD(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public abstract void transform\201)A(AffineTransform)EA( Tx\202
)RP(
)DL(
)DD( Composes a Transform object with the transform in this
Graphics2D according to the rule last-specified-first-applied.
If the currrent transform is Cx, the result of composition
with Tx is a new transform Cx'. Cx' becomes the current
transform for this Graphics2D.
Transforming a point p by the updated transform Cx' is
equivalent to first transforming p by Tx and then transforming
the result by the original transform Cx. In other words,
Cx'\201p\202 = Cx\201Tx\201p\202\202.
A copy of the Tx is made, if necessary, so further
modifications to Tx do not affect rendering.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( Tx - The Transform object to be composed with the current
transform.
)DT( )BD(See Also:)ES(
)DD( )A(setTransform)EA(, TransformChain, )A(AffineTransform)EA(
)LD(
)LD(
o )WB()EA(
)BD(setTransform)ES()EA(
)PR(
public abstract void setTransform\201)A(AffineTransform)EA( Tx\202
)RP(
)DL(
)DD( Sets the Transform in the current graphics state.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( Tx - The Transform object to be used in the rendering process.
)DT( )BD(See Also:)ES(
)DD( )A(transform)EA(, TransformChain, )A(AffineTransform)EA(
)LD(
)LD(
o )WB()EA(
)BD(getTransform)ES()EA(
)PR(
public abstract )A(AffineTransform)EA( getTransform\201\202
)RP(
)DL(
)DD( Returns the current Transform in the Graphics2D state.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(transform)EA(, )A(setTransform)EA(
)LD(
)LD(
o )WB()EA(
)BD(getPaint)ES()EA(
)PR(
public abstract )A(Paint)EA( getPaint\201\202
)RP(
)DL(
)DD( Returns the current Paint in the Graphics2D state.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(setPaint)EA(, setColor
)LD(
)LD(
o )WB()EA(
)BD(getComposite)ES()EA(
)PR(
public abstract )A(Composite)EA( getComposite\201\202
)RP(
)DL(
)DD( Returns the current Composite in the Graphics2D state.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(setComposite)EA(
)LD(
)LD(
o )WB()EA(
)BD(setBackground)ES()EA(
)PR(
public abstract void setBackground\201)A(Color)EA( color\202
)RP(
)DL(
)DD( Sets the background color in this context used for clearing a region.
When Graphics2D is constructed for a component, the backgroung color is
inherited from the component. Setting the background color in the
Graphics2D context only affects the subsequent clearRect\201\202 calls and
not the background color of the component. To change the background
of the component, use appropriate methods of the component.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( color - The background color that should be used in
subsequent calls to clearRect\201\202.
)DT( )BD(See Also:)ES(
)DD( getBackground, )A(Graphics.clearRect)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBackground)ES()EA(
)PR(
public abstract )A(Color)EA( getBackground\201\202
)RP(
)DL(
)DD( Returns the background color used for clearing a region.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( setBackground
)LD(
)LD(
o )WB()EA(
)BD(getStroke)ES()EA(
)PR(
public abstract )A(Stroke)EA( getStroke\201\202
)RP(
)DL(
)DD( Returns the current Stroke in the Graphics2D state.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( setStroke
)LD(
)LD(
o )WB()EA(
)BD(clip)ES()EA(
)PR(
public abstract void clip\201)A(Shape)EA( s\202
)RP(
)DL(
)DD( Intersects the current clip with the interior of the specified Shape
and sets the current clip to the resulting intersection.
The indicated shape is transformed with the current transform in the
Graphics2D state before being intersected with the current clip.
This method is used to make the current clip smaller.
To make the clip larger, use any setClip method.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - The Shape to be intersected with the current clip.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.GraphicsConfiguration
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.GraphicsConfiguration
)EH(
)PR(
java.lang.Object
|
+----java.awt.GraphicsConfiguration
)RP(
)HR(
)DL(
)DT( public abstract class )BD(GraphicsConfiguration)ES(
)DT( extends Object
)LD(
This class describes the characteristics of a physical graphics
destination such as a printer or monitor. There can be many
GraphicsConfiguration objects associated with a single graphics device.
For instance, on X11 windowing systems, each visual
is a different GraphicsConfiguration. On PCs and Macintoshes, the
different screen resolution/color resolution combinations would
be different GraphicsConfigurations.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(GraphicsEnvironment)EA(, )A(GraphicsDevice)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GraphicsConfiguration)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleImage)ES()EA(\201int, int\202
)DD( Returns a BufferedImage with channel layout and color model
compatible with this graphics configuration.
)DT( o )WB(
)A()BD(createCompatibleImage)ES()EA(\201int, int, int\202
)DD( Returns a BufferedImage that supports the specified transparency
and has a channel layout and color model
compatible with this graphics configuration.
)DT( o )WB(
)A()BD(getColorModel)ES()EA(\201\202
)DD( Returns the color model associated with this configuration.
)DT( o )WB(
)A()BD(getColorModel)ES()EA(\201int\202
)DD( Returns the color model associated with this configuration that
supports the specified transparency.
)DT( o )WB(
)A()BD(getDefaultTransform)ES()EA(\201\202
)DD( Returns the default Transform for this configuration.
)DT( o )WB(
)A()BD(getDevice)ES()EA(\201\202
)DD( Return the graphics device associated with this configuration.
)DT( o )WB(
)A()BD(getNormalizingTransform)ES()EA(\201\202
)DD(
Returns a Transform that can be composed with the default Transform
of a Graphics2D so that 72 units in user space will equal 1 inch
in device space.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GraphicsConfiguration)ES(
)PR(
public GraphicsConfiguration\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getDevice)ES()EA(
)PR(
public abstract )A(GraphicsDevice)EA( getDevice\201\202
)RP(
)DL(
)DD( Return the graphics device associated with this configuration.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleImage)ES()EA(
)PR(
public abstract )A(BufferedImage)EA( createCompatibleImage\201int width,
int height\202
)RP(
)DL(
)DD( Returns a BufferedImage with channel layout and color model
compatible with this graphics configuration. This method
has nothing to do with memory-mapping
a device. This BufferedImage has
a layout and color model
that is closest to this native device configuration and thus
can be optimally blitted to this device.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleImage)ES()EA(
)PR(
public abstract )A(BufferedImage)EA( createCompatibleImage\201int width,
int height,
int transparency\202
)RP(
)DL(
)DD( Returns a BufferedImage that supports the specified transparency
and has a channel layout and color model
compatible with this graphics configuration. This method
has nothing to do with memory-mapping
a device. This BufferedImage has a layout and
color model that can be optimally blitted to a device
with this configuration.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(OPAQUE)EA(, )A(BITMASK)EA(, )A(TRANSLUCENT)EA(
)LD(
)LD(
o )WB()EA(
)BD(getColorModel)ES()EA(
)PR(
public abstract )A(ColorModel)EA( getColorModel\201\202
)RP(
)DL(
)DD( Returns the color model associated with this configuration.
)0 P(
)LD(
o )WB()EA(
)BD(getColorModel)ES()EA(
)PR(
public abstract )A(ColorModel)EA( getColorModel\201int transparency\202
)RP(
)DL(
)DD( Returns the color model associated with this configuration that
supports the specified transparency.
)0 P(
)LD(
o )WB()EA(
)BD(getDefaultTransform)ES()EA(
)PR(
public abstract )A(AffineTransform)EA( getDefaultTransform\201\202
)RP(
)DL(
)DD( Returns the default Transform for this configuration. This
Transform is typically the Identity transform for most normal
screens. Device coordinates for screen and printer devices will
have the origin in the upper left-hand corner of the target region of
the device, with X coordinates
increasing to the right and Y coordinates increasing downwards.
For image buffers, this Transform will be the Identity transform.
)0 P(
)LD(
o )WB()EA(
)BD(getNormalizingTransform)ES()EA(
)PR(
public abstract )A(AffineTransform)EA( getNormalizingTransform\201\202
)RP(
)DL(
)DD( Returns a Transform that can be composed with the default Transform
of a Graphics2D so that 72 units in user space will equal 1 inch
in device space.
Given a Graphics2D, g, one can reset the transformation to create
such a mapping by using the following pseudocode:
)PR(
GraphicsConfiguration gc = g.getGraphicsConfiguration\201\202;
g.setTransform\201gc.getDefaultTransform\201\202\202;
g.transform\201gc.getNormalizingTransform\201\202\202;
)RP(
Note that sometimes this Transform will be identity \201e.g. for
printers or metafile output\202 and that this Transform is only
as accurate as the information supplied by the underlying system.
For image buffers, this Transform will be the Identity transform,
since there is no valid distance measurement.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.GraphicsDevice
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.GraphicsDevice
)EH(
)PR(
java.lang.Object
|
+----java.awt.GraphicsDevice
)RP(
)HR(
)DL(
)DT( public abstract class )BD(GraphicsDevice)ES(
)DT( extends Object
)LD(
This class describes the graphics devices that may be available
in a graphics environment. These include screen and printer devices.
Note that there may be many screens and many printers in an instance
of GraphicsEnvironment. Each graphics
device has one or more GraphicsConfiguration objects associated with it.
These specify the different configurations in which the GraphicsDevice
can be used.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(GraphicsEnvironment)EA(, )A(GraphicsConfiguration)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TYPE_IMAGE_BUFFER)ES()EA(
)DD( Device is an image buffer.
)DT( o )WB(
)A()BD(TYPE_PRINTER)ES()EA(
)DD( Device is a printer.
)DT( o )WB(
)A()BD(TYPE_RASTER_SCREEN)ES()EA(
)DD( Device is a raster screen.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GraphicsDevice)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getConfigurations)ES()EA(\201\202
)DD( Returns all of the graphics
configurations associated with this graphics device.
)DT( o )WB(
)A()BD(getDefaultConfiguration)ES()EA(\201\202
)DD( Returns the default graphics configuration
associated with this graphics device.
)DT( o )WB(
)A()BD(getIDstring)ES()EA(\201\202
)DD( Returns the identification string associated with this graphics
device.
)DT( o )WB(
)A()BD(getType)ES()EA(\201\202
)DD( Returns the type of the graphics device.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(TYPE_RASTER_SCREEN)ES(
)PR(
public static final int TYPE_RASTER_SCREEN
)RP(
)DL(
)DD( Device is a raster screen.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_PRINTER)ES(
)PR(
public static final int TYPE_PRINTER
)RP(
)DL(
)DD( Device is a printer.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_IMAGE_BUFFER)ES(
)PR(
public static final int TYPE_IMAGE_BUFFER
)RP(
)DL(
)DD( Device is an image buffer. This buffer may reside in device
or system memory but it is not visible to the user.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GraphicsDevice)ES(
)PR(
public GraphicsDevice\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getType)ES()EA(
)PR(
public abstract int getType\201\202
)RP(
)DL(
)DD( Returns the type of the graphics device.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(TYPE_RASTER_SCREEN)EA(, )A(TYPE_PRINTER)EA(, )A(TYPE_IMAGE_BUFFER)EA(
)LD(
)LD(
o )WB()EA(
)BD(getIDstring)ES()EA(
)PR(
public abstract String getIDstring\201\202
)RP(
)DL(
)DD( Returns the identification string associated with this graphics
device.
)0 P(
)LD(
o )WB()EA(
)BD(getConfigurations)ES()EA(
)PR(
public abstract )A(GraphicsConfiguration)EA([] getConfigurations\201\202
)RP(
)DL(
)DD( Returns all of the graphics
configurations associated with this graphics device.
)0 P(
)LD(
o )WB()EA(
)BD(getDefaultConfiguration)ES()EA(
)PR(
public abstract )A(GraphicsConfiguration)EA( getDefaultConfiguration\201\202
)RP(
)DL(
)DD( Returns the default graphics configuration
associated with this graphics device.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.GraphicsEnvironment
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.GraphicsEnvironment
)EH(
)PR(
java.lang.Object
|
+----java.awt.GraphicsEnvironment
)RP(
)HR(
)DL(
)DT( public abstract class )BD(GraphicsEnvironment)ES(
)DT( extends Object
)LD(
This class specifies the graphics environment. The resources in
this environment
might be local or on a remote machine. The graphics environment
consists of a number of GraphicsDevice objects and Font objects.
GraphicsDevice objects are typically screens or printers and are
the destination of Graphics2D drawing methods. Each GraphicsDevice
has a number of GraphicsConfiguration objects associated with it.
These specify the different configurations in which the GraphicsDevice
can be used.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(GraphicsDevice)EA(, )A(GraphicsConfiguration)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GraphicsEnvironment)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createGraphics)ES()EA(\201BufferedImage\202
)DD( Returns a Graphics2D object for rendering into the
given BufferedImage.
)DT( o )WB(
)A()BD(getAllFonts)ES()EA(\201\202
)DD( Returns all fonts available in this environment.
)DT( o )WB(
)A()BD(getDefaultScreenDevice)ES()EA(\201\202
)DD( Returns the default screen graphics device.
)DT( o )WB(
)A()BD(getFont)ES()EA(\201String\202
)DD(
)DT( o )WB(
)A()BD(getFonts)ES()EA(\201TextAttributeSet\202
)DD( Returns all Fonts available in this environment that match
the specified AttributeSet.
)DT( o )WB(
)A()BD(getImagingLib)ES()EA(\201\202
)DD( Returns a ImagingLib object that can used to process
some/all of the imaging ops.
)DT( o )WB(
)A()BD(getLocalGraphicsEnvironment)ES()EA(\201\202
)DD( Returns the local graphics environment.
)DT( o )WB(
)A()BD(getScreenDevices)ES()EA(\201\202
)DD( Returns an array of all of the screen devices.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GraphicsEnvironment)ES(
)PR(
protected GraphicsEnvironment\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getLocalGraphicsEnvironment)ES()EA(
)PR(
public static )A(GraphicsEnvironment)EA( getLocalGraphicsEnvironment\201\202
)RP(
)DL(
)DD( Returns the local graphics environment.
)0 P(
)LD(
o )WB()EA(
)BD(getScreenDevices)ES()EA(
)PR(
public abstract )A(GraphicsDevice)EA([] getScreenDevices\201\202
)RP(
)DL(
)DD( Returns an array of all of the screen devices.
)0 P(
)LD(
o )WB()EA(
)BD(getDefaultScreenDevice)ES()EA(
)PR(
public abstract )A(GraphicsDevice)EA( getDefaultScreenDevice\201\202
)RP(
)DL(
)DD( Returns the default screen graphics device.
)0 P(
)LD(
o )WB()EA(
)BD(createGraphics)ES()EA(
)PR(
public abstract )A(Graphics2D)EA( createGraphics\201)A(BufferedImage)EA( img\202
)RP(
)DL(
)DD( Returns a Graphics2D object for rendering into the
given BufferedImage.
)0 P(
)LD(
o )WB()EA(
)BD(getImagingLib)ES()EA(
)PR(
public abstract ImagingLib getImagingLib\201\202
)RP(
)DL(
)DD( Returns a ImagingLib object that can used to process
some/all of the imaging ops. Can be null.
)0 P(
)LD(
o )WB()EA(
)BD(getAllFonts)ES()EA(
)PR(
public abstract )A(Font)EA([] getAllFonts\201\202
)RP(
)DL(
)DD( Returns all fonts available in this environment.
)0 P(
)LD(
o )WB()EA(
)BD(getFonts)ES()EA(
)PR(
public abstract )A(Font)EA([] getFonts\201)A(TextAttributeSet)EA( attributes\202
)RP(
)DL(
)DD( Returns all Fonts available in this environment that match
the specified AttributeSet.
)0 P(
)LD(
o )WB()EA(
)BD(getFont)ES()EA(
)PR(
public abstract )A(Font)EA( getFont\201String fontFaceName\202
)RP(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.Rectangle
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.Rectangle
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----)A(java.awt.geom.Rectangle2D)EA(
|
+----java.awt.Rectangle
)RP(
)HR(
)DL(
)DT( public class )BD(Rectangle)ES(
)DT( extends )A(Rectangle2D)EA(
)DT( implements )A(Shape)EA(, Serializable
)LD(
A rectangle specifies an area in a coordinate space that is
defined by the rectangle's top-left point \201)I(x)ES(,\240)I(y)ES(\202
in the coordinate space, its width, and its height.
)0 P(
A rectangle's )SM(width)ES( and )SM(height)ES( are
public fields. The constructors that allow you to create a
rectangle, and the methods that allow you to modify one, do not
prevent you from setting a negative value for width or height.
)0 P(
A rectangle whose width or height is negative is considered
empty, and all methods defined by the )SM(Rectangle)ES( class
behave accordingly. If the rectangle is empty, then the method
)SM(isEmpty)ES( returns )SM(true)ES(. No point can be
contained by or inside an empty rectangle, however the values of
)SM(width)ES( and )SM(height)ES( are still valid. An
empty rectangle still has a location in the coordinate space, and
methods that change its size or location remain valid. The
behavior of methods that operate on more than one rectangle is
undefined if any of the participating rectangles has a negative
)SM(width)ES( or )SM(height)ES(. These methods include
)SM(intersects)ES(, )SM(intersection)ES(, and
)SM(union)ES(.
specified in integer coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(height)ES()EA(
)DD( The height of the rectangle.
)DT( o )WB(
)A()BD(width)ES()EA(
)DD( The width of the rectangle.
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The )I(x)ES( coordinate of the rectangle.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The )I(y)ES( coordinate of the rectangle.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201\202
)DD( Constructs a new rectangle whose top-left corner is at \2010,\2400\202
in the coordinate space, and whose width and height are zero.
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201Dimension\202
)DD( Constructs a new rectangle whose top left corner is
\2010,\2400\202 and whose width and height are specified
by the )SM(dimension)ES( argument.
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201int, int\202
)DD( Constructs a new rectangle whose top-left corner is at \2010,\2400\202
in the coordinate space, and whose width and height are specified
by the arguments of the same name.
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201int, int, int, int\202
)DD( Constructs a new rectangle whose top-left corner is specified as
\201)SM(x)ES(,\240)SM(y)ES(\202 and whose width and height
are specified by the arguments of the same name.
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201Point\202
)DD( Constructs a new rectangle whose top-left corner is the
specified point, and whose width and height are zero.
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201Point, Dimension\202
)DD( Constructs a new rectangle whose top-left corner is specified
by the )SM(point)ES( argument, and whose width and height
are specified by the )SM(dimension)ES( argument.
)DT( o )WB(
)A()BD(Rectangle)ES()EA(\201Rectangle\202
)DD( Constructs a new rectangle, initialized to match the values of
the specificed rectangle.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(add)ES()EA(\201int, int\202
)DD( Adds a point, specified by the integer arguments )SM(newx)ES(
and )SM(newy)ES(, to this rectangle.
)DT( o )WB(
)A()BD(add)ES()EA(\201Point\202
)DD( Adds the point )SM(pt)ES( to this rectangle.
)DT( o )WB(
)A()BD(add)ES()EA(\201Rectangle\202
)DD( Adds a rectangle to this rectangle.
)DT( o )WB(
)A()BD(contains)ES()EA(\201int, int\202
)DD( Checks whether this rectangle contains the point
at the specified location \201)I(x)ES(,\240)I(y)ES(\202.
)DT( o )WB(
)A()BD(contains)ES()EA(\201int, int, int, int\202
)DD( Checks whether this rectangle entirely contains the rectangle
at the specified location \201)I(X)ES(,\240)I(Y)ES(\202 with the
specified dimensions \201)I(W)ES(,\240)I(H)ES(\202.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point\202
)DD( Checks whether this rectangle contains the specified point.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle\202
)DD( Checks whether this rectangle entirely contains the specified
rectangle.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Checks whether two rectangles are equal.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Gets the bounding rectangle of this rectangle.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(getLocation)ES()EA(\201\202
)DD( Returns the location of this rectangle.
)DT( o )WB(
)A()BD(getSize)ES()EA(\201\202
)DD( Gets the size \201width and height\202 of this rectangle.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(grow)ES()EA(\201int, int\202
)DD( Grows the rectangle both horizontally and vertically.
)DT( o )WB(
)A()BD(hashCode)ES()EA(\201\202
)DD( Returns the hashcode for this rectangle.
)DT( o )WB(
)A()BD(inside)ES()EA(\201int, int\202
)DD(
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(intersection)ES()EA(\201Rectangle\202
)DD( Computes the intersection of this rectangle with the
specified rectangle.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle\202
)DD( Determines whether this rectangle and the specified rectangle
intersect.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether this rectangle is empty.
)DT( o )WB(
)A()BD(move)ES()EA(\201int, int\202
)DD(
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(outcode)ES()EA(\201double, double\202
)DD( Determines where the specified float coordinates lie with respect
to this Rectangle.
)DT( o )WB(
)A()BD(reshape)ES()EA(\201int, int, int, int\202
)DD(
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(resize)ES()EA(\201int, int\202
)DD(
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201int, int, int, int\202
)DD( Sets the bounding rectangle of this rectangle to the specified
values for )SM(x)ES(, )SM(y)ES(, )SM(width)ES(,
and )SM(height)ES(.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201Rectangle\202
)DD( Sets the bounding rectangle of this rectangle to match
the specified rectangle.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201int, int\202
)DD( Moves the rectangle to the specified location.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201Point\202
)DD( Moves the rectangle to the specified location.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201double, double, double, double\202
)DD( Set the bounds of this rectangle to the specified x, y, width,
and height.
)DT( o )WB(
)A()BD(setSize)ES()EA(\201Dimension\202
)DD( Sets the size of this rectangle to match the specified dimension.
)DT( o )WB(
)A()BD(setSize)ES()EA(\201int, int\202
)DD( Sets the size of this rectangle to the specified width and height.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns a string representation of this rectangle
and its values.
)DT( o )WB(
)A()BD(translate)ES()EA(\201int, int\202
)DD( Translates the rectangle the indicated distance,
to the right along the )I(x)ES( coordinate axis, and
downward along the )I(y)ES( coordinate axis.
)DT( o )WB(
)A()BD(union)ES()EA(\201Rectangle\202
)DD( Computes the union of this rectangle with the
specified rectangle.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public int x
)RP(
)DL(
)DD( The )I(x)ES( coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public int y
)RP(
)DL(
)DD( The )I(y)ES( coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(width)ES(
)PR(
public int width
)RP(
)DL(
)DD( The width of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(height)ES(
)PR(
public int height
)RP(
)DL(
)DD( The height of the rectangle.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201\202
)RP(
)DL(
)DD( Constructs a new rectangle whose top-left corner is at \2010,\2400\202
in the coordinate space, and whose width and height are zero.
)0 P(
)LD(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Constructs a new rectangle, initialized to match the values of
the specificed rectangle.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - a rectangle from which to copy initial values.
)LD(
)LD(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Constructs a new rectangle whose top-left corner is specified as
\201)SM(x)ES(,\240)SM(y)ES(\202 and whose width and height
are specified by the arguments of the same name.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the )I(x)ES( coordinate.
)DD( y - the )I(y)ES( coordinate.
)DD( width - the width of the rectangle.
)DD( height - the height of the rectangle.
)LD(
)LD(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201int width,
int height\202
)RP(
)DL(
)DD( Constructs a new rectangle whose top-left corner is at \2010,\2400\202
in the coordinate space, and whose width and height are specified
by the arguments of the same name.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - the width of the rectangle.
)DD( height - the height of the rectangle.
)LD(
)LD(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201Point p,
Dimension d\202
)RP(
)DL(
)DD( Constructs a new rectangle whose top-left corner is specified
by the )SM(point)ES( argument, and whose width and height
are specified by the )SM(dimension)ES( argument.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - a point, the top-left corner of the rectangle.
)DD( d - a dimension, representing the width and height.
)LD(
)LD(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201Point p\202
)RP(
)DL(
)DD( Constructs a new rectangle whose top-left corner is the
specified point, and whose width and height are zero.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - the top left corner of the rectangle.
)LD(
)LD(
o )WB()EA(
)BD(Rectangle)ES(
)PR(
public Rectangle\201Dimension d\202
)RP(
)DL(
)DD( Constructs a new rectangle whose top left corner is
\2010,\2400\202 and whose width and height are specified
by the )SM(dimension)ES( argument.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( d - a dimension, specifying width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the bounding rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the bounding rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public double getWidth\201\202
)RP(
)DL(
)DD( Returns the width of the bounding rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public double getHeight\201\202
)RP(
)DL(
)DD( Returns the height of the bounding rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Gets the bounding rectangle of this rectangle.
)0 P(
This method is included for completeness, to parallel the
)SM(getBounds)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a new rectangle, equal to the bounding rectangle
for this rectangle.
)DT( )BD(Overrides:)ES(
)DD( )A(getBounds)EA( in class )A(RectangularShape)EA(
)DT( )BD(See Also:)ES(
)DD( getBounds
)LD(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Sets the bounding rectangle of this rectangle to match
the specified rectangle.
)0 P(
This method is included for completeness, to parallel the
)SM(setBounds)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - a rectangle.
)DT( )BD(See Also:)ES(
)DD( setBounds
)LD(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Sets the bounding rectangle of this rectangle to the specified
values for )SM(x)ES(, )SM(y)ES(, )SM(width)ES(,
and )SM(height)ES(.
)0 P(
This method is included for completeness, to parallel the
)SM(setBounds)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the new )I(x)ES( coordinate for the top-left
corner of this rectangle.
)DD( y - the new )I(y)ES( coordinate for the top-left
corner of this rectangle.
)DD( width - the new width for this rectangle.
)DD( height - the new height for this rectangle.
)DT( )BD(See Also:)ES(
)DD( setBounds
)LD(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201double x,
double y,
double width,
double height\202
)RP(
)DL(
)DD( Set the bounds of this rectangle to the specified x, y, width,
and height.
This method is included for completeness, to parallel the
setBounds method of Component.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - the new width for the Dimension object
)DD( height - the new height for the Dimension object
)DT( )BD(Overrides:)ES(
)DD( )A(setRect)EA( in class )A(Rectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(reshape)ES()EA(
)PR(
public void reshape\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD()BD( Note: reshape\201\202 is deprecated.)ES(
)I(As of JDK version 1.1,
replaced by )SM(setBounds\201int, int, int, int\202)ES(.)ES(
)0 P(
)LD(
o )WB()EA(
)BD(getLocation)ES()EA(
)PR(
public Point getLocation\201\202
)RP(
)DL(
)DD( Returns the location of this rectangle.
)0 P(
This method is included for completeness, to parallel the
)SM(getLocation)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( getLocation
)LD(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public void setLocation\201Point p\202
)RP(
)DL(
)DD( Moves the rectangle to the specified location.
)0 P(
This method is included for completeness, to parallel the
)SM(setLocation)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - the new location for the point.
)DT( )BD(See Also:)ES(
)DD( setLocation
)LD(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public void setLocation\201int x,
int y\202
)RP(
)DL(
)DD( Moves the rectangle to the specified location.
)0 P(
This method is included for completeness, to parallel the
)SM(setLocation)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the )I(x)ES( coordinate of the new location.
)DD( y - the )I(y)ES( coordinate of the new location.
)DT( )BD(See Also:)ES(
)DD( setLocation
)LD(
)LD(
o )WB()EA(
)BD(move)ES()EA(
)PR(
public void move\201int x,
int y\202
)RP(
)DL(
)DD()BD( Note: move\201\202 is deprecated.)ES(
)I(As of JDK version 1.1,
replaced by )SM(setLocation\201int, int\202)ES(.)ES(
)0 P(
)LD(
o )WB()EA(
)BD(translate)ES()EA(
)PR(
public void translate\201int x,
int y\202
)RP(
)DL(
)DD( Translates the rectangle the indicated distance,
to the right along the )I(x)ES( coordinate axis, and
downward along the )I(y)ES( coordinate axis.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( dx - the distance to move the rectangle
along the )I(x)ES( axis.
)DD( dy - the distance to move the rectangle
along the )I(y)ES( axis.
)DT( )BD(See Also:)ES(
)DD( )A(setLocation)EA(, )A(setLocation)EA(
)LD(
)LD(
o )WB()EA(
)BD(getSize)ES()EA(
)PR(
public Dimension getSize\201\202
)RP(
)DL(
)DD( Gets the size \201width and height\202 of this rectangle.
)0 P(
This method is included for completeness, to parallel the
)SM(getSize)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a dimension, representing the size.
)DT( )BD(See Also:)ES(
)DD( getSize
)LD(
)LD(
o )WB()EA(
)BD(setSize)ES()EA(
)PR(
public void setSize\201Dimension d\202
)RP(
)DL(
)DD( Sets the size of this rectangle to match the specified dimension.
)0 P(
This method is included for completeness, to parallel the
)SM(setSize)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( d - the new size for the Dimension object
)DT( )BD(See Also:)ES(
)DD( setSize
)LD(
)LD(
o )WB()EA(
)BD(setSize)ES()EA(
)PR(
public void setSize\201int width,
int height\202
)RP(
)DL(
)DD( Sets the size of this rectangle to the specified width and height.
)0 P(
This method is included for completeness, to parallel the
)SM(setSize)ES( method of )SM(Component)ES(.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - the new width for this rectangle object.
)DD( height - the new height for this rectangle object.
)DT( )BD(See Also:)ES(
)DD( setSize
)LD(
)LD(
o )WB()EA(
)BD(resize)ES()EA(
)PR(
public void resize\201int width,
int height\202
)RP(
)DL(
)DD()BD( Note: resize\201\202 is deprecated.)ES(
)I(As of JDK version 1.1,
replaced by )SM(setSize\201int, int\202)ES(.)ES(
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201Point p\202
)RP(
)DL(
)DD( Checks whether this rectangle contains the specified point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - the point \201location\202 to test.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the point
\201)I(x)ES(,\240)I(y)ES(\202 is inside this rectangle;
)SM(false)ES( otherwise.
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201int x,
int y\202
)RP(
)DL(
)DD( Checks whether this rectangle contains the point
at the specified location \201)I(x)ES(,\240)I(y)ES(\202.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the )I(x)ES( coordinate.
)DD( y - the )I(y)ES( coordinate.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the point
\201)I(x)ES(,\240)I(y)ES(\202 is inside this rectangle;
)SM(false)ES( otherwise.
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Checks whether this rectangle entirely contains the specified
rectangle.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - the rectangle.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the rectangle \201)I(r)ES(\202
is contained entirely inside this rectangle;
)SM(false)ES( otherwise.
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201int X,
int Y,
int W,
int H\202
)RP(
)DL(
)DD( Checks whether this rectangle entirely contains the rectangle
at the specified location \201)I(X)ES(,\240)I(Y)ES(\202 with the
specified dimensions \201)I(W)ES(,\240)I(H)ES(\202.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( X - the )I(x)ES( coordinate.
)DD( Y - the )I(y)ES( coordinate.
)DD( W - the )I(width)ES( of the rectangle.
)DD( H - the )I(height)ES( of the rectangle.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the rectangle specified by
\201)I(X)ES(,\240)I(Y)ES(,\240)I(W)ES(,\240)I(H)ES(\202
is entirely enclosed inside this rectangle;
)SM(false)ES( otherwise.
)LD(
)LD(
o )WB()EA(
)BD(inside)ES()EA(
)PR(
public boolean inside\201int x,
int y\202
)RP(
)DL(
)DD()BD( Note: inside\201\202 is deprecated.)ES(
)I(As of JDK version 1.1,
replaced by )SM(contains\201int, int\202)ES(.)ES(
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Determines whether this rectangle and the specified rectangle
intersect. Two rectangles intersect if their intersection is
nonempty.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - a rectangle.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the specified rectangle
and this rectangle insersect;
)SM(false)ES( otherwise.
)LD(
)LD(
o )WB()EA(
)BD(intersection)ES()EA(
)PR(
public )A(Rectangle)EA( intersection\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Computes the intersection of this rectangle with the
specified rectangle. Returns a new rectangle that
represents the intersection of the two rectangles.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - a rectangle.
)DT( )BD(Returns:)ES(
)DD( the largest rectangle contained in both the
specified rectangle and in this rectangle.
)LD(
)LD(
o )WB()EA(
)BD(union)ES()EA(
)PR(
public )A(Rectangle)EA( union\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Computes the union of this rectangle with the
specified rectangle. Returns a new rectangle that
represents the union of the two rectangles.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - a rectangle.
)DT( )BD(Returns:)ES(
)DD( the smallest rectangle containing both the specified
rectangle and this rectangle.
)LD(
)LD(
o )WB()EA(
)BD(add)ES()EA(
)PR(
public void add\201int newx,
int newy\202
)RP(
)DL(
)DD( Adds a point, specified by the integer arguments )SM(newx)ES(
and )SM(newy)ES(, to this rectangle. The resulting rectangle is
the smallest rectangle that contains both the original rectangle
and the specified point.
)0 P(
After adding a point, a call to )SM(contains)SM( with the
added point as an argument will not necessarily return
)SM(true)ES(. The )SM(contains)ES( method does not
return )SM(true)ES( for points on the right or bottom
edges of a rectangle. Therefore if the added point falls on
the left or bottom edge of the enlarged rectangle,
)SM(contains)ES( will return )SM(false)ES( for that point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( newx - the )I(x)ES( coordinate of the new point.
)DD( newy - the )I(y)ES( coordinate of the new point.
)LD(
)LD(
o )WB()EA(
)BD(add)ES()EA(
)PR(
public void add\201Point pt\202
)RP(
)DL(
)DD( Adds the point )SM(pt)ES( to this rectangle. The resulting
rectangle is the smallest rectangle that contains both the
original rectangle and the specified point.
)0 P(
After adding a point, a call to )SM(contains)SM( with the
added point as an argument will not necessarily return
)SM(true)ES(. The )SM(contains)ES( method does not
return )SM(true)ES( for points on the right or bottom
edges of a rectangle. Therefore if the added point falls on
the left or bottom edge of the enlarged rectangle,
)SM(contains)ES( will return )SM(false)ES( for that point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( pt - the new point to add to the rectangle.
)LD(
)LD(
o )WB()EA(
)BD(add)ES()EA(
)PR(
public void add\201)A(Rectangle)EA( r\202
)RP(
)DL(
)DD( Adds a rectangle to this rectangle. The resulting rectangle is
the union of the two rectangles.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( a - rectangle.
)LD(
)LD(
o )WB()EA(
)BD(grow)ES()EA(
)PR(
public void grow\201int h,
int v\202
)RP(
)DL(
)DD( Grows the rectangle both horizontally and vertically.
)0 P(
This method modifies the rectangle so that it is
)SM(h)ES( units larger on both the left and right side,
and )SM(v)ES( units larger at both the top and bottom.
)0 P(
The new rectangle has \201)SM(x\240-\240h)ES(,
)SM(y\240-\240v)ES(\202 as its top-left corner, a
width of
)SM(width)ES(\240)SM(+)ES(\240)SM(2h)ES(,
and a height of
)SM(height)ES(\240)SM(+)ES(\240)SM(2v)ES(.
)0 P(
If negative values are supplied for )SM(h)ES( and
)SM(v)ES(, the size of the rectangle decreases accordingly.
The )SM(grow)ES( method does not check whether the resulting
values of )SM(width)ES( and )SM(height)ES( are
non-negative.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( h - the horizontal expansion.
)DD( v - the vertical expansion.
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether this rectangle is empty. A rectangle is empty if
its width or its height is less than or equal to zero.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if this rectangle is empty;
)SM(false)ES( otherwise.
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(outcode)ES()EA(
)PR(
public int outcode\201double x,
double y\202
)RP(
)DL(
)DD( Determines where the specified float coordinates lie with respect
to this Rectangle.
This method computes a binary OR of the appropriate mask values
indicating which sides of the rectangle the given point is
outside of.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the logical OR of all appropriate out codes
)DT( )BD(Overrides:)ES(
)DD( )A(outcode)EA( in class )A(Rectangle2D)EA(
)DT( )BD(See Also:)ES(
)DD( )A(OUT_LEFT)EA(, )A(OUT_TOP)EA(, )A(OUT_RIGHT)EA(, )A(OUT_BOTTOM)EA(
)LD(
)LD(
o )WB()EA(
)BD(hashCode)ES()EA(
)PR(
public int hashCode\201\202
)RP(
)DL(
)DD( Returns the hashcode for this rectangle.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the hashcode for this rectangle.
)DT( )BD(Overrides:)ES(
)DD( )A(hashCode)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD( Checks whether two rectangles are equal.
)0 P(
The result is )KB(true)ES( if and only if the argument is not
)KB(null)ES( and is a )KB(Rectangle)ES( object that has the
same top-left corner, width, and height as this rectangle.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( obj - the object to compare with.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the objects are equal;
)SM(false)ES( otherwise.
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns a string representation of this rectangle
and its values.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a string representation of this rectangle.
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.TexturePaint
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.TexturePaint
)EH(
)PR(
java.lang.Object
|
+----java.awt.TexturePaint
)RP(
)HR(
)DL(
)DT( public class )BD(TexturePaint)ES(
)DT( extends Object
)DT( implements )A(Paint)EA(
)LD(
This class provides a way to fill a shape with a given texture.
The texture used in the filling process is given as a BufferedImage.
The size of the texture BufferedImage object should be small because
the BufferedImage data is copied by the TexturePaint object.
The texture is anchored at construction time to the upper left corner
of a Rectangle2D specified in user space. Texture is computed for
locations in the device space by conceptually replicating the given
Rectangle2D infinitely in all directions in user space and mapping
the BufferedImage to each replicated Rectangle2D.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(Paint)EA(, )A(setPaint)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BICUBIC)ES()EA(
)DD( Texture colors are generated with the bicubic algorithm.
)DT( o )WB(
)A()BD(BILINEAR)ES()EA(
)DD( Texture colors are generated with the bilinear algorithm.
)DT( o )WB(
)A()BD(NEAREST_NEIGHBOR)ES()EA(
)DD( Texture colors are generated with the nearest neighbor algorithm.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TexturePaint)ES()EA(\201BufferedImage, Rectangle2D, int\202
)DD( Constructs a TexturePaint object.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createContext)ES()EA(\201ColorModel, Rectangle, Rectangle2D, AffineTransform\202
)DD( Creates and returns a context used to generate the color pattern.
)DT( o )WB(
)A()BD(getTransparency)ES()EA(\201\202
)DD( Return the transparency mode for this TexturePaint.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(NEAREST_NEIGHBOR)ES(
)PR(
public static final int NEAREST_NEIGHBOR
)RP(
)DL(
)DD( Texture colors are generated with the nearest neighbor algorithm.)0 P(
)LD(
o )WB()EA(
)BD(BILINEAR)ES(
)PR(
public static final int BILINEAR
)RP(
)DL(
)DD( Texture colors are generated with the bilinear algorithm.)0 P(
)LD(
o )WB()EA(
)BD(BICUBIC)ES(
)PR(
public static final int BICUBIC
)RP(
)DL(
)DD( Texture colors are generated with the bicubic algorithm.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(TexturePaint)ES(
)PR(
public TexturePaint\201)A(BufferedImage)EA( txtr,
)A(Rectangle2D)EA( rect2d,
int interpolation\202
)RP(
)DL(
)DD( Constructs a TexturePaint object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( txtr - The BufferedImage object with the texture used for painting.
)DD( rect2d - The rectangle in user space used to anchor and replicate
the texture.
)DD( interpolation - The type of algorithm with regard to rendering
quality used to generate the color pattern. Possible values are
NEAREST_NEIGHBOR, BILINEAR and BICUBIC.
)DT( )BD(See Also:)ES(
)DD( )A(NEAREST_NEIGHBOR)EA(, )A(BILINEAR)EA(, )A(BICUBIC)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(createContext)ES()EA(
)PR(
public )A(PaintContext)EA( createContext\201)A(ColorModel)EA( cm,
)A(Rectangle)EA( deviceBounds,
)A(Rectangle2D)EA( userBounds,
)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Creates and returns a context used to generate the color pattern.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( cm - ColorModel in which the caller wishes to receive the
paint data. This is used only as a hint.
)DD( deviceBounds - The rectangle describing the bounding box
in device space of the graphics primitive being rendered.
)DD( userBounds - The rectangle describing the bounding box in
user space of the graphics primitive being rendered.
)DD( xform - The Transform from user space into device space.
)DT( )BD(Returns:)ES(
)DD( The PaintContext for generating color patterns.
)DT( )BD(See Also:)ES(
)DD( )A(PaintContext)EA(
)LD(
)LD(
o )WB()EA(
)BD(getTransparency)ES()EA(
)PR(
public int getTransparency\201\202
)RP(
)DL(
)DD( Return the transparency mode for this TexturePaint.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Transparency)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.color.ColorSpace
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.color.ColorSpace
)EH(
)PR(
java.lang.Object
|
+----java.awt.color.ColorSpace
)RP(
)HR(
)DL(
)DT( public abstract class )BD(ColorSpace)ES(
)DT( extends Object
)DT( super class of:
)DD( )A(ICC_ColorSpace)EA(
)LD(
This abstract class is used to serve as a color space tag to identify the
specific color space of a Color object or, via a ColorModel object,
of an Image, a BufferedImage, or a GraphicsDevice. It contains
methods that transform Colors in a specific color space to/from sRGB
and to/from a well-defined CIEXYZ color space.
)0 P(Several variables are defined for purposes of referring to color
space types \201e.g. TYPE_RGB, TYPE_XYZ, etc.\202 and to refer to specific
color spaces \201e.g. CS_sRGB and CS_CIEXYZ\202.
sRGB is a proposed standard RGB color space. For more information,
see )A(
http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html
)EA(.
)0 P(The purpose of the methods to transform to/from the well-defined
CIEXYZ color space is to support conversions between any two color
spaces at a reasonably high degree of accuracy. It is expected that
particular implementations of subclasses of ColorSpace \201e.g.
ICC_ColorSpace\202 will support high performance conversion based on
underlying platform color management systems.
)0 P(The CS_CIEXYZ space used by the toCIEXYZ/fromCIEXYZ methods can be
described as follows:
)PR(
CIEXYZ
viewing illuminance: 200 lux
viewing white point: CIE D50
media white point: "that of a perfectly reflecting diffuser" -- D50
media black point: 0 lux or 0 Reflectance
flare: 1 percent
surround: 20percent of the media white point
media description: reflection print \201i.e., RLAB, Hunt viewing media\202
note: For developers creating an ICC profile for this conversion space,
the following is applicable. Use a simple Von Kries white point
adaptation folded into the 3X3 matrix parameters and fold the
flare and surround effects into the three one-dimensional
lookup tables \201assuming one uses the minimal model for
monitors\202.
)RP(
)0 P(
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ICC_ColorSpace)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CS_CIEXYZ)ES()EA(
)DD( The CIEXYZ conversion color space defined above.
)DT( o )WB(
)A()BD(CS_sRGB)ES()EA(
)DD( The sRGB color space defined at
)A(
http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html
)EA(.
)DT( o )WB(
)A()BD(TYPE_CMY)ES()EA(
)DD( Any of the family of CMY color spaces.
)DT( o )WB(
)A()BD(TYPE_CMYK)ES()EA(
)DD( Any of the family of CMYK color spaces.
)DT( o )WB(
)A()BD(TYPE_GRAY)ES()EA(
)DD( Any of the family of GRAY color spaces.
)DT( o )WB(
)A()BD(TYPE_HLS)ES()EA(
)DD( Any of the family of HLS color spaces.
)DT( o )WB(
)A()BD(TYPE_HSB)ES()EA(
)DD( Any of the family of HSB color spaces.
)DT( o )WB(
)A()BD(TYPE_HSV)ES()EA(
)DD( Any of the family of HSV color spaces.
)DT( o )WB(
)A()BD(TYPE_Lab)ES()EA(
)DD( Any of the family of Lab color spaces.
)DT( o )WB(
)A()BD(TYPE_Luv)ES()EA(
)DD( Any of the family of Luv color spaces.
)DT( o )WB(
)A()BD(TYPE_RGB)ES()EA(
)DD( Any of the family of RGB color spaces.
)DT( o )WB(
)A()BD(TYPE_XYZ)ES()EA(
)DD( Any of the family of XYZ color spaces.
)DT( o )WB(
)A()BD(TYPE_YCbCr)ES()EA(
)DD( Any of the family of YCbCr color spaces.
)DT( o )WB(
)A()BD(TYPE_Yxy)ES()EA(
)DD( Any of the family of Yxy color spaces.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ColorSpace)ES()EA(\201int, int\202
)DD( Constructs a ColorSpace object given a color space type
and the number of components.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(fromCIEXYZ)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in the CS_CIEXYZ conversion
color space into this ColorSpace.
)DT( o )WB(
)A()BD(fromRGB)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in the default CS_sRGB
color space into this ColorSpace.
)DT( o )WB(
)A()BD(getInstance)ES()EA(\201int\202
)DD( Returns a ColorSpace representing one of the specific
predefined color spaces.
)DT( o )WB(
)A()BD(getName)ES()EA(\201int\202
)DD( Returns the name of the component given the component index
)DT( o )WB(
)A()BD(getNumComponents)ES()EA(\201\202
)DD( Returns the number of components of this ColorSpace.
)DT( o )WB(
)A()BD(getType)ES()EA(\201\202
)DD( Returns the color space type of this ColorSpace \201for example
TYPE_RGB, TYPE_XYZ, ...\202.
)DT( o )WB(
)A()BD(isCS_sRGB)ES()EA(\201\202
)DD( Returns true if the ColorSpace is CS_sRGB
)DT( o )WB(
)A()BD(toCIEXYZ)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in this ColorSpace
into the CS_CIEXYZ conversion color space.
)DT( o )WB(
)A()BD(toRGB)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in this ColorSpace
into a value in the default CS_sRGB color space.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(TYPE_XYZ)ES(
)PR(
public static final int TYPE_XYZ
)RP(
)DL(
)DD( Any of the family of XYZ color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_Lab)ES(
)PR(
public static final int TYPE_Lab
)RP(
)DL(
)DD( Any of the family of Lab color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_Luv)ES(
)PR(
public static final int TYPE_Luv
)RP(
)DL(
)DD( Any of the family of Luv color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_YCbCr)ES(
)PR(
public static final int TYPE_YCbCr
)RP(
)DL(
)DD( Any of the family of YCbCr color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_Yxy)ES(
)PR(
public static final int TYPE_Yxy
)RP(
)DL(
)DD( Any of the family of Yxy color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_RGB)ES(
)PR(
public static final int TYPE_RGB
)RP(
)DL(
)DD( Any of the family of RGB color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_GRAY)ES(
)PR(
public static final int TYPE_GRAY
)RP(
)DL(
)DD( Any of the family of GRAY color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_HSV)ES(
)PR(
public static final int TYPE_HSV
)RP(
)DL(
)DD( Any of the family of HSV color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_HLS)ES(
)PR(
public static final int TYPE_HLS
)RP(
)DL(
)DD( Any of the family of HLS color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_CMYK)ES(
)PR(
public static final int TYPE_CMYK
)RP(
)DL(
)DD( Any of the family of CMYK color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_CMY)ES(
)PR(
public static final int TYPE_CMY
)RP(
)DL(
)DD( Any of the family of CMY color spaces.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_HSB)ES(
)PR(
public static final int TYPE_HSB
)RP(
)DL(
)DD( Any of the family of HSB color spaces.)0 P(
)LD(
o )WB()EA(
)BD(CS_sRGB)ES(
)PR(
public static final int CS_sRGB
)RP(
)DL(
)DD( The sRGB color space defined at
)A(
http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html
)EA(.)0 P(
)LD(
o )WB()EA(
)BD(CS_CIEXYZ)ES(
)PR(
public static final int CS_CIEXYZ
)RP(
)DL(
)DD( The CIEXYZ conversion color space defined above.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ColorSpace)ES(
)PR(
public ColorSpace\201int type,
int numcomponents\202
)RP(
)DL(
)DD( Constructs a ColorSpace object given a color space type
and the number of components.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getInstance)ES()EA(
)PR(
public static )A(ColorSpace)EA( getInstance\201int colorspace\202
)RP(
)DL(
)DD( Returns a ColorSpace representing one of the specific
predefined color spaces.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorspace - a specific color space identified by one of
the predefined class constants \201e.g. CS_sRGB or CS_CIEXYZ\202
)LD(
)LD(
o )WB()EA(
)BD(isCS_sRGB)ES()EA(
)PR(
public boolean isCS_sRGB\201\202
)RP(
)DL(
)DD( Returns true if the ColorSpace is CS_sRGB
)0 P(
)LD(
o )WB()EA(
)BD(toRGB)ES()EA(
)PR(
public abstract float[] toRGB\201float colorvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in this ColorSpace
into a value in the default CS_sRGB color space.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorvalue - a float array with length of at least the number
of components in this ColorSpace
)DT( )BD(Returns:)ES(
)DD( a float array of length 3
)LD(
)LD(
o )WB()EA(
)BD(fromRGB)ES()EA(
)PR(
public abstract float[] fromRGB\201float rgbvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in the default CS_sRGB
color space into this ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rgbvalue - a float array with length of at least 3
)DT( )BD(Returns:)ES(
)DD( a float array with length equal to the number of
components in this ColorSpace
)LD(
)LD(
o )WB()EA(
)BD(toCIEXYZ)ES()EA(
)PR(
public abstract float[] toCIEXYZ\201float colorvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in this ColorSpace
into the CS_CIEXYZ conversion color space.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorvalue - a float array with length of at least the number
of components in this ColorSpace
)DT( )BD(Returns:)ES(
)DD( a float array of length 3
)LD(
)LD(
o )WB()EA(
)BD(fromCIEXYZ)ES()EA(
)PR(
public abstract float[] fromCIEXYZ\201float colorvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in the CS_CIEXYZ conversion
color space into this ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorvalue - a float array with length of at least 3
)DT( )BD(Returns:)ES(
)DD( a float array with length equal to the number of
components in this ColorSpace
)LD(
)LD(
o )WB()EA(
)BD(getType)ES()EA(
)PR(
public int getType\201\202
)RP(
)DL(
)DD( Returns the color space type of this ColorSpace \201for example
TYPE_RGB, TYPE_XYZ, ...\202. The type defines the
number of components of the color space and the interpretation,
e.g. TYPE_RGB identifies a color space with three components - red,
green, and blue. It does not define the particular color
characteristics of the space, e.g. the chromaticities of the
primaries.
)0 P(
)LD(
o )WB()EA(
)BD(getNumComponents)ES()EA(
)PR(
public int getNumComponents\201\202
)RP(
)DL(
)DD( Returns the number of components of this ColorSpace.
)0 P(
)LD(
o )WB()EA(
)BD(getName)ES()EA(
)PR(
public String getName\201int idx\202
)RP(
)DL(
)DD( Returns the name of the component given the component index
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.color.ICC_ColorSpace
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.color.ICC_ColorSpace
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.color.ColorSpace)EA(
|
+----java.awt.color.ICC_ColorSpace
)RP(
)HR(
)DL(
)DT( public class )BD(ICC_ColorSpace)ES(
)DT( extends )A(ColorSpace)EA(
)LD(
An implementation of the abstract ColorSpace class. This representation of
device independent and device dependent color spaces is based on the ICC
Profile Format Specification, Version 3.3, November 11, 1996, from
the International Color Consortium \201see )A(
http://www.color.org)EA(\202.
)0 P(
Typically, a Color or ColorModel would be associated with an ICC
Profile which is either an input, display, or output profile \201see
the ICC specification\202. There are other types of ICC Profiles, e.g.
abstract profiles, device link profiles, and named color profiles,
which do not contain information appropriate for representing the color
space of a color, image, or device \201see ICC_Profile\202.
Attempting to create an ICC_ColorSpace object from an inappropriate ICC
Profile is an error.
)0 P(
ICC Profiles represent transformations from the color space of
the profile \201e.g. a monitor\202 to a Profile Connection Space \201PCS\202.
Profiles of interest for tagging images or colors have a
PCS which is one of the two specific device independent
spaces \201one CIEXYZ space and one CIELab space\202 defined in the
ICC Profile Format Specification. Most profiles of interest
either have invertible transformations or explicitly specify
transformations going both directions. Should an ICC_ColorSpace
object be used in a way requiring a conversion from PCS to
the profile's native space and there is inadequate data to
correctly perform the conversion, the ICC_ColorSpace object will
produce output in the specified type of color space \201e.g. TYPE_RGB,
TYPE_CMYK, etc.\202, but the specific color values of the output data
will be undefined.
)0 P(
The details of this class are not important for simple applets,
which draw in a default color space or manipulate and display
imported images with a known color space. At most, such applets
would need to get one of the default color spaces via
ColorSpace.getInstance\201\202.
)0 P(
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorSpace)EA(, )A(ICC_Profile)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ICC_ColorSpace)ES()EA(\201ICC_Profile\202
)DD( Constructs a new ICC_ColorSpace from an ICC_Profile object.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(fromCIEXYZ)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in the CS_CIEXYZ conversion
color space into this ColorSpace.
)DT( o )WB(
)A()BD(fromRGB)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in the default CS_sRGB
color space into this ColorSpace.
)DT( o )WB(
)A()BD(getProfile)ES()EA(\201\202
)DD( Returns the ICC_Profile for this ICC_ColorSpace.
)DT( o )WB(
)A()BD(toCIEXYZ)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in this ColorSpace
into the CS_CIEXYZ conversion color space.
)DT( o )WB(
)A()BD(toRGB)ES()EA(\201float[]\202
)DD( Transforms a color value assumed to be in this ColorSpace
into a value in the default CS_sRGB color space.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ICC_ColorSpace)ES(
)PR(
public ICC_ColorSpace\201)A(ICC_Profile)EA( profile\202
)RP(
)DL(
)DD( Constructs a new ICC_ColorSpace from an ICC_Profile object.
)0 P(
)DD()DL(
)DT( )BD(Throws:)ES( IllegalArgumentException
)DD( if profile is inappropriate for
representing a ColorSpace.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getProfile)ES()EA(
)PR(
public )A(ICC_Profile)EA( getProfile\201\202
)RP(
)DL(
)DD( Returns the ICC_Profile for this ICC_ColorSpace.
)0 P(
)LD(
o )WB()EA(
)BD(toRGB)ES()EA(
)PR(
public float[] toRGB\201float colorvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in this ColorSpace
into a value in the default CS_sRGB color space.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorvalue - a float array with length of at least the number
of components in this ColorSpace.
)DT( )BD(Returns:)ES(
)DD( a float array of length 3.
)DT( )BD(Overrides:)ES(
)DD( )A(toRGB)EA( in class )A(ColorSpace)EA(
)LD(
)LD(
o )WB()EA(
)BD(fromRGB)ES()EA(
)PR(
public float[] fromRGB\201float rgbvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in the default CS_sRGB
color space into this ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rgbvalue - a float array with length of at least 3.
)DT( )BD(Returns:)ES(
)DD( a float array with length equal to the number of
components in this ColorSpace.
)DT( )BD(Overrides:)ES(
)DD( )A(fromRGB)EA( in class )A(ColorSpace)EA(
)LD(
)LD(
o )WB()EA(
)BD(toCIEXYZ)ES()EA(
)PR(
public float[] toCIEXYZ\201float colorvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in this ColorSpace
into the CS_CIEXYZ conversion color space.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorvalue - a float array with length of at least the number
of components in this ColorSpace.
)DT( )BD(Returns:)ES(
)DD( a float array of length 3.
)DT( )BD(Overrides:)ES(
)DD( )A(toCIEXYZ)EA( in class )A(ColorSpace)EA(
)LD(
)LD(
o )WB()EA(
)BD(fromCIEXYZ)ES()EA(
)PR(
public float[] fromCIEXYZ\201float colorvalue[]\202
)RP(
)DL(
)DD( Transforms a color value assumed to be in the CS_CIEXYZ conversion
color space into this ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorvalue - a float array with length of at least 3.
)DT( )BD(Returns:)ES(
)DD( a float array with length equal to the number of
components in this ColorSpace.
)DT( )BD(Overrides:)ES(
)DD( )A(fromCIEXYZ)EA( in class )A(ColorSpace)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.color.ICC_Profile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.color.ICC_Profile
)EH(
)PR(
java.lang.Object
|
+----java.awt.color.ICC_Profile
)RP(
)HR(
)DL(
)DT( public class )BD(ICC_Profile)ES(
)DT( extends Object
)DT( super class of:
)DD( )A(ICC_ProfileGray)EA(, )A(ICC_ProfileRGB)EA(
)LD(
A representation of color profile data for device
independent and device dependent color spaces based on the ICC
Profile Format Specification, Version 3.3, November 11, 1996, from
the International Color Consortium \201see )A(
http://www.color.org)EA(\202.
)0 P(
An ICC_ColorSpace object can be constructed from an appropriate
ICC_Profile.
Typically, an ICC_ColorSpace would be associated with an ICC
Profile which is either an input, display, or output profile \201see
the ICC specification\202. There are also device link, abstract,
color space conversion, and named color profiles. These are less
useful for tagging a color or image, but are useful for other
purposes \201in particular device link profiles can provide improved
performance for converting from one device's color space to
another's\202.
)0 P(
ICC Profiles represent transformations from the color space of
the profile \201e.g. a monitor\202 to a Profile Connection Space \201PCS\202.
Profiles of interest for tagging images or colors have a PCS
which is one of the two specific device independent
spaces \201one CIEXYZ space and one CIELab space\202 defined in the
ICC Profile Format Specification. Most profiles of interest
either have invertible transformations or explicitly specify
transformations going both directions.
)0 P(
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ICC_ColorSpace)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CLASS_ABSTRACT)ES()EA(
)DD( Profile class is abstract.
)DT( o )WB(
)A()BD(CLASS_COLORSPACECONVERSION)ES()EA(
)DD( Profile class is color space conversion.
)DT( o )WB(
)A()BD(CLASS_DEVICELINK)ES()EA(
)DD( Profile class is device link.
)DT( o )WB(
)A()BD(CLASS_DISPLAY)ES()EA(
)DD( Profile class is display.
)DT( o )WB(
)A()BD(CLASS_INPUT)ES()EA(
)DD( Profile class is input.
)DT( o )WB(
)A()BD(CLASS_NAMEDCOLOR)ES()EA(
)DD( Profile class is named color.
)DT( o )WB(
)A()BD(CLASS_OUTPUT)ES()EA(
)DD( Profile class is output.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ICC_Profile)ES()EA(\201\202
)DD( Constructs an empty ICC_Profile object.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getColorSpaceType)ES()EA(\201\202
)DD( Returns the color space type.
)DT( o )WB(
)A()BD(getData)ES()EA(\201String\202
)DD( Returns a particular tagged data element from the profile as
a byte array.
)DT( o )WB(
)A()BD(getInstance)ES()EA(\201byte[]\202
)DD( Returns an ICC_Profile corresponding to the data in a byte array.
)DT( o )WB(
)A()BD(getInstance)ES()EA(\201InputStream\202
)DD( Returns an ICC_Profile corresponding to the data in an InputStream.
)DT( o )WB(
)A()BD(getInstance)ES()EA(\201int\202
)DD( Returns an ICC_Profile corresponding to one of the specific color
spaces defined by the ColorSpace class \201for example CS_sRGB\202.
)DT( o )WB(
)A()BD(getMajorVersion)ES()EA(\201\202
)DD( Returns profile major version.
)DT( o )WB(
)A()BD(getMinorVersion)ES()EA(\201\202
)DD( Returns profile minor version.
)DT( o )WB(
)A()BD(getNumComponents)ES()EA(\201\202
)DD( Returns the number of color components in the "input" color
space of this profile.
)DT( o )WB(
)A()BD(getPCSType)ES()EA(\201\202
)DD( Returns the color space type of the Profile Connection Space \201PCS\202.
)DT( o )WB(
)A()BD(getProfileClass)ES()EA(\201\202
)DD( Returns the profile class.
)DT( o )WB(
)A()BD(setData)ES()EA(\201String, byte[]\202
)DD( Sets a particular tagged data element in the profile from
a byte array.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(CLASS_INPUT)ES(
)PR(
public static final int CLASS_INPUT
)RP(
)DL(
)DD( Profile class is input.)0 P(
)LD(
o )WB()EA(
)BD(CLASS_DISPLAY)ES(
)PR(
public static final int CLASS_DISPLAY
)RP(
)DL(
)DD( Profile class is display.)0 P(
)LD(
o )WB()EA(
)BD(CLASS_OUTPUT)ES(
)PR(
public static final int CLASS_OUTPUT
)RP(
)DL(
)DD( Profile class is output.)0 P(
)LD(
o )WB()EA(
)BD(CLASS_DEVICELINK)ES(
)PR(
public static final int CLASS_DEVICELINK
)RP(
)DL(
)DD( Profile class is device link.)0 P(
)LD(
o )WB()EA(
)BD(CLASS_COLORSPACECONVERSION)ES(
)PR(
public static final int CLASS_COLORSPACECONVERSION
)RP(
)DL(
)DD( Profile class is color space conversion.)0 P(
)LD(
o )WB()EA(
)BD(CLASS_ABSTRACT)ES(
)PR(
public static final int CLASS_ABSTRACT
)RP(
)DL(
)DD( Profile class is abstract.)0 P(
)LD(
o )WB()EA(
)BD(CLASS_NAMEDCOLOR)ES(
)PR(
public static final int CLASS_NAMEDCOLOR
)RP(
)DL(
)DD( Profile class is named color.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ICC_Profile)ES(
)PR(
public ICC_Profile\201\202
)RP(
)DL(
)DD( Constructs an empty ICC_Profile object.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getInstance)ES()EA(
)PR(
public static )A(ICC_Profile)EA( getInstance\201int cspace\202
)RP(
)DL(
)DD( Returns an ICC_Profile corresponding to one of the specific color
spaces defined by the ColorSpace class \201for example CS_sRGB\202.
)0 P(
)LD(
o )WB()EA(
)BD(getInstance)ES()EA(
)PR(
public static )A(ICC_Profile)EA( getInstance\201byte data[]\202
)RP(
)DL(
)DD( Returns an ICC_Profile corresponding to the data in a byte array.
)0 P(
)LD(
o )WB()EA(
)BD(getInstance)ES()EA(
)PR(
public static )A(ICC_Profile)EA( getInstance\201InputStream s\202
)RP(
)DL(
)DD( Returns an ICC_Profile corresponding to the data in an InputStream.
)0 P(
)LD(
o )WB()EA(
)BD(getMajorVersion)ES()EA(
)PR(
public int getMajorVersion\201\202
)RP(
)DL(
)DD( Returns profile major version.
)0 P(
)LD(
o )WB()EA(
)BD(getMinorVersion)ES()EA(
)PR(
public int getMinorVersion\201\202
)RP(
)DL(
)DD( Returns profile minor version.
)0 P(
)LD(
o )WB()EA(
)BD(getProfileClass)ES()EA(
)PR(
public int getProfileClass\201\202
)RP(
)DL(
)DD( Returns the profile class. Returns one of the predefined profile
class constants.
)0 P(
)LD(
o )WB()EA(
)BD(getColorSpaceType)ES()EA(
)PR(
public int getColorSpaceType\201\202
)RP(
)DL(
)DD( Returns the color space type. Returns one of the color space type
constants defined by the ColorSpace class. This is the
"input" color space of the profile. The type defines the
number of components of the color space and the interpretation,
e.g. TYPE_RGB identifies a color space with three components - red,
green, and blue. It does not define the particular color
characteristics of the space, e.g. the chromaticities of the
primaries.
)0 P(
)LD(
o )WB()EA(
)BD(getPCSType)ES()EA(
)PR(
public int getPCSType\201\202
)RP(
)DL(
)DD( Returns the color space type of the Profile Connection Space \201PCS\202.
Returns one of the color space type constants defined by the
ColorSpace class. This is the "output" color space of the
profile. For an input, display, or output profile useful
for tagging colors or images, this will be either TYPE_XYZ or
TYPE_Lab and should be interpreted as the corresponding specific
color space defined in the ICC specification. For a device
link profile, this could be any of the color space type constants.
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public byte[] getData\201String s\202
)RP(
)DL(
)DD( Returns a particular tagged data element from the profile as
a byte array. Elements are identified by strings
of four letters as defined in the ICC specification. The string
"head" can be used to get the header. This method is useful
for advanced applets or applications which need to access
profile data directly. Returns null if no such tag exists.
)0 P(
)LD(
o )WB()EA(
)BD(setData)ES()EA(
)PR(
public void setData\201String s,
byte iccdata[]\202
)RP(
)DL(
)DD( Sets a particular tagged data element in the profile from
a byte array. Elements are identified by strings
of four letters as defined in the ICC specification. The string
"head" can be used to set the header. This method is useful
for advanced applets or applications which need to access
profile data directly.
)0 P(
)LD(
o )WB()EA(
)BD(getNumComponents)ES()EA(
)PR(
public int getNumComponents\201\202
)RP(
)DL(
)DD( Returns the number of color components in the "input" color
space of this profile. For example if the color space type
of this profile is TYPE_RGB, then this method will return 3.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.color.ICC_ProfileGray
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.color.ICC_ProfileGray
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.color.ICC_Profile)EA(
|
+----java.awt.color.ICC_ProfileGray
)RP(
)HR(
)DL(
)DT( public class )BD(ICC_ProfileGray)ES(
)DT( extends )A(ICC_Profile)EA(
)LD(
A subclass of the ICC_Profile class which represents profiles
which meet the following criteria: the color space type of the
profile is TYPE_GRAY, the PCS is the CIEXYZ space defined by the ICC
specification, and the profile includes the grayTRCTag and
mediaWhitePointTag tags. Examples of this kind of profile are
monochrome input profiles, monochrome display profiles, and
monochrome output profiles. The
)A(
ICC_Profile.getInstance\201\202
)EA(
method will
return an ICC_ProfileGray object when the above conditions are
met. The advantage of this class is that it provides a lookup
table that Java or native methods may be able to use directly to
optimize color conversion in some cases.
)0 P(
To transform from a GRAY device profile color space to the CIEXYZ Profile
Connection Space, the device gray component is transformed by
a lookup through the tone reproduction curve \201TRC\202. The result is
treated as the achromatic component of the PCS.
)PR(
PCSY = grayTRC[deviceGray]
)RP(
The inverse transform is done by converting the PCS Y components to
device Gray via the inverse of the grayTRC.
)0 P(
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ICC_ProfileGray)ES()EA(\201\202
)DD( Constructs an empty ICC_ProfileGray.
)DT( o )WB(
)A()BD(ICC_ProfileGray)ES()EA(\201byte[]\202
)DD( Constructs a new ICC_ProfileGray from a byte data array.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getGamma)ES()EA(\201\202
)DD( Returns a gamma value representing the tone reproduction
curve \201TRC\202.
)DT( o )WB(
)A()BD(getMediaWhitePoint)ES()EA(\201\202
)DD( Returns a float array of length 3 containing the X, Y, and Z
components of the mediaWhitePointTag in the ICC profile.
)DT( o )WB(
)A()BD(getTRC)ES()EA(\201\202
)DD( Returns the TRC as an array of shorts.
)DT( o )WB(
)A()BD(getTRCLUT)ES()EA(\201boolean, int, int\202
)DD( Returns a LookupTable object which represents the TRC.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ICC_ProfileGray)ES(
)PR(
public ICC_ProfileGray\201\202
)RP(
)DL(
)DD( Constructs an empty ICC_ProfileGray. Before using the profile
for any purpose all necessary profile data must be set to
appropriate values.
)0 P(
)LD(
o )WB()EA(
)BD(ICC_ProfileGray)ES(
)PR(
public ICC_ProfileGray\201byte data[]\202
)RP(
)DL(
)DD( Constructs a new ICC_ProfileGray from a byte data array.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getMediaWhitePoint)ES()EA(
)PR(
public float[] getMediaWhitePoint\201\202
)RP(
)DL(
)DD( Returns a float array of length 3 containing the X, Y, and Z
components of the mediaWhitePointTag in the ICC profile.
)0 P(
)LD(
o )WB()EA(
)BD(getGamma)ES()EA(
)PR(
public float getGamma\201\202
)RP(
)DL(
)DD( Returns a gamma value representing the tone reproduction
curve \201TRC\202. If the profile represents the TRC as a table rather
than a single gamma value, then an exception is thrown. In this
case the actual table can be obtained via getTRC\201\202. When
using a gamma value, the PCS Y component is computed as follows:
)PR(
gamma
PCSY = deviceGray
)RP(
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the gamma value as a float.
)DT( )BD(Throws:)ES( )A(NoSuchProfileDataException)EA(
)DD( if the profile does not specify
the TRC as a single gamma value.
)LD(
)LD(
o )WB()EA(
)BD(getTRC)ES()EA(
)PR(
public short[] getTRC\201\202
)RP(
)DL(
)DD( Returns the TRC as an array of shorts. If the profile has
specified the TRC as linear \201gamma = 1.0\202 or as a simple gamma
value, this method throws an exception, and the getGamma\201\202 method
should be used to get the gamma value. Otherwise the short array
returned here represents a lookup table where the input Gray value
is conceptually in the range [0.0, 1.0]. Value 0.0 maps
to array index 0 and value 1.0 maps to array index length-1.
Interpolation may be used to generate output values for
input values which do not map exactly to an index in the
array. Output values also map linearly to the range [0.0, 1.0].
Value 0.0 is represented by an array value of 0x0000 and
value 1.0 by 0xFFFF, i.e. the values are really unsigned
short values, although they are returned in a short array.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a short array representing the TRC.
)DT( )BD(Throws:)ES( )A(NoSuchProfileDataException)EA(
)DD( if the profile does not specify
the TRC as a table.
)LD(
)LD(
o )WB()EA(
)BD(getTRCLUT)ES()EA(
)PR(
public )A(LookupTable)EA( getTRCLUT\201boolean shortdata,
int num_entries,
int offset\202
)RP(
)DL(
)DD( Returns a LookupTable object which represents the TRC.
If shortdata is true, a ShortLookupTable is returned.
Otherwise, a ByteLookupTable is returned.
The number of entries and offset for the
LookupTable are provided as arguments to this method. The
first entry in the LookupTable will correspond to a TRC input
value of 0.0, and the last entry to 1.0. The byte or short
entries in the LookupTable will be computed from the TRC of the
profile and are unsigned values ranging from 0x00 to 0xFF for
byte data and from 0x0000 to 0xFFFF for short data.
This method returns a valid LookupTable both for TRCs
specified as tables and those specified as gamma values in the
profile.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a LookupTable representing the TRC.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.color.ICC_ProfileRGB
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.color.ICC_ProfileRGB
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.color.ICC_Profile)EA(
|
+----java.awt.color.ICC_ProfileRGB
)RP(
)HR(
)DL(
)DT( public class )BD(ICC_ProfileRGB)ES(
)DT( extends )A(ICC_Profile)EA(
)LD(
A subclass of the ICC_Profile class which represents profiles
which meet the following criteria: the color space type of the
profile is RGB, the PCS is the CIEXYZ space defined by the ICC
specification, and the profile includes the redColorantTag,
greenColorantTag, blueColorantTag, redTRCTag, greenTRCTag,
blueTRCTag, and mediaWhitePointTag tags. Examples of this
kind of profile are three-component matrix-based input profiles
and RGB display profiles. The
)A(
ICC_Profile.getInstance\201\202
)EA(
method will return an ICC_ProfileRGB object
when the above conditions are met. The advantage of this class
is that it provides color transform matrices and lookup tables
that Java or native methods may be able to use directly to
optimize color conversion in some cases.
)0 P(
To transform from a device profile color space to the CIEXYZ Profile
Connection Space, each device color component is first linearized by
a lookup through the corresponding tone reproduction curve \201TRC\202.
Then the resulting linear RGB components are converted via a 3x3 matrix
\201constructed from the RGB colorants\202 to the CIEXYZ PCS.
)PR(
linearR = redTRC[deviceR]
linearG = greenTRC[deviceG]
linearB = blueTRC[deviceB]
_ _ _ _ _ _
[ PCSX ] [ redColorantX greenColorantX blueColorantX ] [ linearR ]
[ ] [ ] [ ]
[ PCSY ] = [ redColorantY greenColorantY blueColorantY ] [ linearG ]
[ ] [ ] [ ]
[_ PCSZ _] [_ redColorantZ greenColorantZ blueColorantZ _] [_ linearB _]
)RP(
The inverse transform is done by converting PCS XYZ components to linear
RGB components via the inverse of the above 3x3 matrix, and then converting
linear RGB to device RGB via inverses of the TRCs.
)0 P(
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ALLCOMPONENTS)ES()EA(
)DD( To request a TRCLUT for the components.
)DT( o )WB(
)A()BD(BLUECOMPONENT)ES()EA(
)DD( To request a gamma value, TRC, or TRCLUT for the blue component.
)DT( o )WB(
)A()BD(GREENCOMPONENT)ES()EA(
)DD( To request a gamma value, TRC, or TRCLUT for the green component.
)DT( o )WB(
)A()BD(REDCOMPONENT)ES()EA(
)DD( To request a gamma value, TRC, or TRCLUT for the red component.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ICC_ProfileRGB)ES()EA(\201\202
)DD( Constructs an empty ICC_ProfileRGB.
)DT( o )WB(
)A()BD(ICC_ProfileRGB)ES()EA(\201byte[]\202
)DD( Constructs a new ICC_ProfileRGB from a byte data array.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getGamma)ES()EA(\201int\202
)DD( Returns a gamma value representing the tone reproduction curve
\201TRC\202 for a particular component.
)DT( o )WB(
)A()BD(getMatrix)ES()EA(\201\202
)DD( Returns a 3x3 float matrix constructed from the X, Y, and Z
components of the redColorantTag, greenColorantTag, and
blueColorantTag in the ICC profile, as described above.
)DT( o )WB(
)A()BD(getMediaWhitePoint)ES()EA(\201\202
)DD( Returns a float array of length 3 containing the X, Y, and Z
components of the mediaWhitePointTag in the ICC profile.
)DT( o )WB(
)A()BD(getTRC)ES()EA(\201int\202
)DD( Returns the TRC for a particular component as an array of
shorts.
)DT( o )WB(
)A()BD(getTRCLUT)ES()EA(\201int, boolean, int, int\202
)DD( Returns a LookupTable object which represents the TRC for
a single component \201specify REDCOMPONENT, GREENCOMPONENT,
or BLUECOMPONENT\202 or for all three components \201specify
ALLCOMPONENTS\202.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(REDCOMPONENT)ES(
)PR(
public static final int REDCOMPONENT
)RP(
)DL(
)DD( To request a gamma value, TRC, or TRCLUT for the red component.)0 P(
)LD(
o )WB()EA(
)BD(GREENCOMPONENT)ES(
)PR(
public static final int GREENCOMPONENT
)RP(
)DL(
)DD( To request a gamma value, TRC, or TRCLUT for the green component.)0 P(
)LD(
o )WB()EA(
)BD(BLUECOMPONENT)ES(
)PR(
public static final int BLUECOMPONENT
)RP(
)DL(
)DD( To request a gamma value, TRC, or TRCLUT for the blue component.)0 P(
)LD(
o )WB()EA(
)BD(ALLCOMPONENTS)ES(
)PR(
public static final int ALLCOMPONENTS
)RP(
)DL(
)DD( To request a TRCLUT for the components.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ICC_ProfileRGB)ES(
)PR(
public ICC_ProfileRGB\201\202
)RP(
)DL(
)DD( Constructs an empty ICC_ProfileRGB. Before using the profile
for any purpose all necessary profile data must be set to
appropriate values.
)0 P(
)LD(
o )WB()EA(
)BD(ICC_ProfileRGB)ES(
)PR(
public ICC_ProfileRGB\201byte data[]\202
)RP(
)DL(
)DD( Constructs a new ICC_ProfileRGB from a byte data array.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getMediaWhitePoint)ES()EA(
)PR(
public float[] getMediaWhitePoint\201\202
)RP(
)DL(
)DD( Returns a float array of length 3 containing the X, Y, and Z
components of the mediaWhitePointTag in the ICC profile.
)0 P(
)LD(
o )WB()EA(
)BD(getMatrix)ES()EA(
)PR(
public float[][] getMatrix\201\202
)RP(
)DL(
)DD( Returns a 3x3 float matrix constructed from the X, Y, and Z
components of the redColorantTag, greenColorantTag, and
blueColorantTag in the ICC profile, as described above.
This matrix can be used for color transforms in the forward
direction of the profile, i.e. from the profile color space
to the CIEXYZ PCS.
)0 P(
)LD(
o )WB()EA(
)BD(getGamma)ES()EA(
)PR(
public float getGamma\201int component\202
)RP(
)DL(
)DD( Returns a gamma value representing the tone reproduction curve
\201TRC\202 for a particular component. Component must be one of
REDCOMPONENT, GREENCOMPONENT, or BLUECOMPONENT. If the profile
represents the TRC for the corresponding component
as a table rather than a single gamma value, then an
exception is thrown. In this case the actual table
can be obtained via getTRC\201\202. When using a gamma value,
the linear component \201R, G, or B\202 is computed as follows:
)PR(
gamma
linearComponent = deviceComponent
)RP(
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the gamma value as a float.
)DT( )BD(Throws:)ES( )A(NoSuchProfileDataException)EA(
)DD( if the profile does not specify
the corresponding TRC as a single gamma value.
)LD(
)LD(
o )WB()EA(
)BD(getTRC)ES()EA(
)PR(
public short[] getTRC\201int component\202
)RP(
)DL(
)DD( Returns the TRC for a particular component as an array of
shorts. Component must be one of REDCOMPONENT, GREENCOMPONENT, or
BLUECOMPONENT. If the profile has specified the corresponding TRC
as linear \201gamma = 1.0\202 or as a simple gamma value, this method
throws an exception, and the getGamma\201\202 method should be used
to get the gamma value. Otherwise the short array returned here
represents a lookup table where the input component value
is conceptually in the range [0.0, 1.0]. Value 0.0 maps
to array index 0 and value 1.0 maps to array index length-1.
Interpolation may be used to generate output values for
input values which do not map exactly to an index in the
array. Output values also map linearly to the range [0.0, 1.0].
Value 0.0 is represented by an array value of 0x0000 and
value 1.0 by 0xFFFF, i.e. the values are really unsigned
short values, although they are returned in a short array.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a short array representing the TRC.
)DT( )BD(Throws:)ES( )A(NoSuchProfileDataException)EA(
)DD( if the profile does not specify
the corresponding TRC as a table.
)LD(
)LD(
o )WB()EA(
)BD(getTRCLUT)ES()EA(
)PR(
public )A(LookupTable)EA( getTRCLUT\201int component,
boolean shortdata,
int num_entries,
int offset\202
)RP(
)DL(
)DD( Returns a LookupTable object which represents the TRC for
a single component \201specify REDCOMPONENT, GREENCOMPONENT,
or BLUECOMPONENT\202 or for all three components \201specify
ALLCOMPONENTS\202. If shortdata is true, a ShortLookupTable is
returned. Otherwise, a ByteLookupTable is returned.
The number of entries
and offset for the LookupTable are provided as arguments to
this method. The first entry in the LookupTable will correspond
to a TRC input value of 0.0, and the last entry to 1.0. The
byte or short entries in the LookupTable will be computed from
the TRCs of the profile and are unsigned values ranging from
0x00 to 0xFF for byte data and from 0x0000 to 0xFFFF for short
data. This method returns a valid LookupTable
both for TRCs specified as tables and those specified as
gamma values in the profile.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a LookupTable representing the TRC\201s\202.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.color.NoSuchProfileDataException
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.color.NoSuchProfileDataException
)EH(
)PR(
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----java.lang.RuntimeException
|
+----java.awt.color.NoSuchProfileDataException
)RP(
)HR(
)DL(
)DT( public class )BD(NoSuchProfileDataException)ES(
)DT( extends RuntimeException
)LD(
This exception is thrown if an attempt is made to access data in
an ICC_Profile object when such data doesn't exist.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(NoSuchProfileDataException)ES()EA(\201String\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(NoSuchProfileDataException)ES(
)PR(
public NoSuchProfileDataException\201String s\202
)RP(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.font.MultipleMaster
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.font.MultipleMaster
)EH(
)DL(
)DT( public interface )BD(MultipleMaster)ES(
)LD(
This is an interface representing Type 1 Multiple Master fonts.
A particular Font object may implement this interface.
)0 P(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(deriveMMFont)ES()EA(\201float[]\202
)DD( Creates a new instance of a multiple master font based on the design axes
values specified by the array.
)DT( o )WB(
)A()BD(deriveMMFont)ES()EA(\201float[], float, float, float, float\202
)DD( Creates a new instance of a multiple master font based on detailed metric
information.
)DT( o )WB(
)A()BD(getDesignAxisDefaults)ES()EA(\201\202
)DD( Returns an array of default design values for each axis.
)DT( o )WB(
)A()BD(getDesignAxisNames)ES()EA(\201\202
)DD( Returns the name for each design axis.
)DT( o )WB(
)A()BD(getDesignAxisRanges)ES()EA(\201\202
)DD( Returns an array of design limits interleaved in the form [from->to]
for each axis.
)DT( o )WB(
)A()BD(getNumDesignAxes)ES()EA(\201\202
)DD( Returns the number of multiple master design controls.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getNumDesignAxes)ES()EA(
)PR(
public abstract int getNumDesignAxes\201\202
)RP(
)DL(
)DD( Returns the number of multiple master design controls.
Design axes include things like width, weight and optical scaling.
)0 P(
)LD(
o )WB()EA(
)BD(getDesignAxisRanges)ES()EA(
)PR(
public abstract float[] getDesignAxisRanges\201\202
)RP(
)DL(
)DD( Returns an array of design limits interleaved in the form [from->to]
for each axis. For example,
design limits for weight could be from 0.1 to 1.0. The values will be
returned in the same order returned by getDesignAxisNames\201\202.
)0 P(
)LD(
o )WB()EA(
)BD(getDesignAxisDefaults)ES()EA(
)PR(
public abstract float[] getDesignAxisDefaults\201\202
)RP(
)DL(
)DD( Returns an array of default design values for each axis. For example,
the default value for weight could be 1.6. The values will be returned
in the same order returned by getDesignAxisNames\201\202.
)0 P(
)LD(
o )WB()EA(
)BD(getDesignAxisNames)ES()EA(
)PR(
public abstract String[] getDesignAxisNames\201\202
)RP(
)DL(
)DD( Returns the name for each design axis. This also determines the order in
which the values for each axis will be returned.
)0 P(
)LD(
o )WB()EA(
)BD(deriveMMFont)ES()EA(
)PR(
public abstract )A(Font)EA( deriveMMFont\201float axes[]\202
)RP(
)DL(
)DD( Creates a new instance of a multiple master font based on the design axes
values specified by the array. The size of the array
must correspond to the value returned from getNumDesignAxes\201\202 and the
values of the array elements must fall within limits specified by
getDesignAxesLimits\201\202. In case of an error, NULL is returned.
)0 P(
)LD(
o )WB()EA(
)BD(deriveMMFont)ES()EA(
)PR(
public abstract )A(Font)EA( deriveMMFont\201float glyphWidths[],
float avgStemWidth,
float typicalCapHeight,
float typicalXHeight,
float italicAngle\202
)RP(
)DL(
)DD( Creates a new instance of a multiple master font based on detailed metric
information. In case of an error, NULL is returned.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( glyphWidths - An array of floats representing the desired width of
each glyph in font space.
)DD( avgStemWidth - The average stem width for the overall font in font
space.
)DD( typicalCapHeight - The height of a typical upper case char.
)DD( typicalXHeight - The height of a typical lower case char.
)DD( italicAngle - The angle at which the italics lean, in degrees
counterclockwise from vertical.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.font.OpenType
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.font.OpenType
)EH(
)DL(
)DT( public interface )BD(OpenType)ES(
)LD(
This interface represents OpenType and TrueType fonts. The goal
for this interface is to be able to return )I(sfnt)ES( tables from
the font. A particular Font object may implement this interface.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TAG_ACNT)ES()EA(
)DD( Accent attachment.
)DT( o )WB(
)A()BD(TAG_AVAR)ES()EA(
)DD( Axis variaiton.
)DT( o )WB(
)A()BD(TAG_BASE)ES()EA(
)DD( Baseline data.
)DT( o )WB(
)A()BD(TAG_BDAT)ES()EA(
)DD( Bitmap data.
)DT( o )WB(
)A()BD(TAG_BLOC)ES()EA(
)DD( Bitmap location.
)DT( o )WB(
)A()BD(TAG_BSLN)ES()EA(
)DD( Baselint table.
)DT( o )WB(
)A()BD(TAG_CFF)ES()EA(
)DD( Compact font format \201Type1 font\202.
)DT( o )WB(
)A()BD(TAG_CMAP)ES()EA(
)DD( Character to glyph mapping.
)DT( o )WB(
)A()BD(TAG_CVAR)ES()EA(
)DD( CVT variation.
)DT( o )WB(
)A()BD(TAG_CVT)ES()EA(
)DD( Control value table.
)DT( o )WB(
)A()BD(TAG_DSIG)ES()EA(
)DD( Digital signature.
)DT( o )WB(
)A()BD(TAG_EBDT)ES()EA(
)DD( Embedded bitmap data.
)DT( o )WB(
)A()BD(TAG_EBLC)ES()EA(
)DD( Embedded bitmap location.
)DT( o )WB(
)A()BD(TAG_EBSC)ES()EA(
)DD( Embedded bitmap scaling.
)DT( o )WB(
)A()BD(TAG_FDSC)ES()EA(
)DD( Font descriptors.
)DT( o )WB(
)A()BD(TAG_FEAT)ES()EA(
)DD( Feature name.
)DT( o )WB(
)A()BD(TAG_FMTX)ES()EA(
)DD( Font metrics.
)DT( o )WB(
)A()BD(TAG_FPGM)ES()EA(
)DD( Font program.
)DT( o )WB(
)A()BD(TAG_FVAR)ES()EA(
)DD( Font variation.
)DT( o )WB(
)A()BD(TAG_GASP)ES()EA(
)DD( Grid_fitting and scan conversion procedure.
)DT( o )WB(
)A()BD(TAG_GDEF)ES()EA(
)DD( Glyph definition.
)DT( o )WB(
)A()BD(TAG_GLYF)ES()EA(
)DD( Glyph data.
)DT( o )WB(
)A()BD(TAG_GPOS)ES()EA(
)DD( Glyph positioning.
)DT( o )WB(
)A()BD(TAG_GSUB)ES()EA(
)DD( Glyph substitution.
)DT( o )WB(
)A()BD(TAG_GVAR)ES()EA(
)DD( Glyph variation.
)DT( o )WB(
)A()BD(TAG_HDMX)ES()EA(
)DD( Horizontal device metrics.
)DT( o )WB(
)A()BD(TAG_HEAD)ES()EA(
)DD( Font header.
)DT( o )WB(
)A()BD(TAG_HHEA)ES()EA(
)DD( Horizontal metrics header.
)DT( o )WB(
)A()BD(TAG_HMTX)ES()EA(
)DD( Horizontal metrics.
)DT( o )WB(
)A()BD(TAG_JSTF)ES()EA(
)DD( Justification.
)DT( o )WB(
)A()BD(TAG_JUST)ES()EA(
)DD( Justification.
)DT( o )WB(
)A()BD(TAG_KERN)ES()EA(
)DD( Kerning.
)DT( o )WB(
)A()BD(TAG_LCAR)ES()EA(
)DD( Ligature caret.
)DT( o )WB(
)A()BD(TAG_LOCA)ES()EA(
)DD( Index to location.
)DT( o )WB(
)A()BD(TAG_LTSH)ES()EA(
)DD( Linear threshold.
)DT( o )WB(
)A()BD(TAG_MAXP)ES()EA(
)DD( Maximum profile.
)DT( o )WB(
)A()BD(TAG_MMFX)ES()EA(
)DD( Multiple master font metrics.
)DT( o )WB(
)A()BD(TAG_MMSD)ES()EA(
)DD( Multiple master supplementary data.
)DT( o )WB(
)A()BD(TAG_MORT)ES()EA(
)DD( Glyph metamorphosis.
)DT( o )WB(
)A()BD(TAG_NAME)ES()EA(
)DD( Naming table.
)DT( o )WB(
)A()BD(TAG_OPBD)ES()EA(
)DD( Optical bounds.
)DT( o )WB(
)A()BD(TAG_OS2)ES()EA(
)DD( OS/2 and windows specific metrics.
)DT( o )WB(
)A()BD(TAG_PCLT)ES()EA(
)DD( PCL 5 data.
)DT( o )WB(
)A()BD(TAG_POST)ES()EA(
)DD( Postscript Information.
)DT( o )WB(
)A()BD(TAG_PREP)ES()EA(
)DD( CVT preprogram.
)DT( o )WB(
)A()BD(TAG_PROP)ES()EA(
)DD( Glyph properties.
)DT( o )WB(
)A()BD(TAG_TRAK)ES()EA(
)DD( Tracking.
)DT( o )WB(
)A()BD(TAG_TYP1)ES()EA(
)DD( Adobe Type 1 font data.
)DT( o )WB(
)A()BD(TAG_VDMX)ES()EA(
)DD( Vertical device metrics.
)DT( o )WB(
)A()BD(TAG_VHEA)ES()EA(
)DD( Vertical metrics header.
)DT( o )WB(
)A()BD(TAG_VMTX)ES()EA(
)DD( Vertical metrics.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getFontTable)ES()EA(\201int\202
)DD( Returns the table as an array of bytes for a given tag.
)DT( o )WB(
)A()BD(getVersion)ES()EA(\201\202
)DD( Returns the version of the OpenType font.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(TAG_CMAP)ES(
)PR(
public static final int TAG_CMAP
)RP(
)DL(
)DD( Character to glyph mapping.)0 P(
)LD(
o )WB()EA(
)BD(TAG_HEAD)ES(
)PR(
public static final int TAG_HEAD
)RP(
)DL(
)DD( Font header.)0 P(
)LD(
o )WB()EA(
)BD(TAG_NAME)ES(
)PR(
public static final int TAG_NAME
)RP(
)DL(
)DD( Naming table.)0 P(
)LD(
o )WB()EA(
)BD(TAG_GLYF)ES(
)PR(
public static final int TAG_GLYF
)RP(
)DL(
)DD( Glyph data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_MAXP)ES(
)PR(
public static final int TAG_MAXP
)RP(
)DL(
)DD( Maximum profile.)0 P(
)LD(
o )WB()EA(
)BD(TAG_PREP)ES(
)PR(
public static final int TAG_PREP
)RP(
)DL(
)DD( CVT preprogram.)0 P(
)LD(
o )WB()EA(
)BD(TAG_HMTX)ES(
)PR(
public static final int TAG_HMTX
)RP(
)DL(
)DD( Horizontal metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_KERN)ES(
)PR(
public static final int TAG_KERN
)RP(
)DL(
)DD( Kerning.)0 P(
)LD(
o )WB()EA(
)BD(TAG_HDMX)ES(
)PR(
public static final int TAG_HDMX
)RP(
)DL(
)DD( Horizontal device metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_LOCA)ES(
)PR(
public static final int TAG_LOCA
)RP(
)DL(
)DD( Index to location.)0 P(
)LD(
o )WB()EA(
)BD(TAG_POST)ES(
)PR(
public static final int TAG_POST
)RP(
)DL(
)DD( Postscript Information.)0 P(
)LD(
o )WB()EA(
)BD(TAG_OS2)ES(
)PR(
public static final int TAG_OS2
)RP(
)DL(
)DD( OS/2 and windows specific metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_CVT)ES(
)PR(
public static final int TAG_CVT
)RP(
)DL(
)DD( Control value table.)0 P(
)LD(
o )WB()EA(
)BD(TAG_GASP)ES(
)PR(
public static final int TAG_GASP
)RP(
)DL(
)DD( Grid_fitting and scan conversion procedure.)0 P(
)LD(
o )WB()EA(
)BD(TAG_VDMX)ES(
)PR(
public static final int TAG_VDMX
)RP(
)DL(
)DD( Vertical device metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_VMTX)ES(
)PR(
public static final int TAG_VMTX
)RP(
)DL(
)DD( Vertical metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_VHEA)ES(
)PR(
public static final int TAG_VHEA
)RP(
)DL(
)DD( Vertical metrics header.)0 P(
)LD(
o )WB()EA(
)BD(TAG_HHEA)ES(
)PR(
public static final int TAG_HHEA
)RP(
)DL(
)DD( Horizontal metrics header.)0 P(
)LD(
o )WB()EA(
)BD(TAG_TYP1)ES(
)PR(
public static final int TAG_TYP1
)RP(
)DL(
)DD( Adobe Type 1 font data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_BSLN)ES(
)PR(
public static final int TAG_BSLN
)RP(
)DL(
)DD( Baselint table.)0 P(
)LD(
o )WB()EA(
)BD(TAG_GSUB)ES(
)PR(
public static final int TAG_GSUB
)RP(
)DL(
)DD( Glyph substitution.)0 P(
)LD(
o )WB()EA(
)BD(TAG_DSIG)ES(
)PR(
public static final int TAG_DSIG
)RP(
)DL(
)DD( Digital signature.)0 P(
)LD(
o )WB()EA(
)BD(TAG_FPGM)ES(
)PR(
public static final int TAG_FPGM
)RP(
)DL(
)DD( Font program.)0 P(
)LD(
o )WB()EA(
)BD(TAG_FVAR)ES(
)PR(
public static final int TAG_FVAR
)RP(
)DL(
)DD( Font variation.)0 P(
)LD(
o )WB()EA(
)BD(TAG_GVAR)ES(
)PR(
public static final int TAG_GVAR
)RP(
)DL(
)DD( Glyph variation.)0 P(
)LD(
o )WB()EA(
)BD(TAG_CFF)ES(
)PR(
public static final int TAG_CFF
)RP(
)DL(
)DD( Compact font format \201Type1 font\202.)0 P(
)LD(
o )WB()EA(
)BD(TAG_MMSD)ES(
)PR(
public static final int TAG_MMSD
)RP(
)DL(
)DD( Multiple master supplementary data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_MMFX)ES(
)PR(
public static final int TAG_MMFX
)RP(
)DL(
)DD( Multiple master font metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_BASE)ES(
)PR(
public static final int TAG_BASE
)RP(
)DL(
)DD( Baseline data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_GDEF)ES(
)PR(
public static final int TAG_GDEF
)RP(
)DL(
)DD( Glyph definition.)0 P(
)LD(
o )WB()EA(
)BD(TAG_GPOS)ES(
)PR(
public static final int TAG_GPOS
)RP(
)DL(
)DD( Glyph positioning.)0 P(
)LD(
o )WB()EA(
)BD(TAG_JSTF)ES(
)PR(
public static final int TAG_JSTF
)RP(
)DL(
)DD( Justification.)0 P(
)LD(
o )WB()EA(
)BD(TAG_EBDT)ES(
)PR(
public static final int TAG_EBDT
)RP(
)DL(
)DD( Embedded bitmap data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_EBLC)ES(
)PR(
public static final int TAG_EBLC
)RP(
)DL(
)DD( Embedded bitmap location.)0 P(
)LD(
o )WB()EA(
)BD(TAG_EBSC)ES(
)PR(
public static final int TAG_EBSC
)RP(
)DL(
)DD( Embedded bitmap scaling.)0 P(
)LD(
o )WB()EA(
)BD(TAG_LTSH)ES(
)PR(
public static final int TAG_LTSH
)RP(
)DL(
)DD( Linear threshold.)0 P(
)LD(
o )WB()EA(
)BD(TAG_PCLT)ES(
)PR(
public static final int TAG_PCLT
)RP(
)DL(
)DD( PCL 5 data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_ACNT)ES(
)PR(
public static final int TAG_ACNT
)RP(
)DL(
)DD( Accent attachment.)0 P(
)LD(
o )WB()EA(
)BD(TAG_AVAR)ES(
)PR(
public static final int TAG_AVAR
)RP(
)DL(
)DD( Axis variaiton.)0 P(
)LD(
o )WB()EA(
)BD(TAG_BDAT)ES(
)PR(
public static final int TAG_BDAT
)RP(
)DL(
)DD( Bitmap data.)0 P(
)LD(
o )WB()EA(
)BD(TAG_BLOC)ES(
)PR(
public static final int TAG_BLOC
)RP(
)DL(
)DD( Bitmap location.)0 P(
)LD(
o )WB()EA(
)BD(TAG_CVAR)ES(
)PR(
public static final int TAG_CVAR
)RP(
)DL(
)DD( CVT variation.)0 P(
)LD(
o )WB()EA(
)BD(TAG_FEAT)ES(
)PR(
public static final int TAG_FEAT
)RP(
)DL(
)DD( Feature name.)0 P(
)LD(
o )WB()EA(
)BD(TAG_FDSC)ES(
)PR(
public static final int TAG_FDSC
)RP(
)DL(
)DD( Font descriptors.)0 P(
)LD(
o )WB()EA(
)BD(TAG_FMTX)ES(
)PR(
public static final int TAG_FMTX
)RP(
)DL(
)DD( Font metrics.)0 P(
)LD(
o )WB()EA(
)BD(TAG_JUST)ES(
)PR(
public static final int TAG_JUST
)RP(
)DL(
)DD( Justification.)0 P(
)LD(
o )WB()EA(
)BD(TAG_LCAR)ES(
)PR(
public static final int TAG_LCAR
)RP(
)DL(
)DD( Ligature caret.)0 P(
)LD(
o )WB()EA(
)BD(TAG_MORT)ES(
)PR(
public static final int TAG_MORT
)RP(
)DL(
)DD( Glyph metamorphosis.)0 P(
)LD(
o )WB()EA(
)BD(TAG_OPBD)ES(
)PR(
public static final int TAG_OPBD
)RP(
)DL(
)DD( Optical bounds.)0 P(
)LD(
o )WB()EA(
)BD(TAG_PROP)ES(
)PR(
public static final int TAG_PROP
)RP(
)DL(
)DD( Glyph properties.)0 P(
)LD(
o )WB()EA(
)BD(TAG_TRAK)ES(
)PR(
public static final int TAG_TRAK
)RP(
)DL(
)DD( Tracking.)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getVersion)ES()EA(
)PR(
public abstract int getVersion\201\202
)RP(
)DL(
)DD( Returns the version of the OpenType font.
1.0 is represented as 0x00010000.
)0 P(
)LD(
o )WB()EA(
)BD(getFontTable)ES()EA(
)PR(
public abstract byte[] getFontTable\201int sfntTag\202
)RP(
)DL(
)DD( Returns the table as an array of bytes for a given tag. Tags for sfnt
tables include items like )I(cmap)ES(, )I(name)ES( and )I(head)ES(.
The byte array returned is a copy of the font data in memory.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.font.GlyphMetrics
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.font.GlyphMetrics
)EH(
)PR(
java.lang.Object
|
+----java.awt.font.GlyphMetrics
)RP(
)HR(
)DL(
)DT( public final class )BD(GlyphMetrics)ES(
)DT( extends Object
)LD(
This class provides metrics for a single glyph. This information
defines how to place the glyphs. It does not take into account
any kerning information.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(getGlyphMetrics)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(COMBINING)ES()EA(
)DD( This type indicates a glyph that represents a combining character, such as an umlaut.
)DT( o )WB(
)A()BD(COMPONENT)ES()EA(
)DD( This type indicates a glyph that is used in addition to the logically preceeding DEFAULT or LIGATURE
glyph.
)DT( o )WB(
)A()BD(HANGING_PUNCTUATION)ES()EA(
)DD( This value is added to the base type to indicate hanging punctuation.
)DT( o )WB(
)A()BD(LIGATURE)ES()EA(
)DD( This type indicates a glyph that represents multiple characters as a ligature, i.e.
)DT( o )WB(
)A()BD(STANDARD)ES()EA(
)DD( This type indicates a glyph that represents a single standard spacing character.
)DT( o )WB(
)A()BD(WHITESPACE)ES()EA(
)DD( This value is added to the base type to indicate whitespace.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GlyphMetrics)ES()EA(\201float, Rectangle2D, byte\202
)DD( Creates a GlyphMetrics object from an advance and bounds of a glyph.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getAdvance)ES()EA(\201\202
)DD( Returns the device independent advance.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Returns the device independent bounding box.
)DT( o )WB(
)A()BD(getLSB)ES()EA(\201\202
)DD( Returns the left side bearing of the glyph.
)DT( o )WB(
)A()BD(getRSB)ES()EA(\201\202
)DD( Returns the right side bearing of the glyph.
)DT( o )WB(
)A()BD(getType)ES()EA(\201\202
)DD( Return the raw glyph type code.
)DT( o )WB(
)A()BD(isCombining)ES()EA(\201\202
)DD( Return true if this is a combining glyph.
)DT( o )WB(
)A()BD(isComponent)ES()EA(\201\202
)DD( Return true if this is a component glyph.
)DT( o )WB(
)A()BD(isHangingPunctuation)ES()EA(\201\202
)DD( Return true if this is a hanging punctuation glyph.
)DT( o )WB(
)A()BD(isLigature)ES()EA(\201\202
)DD( Return true if this is a ligature glyph.
)DT( o )WB(
)A()BD(isStandard)ES()EA(\201\202
)DD( Return true if this is a standard glyph.
)DT( o )WB(
)A()BD(isVertical)ES()EA(\201\202
)DD( Returns true if the metrics associated with this glyph are vertical
and false if they are horizontal.
)DT( o )WB(
)A()BD(isWhitespace)ES()EA(\201\202
)DD( Return true if this is a whitespace glyph.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(STANDARD)ES(
)PR(
public static final byte STANDARD
)RP(
)DL(
)DD( This type indicates a glyph that represents a single standard spacing character.)0 P(
)LD(
o )WB()EA(
)BD(LIGATURE)ES(
)PR(
public static final byte LIGATURE
)RP(
)DL(
)DD( This type indicates a glyph that represents multiple characters as a ligature, i.e. 'fi' or 'ffi'
It is followed by non-spacing, non-drawing combining glyphs for the remaining characters.)0 P(
)LD(
o )WB()EA(
)BD(COMBINING)ES(
)PR(
public static final byte COMBINING
)RP(
)DL(
)DD( This type indicates a glyph that represents a combining character, such as an umlaut.)0 P(
)LD(
o )WB()EA(
)BD(COMPONENT)ES(
)PR(
public static final byte COMPONENT
)RP(
)DL(
)DD( This type indicates a glyph that is used in addition to the logically preceeding DEFAULT or LIGATURE
glyph. It has no corresponding character in the backing store, but instead is associated with
the characters represented by the base glyph.)0 P(
)LD(
o )WB()EA(
)BD(HANGING_PUNCTUATION)ES(
)PR(
public static final byte HANGING_PUNCTUATION
)RP(
)DL(
)DD( This value is added to the base type to indicate hanging punctuation. This
information is used in justification.)0 P(
)LD(
o )WB()EA(
)BD(WHITESPACE)ES(
)PR(
public static final byte WHITESPACE
)RP(
)DL(
)DD( This value is added to the base type to indicate whitespace. This information
is used in justification.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GlyphMetrics)ES(
)PR(
public GlyphMetrics\201float advance,
)A(Rectangle2D)EA( bounds,
byte glyphType\202
)RP(
)DL(
)DD( Creates a GlyphMetrics object from an advance and bounds of a glyph.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( float - the advance width of the glyph.
)DD( bounds - the device independent bounding box of the glyph.
)DD( isVertical - it is true if the associated metrics are vertical.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getAdvance)ES()EA(
)PR(
public float getAdvance\201\202
)RP(
)DL(
)DD( Returns the device independent advance. This method takes point
size into account. The advance returned is effectively in
user space coordinates.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the advance of the glyph
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Returns the device independent bounding box.
This method takes point size into account.
The bounding box returned is effectively in user space coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getLSB)ES()EA(
)PR(
public float getLSB\201\202
)RP(
)DL(
)DD( Returns the left side bearing of the glyph. This value is calculated.
)0 P(
)LD(
o )WB()EA(
)BD(getRSB)ES()EA(
)PR(
public float getRSB\201\202
)RP(
)DL(
)DD( Returns the right side bearing of the glyph. This value is calculated.
)0 P(
)LD(
o )WB()EA(
)BD(isVertical)ES()EA(
)PR(
public boolean isVertical\201\202
)RP(
)DL(
)DD( Returns true if the metrics associated with this glyph are vertical
and false if they are horizontal.
)0 P(
)LD(
o )WB()EA(
)BD(getType)ES()EA(
)PR(
public byte getType\201\202
)RP(
)DL(
)DD( Return the raw glyph type code.
)0 P(
)LD(
o )WB()EA(
)BD(isStandard)ES()EA(
)PR(
public boolean isStandard\201\202
)RP(
)DL(
)DD( Return true if this is a standard glyph.
)0 P(
)LD(
o )WB()EA(
)BD(isLigature)ES()EA(
)PR(
public boolean isLigature\201\202
)RP(
)DL(
)DD( Return true if this is a ligature glyph.
)0 P(
)LD(
o )WB()EA(
)BD(isCombining)ES()EA(
)PR(
public boolean isCombining\201\202
)RP(
)DL(
)DD( Return true if this is a combining glyph.
)0 P(
)LD(
o )WB()EA(
)BD(isComponent)ES()EA(
)PR(
public boolean isComponent\201\202
)RP(
)DL(
)DD( Return true if this is a component glyph.
)0 P(
)LD(
o )WB()EA(
)BD(isWhitespace)ES()EA(
)PR(
public boolean isWhitespace\201\202
)RP(
)DL(
)DD( Return true if this is a whitespace glyph.
)0 P(
)LD(
o )WB()EA(
)BD(isHangingPunctuation)ES()EA(
)PR(
public boolean isHangingPunctuation\201\202
)RP(
)DL(
)DD( Return true if this is a hanging punctuation glyph.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.font.GlyphSet
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.font.GlyphSet
)EH(
)PR(
java.lang.Object
|
+----java.awt.font.GlyphSet
)RP(
)HR(
)DL(
)DT( public class )BD(GlyphSet)ES(
)DT( extends Object
)LD(
This is the lowest level representation used to draw text. Exact
glyph codes and positions are used.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(drawString)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(LEFT_CONNECT_MASK)ES()EA(
)DD( Flag indicating a glyph is graphically connected to the preceeding
glyph.
)DT( o )WB(
)A()BD(LEFT_SHAPED_MASK)ES()EA(
)DD( Flag indicating a glyph's shape has been modifed by the glyph
preceeding it.
)DT( o )WB(
)A()BD(NO_MASK)ES()EA(
)DD(
Flag indicating a glyph is graphically unaffected by surrounding
glyphs.
)DT( o )WB(
)A()BD(RIGHT_CONNECT_MASK)ES()EA(
)DD(
Flag indicating a glyph is graphically connected to the following
glyph.
)DT( o )WB(
)A()BD(RIGHT_SHAPED_MASK)ES()EA(
)DD( Flag indicating a glyph's shape has been modifed by the glyph
following it.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GlyphSet)ES()EA(\201Font, int[], byte, float, float[], float, float[], int[], byte[], int\202
)DD( Constructs a new GlyphSet.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(appendGlyphs)ES()EA(\201int, int[], float[], float[], byte[], int[]\202
)DD( Append glyphs to this GlyphSet.
)DT( o )WB(
)A()BD(applyJustification)ES()EA(\201float[], int, boolean[]\202
)DD( Return a justified copy of this glyphset.
)DT( o )WB(
)A()BD(clone)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(equals)ES()EA(\201GlyphSet\202
)DD(
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(getAdvance)ES()EA(\201\202
)DD( Get the advance of the GlyphSet along its baseline.
)DT( o )WB(
)A()BD(getAdvanceBetween)ES()EA(\201int, int\202
)DD( Return the sum of the advances for the glyphs corresponding to characters
in logical positions from start up to limit.
)DT( o )WB(
)A()BD(getAdvances)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(getAdvances)ES()EA(\201boolean\202
)DD(
)DT( o )WB(
)A()BD(getAscent)ES()EA(\201\202
)DD( Get the maximum ascent of the glyphs in a GlyphSet.
)DT( o )WB(
)A()BD(getBackMapping)ES()EA(\201\202
)DD( Returns the backmapping for the GlyphSet.
)DT( o )WB(
)A()BD(getBaseline)ES()EA(\201\202
)DD( Return the baseline used by this glyphset.
)DT( o )WB(
)A()BD(getDescent)ES()EA(\201\202
)DD( Get the maximum descent of the glyphs in a GlyphSet.
)DT( o )WB(
)A()BD(getFont)ES()EA(\201\202
)DD( Returns the Font associated with this GlyphSet.
)DT( o )WB(
)A()BD(getGlyphCodes)ES()EA(\201\202
)DD( Returns an int array of the glyph codes for this GlyphSet.
)DT( o )WB(
)A()BD(getInverseOrder)ES()EA(\201int[]\202
)DD( Return the inverse array, source array must map 1-1
i.e.
)DT( o )WB(
)A()BD(getLevels)ES()EA(\201\202
)DD( Return an array indicating the direction levels of each glyph.
)DT( o )WB(
)A()BD(getLineBreakIndex)ES()EA(\201int, float\202
)DD(
)DT( o )WB(
)A()BD(getNormalizedOrder)ES()EA(\201int[], int, int\202
)DD( Return an array containing the values from start up to limit, normalized
to fall within the range from 0 up to limit - start.
)DT( o )WB(
)A()BD(getNumCharacters)ES()EA(\201\202
)DD( Return the number of characters represented by this glyphset.
)DT( o )WB(
)A()BD(getNumGlyphs)ES()EA(\201\202
)DD( Returns the number of glyphs associated with this GlyphSet.
)DT( o )WB(
)A()BD(getVisualOrder)ES()EA(\201\202
)DD( Return a mapping array from visual order to logical order.
)DT( o )WB(
)A()BD(getXAdjust)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(getXAdvances)ES()EA(\201boolean\202
)DD( Returns the advance of each glyph along the X axis.
)DT( o )WB(
)A()BD(getYAdjust)ES()EA(\201\202
)DD( Return the adjustment to the y position of the glyphset.
)DT( o )WB(
)A()BD(getYAdvances)ES()EA(\201boolean\202
)DD( Returns the advance of each glyph along the Y axis.
)DT( o )WB(
)A()BD(hashCode)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(isVertical)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(subset)ES()EA(\201int, int\202
)DD(
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(NO_MASK)ES(
)PR(
public static final int NO_MASK
)RP(
)DL(
)DD( Flag indicating a glyph is graphically unaffected by surrounding
glyphs.)0 P(
)LD(
o )WB()EA(
)BD(RIGHT_CONNECT_MASK)ES(
)PR(
public static final int RIGHT_CONNECT_MASK
)RP(
)DL(
)DD( Flag indicating a glyph is graphically connected to the following
glyph.)0 P(
)LD(
o )WB()EA(
)BD(LEFT_CONNECT_MASK)ES(
)PR(
public static final int LEFT_CONNECT_MASK
)RP(
)DL(
)DD( Flag indicating a glyph is graphically connected to the preceeding
glyph.)0 P(
)LD(
o )WB()EA(
)BD(RIGHT_SHAPED_MASK)ES(
)PR(
public static final int RIGHT_SHAPED_MASK
)RP(
)DL(
)DD( Flag indicating a glyph's shape has been modifed by the glyph
following it.)0 P(
)LD(
o )WB()EA(
)BD(LEFT_SHAPED_MASK)ES(
)PR(
public static final int LEFT_SHAPED_MASK
)RP(
)DL(
)DD( Flag indicating a glyph's shape has been modifed by the glyph
preceeding it.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GlyphSet)ES(
)PR(
public GlyphSet\201)A(Font)EA( font,
int glyphCodes[],
byte baseline,
float xAdjust,
float xAdvances[],
float yAdjust,
float yAdvances[],
int visualOrder[],
byte levels[],
int glyphCount\202
)RP(
)DL(
)DD( Constructs a new GlyphSet.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( font - the Font object for the GlyphSet from which the glyphs are taken.
)DD( size - the mininum size of array parameters. Elements in the
input arrays at index size and beyond are ignored by the GlyphSet.
)DD( glyphCodes - an int array of glyph codes representing specific glyphs
in the font. The array must be non-null.
)DD( advanceWidths - the advances of the glyphs along the x-axis.
All values must be non-negative. If null then default values will be generated.
)DD( flags - an array of flags indicating how each glyph's shape is
influenced by its neighboring glyphs. Null may be passed if all values are
set to NOT_CONNECTED_MASK.
)DD( backMapping - an int array representing the mapping from logical to visual
order. If null, each glyph represents exactly one character in the text and
the visual and logical order are assumed to be the same.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getInverseOrder)ES()EA(
)PR(
public static int[] getInverseOrder\201int values[]\202
)RP(
)DL(
)DD( Return the inverse array, source array must map 1-1
i.e. if values[i] = j, then inverse[j] = i.
)0 P(
)LD(
o )WB()EA(
)BD(getNormalizedOrder)ES()EA(
)PR(
public static int[] getNormalizedOrder\201int values[],
int start,
int limit\202
)RP(
)DL(
)DD( Return an array containing the values from start up to limit, normalized
to fall within the range from 0 up to limit - start. If this would be
a canonical ltr ordering, return null.
)0 P(
)LD(
o )WB()EA(
)BD(getFont)ES()EA(
)PR(
public )A(Font)EA( getFont\201\202
)RP(
)DL(
)DD( Returns the Font associated with this GlyphSet.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( font object associated with this glyph set.
)LD(
)LD(
o )WB()EA(
)BD(appendGlyphs)ES()EA(
)PR(
public void appendGlyphs\201int size,
int glyphCodes[],
float xAdvance[],
float yAdvance[],
byte flags[],
int backMapping[]\202
)RP(
)DL(
)DD( Append glyphs to this GlyphSet.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( size - the mininum size of array parameters. Elements in the
input arrays at index size and beyond are ignored by the GlyphSet.
)DD( glyphCodes - an int array of glyph codes representing specific glyphs
in the font. The array must be non-null.
)DD( xAdvance - the advance of the glyphs along the x-axis.
All values must be non-negative. If null then default values will be generated.
)DD( yAdvance - the advance of the glyphs along the y-axis.
All values must be non-negative. If null then default values will be generated.
)DD( flags - an array of flags indicating how each glyph's shape is
influenced by its neighboring glyphs. Null may be passed if all values are
set to NOT_CONNECTED_MASK.
)DD( backMapping - an int array representing the mapping from logical to visual
order. If null, each glyph represents exactly one character in the text and
the visual and logical order are assumed to be the same.
)LD(
)LD(
o )WB()EA(
)BD(clone)ES()EA(
)PR(
public Object clone\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(clone)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(getAdvance)ES()EA(
)PR(
public float getAdvance\201\202
)RP(
)DL(
)DD( Get the advance of the GlyphSet along its baseline.
)0 P(
)LD(
o )WB()EA(
)BD(getAscent)ES()EA(
)PR(
public float getAscent\201\202
)RP(
)DL(
)DD( Get the maximum ascent of the glyphs in a GlyphSet.
)0 P(
)LD(
o )WB()EA(
)BD(getDescent)ES()EA(
)PR(
public float getDescent\201\202
)RP(
)DL(
)DD( Get the maximum descent of the glyphs in a GlyphSet.
)0 P(
)LD(
o )WB()EA(
)BD(getNumGlyphs)ES()EA(
)PR(
public int getNumGlyphs\201\202
)RP(
)DL(
)DD( Returns the number of glyphs associated with this GlyphSet.
)0 P(
)LD(
o )WB()EA(
)BD(getNumCharacters)ES()EA(
)PR(
public int getNumCharacters\201\202
)RP(
)DL(
)DD( Return the number of characters represented by this glyphset.
Kashida justification may lead to there being more glyphs than characters. There
are never fewer glyphs than characters.
)0 P(
)LD(
o )WB()EA(
)BD(getGlyphCodes)ES()EA(
)PR(
public int[] getGlyphCodes\201\202
)RP(
)DL(
)DD( Returns an int array of the glyph codes for this GlyphSet.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( an array of glyph codes associated with this GlyphSet.
)LD(
)LD(
o )WB()EA(
)BD(getXAdvances)ES()EA(
)PR(
public float[] getXAdvances\201boolean mustBeNonNull\202
)RP(
)DL(
)DD( Returns the advance of each glyph along the X axis. If non-null,
only the first getNumGlyphs glyph codes are valid.
If null, all glyphs advance 0 along the X axis.
This array reflects the actual internal structure of the glyph set
and any modification to it will be reflected in the glyph set
itself.
)0 P(
)LD(
o )WB()EA(
)BD(getYAdvances)ES()EA(
)PR(
public float[] getYAdvances\201boolean mustBeNonNull\202
)RP(
)DL(
)DD( Returns the advance of each glyph along the Y axis. If non-null,
only the first getNumGlyphs glyph codes are valid.
If null, all glyphs advance 0 along the Y axis.
This array reflects the actual internal structure of the glyph set
and any modification to it will be reflected in the glyph set
itself.
)0 P(
)LD(
o )WB()EA(
)BD(getBaseline)ES()EA(
)PR(
public byte getBaseline\201\202
)RP(
)DL(
)DD( Return the baseline used by this glyphset. All glyphs in a single glyphset align to the same
baseline.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Font.getBaselineFor)EA(
)LD(
)LD(
o )WB()EA(
)BD(getXAdjust)ES()EA(
)PR(
public float getXAdjust\201\202
)RP(
o )WB()EA(
)BD(getYAdjust)ES()EA(
)PR(
public float getYAdjust\201\202
)RP(
)DL(
)DD( Return the adjustment to the y position of the glyphset.
The first visual glyph in the glyphset is positioned at offset by x, y from the
origin of the glyphset. This supports such features as superscript and hanging punctuation.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getXAdjust)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBackMapping)ES()EA(
)PR(
public int[] getBackMapping\201\202
)RP(
)DL(
)DD( Returns the backmapping for the GlyphSet. If null, each glyph
represents exactly one character in the text and the text's
visual order and logical order are assumed to be the same.
)0 P(
)LD(
o )WB()EA(
)BD(isVertical)ES()EA(
)PR(
public boolean isVertical\201\202
)RP(
o )WB()EA(
)BD(getAdvances)ES()EA(
)PR(
public float[] getAdvances\201\202
)RP(
o )WB()EA(
)BD(getAdvances)ES()EA(
)PR(
public float[] getAdvances\201boolean mustNotBeNull\202
)RP(
o )WB()EA(
)BD(getVisualOrder)ES()EA(
)PR(
public int[] getVisualOrder\201\202
)RP(
)DL(
)DD( Return a mapping array from visual order to logical order.
This array may be null, in which case the visual order == the logical order. Otherwise,
the index used to access information about the leftmost \201topmost\202 visual glyphs is
provided by getVisualOrder\201\202[0], the next glyph by getVisualOrder\201\202[1], and so on.
)0 P(
The array may be longer than necessary. The actual number of valid values in the array
is provided by getNumGlyphs\201\202.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getNumGlyphs)EA(
)LD(
)LD(
o )WB()EA(
)BD(getLevels)ES()EA(
)PR(
public byte[] getLevels\201\202
)RP(
)DL(
)DD( Return an array indicating the direction levels of each glyph.
Glyphs whose level is even run from left to right \201top to bottom\202, glyphs whose level is odd
run from right to left \201bottom to top\202. This array may be null, in which case the level of
each glyph is zero.
)0 P(
The array may be longer than necessary. The actual number of valid values in the array
is provided by getNumGlyphs\201\202.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getNumGlyphs)EA(
)LD(
)LD(
o )WB()EA(
)BD(applyJustification)ES()EA(
)PR(
public )A(GlyphSet)EA( applyJustification\201float deltas[],
int index,
boolean flags[]\202
)RP(
)DL(
)DD( Return a justified copy of this glyphset.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Font.handleApplyJustification)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAdvanceBetween)ES()EA(
)PR(
public float getAdvanceBetween\201int start,
int limit\202
)RP(
)DL(
)DD( Return the sum of the advances for the glyphs corresponding to characters
in logical positions from start up to limit. Note these are character indices, not
glyph indices. They will be mapped internally to glyph indices.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( start - the character index at which to start measuring
)DD( limit - the character index at which to stop measuring
)LD(
)LD(
o )WB()EA(
)BD(getLineBreakIndex)ES()EA(
)PR(
public int getLineBreakIndex\201int start,
float hitAdvance\202
)RP(
o )WB()EA(
)BD(subset)ES()EA(
)PR(
public )A(GlyphSet)EA( subset\201int logicalStart,
int logicalLimit\202
)RP(
o )WB()EA(
)BD(hashCode)ES()EA(
)PR(
public int hashCode\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(hashCode)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201)A(GlyphSet)EA( set\202
)RP(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.font.StyledString
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.font.StyledString
)EH(
)PR(
java.lang.Object
|
+----java.awt.font.StyledString
)RP(
)HR(
)DL(
)DT( public class )BD(StyledString)ES(
)DT( extends Object
)LD(
This class encapsulates information needed to draw text. It simplifies
drawing text strings with multiple Fonts and languages. It performs
layout of glyphs representing text strings with multiple Fonts,
including bi-directional layout for mixed languages.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(drawString)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(StyledString)ES()EA(\201\202
)DD( Constructs a new StyledString with no characters.
)DT( o )WB(
)A()BD(StyledString)ES()EA(\201String, Font\202
)DD( Constructs a new StyledString from the given String using the given Font.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(charAt)ES()EA(\201int\202
)DD( Returns the character at the specified index.
)DT( o )WB(
)A()BD(concat)ES()EA(\201StyledString\202
)DD( Concatenates the specified StyledString to the end of this StyledString
and returns a new StyledString object representing the concatenation.
)DT( o )WB(
)A()BD(createIterator)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(createIterator)ES()EA(\201int, int, int\202
)DD(
)DT( o )WB(
)A()BD(getAdvanceVector)ES()EA(\201\202
)DD( Returns the advance vector for the end position of this StyledString.
)DT( o )WB(
)A()BD(getAscent)ES()EA(\201\202
)DD( Returns the largest ascent of any font represented in this StyledString.
)DT( o )WB(
)A()BD(getAttributes)ES()EA(\201int\202
)DD(
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Returns the bounding box of this StyledString.
)DT( o )WB(
)A()BD(getDescent)ES()EA(\201\202
)DD( Returns the largest descent of any font represented in this StyledString.
)DT( o )WB(
)A()BD(getFontAt)ES()EA(\201int\202
)DD( Returns the Font associated with the character at the specified index.
)DT( o )WB(
)A()BD(getGlyphSets)ES()EA(\201\202
)DD( Returns an array of GlyphSet objects associated with this StyledString.
)DT( o )WB(
)A()BD(getLeading)ES()EA(\201\202
)DD( Returns the largest leading of any font represented in this StyledString.
)DT( o )WB(
)A()BD(getRunLimit)ES()EA(\201int\202
)DD(
)DT( o )WB(
)A()BD(getRunStart)ES()EA(\201int\202
)DD(
)DT( o )WB(
)A()BD(getStringOutline)ES()EA(\201\202
)DD( Returns the Shape object for this StyledString, which is the union
of all the outlines for glyphs in the StyledString.
)DT( o )WB(
)A()BD(length)ES()EA(\201\202
)DD( Returns the length of the StyledString.
)DT( o )WB(
)A()BD(substring)ES()EA(\201int, int\202
)DD( Creates a StyledString object that is a substring of this StyledString.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Generates a String representation of the StyledString.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(StyledString)ES(
)PR(
public StyledString\201\202
)RP(
)DL(
)DD( Constructs a new StyledString with no characters.
)0 P(
)LD(
o )WB()EA(
)BD(StyledString)ES(
)PR(
public StyledString\201String str,
)A(Font)EA( font\202
)RP(
)DL(
)DD( Constructs a new StyledString from the given String using the given Font.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( str - the String object.
)DD( font - the Font object.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(substring)ES()EA(
)PR(
public )A(StyledString)EA( substring\201int beginIndex,
int endIndex\202
)RP(
)DL(
)DD( Creates a StyledString object that is a substring of this StyledString.
The substring is specified by a beginIndex \201inclusive\202 and an endIndex
\201exclusive\202.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( beginIndex - the beginning character index \201inclusive\202 for the
substring.
)DD( endIndex - the ending character index \201exclusive\202 for the substring.
)DT( )BD(Throws:)ES( StringIndexOutOfBoundsException
)DD( if the beginIndex
or the endIndex is out of range, or if the beginIndex is greater than
the endIndex.
)LD(
)LD(
o )WB()EA(
)BD(getAscent)ES()EA(
)PR(
public float getAscent\201\202
)RP(
)DL(
)DD( Returns the largest ascent of any font represented in this StyledString.
The units are user space coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getDescent)ES()EA(
)PR(
public float getDescent\201\202
)RP(
)DL(
)DD( Returns the largest descent of any font represented in this StyledString.
The units are user space coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getLeading)ES()EA(
)PR(
public float getLeading\201\202
)RP(
)DL(
)DD( Returns the largest leading of any font represented in this StyledString.
The units are user space coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getAttributes)ES()EA(
)PR(
public AttributeSet getAttributes\201int index\202
)RP(
o )WB()EA(
)BD(getRunStart)ES()EA(
)PR(
public int getRunStart\201int index\202
)RP(
o )WB()EA(
)BD(getRunLimit)ES()EA(
)PR(
public int getRunLimit\201int index\202
)RP(
o )WB()EA(
)BD(getAdvanceVector)ES()EA(
)PR(
public )A(Point2D)EA( getAdvanceVector\201\202
)RP(
)DL(
)DD( Returns the advance vector for the end position of this StyledString.
The units are user space coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Returns the bounding box of this StyledString.
The units are user space coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getGlyphSets)ES()EA(
)PR(
public )A(GlyphSet)EA([] getGlyphSets\201\202
)RP(
)DL(
)DD( Returns an array of GlyphSet objects associated with this StyledString.
)0 P(
)LD(
o )WB()EA(
)BD(getStringOutline)ES()EA(
)PR(
public )A(Shape)EA( getStringOutline\201\202
)RP(
)DL(
)DD( Returns the Shape object for this StyledString, which is the union
of all the outlines for glyphs in the StyledString.
)0 P(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Generates a String representation of the StyledString.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(concat)ES()EA(
)PR(
public )A(StyledString)EA( concat\201)A(StyledString)EA( str\202
)RP(
)DL(
)DD( Concatenates the specified StyledString to the end of this StyledString
and returns a new StyledString object representing the concatenation.
)0 P(
)LD(
o )WB()EA(
)BD(charAt)ES()EA(
)PR(
public char charAt\201int index\202
)RP(
)DL(
)DD( Returns the character at the specified index. An index ranges from 0
to length\201\202 - 1.
)0 P(
)DD()DL(
)DT( )BD(Throws:)ES( StringIndexOutOfBoundsException
)DD( if the index
is not in the range 0 to length\201\202-1.
)LD(
)LD(
o )WB()EA(
)BD(getFontAt)ES()EA(
)PR(
public )A(Font)EA( getFontAt\201int index\202
)RP(
)DL(
)DD( Returns the Font associated with the character at the specified index.
An index ranges from 0 to length\201\202 - 1.
)0 P(
)DD()DL(
)DT( )BD(Throws:)ES( StringIndexOutOfBoundsException
)DD( if the index
is not in the range 0 to length\201\202-1.
)LD(
)LD(
o )WB()EA(
)BD(length)ES()EA(
)PR(
public int length\201\202
)RP(
)DL(
)DD( Returns the length of the StyledString. The length of the
StyledString is equal to the number of 16-bit Unicode characters
in the String.
)0 P(
)LD(
o )WB()EA(
)BD(createIterator)ES()EA(
)PR(
public AttributedCharacterIterator createIterator\201\202
)RP(
o )WB()EA(
)BD(createIterator)ES()EA(
)PR(
public AttributedCharacterIterator createIterator\201int start,
int limit,
int pos\202
)RP(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.font.TextAttributeSet
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.font.TextAttributeSet
)EH(
)PR(
java.lang.Object
|
+----java.awt.font.TextAttributeSet
)RP(
)HR(
)DL(
)DT( public final class )BD(TextAttributeSet)ES(
)DT( extends Object
)DT( implements MutableAttributeSet
)LD(
This defines attributes and values used by the text layout classes.
It also provides a simple implementation of MutableAttributeSet.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BACKGROUND)ES()EA(
)DD( The background color.
)DT( o )WB(
)A()BD(BACKGROUND_DEFAULT)ES()EA(
)DD( The default background color if BACKGROUND is unspecified.
)DT( o )WB(
)A()BD(BASELINE)ES()EA(
)DD( Baseline to which to align lines.
)DT( o )WB(
)A()BD(BASELINE_DEFAULT)ES()EA(
)DD( The default baseline if BASELINE is unspecified.
)DT( o )WB(
)A()BD(BASELINE_HANGING)ES()EA(
)DD( Use a hanging baseline for the line.
)DT( o )WB(
)A()BD(BASELINE_IDEOGRAPHIC)ES()EA(
)DD( Use a center baseline for the line.
)DT( o )WB(
)A()BD(BASELINE_OFFSETS)ES()EA(
)DD( Baseline offsets used by a line.
)DT( o )WB(
)A()BD(BASELINE_OFFSETS_DEFAULT)ES()EA(
)DD( The default baseline offsets if BASELINE_OFFSETS is unspecified.
)DT( o )WB(
)A()BD(BASELINE_ROMAN)ES()EA(
)DD( Use a roman baseline for the line.
)DT( o )WB(
)A()BD(BIDI_EMBEDDING)ES()EA(
)DD( The embedding level for nested bidirectional runs.
)DT( o )WB(
)A()BD(BIDI_EMBEDDING_DEFAULT)ES()EA(
)DD( The default embedding if BIDI_EMBEDDING is unspecified.
)DT( o )WB(
)A()BD(BIDI_NUMERIC)ES()EA(
)DD( The bidirectional layout control for roman numeral text.
)DT( o )WB(
)A()BD(BIDI_NUMERIC_DEFAULT)ES()EA(
)DD(
)DT( o )WB(
)A()BD(BIDI_NUMERIC_STRONG_ARABIC)ES()EA(
)DD( Interpret roman numerals as arabic numerals always.
)DT( o )WB(
)A()BD(BIDI_NUMERIC_STRONG_ROMAN)ES()EA(
)DD( Interpret roman numerals as roman numerals always.
)DT( o )WB(
)A()BD(BIDI_NUMERIC_WEAK_ARABIC)ES()EA(
)DD( Interpret roman numerals as having arabic line order.
)DT( o )WB(
)A()BD(EMPTY)ES()EA(
)DD( An empty attribute set, for convenience.
)DT( o )WB(
)A()BD(FAMILY)ES()EA(
)DD( The unlocalized font family name.
)DT( o )WB(
)A()BD(FAMILY_ALL)ES()EA(
)DD(
)DT( o )WB(
)A()BD(FONT)ES()EA(
)DD( The font to use to render this text.
)DT( o )WB(
)A()BD(FOREGROUND)ES()EA(
)DD( The foreground color.
)DT( o )WB(
)A()BD(FOREGROUND_DEFAULT)ES()EA(
)DD( The default foreground color if FOREGROUND is unspecified.
)DT( o )WB(
)A()BD(INPUT_METHOD_SEGMENT)ES()EA(
)DD( Constant for the attribute "input method segment".
)DT( o )WB(
)A()BD(JUSTIFICATION)ES()EA(
)DD( Justification for the paragraph.
)DT( o )WB(
)A()BD(JUSTIFICATION_DEFAULT)ES()EA(
)DD( The default justification if JUSTIFICATION is unspecified.
)DT( o )WB(
)A()BD(JUSTIFICATION_FULL)ES()EA(
)DD( Justify the line to the full requested width.
)DT( o )WB(
)A()BD(LANGUAGE)ES()EA(
)DD( Constant for the attribute "language".
)DT( o )WB(
)A()BD(POSTURE)ES()EA(
)DD( The posture of the font.
)DT( o )WB(
)A()BD(POSTURE_DEFAULT)ES()EA(
)DD( The default posture if POSTURE is unspecified.
)DT( o )WB(
)A()BD(POSTURE_ITALIC)ES()EA(
)DD( The standard italic posture for the font.
)DT( o )WB(
)A()BD(READING)ES()EA(
)DD( Constant for the attribute "reading".
)DT( o )WB(
)A()BD(RUN_DIRECTION)ES()EA(
)DD( The run direction of the line, either left-to-right or right-to-left.
)DT( o )WB(
)A()BD(RUN_DIRECTION_DEFAULT)ES()EA(
)DD( The default direction if RUN_DIRECTION is unspecified.
)DT( o )WB(
)A()BD(RUN_DIRECTION_LTR)ES()EA(
)DD( Left-to-right \201top-to-bottom\202 run direction.
)DT( o )WB(
)A()BD(RUN_DIRECTION_RTL)ES()EA(
)DD( Right-to-left \201bottom-to-top\202 run direction.
)DT( o )WB(
)A()BD(SIZE)ES()EA(
)DD( The font size in points.
)DT( o )WB(
)A()BD(STRIKETHROUGH)ES()EA(
)DD( Adorn the text with strikethrough.
)DT( o )WB(
)A()BD(STRIKETHROUGH_DEFAULT)ES()EA(
)DD( The default strikethrough if STRIKETHROUGH is unspecified, the value is false.
)DT( o )WB(
)A()BD(STRIKETHROUGH_ON)ES()EA(
)DD( A single strikethrough.
)DT( o )WB(
)A()BD(SUPERSUBSCRIPT)ES()EA(
)DD( Super and subscripting.
)DT( o )WB(
)A()BD(SUPERSUBSCRIPT_DEFAULT)ES()EA(
)DD( The default supersubscript if SUPERSUBSCRIPT is unspecified.
)DT( o )WB(
)A()BD(SUPERSUBSCRIPT_DOWN1)ES()EA(
)DD( Standard subscript.
)DT( o )WB(
)A()BD(SUPERSUBSCRIPT_UP1)ES()EA(
)DD( Standard superscript.
)DT( o )WB(
)A()BD(TRANSFORM)ES()EA(
)DD( The transform of the font.
)DT( o )WB(
)A()BD(TRANSFORM_DEFAULT)ES()EA(
)DD( The default transform if TRANSFORM is unspecified.
)DT( o )WB(
)A()BD(UNDERLINE)ES()EA(
)DD( Adorn the text with underlining.
)DT( o )WB(
)A()BD(UNDERLINE_DEFAULT)ES()EA(
)DD( The default underline if UNDERLINE is unspecified.
)DT( o )WB(
)A()BD(UNDERLINE_ON)ES()EA(
)DD( Draw an underline.
)DT( o )WB(
)A()BD(WEIGHT)ES()EA(
)DD( The weight of the font.
)DT( o )WB(
)A()BD(WEIGHT_BOLD)ES()EA(
)DD( The bold weight for the font.
)DT( o )WB(
)A()BD(WEIGHT_DEFAULT)ES()EA(
)DD( The default weight if WEIGHT is unspecified.
)DT( o )WB(
)A()BD(WEIGHT_LIGHT)ES()EA(
)DD( The light weight for the font.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TextAttributeSet)ES()EA(\201\202
)DD( Construct a new mutable attribute set.
)DT( o )WB(
)A()BD(TextAttributeSet)ES()EA(\201AttributeSet\202
)DD( Construct a new mutable attribute set containing the provided attributes.
)DT( o )WB(
)A()BD(TextAttributeSet)ES()EA(\201String, Object\202
)DD( Construct a new mutable attribute set containing the provided attribute.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(add)ES()EA(\201AttributeSet\202
)DD( Remove any existing attributes with the same names, and add the
new attributes.
)DT( o )WB(
)A()BD(add)ES()EA(\201String, Object\202
)DD( Remove any existing attribute with the same name, and add a new
attribute with the given name and value.
)DT( o )WB(
)A()BD(clone)ES()EA(\201\202
)DD( Return a copy of this attribute set.
)DT( o )WB(
)A()BD(contains)ES()EA(\201AttributeSet\202
)DD( Returns true if this set contains all the attributes with equal values.
)DT( o )WB(
)A()BD(contains)ES()EA(\201String, Object\202
)DD( Returns true if this set contains this attribute with an equal value,
or if the value is null and the attribute is not defined.
)DT( o )WB(
)A()BD(equals)ES()EA(\201AttributeSet\202
)DD( Return true if the argument contains the same attributes as this.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Return true if the argument is an attribute set containing the same attributes as this.
)DT( o )WB(
)A()BD(get)ES()EA(\201String\202
)DD( Returns the value of the attribute with this name, or null if the
attribute is not defined.
)DT( o )WB(
)A()BD(getSize)ES()EA(\201\202
)DD( Returns the number of attributes.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Returns true if the set is empty.
)DT( o )WB(
)A()BD(names)ES()EA(\201\202
)DD( Returns an enumeration over the names of the attributes in the set.
)DT( o )WB(
)A()BD(remove)ES()EA(\201Enumeration\202
)DD( Remove any existing attributes with the given names.
)DT( o )WB(
)A()BD(remove)ES()EA(\201String\202
)DD( Remove any existing attribute with the given name.
)DT( o )WB(
)A()BD(set)ES()EA(\201AttributeSet\202
)DD( Removes all attributes, then adds the new attributes.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(LANGUAGE)ES(
)PR(
public static final String LANGUAGE
)RP(
)DL(
)DD( Constant for the attribute "language". The value of this attribute should
be an instance of Locale.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( Locale
)LD(
)LD(
o )WB()EA(
)BD(READING)ES(
)PR(
public static final String READING
)RP(
)DL(
)DD( Constant for the attribute "reading". In languages where the written form
and the pronunciation of a word are only loosely related \201such as Japanese\202,
it is often necessary to store the reading \201pronunciation\202 along with the
written form. This is an annotation attribute. The value should be an instance
of Annotation holding an instance of String.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( Annotation, String
)LD(
)LD(
o )WB()EA(
)BD(INPUT_METHOD_SEGMENT)ES(
)PR(
public static final String INPUT_METHOD_SEGMENT
)RP(
)DL(
)DD( Constant for the attribute "input method segment". Input methods often break
up text into segments, which usually correspond to words. This is an annotation
attribute. The value should be an instance of Annotation holding a value of null.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( String
)LD(
)LD(
o )WB()EA(
)BD(FAMILY)ES(
)PR(
public static final String FAMILY
)RP(
)DL(
)DD( The unlocalized font family name.
)0 P(Values are instances of String, e.g. "Serif", "Palatino".)0 P(
)LD(
o )WB()EA(
)BD(FAMILY_ALL)ES(
)PR(
public static final String FAMILY_ALL
)RP(
o )WB()EA(
)BD(WEIGHT)ES(
)PR(
public static final String WEIGHT
)RP(
)DL(
)DD( The weight of the font.
)0 P(Values are instances of Float. The value is between 0.0 and 2.0.
This roughly corresponds to the ratio of the stem width to the width of regular characters
for this typeface. Lower values are lighter.)0 P(
)LD(
o )WB()EA(
)BD(WEIGHT_DEFAULT)ES(
)PR(
public static final Float WEIGHT_DEFAULT
)RP(
)DL(
)DD( The default weight if WEIGHT is unspecified. This value is 1.0.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(WEIGHT)EA(
)LD(
)LD(
o )WB()EA(
)BD(WEIGHT_BOLD)ES(
)PR(
public static final Float WEIGHT_BOLD
)RP(
)DL(
)DD( The bold weight for the font. This value is 1.5.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(WEIGHT)EA(
)LD(
)LD(
o )WB()EA(
)BD(WEIGHT_LIGHT)ES(
)PR(
public static final Float WEIGHT_LIGHT
)RP(
)DL(
)DD( The light weight for the font. This value is 0.7.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(WEIGHT)EA(
)LD(
)LD(
o )WB()EA(
)BD(POSTURE)ES(
)PR(
public static final String POSTURE
)RP(
)DL(
)DD( The posture of the font.
)0 P(Values are instances of Float. The value is the run/rise, generally
between -1.0 and 1.0, where negative values indicate a leftwards slant, positive a rightwards
slant, and zero no slant. There is no guarantee, however, that the slope of the text
as returned by font will be the same as the posture value.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getItalicAngle)EA(
)LD(
)LD(
o )WB()EA(
)BD(POSTURE_DEFAULT)ES(
)PR(
public static final Float POSTURE_DEFAULT
)RP(
)DL(
)DD( The default posture if POSTURE is unspecified. This value is 0.0.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(POSTURE)EA(
)LD(
)LD(
o )WB()EA(
)BD(POSTURE_ITALIC)ES(
)PR(
public static final Float POSTURE_ITALIC
)RP(
)DL(
)DD( The standard italic posture for the font. This value is 0.333.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(POSTURE)EA(
)LD(
)LD(
o )WB()EA(
)BD(SIZE)ES(
)PR(
public static final String SIZE
)RP(
)DL(
)DD( The font size in points.
)0 P( Values are instances of Float. The value can be any positive
value, although most fonts will pin to a reasonable range.)0 P(
)LD(
o )WB()EA(
)BD(TRANSFORM)ES(
)PR(
public static final String TRANSFORM
)RP(
)DL(
)DD( The transform of the font.
)0 P( Values are instances of Transform. A null value indicates the font should use
its default transform.)0 P(
)LD(
o )WB()EA(
)BD(TRANSFORM_DEFAULT)ES(
)PR(
public static final )A(AffineTransform)EA( TRANSFORM_DEFAULT
)RP(
)DL(
)DD( The default transform if TRANSFORM is unspecified. This value is null.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(TRANSFORM)EA(
)LD(
)LD(
o )WB()EA(
)BD(FONT)ES(
)PR(
public static final String FONT
)RP(
)DL(
)DD( The font to use to render this text.
)0 P(Values are instances of Font. A null value indicates that text layout
should try to resolve the font
as best it can for the given text.)0 P(
)LD(
o )WB()EA(
)BD(BIDI_EMBEDDING)ES(
)PR(
public static final String BIDI_EMBEDDING
)RP(
)DL(
)DD( The embedding level for nested bidirectional runs.
)0 P(TextLayout assumes this feature has the same value for all text in a paragraph.
)0 P(Values are instances of Integer, between 0 and 31 inclusive. Values from 0 to 15
represent embeddings. If bit 4 is set \201values from 16 to 31\202 they represent
directional overrides. Even values indicate left-to-right, odd indicate right-to-left.
Within an embedding, text assumes a base line direction corresponding to the
embedding, and the standard bidirectional properties of the text applies. Within
an override, all text flows in the given direction, and the standard bidirectional
properties of the text are overridden. See the Unicode Standard v. 2.0, section 3-11.)0 P(
)LD(
o )WB()EA(
)BD(BIDI_EMBEDDING_DEFAULT)ES(
)PR(
public static final Integer BIDI_EMBEDDING_DEFAULT
)RP(
)DL(
)DD( The default embedding if BIDI_EMBEDDING is unspecified. This value is 0.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BIDI_EMBEDDING)EA(
)LD(
)LD(
o )WB()EA(
)BD(BACKGROUND)ES(
)PR(
public static final String BACKGROUND
)RP(
)DL(
)DD( The background color.
)0 P(Values are instances of Color. Null indicates a transparent background.)0 P(
)LD(
o )WB()EA(
)BD(BACKGROUND_DEFAULT)ES(
)PR(
public static final )A(Color)EA( BACKGROUND_DEFAULT
)RP(
)DL(
)DD( The default background color if BACKGROUND is unspecified. This value is null.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BACKGROUND)EA(
)LD(
)LD(
o )WB()EA(
)BD(FOREGROUND)ES(
)PR(
public static final String FOREGROUND
)RP(
)DL(
)DD( The foreground color.
)0 P(Values are instances of Color. Null indicates use the 'current' color in the Graphics.)0 P(
)LD(
o )WB()EA(
)BD(FOREGROUND_DEFAULT)ES(
)PR(
public static final )A(Color)EA( FOREGROUND_DEFAULT
)RP(
)DL(
)DD( The default foreground color if FOREGROUND is unspecified. This value is null.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(FOREGROUND)EA(
)LD(
)LD(
o )WB()EA(
)BD(UNDERLINE)ES(
)PR(
public static final String UNDERLINE
)RP(
)DL(
)DD( Adorn the text with underlining.
)0 P(Values are instances of Boolean.)0 P(
)LD(
o )WB()EA(
)BD(UNDERLINE_DEFAULT)ES(
)PR(
public static final Boolean UNDERLINE_DEFAULT
)RP(
)DL(
)DD( The default underline if UNDERLINE is unspecified. This value is false, indicating no underline.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(UNDERLINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(UNDERLINE_ON)ES(
)PR(
public static final Boolean UNDERLINE_ON
)RP(
)DL(
)DD( Draw an underline. This value is true.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(UNDERLINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(STRIKETHROUGH)ES(
)PR(
public static final String STRIKETHROUGH
)RP(
)DL(
)DD( Adorn the text with strikethrough.
)0 P(Values are instances of Boolean.)0 P(
)LD(
o )WB()EA(
)BD(STRIKETHROUGH_DEFAULT)ES(
)PR(
public static final Boolean STRIKETHROUGH_DEFAULT
)RP(
)DL(
)DD( The default strikethrough if STRIKETHROUGH is unspecified, the value is false.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(STRIKETHROUGH)EA(
)LD(
)LD(
o )WB()EA(
)BD(STRIKETHROUGH_ON)ES(
)PR(
public static final Boolean STRIKETHROUGH_ON
)RP(
)DL(
)DD( A single strikethrough. This value is true.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(STRIKETHROUGH)EA(
)LD(
)LD(
o )WB()EA(
)BD(SUPERSUBSCRIPT)ES(
)PR(
public static final String SUPERSUBSCRIPT
)RP(
)DL(
)DD( Super and subscripting.
)0 P(Values are arrays of two floats. The first value is is used to scale the point size,
the second computes the offset as a ratio of the point size. For example, when applied to a
12 point font, a value of [.75, -.5] requests a point size of 9, positioned 6 points above
the baseline.)0 P(
)LD(
o )WB()EA(
)BD(SUPERSUBSCRIPT_DEFAULT)ES(
)PR(
public static final float SUPERSUBSCRIPT_DEFAULT[]
)RP(
)DL(
)DD( The default supersubscript if SUPERSUBSCRIPT is unspecified. This value is [1, 0].)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SUPERSUBSCRIPT)EA(
)LD(
)LD(
o )WB()EA(
)BD(SUPERSUBSCRIPT_UP1)ES(
)PR(
public static final float SUPERSUBSCRIPT_UP1[]
)RP(
)DL(
)DD( Standard superscript. This value is [0.75, -0.5].)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SUPERSUBSCRIPT)EA(
)LD(
)LD(
o )WB()EA(
)BD(SUPERSUBSCRIPT_DOWN1)ES(
)PR(
public static final float SUPERSUBSCRIPT_DOWN1[]
)RP(
)DL(
)DD( Standard subscript. This value is [0.75, 0.5].)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SUPERSUBSCRIPT)EA(
)LD(
)LD(
o )WB()EA(
)BD(JUSTIFICATION)ES(
)PR(
public static final String JUSTIFICATION
)RP(
)DL(
)DD( Justification for the paragraph.
)0 P(TextLayout assumes this feature has the same value for all text in a paragraph.
Value is a float, extracted as a Double. This is a ratio controlling the space adjustment. For example,
if a line's natural advance is 50 pixels, and it is asked to justify to a width of 100 pixels, a ratio of
1.0 results in a justified line with an advance of 100 pixels, and a ratio of 0.5 results in a justified
line with an advance of 75 pixels.)0 P(
)LD(
o )WB()EA(
)BD(JUSTIFICATION_DEFAULT)ES(
)PR(
public static final Float JUSTIFICATION_DEFAULT
)RP(
)DL(
)DD( The default justification if JUSTIFICATION is unspecified. This value is 0.0.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(JUSTIFICATION)EA(
)LD(
)LD(
o )WB()EA(
)BD(JUSTIFICATION_FULL)ES(
)PR(
public static final Float JUSTIFICATION_FULL
)RP(
)DL(
)DD( Justify the line to the full requested width. This value is 1.0.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(JUSTIFICATION)EA(
)LD(
)LD(
o )WB()EA(
)BD(RUN_DIRECTION)ES(
)PR(
public static final String RUN_DIRECTION
)RP(
)DL(
)DD( The run direction of the line, either left-to-right or right-to-left. On vertical lines, left-to-right
means top-to-bottom.
)0 P(TextLayout assumes this feature has the same value for all text in a paragraph.
)0 P(Values are instances of boolean.)0 P(
)LD(
o )WB()EA(
)BD(RUN_DIRECTION_DEFAULT)ES(
)PR(
public static final Boolean RUN_DIRECTION_DEFAULT
)RP(
)DL(
)DD( The default direction if RUN_DIRECTION is unspecified. This value is false, indicating left-to-right.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(RUN_DIRECTION)EA(
)LD(
)LD(
o )WB()EA(
)BD(RUN_DIRECTION_LTR)ES(
)PR(
public static final Boolean RUN_DIRECTION_LTR
)RP(
)DL(
)DD( Left-to-right \201top-to-bottom\202 run direction. This value is false.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(RUN_DIRECTION)EA(
)LD(
)LD(
o )WB()EA(
)BD(RUN_DIRECTION_RTL)ES(
)PR(
public static final Boolean RUN_DIRECTION_RTL
)RP(
)DL(
)DD( Right-to-left \201bottom-to-top\202 run direction. This value is true.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(RUN_DIRECTION)EA(
)LD(
)LD(
o )WB()EA(
)BD(BIDI_NUMERIC)ES(
)PR(
public static final String BIDI_NUMERIC
)RP(
)DL(
)DD( The bidirectional layout control for roman numeral text.
)0 P(Values are instances of Integer.)0 P(
)LD(
o )WB()EA(
)BD(BIDI_NUMERIC_STRONG_ROMAN)ES(
)PR(
public static final Integer BIDI_NUMERIC_STRONG_ROMAN
)RP(
)DL(
)DD( Interpret roman numerals as roman numerals always.)0 P(
)LD(
o )WB()EA(
)BD(BIDI_NUMERIC_STRONG_ARABIC)ES(
)PR(
public static final Integer BIDI_NUMERIC_STRONG_ARABIC
)RP(
)DL(
)DD( Interpret roman numerals as arabic numerals always.)0 P(
)LD(
o )WB()EA(
)BD(BIDI_NUMERIC_WEAK_ARABIC)ES(
)PR(
public static final Integer BIDI_NUMERIC_WEAK_ARABIC
)RP(
)DL(
)DD( Interpret roman numerals as having arabic line order.)0 P(
)LD(
o )WB()EA(
)BD(BIDI_NUMERIC_DEFAULT)ES(
)PR(
public static final Integer BIDI_NUMERIC_DEFAULT
)RP(
o )WB()EA(
)BD(BASELINE)ES(
)PR(
public static final String BASELINE
)RP(
)DL(
)DD( Baseline to which to align lines.
)0 P(TextLayout assumes this feature has the same value for all text in a paragraph.
Regardless of the baselines to which characters align, the layout as a whole will
align to this line.
)0 P(Values are instances of Integer.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(ROMAN_BASELINE)EA(, )A(CENTER_BASELINE)EA(, )A(HANGING_BASELINE)EA(, )A(getBaselineOffsetsFor)EA(, )A(getBaselineFor)EA(
)LD(
)LD(
o )WB()EA(
)BD(BASELINE_DEFAULT)ES(
)PR(
public static final Integer BASELINE_DEFAULT
)RP(
)DL(
)DD( The default baseline if BASELINE is unspecified. This value is Font.ROMAN_BASELINE.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BASELINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(BASELINE_ROMAN)ES(
)PR(
public static final Integer BASELINE_ROMAN
)RP(
)DL(
)DD( Use a roman baseline for the line. This value is Font.ROMAN_BASELINE.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BASELINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(BASELINE_IDEOGRAPHIC)ES(
)PR(
public static final Integer BASELINE_IDEOGRAPHIC
)RP(
)DL(
)DD( Use a center baseline for the line. This value is Font.CENTER_BASELINE.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BASELINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(BASELINE_HANGING)ES(
)PR(
public static final Integer BASELINE_HANGING
)RP(
)DL(
)DD( Use a hanging baseline for the line. This value is Font.HANGING_BASELINE.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BASELINE)EA(
)LD(
)LD(
o )WB()EA(
)BD(BASELINE_OFFSETS)ES(
)PR(
public static final String BASELINE_OFFSETS
)RP(
)DL(
)DD( Baseline offsets used by a line.
)0 P(TextLayout assumes this feature has the same value for all text in a paragraph.
)0 P(Values are arrays of three floats. If defaulted, TextLayout attempts to find a
reasonable value for all text in
the paragraph.)0 P(
)LD(
o )WB()EA(
)BD(BASELINE_OFFSETS_DEFAULT)ES(
)PR(
public static final float BASELINE_OFFSETS_DEFAULT[]
)RP(
)DL(
)DD( The default baseline offsets if BASELINE_OFFSETS is unspecified. This value is null.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(BASELINE_OFFSETS)EA(
)LD(
)LD(
o )WB()EA(
)BD(EMPTY)ES(
)PR(
public static final AttributeSet EMPTY
)RP(
)DL(
)DD( An empty attribute set, for convenience.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(TextAttributeSet)ES(
)PR(
public TextAttributeSet\201\202
)RP(
)DL(
)DD( Construct a new mutable attribute set.
)0 P(
)LD(
o )WB()EA(
)BD(TextAttributeSet)ES(
)PR(
public TextAttributeSet\201AttributeSet source\202
)RP(
)DL(
)DD( Construct a new mutable attribute set containing the provided attributes.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( source - the attributes to copy into this set.
)LD(
)LD(
o )WB()EA(
)BD(TextAttributeSet)ES(
)PR(
public TextAttributeSet\201String name,
Object value\202
)RP(
)DL(
)DD( Construct a new mutable attribute set containing the provided attribute.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( name - the name of the attribute.
)DD( value - the value of the attribute.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Returns true if the set is empty.
)0 P(
)LD(
o )WB()EA(
)BD(getSize)ES()EA(
)PR(
public int getSize\201\202
)RP(
)DL(
)DD( Returns the number of attributes.
)0 P(
)LD(
o )WB()EA(
)BD(names)ES()EA(
)PR(
public Enumeration names\201\202
)RP(
)DL(
)DD( Returns an enumeration over the names of the attributes in the set.
The elements of the enumeration are all Strings.
)0 P(
)LD(
o )WB()EA(
)BD(get)ES()EA(
)PR(
public Object get\201String name\202
)RP(
)DL(
)DD( Returns the value of the attribute with this name, or null if the
attribute is not defined.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201String name,
Object value\202
)RP(
)DL(
)DD( Returns true if this set contains this attribute with an equal value,
or if the value is null and the attribute is not defined.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201AttributeSet rhs\202
)RP(
)DL(
)DD( Returns true if this set contains all the attributes with equal values.
)0 P(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object rhs\202
)RP(
)DL(
)DD( Return true if the argument is an attribute set containing the same attributes as this.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rhs - the object which may be an attribute set.
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201AttributeSet rhs\202
)RP(
)DL(
)DD( Return true if the argument contains the same attributes as this.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rhs - the attribute set to test against.
)LD(
)LD(
o )WB()EA(
)BD(add)ES()EA(
)PR(
public void add\201String name,
Object value\202
)RP(
)DL(
)DD( Remove any existing attribute with the same name, and add a new
attribute with the given name and value. The value must be
immutable, or not mutated by any client.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( name - the name of the attribute to add
)DD( value - the value of the attribute to add
)LD(
)LD(
o )WB()EA(
)BD(add)ES()EA(
)PR(
public void add\201AttributeSet attributes\202
)RP(
)DL(
)DD( Remove any existing attributes with the same names, and add the
new attributes.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( attributes - the set of attributes to add
)LD(
)LD(
o )WB()EA(
)BD(remove)ES()EA(
)PR(
public void remove\201String name\202
)RP(
)DL(
)DD( Remove any existing attribute with the given name.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( name - the name of the attribute to remove
)LD(
)LD(
o )WB()EA(
)BD(remove)ES()EA(
)PR(
public void remove\201Enumeration names\202
)RP(
)DL(
)DD( Remove any existing attributes with the given names.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( names - an enumeration over the names of attributes to remove. The
elements of the enumeration are Strings.
)LD(
)LD(
o )WB()EA(
)BD(set)ES()EA(
)PR(
public void set\201AttributeSet attributes\202
)RP(
)DL(
)DD( Removes all attributes, then adds the new attributes.
)0 P(
)LD(
o )WB()EA(
)BD(clone)ES()EA(
)PR(
public Object clone\201\202
)RP(
)DL(
)DD( Return a copy of this attribute set. Attributes are shared with the copy.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(clone)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.font.TextHitInfo
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.font.TextHitInfo
)EH(
)PR(
java.lang.Object
|
+----java.awt.font.TextHitInfo
)RP(
)HR(
)DL(
)DT( public final class )BD(TextHitInfo)ES(
)DT( extends Object
)LD(
This class represents hit test information for characters in a
TextLayout. This information enables developers to correctly draw
a caret identifying an insertion point when a user clicks on a point
in the bounding box of a TextLayout,
)0 P(Text has direction. In bi-directional text, there is both left-to-right
and right-to-left direction. In Roman text )I(left)ES( of the glyph is
called the leading edge and )I(right)ES( is the trailing edge.
However, in Hebrew or Arabic, the right of the glyph is the leading edge
and the left is the trailing edge.
)0 P(In a bi-directional string, it is important to know
if the glyph is at the boundary of left-to-right glyphs and
right-to-left glyphs. If that is true, then isLeadingEdge\201\202
indicates whether the next insertion is a left-to-right direction
or a right-to-left direction.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(TextLayout)EA(, )A(hitTestChar)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(LEADING)ES()EA(
)DD(
)DT( o )WB(
)A()BD(TRAILING)ES()EA(
)DD(
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TextHitInfo)ES()EA(\201int, boolean\202
)DD( Constructor for TextHitInfo.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(getCharIndex)ES()EA(\201\202
)DD(
Returns the index of the character where the user has clicked.
)DT( o )WB(
)A()BD(getInsertionIndex)ES()EA(\201\202
)DD( Returns the insertion index.
)DT( o )WB(
)A()BD(getOffsetHit)ES()EA(\201int\202
)DD( Returns a hit whose character index is offset by delta.
)DT( o )WB(
)A()BD(getOtherHit)ES()EA(\201\202
)DD( Returns the hit on the other side of the insertion point from hit.
)DT( o )WB(
)A()BD(hashCode)ES()EA(\201\202
)DD( Returns the hash code.
)DT( o )WB(
)A()BD(isLeadingEdge)ES()EA(\201\202
)DD(
Returns true if the hit is on the leading edge of a glyph and false
if the hit is on the trailing edge.
)DT( o )WB(
)A()BD(leading)ES()EA(\201int\202
)DD( Create a hit on the leading edge of the character at charIndex.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(trailing)ES()EA(\201int\202
)DD( Create a hit on the trailing edge of the character at charIndex.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(LEADING)ES(
)PR(
public static boolean LEADING
)RP(
o )WB()EA(
)BD(TRAILING)ES(
)PR(
public static boolean TRAILING
)RP(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(TextHitInfo)ES(
)PR(
public TextHitInfo\201int charIndex,
boolean isLeadingEdge\202
)RP(
)DL(
)DD( Constructor for TextHitInfo.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( charIndex - identifies the character index in the TextLayout.
)DD( isLeadingEdge - true if the hit is on the leading edge of a glyph.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getCharIndex)ES()EA(
)PR(
public int getCharIndex\201\202
)RP(
)DL(
)DD( Returns the index of the character where the user has clicked.
)0 P(
)LD(
o )WB()EA(
)BD(isLeadingEdge)ES()EA(
)PR(
public boolean isLeadingEdge\201\202
)RP(
)DL(
)DD( Returns true if the hit is on the leading edge of a glyph and false
if the hit is on the trailing edge.
)0 P(
)LD(
o )WB()EA(
)BD(getInsertionIndex)ES()EA(
)PR(
public int getInsertionIndex\201\202
)RP(
)DL(
)DD( Returns the insertion index. This is the character index if the leading edge of the
character was hit, and one greater than the character index if the trailing edge was hit.
)0 P(
)LD(
o )WB()EA(
)BD(hashCode)ES()EA(
)PR(
public int hashCode\201\202
)RP(
)DL(
)DD( Returns the hash code.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(hashCode)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(leading)ES()EA(
)PR(
public static )A(TextHitInfo)EA( leading\201int charIndex\202
)RP(
)DL(
)DD( Create a hit on the leading edge of the character at charIndex.
)0 P(
)LD(
o )WB()EA(
)BD(trailing)ES()EA(
)PR(
public static )A(TextHitInfo)EA( trailing\201int charIndex\202
)RP(
)DL(
)DD( Create a hit on the trailing edge of the character at charIndex.
)0 P(
)LD(
o )WB()EA(
)BD(getOtherHit)ES()EA(
)PR(
public )A(TextHitInfo)EA( getOtherHit\201\202
)RP(
)DL(
)DD( Returns the hit on the other side of the insertion point from hit.
)0 P(
)LD(
o )WB()EA(
)BD(getOffsetHit)ES()EA(
)PR(
public )A(TextHitInfo)EA( getOffsetHit\201int delta\202
)RP(
)DL(
)DD( Returns a hit whose character index is offset by delta.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.font.TextLayout
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.font.TextLayout
)EH(
)PR(
java.lang.Object
|
+----java.awt.font.TextLayout
)RP(
)HR(
)DL(
)DT( public final class )BD(TextLayout)ES(
)DT( extends Object
)DT( implements Cloneable
)LD(
This class encapsulates extensions to the layout information
for drawing text. It also provides information for hit testing
of text.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(drawString)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TextLayout)ES()EA(\201AttributedCharacterIterator\202
)DD( Construct a layout from an iterator over styled text.
)DT( o )WB(
)A()BD(TextLayout)ES()EA(\201String, Font\202
)DD( Construct a layout from a string and a font.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(clone)ES()EA(\201\202
)DD( Create a copy of this layout.
)DT( o )WB(
)A()BD(deleteChar)ES()EA(\201AttributedCharacterIterator, int, float\202
)DD( An optimization to facilitate deleting single characters from left-to-right text.
)DT( o )WB(
)A()BD(draw)ES()EA(\201Graphics2D, float, float\202
)DD( Render the layout at the provided location in the graphics.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Return true if the object is a TextLayout and this equals the object.
)DT( o )WB(
)A()BD(equals)ES()EA(\201TextLayout\202
)DD( Return true if the two layouts are equal.
)DT( o )WB(
)A()BD(getAdvance)ES()EA(\201\202
)DD( Return the advance of the layout.
)DT( o )WB(
)A()BD(getAllAvailableAttributes)ES()EA(\201\202
)DD( Return list of the attributes used by this layout.
)DT( o )WB(
)A()BD(getAscent)ES()EA(\201\202
)DD( Return the ascent of the layout.
)DT( o )WB(
)A()BD(getBaseline)ES()EA(\201\202
)DD( Return the baseline for this layout.
)DT( o )WB(
)A()BD(getBaselineOffsets)ES()EA(\201\202
)DD( Return the offsets array for the baselines used for this layout.
)DT( o )WB(
)A()BD(getBlackBoxBounds)ES()EA(\201int, int\202
)DD( Return the black box bounds of the characters between start and limit.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounds of the layout.
)DT( o )WB(
)A()BD(getCaretInfo)ES()EA(\201TextHitInfo\202
)DD( Return information about the caret corresponding to hit.
)DT( o )WB(
)A()BD(getCaretShapes)ES()EA(\201TextHitInfo\202
)DD( A convenience override that uses the natural bounds of the layout as the bounds.
)DT( o )WB(
)A()BD(getCaretShapes)ES()EA(\201TextHitInfo, Rectangle2D\202
)DD( Return two paths corresponding to the strong and weak caret.
)DT( o )WB(
)A()BD(getCharacterCount)ES()EA(\201\202
)DD( Return the number of characters represented by this layout.
)DT( o )WB(
)A()BD(getDescent)ES()EA(\201\202
)DD( Return the descent of the layout.
)DT( o )WB(
)A()BD(getHighlightShape)ES()EA(\201TextHitInfo, TextHitInfo, boolean\202
)DD( A convenience overload that uses the natural bounds of the text as the bounds used to
determine the highlight path.
)DT( o )WB(
)A()BD(getHighlightShape)ES()EA(\201TextHitInfo, TextHitInfo, boolean, Rectangle2D\202
)DD( Return a logical or visual selection corresponding to startHit and limitHit.
)DT( o )WB(
)A()BD(getJustifiedLayout)ES()EA(\201float\202
)DD( Create a copy of this layout justified to the given width.
)DT( o )WB(
)A()BD(getLeading)ES()EA(\201\202
)DD( Return the leading of the layout.
)DT( o )WB(
)A()BD(getLineBreakIndex)ES()EA(\201int, float\202
)DD( Accumulate the advances of the characters at and after startPos, until a
character is reached whose advance would equal or exceed width.
)DT( o )WB(
)A()BD(getLogicalHighlightShape)ES()EA(\201int, int, Rectangle2D\202
)DD( Return a path enclosing the logical selection between start and limit, extended to bounds.
)DT( o )WB(
)A()BD(getLogicalRangesForVisualSelection)ES()EA(\201TextHitInfo, TextHitInfo\202
)DD( Return the logical ranges of text corresponding to a visual selection.
)DT( o )WB(
)A()BD(getNextLeftHit)ES()EA(\201TextHitInfo\202
)DD( Return the hit for the next strong caret to the left \201top\202; if no such hit, return null.
)DT( o )WB(
)A()BD(getNextRightHit)ES()EA(\201TextHitInfo\202
)DD( Return the hit for the next strong caret to the right \201bottom\202; if no such hit, return null.
)DT( o )WB(
)A()BD(getVisibleAdvance)ES()EA(\201\202
)DD( Return the advance of the layout, minus trailing whitespace.
)DT( o )WB(
)A()BD(getVisualHighlightShape)ES()EA(\201TextHitInfo, TextHitInfo, Rectangle2D\202
)DD( Return a path enclosing the visual selection between start and limit, extended to bounds.
)DT( o )WB(
)A()BD(handleJustify)ES()EA(\201float\202
)DD( Justify this layout.
)DT( o )WB(
)A()BD(hashCode)ES()EA(\201\202
)DD( Return the hash code of this layout.
)DT( o )WB(
)A()BD(hitTestChar)ES()EA(\201float, float\202
)DD( Return a TextHitInfo corresponding to the point.
)DT( o )WB(
)A()BD(insertChar)ES()EA(\201AttributedCharacterIterator, int, float\202
)DD( An optimization to facilitate inserting single characters into left-to-right text.
)DT( o )WB(
)A()BD(isLeftToRight)ES()EA(\201\202
)DD( Return true if the layout is left-to-right.
)DT( o )WB(
)A()BD(isVertical)ES()EA(\201\202
)DD( Return true if the layout is vertical.
)DT( o )WB(
)A()BD(sublayout)ES()EA(\201int, int\202
)DD( Return a layout that represents a subsection of this layout.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Display the glyphsets contained in the layout, for debugging only.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(TextLayout)ES(
)PR(
public TextLayout\201String string,
)A(Font)EA( font\202
)RP(
)DL(
)DD( Construct a layout from a string and a font.
All the text is styled using the provided font.
The string must specify a single paragraph of text, as an entire paragraph is required for the bidi
algorithm. Lines may then be constructed by taking subranges of the layout.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( str - the text to display.
)DD( font - a font used to style the text.
)LD(
)LD(
o )WB()EA(
)BD(TextLayout)ES(
)PR(
public TextLayout\201AttributedCharacterIterator text\202
)RP(
)DL(
)DD( Construct a layout from an iterator over styled text.
The iterator must specify a single paragraph of text, as an entire
paragraph is required for the bidi algorithm. Lines may then be
constructed by taking subranges of the layout.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( text - the styled text to display.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(clone)ES()EA(
)PR(
protected Object clone\201\202
)RP(
)DL(
)DD( Create a copy of this layout.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(clone)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(getJustifiedLayout)ES()EA(
)PR(
public )A(TextLayout)EA( getJustifiedLayout\201float justificationWidth\202
)RP(
)DL(
)DD( Create a copy of this layout justified to the given width.
If this layout has itself already been justified, or the justification
ratio is zero, return this layout unchanged.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( justificationWidth - the width to use when justifying the line.
For best results, it should not be too different from the current
advance of the line.
)DT( )BD(Returns:)ES(
)DD( a layout justified to the given width.
)DT( )BD(See Also:)ES(
)DD( )A(justify)EA(
)LD(
)LD(
o )WB()EA(
)BD(handleJustify)ES()EA(
)PR(
protected void handleJustify\201float justificationWidth\202
)RP(
)DL(
)DD( Justify this layout. Overridden by subclassers to control justification.
The layout will only justify if the paragraph attributes \201from the source text, possibly defaulted by the
layout attributes\202 indicate a non-zero justification ratio. The text will be justified to the
indicated width. The current implementation also adjusts hanging punctuation and trailing whitespace
to overhang the justification width. Once justified, the layout may not be rejustified.
)0 P(
Some code may rely on immutablity of layouts. Subclassers should not call this directly, but instead
should call getJustifiedLayout, which will call this method on a clone of this layout, preserving
the original.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( justificationWidth - the width to use when justifying the line. For best results, it should not be
too different from the current advance of the line.
)DT( )BD(See Also:)ES(
)DD( )A(getJustifiedLayout)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBaseline)ES()EA(
)PR(
public int getBaseline\201\202
)RP(
)DL(
)DD( Return the baseline for this layout.
The baseline is one of the values defined in Font \201roman, centered, hanging\202. Ascent and descent are
relative to this baseline. The baselineOffsets are also relative to this baseline.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getBaselineOffsets)EA(, )A(Font)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBaselineOffsets)ES()EA(
)PR(
public float[] getBaselineOffsets\201\202
)RP(
)DL(
)DD( Return the offsets array for the baselines used for this layout.
The array is indexed by one of the values defined in Font \201roman, centered, hanging\202. The values
are relative to this layout's baseline, so that getBaselineOffsets[getBaseline\201\202] == 0. Offsets
are added to the position of the layout's baseline to get the position for the new baseline, i.e.
on horizontal layouts, negative offsets are up, and on vertical layouts, negative offsets are left.
)BR(!!! This differs from other metric information, where on vertical lines the math works as
though x positions to the right were lower instead of higher.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getBaseline)EA(, )A(Font)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAdvance)ES()EA(
)PR(
public float getAdvance\201\202
)RP(
)DL(
)DD( Return the advance of the layout.
The advance is the distance from the origin to the advance of the rightmost \201bottommost\202 character
measuring in the line direction.
)0 P(
)LD(
o )WB()EA(
)BD(getVisibleAdvance)ES()EA(
)PR(
public float getVisibleAdvance\201\202
)RP(
)DL(
)DD( Return the advance of the layout, minus trailing whitespace.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getAdvance)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAscent)ES()EA(
)PR(
public float getAscent\201\202
)RP(
)DL(
)DD( Return the ascent of the layout.
The ascent is the distance from the top \201right\202 of the layout to the baseline. It is always
positive or zero. The ascent is sufficient to accomodate superscripted text and is
the maximum of the sum of the the ascent, offset, and baseline of each glyph.
)0 P(
)LD(
o )WB()EA(
)BD(getDescent)ES()EA(
)PR(
public float getDescent\201\202
)RP(
)DL(
)DD( Return the descent of the layout.
The descent is the distance from the baseline to the bottom \201left\202 of the layout. It is
always positive or zero. The descent is sufficient to accomodate subscripted text and is
maximum of the sum of the descent, offset, and baseline of each glyph.
)0 P(
)LD(
o )WB()EA(
)BD(getLeading)ES()EA(
)PR(
public float getLeading\201\202
)RP(
)DL(
)DD( Return the leading of the layout.
The leading is the suggested interline spacing for this layout.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounds of the layout.
This bounds all space that can be drawn on by text or carets. It extends from ascent to descent + leading,
and from the left \201top\202 edge of the first character to the right \201bottom\202 edge of the last. If there is
hanging punctuation, the left \201top\202 of the bounds may be negative.
)0 P(
)LD(
o )WB()EA(
)BD(isLeftToRight)ES()EA(
)PR(
public boolean isLeftToRight\201\202
)RP(
)DL(
)DD( Return true if the layout is left-to-right.
The layout has a base direction of either left-to-right \201LTR\202 or right-to-left \201RTL\202. This
is independent of the actual direction of text on the line, which may be either or mixed.
Left-to-right layouts by default should position flush left, and if on a tabbed line, the
tabs run left to right, so that logically successive layouts position left to right. The
opposite is true for RTL layouts. By default they should position flush left, and tabs
run right-to-left.
On vertical lines all text runs top-to-bottom, and is treated as LTR.
)0 P(
)LD(
o )WB()EA(
)BD(isVertical)ES()EA(
)PR(
public boolean isVertical\201\202
)RP(
)DL(
)DD( Return true if the layout is vertical.
)0 P(
)LD(
o )WB()EA(
)BD(getCharacterCount)ES()EA(
)PR(
public int getCharacterCount\201\202
)RP(
)DL(
)DD( Return the number of characters represented by this layout.
)0 P(
)LD(
o )WB()EA(
)BD(getCaretInfo)ES()EA(
)PR(
public float[] getCaretInfo\201)A(TextHitInfo)EA( hit\202
)RP(
)DL(
)DD( Return information about the caret corresponding to hit.
The first element of the array is the intersection of the caret with the baseline.
The second element of the array is the slope \201run/rise\202 of the caret.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hit - a hit on a character in this layout
)DT( )BD(Returns:)ES(
)DD( a two-element array containing the position and slope of the caret
)LD(
)LD(
o )WB()EA(
)BD(getNextRightHit)ES()EA(
)PR(
public )A(TextHitInfo)EA( getNextRightHit\201)A(TextHitInfo)EA( hit\202
)RP(
)DL(
)DD( Return the hit for the next strong caret to the right \201bottom\202; if no such hit, return null.
If the hit character index is out of bounds, an IllegalArgumentException is thrown.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hit - a hit on a character in this layout.
)DT( )BD(Returns:)ES(
)DD( a hit whose strong caret appears at the next position to the right \201bottom\202
of the strong caret of the provided hit, or null.
)LD(
)LD(
o )WB()EA(
)BD(getNextLeftHit)ES()EA(
)PR(
public )A(TextHitInfo)EA( getNextLeftHit\201)A(TextHitInfo)EA( hit\202
)RP(
)DL(
)DD( Return the hit for the next strong caret to the left \201top\202; if no such hit, return null.
If the hit character index is out of bounds, an IllegalArgumentException is thrown.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hit - a hit on a character in this layout.
)DT( )BD(Returns:)ES(
)DD( a hit whose strong caret appears at the next position to the left \201top\202
of the strong caret of the provided hit, or null.
)LD(
)LD(
o )WB()EA(
)BD(getCaretShapes)ES()EA(
)PR(
public )A(Shape)EA([] getCaretShapes\201)A(TextHitInfo)EA( hit,
)A(Rectangle2D)EA( bounds\202
)RP(
)DL(
)DD( Return two paths corresponding to the strong and weak caret.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( hit - a hit on a character in this layout
)DD( bounds - the bounds to which to extend the carets
)DT( )BD(Returns:)ES(
)DD( an array of two paths. Element zero is the strong caret. There is always a strong caret.
Element one is the weak caret \201if any\202 or null.
)LD(
)LD(
o )WB()EA(
)BD(getCaretShapes)ES()EA(
)PR(
public )A(Shape)EA([] getCaretShapes\201)A(TextHitInfo)EA( hit\202
)RP(
)DL(
)DD( A convenience override that uses the natural bounds of the layout as the bounds.
)0 P(
)LD(
o )WB()EA(
)BD(getHighlightShape)ES()EA(
)PR(
public )A(Area)EA( getHighlightShape\201)A(TextHitInfo)EA( startHit,
)A(TextHitInfo)EA( limitHit,
boolean visual,
)A(Rectangle2D)EA( bounds\202
)RP(
)DL(
)DD( Return a logical or visual selection corresponding to startHit and limitHit.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( startHit - a hit representing the start of the selection.
)DD( limitHit - a hit representing the limit of the selection.
)DD( visual - true if the selection should be visually contiguous. The area
between the carets defined by startHit and limitHit will be selected. Otherwise,
the hits are mapped to insertion points, and the characters between these
insertion points will be selected. In mixed directional text, this will result
in a discontiguous selection \201representing the contiguous logical ranges of text\202.
)DD( bounds - the bounds of the path. On horizontal lines, the top and bottom of
the bounds determine the top and bottom of the resulting path, and the right and
left are used to extend selections that include the characters on the endpoints of
the line. On vertical lines the roles of top/bottom and left/right are exchanged.
The origin of bounds is at position 0,0 in the layout.
)DT( )BD(See Also:)ES(
)DD( )A(getLogicalHighlightShape)EA(, )A(getVisualHighlightShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHighlightShape)ES()EA(
)PR(
public )A(Area)EA( getHighlightShape\201)A(TextHitInfo)EA( startHit,
)A(TextHitInfo)EA( limitHit,
boolean visual\202
)RP(
)DL(
)DD( A convenience overload that uses the natural bounds of the text as the bounds used to
determine the highlight path.
)0 P(
)LD(
o )WB()EA(
)BD(getLogicalRangesForVisualSelection)ES()EA(
)PR(
public int[] getLogicalRangesForVisualSelection\201)A(TextHitInfo)EA( startHit,
)A(TextHitInfo)EA( limitHit\202
)RP(
)DL(
)DD( Return the logical ranges of text corresponding to a visual selection.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( startHit - the start of the visual range
)DD( limitHit - the end of the visual range
)DT( )BD(Returns:)ES(
)DD( an array of integers representing start/limit pairs for the selected ranges
)DT( )BD(See Also:)ES(
)DD( )A(getVisualHighlightShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getVisualHighlightShape)ES()EA(
)PR(
public )A(Area)EA( getVisualHighlightShape\201)A(TextHitInfo)EA( startHit,
)A(TextHitInfo)EA( limitHit,
)A(Rectangle2D)EA( bounds\202
)RP(
)DL(
)DD( Return a path enclosing the visual selection between start and limit, extended to bounds.
)0 P(
If the selection includes the leftmost \201topmost\202 position, the selection is extended to the
left \201top\202 of the bounds. If the selection includes the rightmost \201bottommost\202 position, the
selection is extended to the right \201bottom\202 of the bounds. The height \201width on vertical
lines\202 of the selection is always extended to bounds.
)0 P(
Although the selection is always contiguous, the logically selected text can be discontiguous
on lines with mixed-direction text. The logical ranges of text selected can be retrieved using
getLogicalRangesForVisualSelection. For example, consider the text 'ABCdef' where capital
letters indicate right-to-left text, rendered on a right-to-left line, with a visual selection
from 0L \201the leading edge of 'A'\202 to 3T \201the trailing edge of 'd'\202. The text appears as follows,
with bold underlined areas representing the selection:
)BR()PR(
d)UN()BD(efCBA )ES()NU(
)RP(
The logical selection ranges are 0-3, 4-6 \201ABC, ef\202 because the visually contiguous text is
logically discontiguous. Also note that since the rightmost position on the layout \201to the
right of 'A'\202 is selected, the selection is extended to the right of the bounds.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( startHit - the start of the visual selection
)DD( limitHit - the limit of the visual selection
)DD( bounds - the bounding rectangle to which to extend the selection
)DT( )BD(Returns:)ES(
)DD( an area enclosing the selection
)DT( )BD(See Also:)ES(
)DD( )A(getLogicalRangesForVisualSelection)EA(, )A(getLogicalHighlightShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getLogicalHighlightShape)ES()EA(
)PR(
public )A(Area)EA( getLogicalHighlightShape\201int start,
int limit,
)A(Rectangle2D)EA( bounds\202
)RP(
)DL(
)DD( Return a path enclosing the logical selection between start and limit, extended to bounds.
)0 P(
If the selection range includes the first logical character, the selection is extended
to the portion of bounds before the start of the layout. If the range includes the last
logical character, the selection is extended to the portion of bounds after the end of
the layout. The height \201width on vertical lines\202 of the selection is always extended to
bounds.
)0 P(
The selection can be discontiguous on lines with mixed-direction text. Only those
characters in the logical range between start and limit will appear selected. For
example consider the text 'ABCdef' where capital letters indicate right-to-left text,
rendered on a right-to-left line, with a logical selection from 0 to 4 \201'ABCd'\202. The text
appears as follows, with bold standing in for the selection, and underlining for the extension:
)BR()PR(
)UN()BD(d)ES()NU(ef)UN()BD(CBA )ES()NU(
)RP(
The selection is discontiguous because the selected characters are visually discontiguous.
Also note that since the range includes the first logical character \201A\202, the selection is extended
to the portion of the bounds before the start of the layout, which in this case \201a right-to-left
line\202 is the right portion of the bounds.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( start - the start of the range of characters to select
)DD( limit - the limit of the range of characters to select
)DD( bounds - the bounding rectangle to which to extend the selection
)DT( )BD(Returns:)ES(
)DD( an area enclosing the selection
)DT( )BD(See Also:)ES(
)DD( )A(getVisualHighlightShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlackBoxBounds)ES()EA(
)PR(
public )A(Area)EA( getBlackBoxBounds\201int start,
int limit\202
)RP(
)DL(
)DD( Return the black box bounds of the characters between start and limit.
The black box bounds is an area consisting of the union of the bounding boxes of all
the glyphs corresponding to the characters between start and limit. This path
may be disjoint.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( start - the index of the first character to include in the bounds
)DD( limit - the index past the last character to include in the bounds
)DT( )BD(Returns:)ES(
)DD( a path enclosing the black box bounds
)LD(
)LD(
o )WB()EA(
)BD(getLineBreakIndex)ES()EA(
)PR(
public int getLineBreakIndex\201int startPos,
float width\202
)RP(
)DL(
)DD( Accumulate the advances of the characters at and after startPos, until a
character is reached whose advance would equal or exceed width.
Return the index of that character.
)0 P(
)LD(
o )WB()EA(
)BD(hitTestChar)ES()EA(
)PR(
public )A(TextHitInfo)EA( hitTestChar\201float x,
float y\202
)RP(
)DL(
)DD( Return a TextHitInfo corresponding to the point.
Coordinates outside the bounds of the layout map to hits on the leading edge of the first
logical character, or the trailing edge of the last logical character, as appropriate,
regardless of the position of that character in the line. Only the
direction along the baseline is used to make this evaluation.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the x offset from the origin of the layout
)DD( y - the y offset from the origin of the layout
)DT( )BD(Returns:)ES(
)DD( a hit describing the character and edge \201leading or trailing\202 under the point
)LD(
)LD(
o )WB()EA(
)BD(getAllAvailableAttributes)ES()EA(
)PR(
public static String[] getAllAvailableAttributes\201\202
)RP(
)DL(
)DD( Return list of the attributes used by this layout.
)0 P(
)LD(
o )WB()EA(
)BD(sublayout)ES()EA(
)PR(
public )A(TextLayout)EA( sublayout\201int start,
int limit\202
)RP(
)DL(
)DD( Return a layout that represents a subsection of this layout. The number of characters
must be >= 1. The original layout must not be justified. The new layout will apply
the bidi 'line reordering' rules to the text.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( start - the index of the first character to use
)DD( limit - the index past the last character to use
)DT( )BD(Returns:)ES(
)DD( a new layout
)LD(
)LD(
o )WB()EA(
)BD(insertChar)ES()EA(
)PR(
public )A(TextLayout)EA( insertChar\201AttributedCharacterIterator newText,
int insertPos,
float maxAdvance\202
)RP(
)DL(
)DD( An optimization to facilitate inserting single characters into left-to-right text.
This attempts to produce a new layout based on modifications to this one. If that cannot be
be done easily, this returns null. Clients should always be prepared to handle a null result.
If null is returned, the client should construct a new layout.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( newText - the text for the new layout. This represents the text after the insertion
occurred. The new layout will represent all the text.
)DD( insertPos - the position at which the single character was inserted.
)DD( maxAdvance - a maximum advance the new layout must fit.
)DT( )BD(Returns:)ES(
)DD( a new layout representing newText whose advance is less than maxAdvance, or null.
)LD(
)LD(
o )WB()EA(
)BD(deleteChar)ES()EA(
)PR(
public )A(TextLayout)EA( deleteChar\201AttributedCharacterIterator newText,
int deletePos,
float minAdvance\202
)RP(
)DL(
)DD( An optimization to facilitate deleting single characters from left-to-right text.
This attempts to produce a new layout based on modifications to this one. If that cannot be
be done easily, this returns null. Clients should always be prepared to handle a null result.
If null is returned, the client should construct a new layout.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( newText - the text for the new layout. This represents the text after the deletion
occurred. The new layout will represent all the text.
)DD( deletePos - the position at which the single character was deleted.
)DD( minAdvance - a minimum advance the new layout must fit.
)DT( )BD(Returns:)ES(
)DD( a new layout representing newText whose advance equals or exceeds minAdvance, or null.
)LD(
)LD(
o )WB()EA(
)BD(hashCode)ES()EA(
)PR(
public int hashCode\201\202
)RP(
)DL(
)DD( Return the hash code of this layout.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(hashCode)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD( Return true if the object is a TextLayout and this equals the object.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201)A(TextLayout)EA( layout\202
)RP(
)DL(
)DD( Return true if the two layouts are equal.
Two layouts are equal if they contain equal glyphsets in the same order.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( layout - the layout to which to compare this layout.
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Display the glyphsets contained in the layout, for debugging only.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(draw)ES()EA(
)PR(
public void draw\201)A(Graphics2D)EA( g2,
float x,
float y\202
)RP(
)DL(
)DD( Render the layout at the provided location in the graphics.
The origin of the layout is placed at x, y. Rendering may touch any
point within getBounds\201\202 of this position. This leaves the graphics
unchanged.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( g2 - the graphics into which to render the layout
)DD( x - the x position for the origin of the layout
)DD( y - the y position for the origin of the layout
)DT( )BD(See Also:)ES(
)DD( )A(getBounds)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.geom.PathIterator
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.geom.PathIterator
)EH(
)DL(
)DT( public interface )BD(PathIterator)ES(
)LD(
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(SEG_CLOSE)ES()EA(
)DD( The point type that specifies that the preceding subpath should be
closed by appending a line segment back to the point corresponding
to the most recent SEG_MOVETO.
)DT( o )WB(
)A()BD(SEG_CUBICTO)ES()EA(
)DD( The point type for the set of 3 points that specify a cubic
parametric curve to be drawn from the most recently specified
point.
)DT( o )WB(
)A()BD(SEG_LINETO)ES()EA(
)DD( The point type for a point that specifies the end point of a
line to be drawn from the most recently specified point.
)DT( o )WB(
)A()BD(SEG_MOVETO)ES()EA(
)DD( The point type for a point that specifies the starting location
for a new subpath.
)DT( o )WB(
)A()BD(SEG_QUADTO)ES()EA(
)DD( The point type for the pair of points that specify a quadratic
parametric curve to be drawn from the most recently specified
point.
)DT( o )WB(
)A()BD(WIND_EVEN_ODD)ES()EA(
)DD( An even-odd winding rule for determining the interior of
a path.
)DT( o )WB(
)A()BD(WIND_NON_ZERO)ES()EA(
)DD( A non-zero winding rule for determining the interior of a
path.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(currentSegment)ES()EA(\201double[]\202
)DD( Returns the coordinates and type of the current path segment in
the iteration.
)DT( o )WB(
)A()BD(currentSegment)ES()EA(\201float[]\202
)DD( Returns the coordinates and type of the current path segment in
the iteration.
)DT( o )WB(
)A()BD(getWindingRule)ES()EA(\201\202
)DD( Return the winding rule for determining the interior of the
path.
)DT( o )WB(
)A()BD(isDone)ES()EA(\201\202
)DD( Tests if there are more points to read.
)DT( o )WB(
)A()BD(next)ES()EA(\201\202
)DD( Moves the iterator to the next segment of the path forwards
along the primary direction of traversal as long as there are
more points in that direction.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(WIND_EVEN_ODD)ES(
)PR(
public static final byte WIND_EVEN_ODD
)RP(
)DL(
)DD( An even-odd winding rule for determining the interior of
a path.)0 P(
)LD(
o )WB()EA(
)BD(WIND_NON_ZERO)ES(
)PR(
public static final byte WIND_NON_ZERO
)RP(
)DL(
)DD( A non-zero winding rule for determining the interior of a
path.)0 P(
)LD(
o )WB()EA(
)BD(SEG_MOVETO)ES(
)PR(
public static final byte SEG_MOVETO
)RP(
)DL(
)DD( The point type for a point that specifies the starting location
for a new subpath.)0 P(
)LD(
o )WB()EA(
)BD(SEG_LINETO)ES(
)PR(
public static final byte SEG_LINETO
)RP(
)DL(
)DD( The point type for a point that specifies the end point of a
line to be drawn from the most recently specified point.)0 P(
)LD(
o )WB()EA(
)BD(SEG_QUADTO)ES(
)PR(
public static final byte SEG_QUADTO
)RP(
)DL(
)DD( The point type for the pair of points that specify a quadratic
parametric curve to be drawn from the most recently specified
point. The curve is interpolated by solving the parametric
control equation in the range )SM(\201t = [0..1]\202)ES( using
the most recently specified \201current\202 point \201CP\202,
the first control point \201P1\202,
and the final interpolated control point \201P2\202.
The parametric control equation for this curve is:
)PR(
P\201t\202 = B\2012,0\202*CP + B\2012,1\202*P1 + B\2012,2\202*P2
0 <= t <= 1
B\201n,m\202 = mth coefficient of nth degree Bernstein polynomial
= C\201n,m\202 * t^\201m\202 * \2011 - t\202^\201n-m\202
C\201n,m\202 = Combinations of n things, taken m at a time
= n! / \201m! * \201n-m\202!\202
)RP()0 P(
)LD(
o )WB()EA(
)BD(SEG_CUBICTO)ES(
)PR(
public static final byte SEG_CUBICTO
)RP(
)DL(
)DD( The point type for the set of 3 points that specify a cubic
parametric curve to be drawn from the most recently specified
point. The curve is interpolated by solving the parametric
control equation in the range )SM(\201t = [0..1]\202)ES( using
the most recently specified \201current\202 point \201CP\202,
the first control point \201P1\202,
the second control point \201P2\202,
and the final interpolated control point \201P3\202.
The parametric control equation for this curve is:
)PR(
P\201t\202 = B\2013,0\202*CP + B\2013,1\202*P1 + B\2013,2\202*P2 + B\2013,3\202*P3
0 <= t <= 1
B\201n,m\202 = mth coefficient of nth degree Bernstein polynomial
= C\201n,m\202 * t^\201m\202 * \2011 - t\202^\201n-m\202
C\201n,m\202 = Combinations of n things, taken m at a time
= n! / \201m! * \201n-m\202!\202
)RP(
This form of curve is commonly known as a B\351zier curve.)0 P(
)LD(
o )WB()EA(
)BD(SEG_CLOSE)ES(
)PR(
public static final byte SEG_CLOSE
)RP(
)DL(
)DD( The point type that specifies that the preceding subpath should be
closed by appending a line segment back to the point corresponding
to the most recent SEG_MOVETO.)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getWindingRule)ES()EA(
)PR(
public abstract int getWindingRule\201\202
)RP(
)DL(
)DD( Return the winding rule for determining the interior of the
path.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(WIND_EVEN_ODD)EA(, )A(WIND_NON_ZERO)EA(
)LD(
)LD(
o )WB()EA(
)BD(isDone)ES()EA(
)PR(
public abstract boolean isDone\201\202
)RP(
)DL(
)DD( Tests if there are more points to read.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( true if there are more points to read
)LD(
)LD(
o )WB()EA(
)BD(next)ES()EA(
)PR(
public abstract void next\201\202
)RP(
)DL(
)DD( Moves the iterator to the next segment of the path forwards
along the primary direction of traversal as long as there are
more points in that direction.
)0 P(
)LD(
o )WB()EA(
)BD(currentSegment)ES()EA(
)PR(
public abstract int currentSegment\201float coords[]\202
)RP(
)DL(
)DD( Returns the coordinates and type of the current path segment in
the iteration.
The return value is the path segment type:
SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE.
A float array of length 6 must be passed in and may be used to
store the coordinates of the point\201s\202.
Each point is stored as a pair of float x,y coordinates.
SEG_MOVETO and SEG_LINETO types will return one point,
SEG_QUADTO will return two points,
SEG_CUBICTO will return 3 points
and SEG_CLOSE will not return any points.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SEG_MOVETO)EA(, )A(SEG_LINETO)EA(, )A(SEG_QUADTO)EA(, )A(SEG_CUBICTO)EA(, )A(SEG_CLOSE)EA(
)LD(
)LD(
o )WB()EA(
)BD(currentSegment)ES()EA(
)PR(
public abstract int currentSegment\201double coords[]\202
)RP(
)DL(
)DD( Returns the coordinates and type of the current path segment in
the iteration.
The return value is the path segment type:
SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE.
A double array of length 6 must be passed in and may be used to
store the coordinates of the point\201s\202.
Each point is stored as a pair of double x,y coordinates.
SEG_MOVETO and SEG_LINETO types will return one point,
SEG_QUADTO will return two points,
SEG_CUBICTO will return 3 points
and SEG_CLOSE will not return any points.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SEG_MOVETO)EA(, )A(SEG_LINETO)EA(, )A(SEG_QUADTO)EA(, )A(SEG_CUBICTO)EA(, )A(SEG_CLOSE)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.AffineTransform
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.AffineTransform
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.AffineTransform
)RP(
)HR(
)DL(
)DT( public class )BD(AffineTransform)ES(
)DT( extends Object
)DT( implements Cloneable
)LD(
This class represents a 2D affine transform which performs a linear
mapping from 2D coordinates to other 2D coordinates in a manner which
preserves the "straightness" and "parallelness" of lines. Affine
transformations can be constructed using sequences of translations,
scales, flips, rotations, and shears.
)0 P(
Such a coordinate transformation can be represented by a 3 row by
3 column matrix with an implied last row of [ 0 0 1 ] which is
applied to the coordinates by considering
them to be a column vector and multiplying the coordinate vector
by the matrix according to the following process.
)PR(
[ m00 m01 m02 ] [ x ] [ m00x + m01y + m02 ]
[ m10 m11 m12 ] [ y ] = [ m10x + m11y + m12 ]
[ 0 0 1 ] [ 1 ] [ 1 ]
)RP(
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ANY_ROTATION_MASK)ES()EA(
)DD( This flag is a bit mask for any of the rotation flag bits.
)DT( o )WB(
)A()BD(ANY_SCALE_MASK)ES()EA(
)DD( This flag is a bit mask for any of the scale flag bits.
)DT( o )WB(
)A()BD(GENERAL_ROTATION)ES()EA(
)DD( This flag bit indicates that the transform defined by this object
performs a rotation by an arbitrary angle in addition to the
conversions indicated by other flag bits.
)DT( o )WB(
)A()BD(GENERAL_SCALE)ES()EA(
)DD( This flag bit indicates that the transform defined by this object
performs a general scale in addition to the conversions indicated
by other flag bits.
)DT( o )WB(
)A()BD(GENERAL_TRANSFORM)ES()EA(
)DD( This flag bit indicates that the transform defined by this object
performs an arbitrary conversion of the input coordinates.
)DT( o )WB(
)A()BD(IDENTITY)ES()EA(
)DD( This constant indicates that the transform defined by this object
is an identity transform.
)DT( o )WB(
)A()BD(QUADRANT_ROTATION)ES()EA(
)DD( This flag bit indicates that the transform defined by this object
performs a quadrant rotation by some multiple of 90 degrees in
addition to the conversions indicated by other flag bits.
)DT( o )WB(
)A()BD(TRANSLATION)ES()EA(
)DD( This flag bit indicates that the transform defined by this object
performs a translation in addition to the conversions indicated
by other flag bits.
)DT( o )WB(
)A()BD(UNIFORM_SCALE)ES()EA(
)DD( This flag bit indicates that the transform defined by this object
performs a uniform scale in addition to the conversions indicated
by other flag bits.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201\202
)DD( Constructs a new AffineTransform representing the Identity
transformation.
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201double, double, double, double, double, double\202
)DD( Constructs a new AffineTransform from 6 double precision values
representing the 6 specifiable entries of the 3x3 transformation matrix.
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201double[]\202
)DD( Constructs a new AffineTransform from an array of double precision
values representing either the 4 non-translation or the 6 specifiable
entries of
the 3x3 transformation matrix.
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201double[][]\202
)DD( Constructs a new AffineTransform from a 2-dimensional array of
double precision values representing either the 4 non-translation or the
6 specifiable entries of the 3x3 transformation matrix.
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201float, float, float, float, float, float\202
)DD( Constructs a new AffineTransform from 6 floating point values
representing the 6 specifiable entries of the 3x3 transformation matrix.
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201float[]\202
)DD( Constructs a new AffineTransform from an array of floating point
values representing either the 4 non-translation or the 6 specifiable
entries of
the 3x3 transformation matrix.
)DT( o )WB(
)A()BD(AffineTransform)ES()EA(\201float[][]\202
)DD( Constructs a new AffineTransform from a 2-dimensional array of
floating point values representing either the 4 non-translation or the
6 specifiable entries of the 3x3 transformation matrix.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(append)ES()EA(\201AffineTransform\202
)DD(
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(clone)ES()EA(\201\202
)DD( Returns a copy of this AffineTransform object.
)DT( o )WB(
)A()BD(concatenate)ES()EA(\201AffineTransform\202
)DD( Concatenates an AffineTransform Tx to this AffineTransform Cx
in the most commonly useful way to provide a new user space
which is mapped to the former user space by Tx.
)DT( o )WB(
)A()BD(createInverse)ES()EA(\201\202
)DD( Returns a Transform object representing the inverse transformation.
)DT( o )WB(
)A()BD(createTransformedShape)ES()EA(\201Shape\202
)DD( Transforms a shape object by this transform.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(getMatrix)ES()EA(\201double[]\202
)DD( Retrieves the 6 specifiable values in the 3x3 affine transformation
matrix into
an array of double precisions values.
)DT( o )WB(
)A()BD(getMatrix)ES()EA(\201double[][]\202
)DD( Retrieves the 6 specifiable values in the 3x3 affine transformation
matrix into
a 2-dimensional array of double precision values.
)DT( o )WB(
)A()BD(getScaleX)ES()EA(\201\202
)DD( Returns the X coordinate scaling element \201m00\202 of the 3x3
affine transformation matrix.
)DT( o )WB(
)A()BD(getScaleY)ES()EA(\201\202
)DD( Returns the Y coordinate scaling element \201m11\202 of the 3x3
affine transformation matrix.
)DT( o )WB(
)A()BD(getShearX)ES()EA(\201\202
)DD( Returns the X coordinate shearing element \201m01\202 of the 3x3
affine transformation matrix.
)DT( o )WB(
)A()BD(getShearY)ES()EA(\201\202
)DD( Returns the Y coordinate shearing element \201m10\202 of the 3x3
affine transformation matrix.
)DT( o )WB(
)A()BD(getTranslateX)ES()EA(\201\202
)DD( Returns the X coordinate translation element \201m02\202 of the 3x3
affine transformation matrix.
)DT( o )WB(
)A()BD(getTranslateY)ES()EA(\201\202
)DD( Returns the Y coordinate translation element \201m12\202 of the 3x3
affine transformation matrix.
)DT( o )WB(
)A()BD(getType)ES()EA(\201\202
)DD( Retrieves the flag bits describing the conversion properties of
this transform.
)DT( o )WB(
)A()BD(inverseTransform)ES()EA(\201double[], int, double[], int, int\202
)DD( Inverse transforms an array of double precision coordinates by
this transform.
)DT( o )WB(
)A()BD(inverseTransform)ES()EA(\201Point2D, Point2D\202
)DD( Inverse transforms the specified ptSrc and stores the result in ptDst.
)DT( o )WB(
)A()BD(isIdentity)ES()EA(\201\202
)DD( Returns the boolean true value if this AffineTransform is an
identity transform.
)DT( o )WB(
)A()BD(preConcatenate)ES()EA(\201AffineTransform\202
)DD( Concatenates an AffineTransform Tx to this AffineTransform Cx
in a less commonly used way such that Tx modifies the
coordinate transformation relative to the absolute pixel
space rather than relative to the existing user space.
)DT( o )WB(
)A()BD(prepend)ES()EA(\201AffineTransform\202
)DD(
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(rotate)ES()EA(\201double\202
)DD( Concatenates this transform with a rotation transformation.
)DT( o )WB(
)A()BD(rotate)ES()EA(\201double, double, double\202
)DD( Concatenates this transform with a translated rotation transformation.
)DT( o )WB(
)A()BD(scale)ES()EA(\201double, double\202
)DD( Concatenates this transform with a scaling transformation.
)DT( o )WB(
)A()BD(setToIdentity)ES()EA(\201\202
)DD( Resets this transform to the Identity transform.
)DT( o )WB(
)A()BD(setToRotation)ES()EA(\201double\202
)DD( Sets this transform to a rotation transformation.
)DT( o )WB(
)A()BD(setToRotation)ES()EA(\201double, double, double\202
)DD( Sets this transform to a translated rotation transformation.
)DT( o )WB(
)A()BD(setToScale)ES()EA(\201double, double\202
)DD( Sets this transform to a scaling transformation.
)DT( o )WB(
)A()BD(setToShear)ES()EA(\201double, double\202
)DD( Sets this transform to a shearing transformation.
)DT( o )WB(
)A()BD(setToTranslation)ES()EA(\201double, double\202
)DD( Sets this transform to a translation transformation.
)DT( o )WB(
)A()BD(shear)ES()EA(\201double, double\202
)DD( Concatenates this transform with a shearing transformation.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns a String that represents the value of this Object.
)DT( o )WB(
)A()BD(transform)ES()EA(\201double[], int, double[], int, int\202
)DD( Transforms an array of double precision coordinates by this transform.
)DT( o )WB(
)A()BD(transform)ES()EA(\201double[], int, float[], int, int\202
)DD( Transforms an array of double precision coordinates by this transform,
storing the results into an array of floats.
)DT( o )WB(
)A()BD(transform)ES()EA(\201float[], int, double[], int, int\202
)DD( Transforms an array of floating point coordinates by this transform,
storing the results into an array of doubles.
)DT( o )WB(
)A()BD(transform)ES()EA(\201float[], int, float[], int, int\202
)DD( Transforms an array of floating point coordinates by this transform.
)DT( o )WB(
)A()BD(transform)ES()EA(\201Point2D, Point2D\202
)DD( Transforms the specified ptSrc and stores the result in ptDst.
)DT( o )WB(
)A()BD(transform)ES()EA(\201Point2D[], int, Point2D[], int, int\202
)DD( Transforms an array of point objects by this transform.
)DT( o )WB(
)A()BD(translate)ES()EA(\201double, double\202
)DD( Concatenates this transform with a translation transformation.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(IDENTITY)ES(
)PR(
public static final int IDENTITY
)RP(
)DL(
)DD( This constant indicates that the transform defined by this object
is an identity transform.
An identity transform is one in which the output coordinates are
always the same as the input coordinates.
If this transform is anything other than the identity transform,
the type will be a combination of the appropriate flag bits for
the various coordinate conversions that this transform performs.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(TRANSLATION)EA(, )A(UNIFORM_SCALE)EA(, )A(GENERAL_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(, )A(getType)EA(
)LD(
)LD(
o )WB()EA(
)BD(TRANSLATION)ES(
)PR(
public static final int TRANSLATION
)RP(
)DL(
)DD( This flag bit indicates that the transform defined by this object
performs a translation in addition to the conversions indicated
by other flag bits.
A translation moves the coordinates by a constant amount in x
and y without changing the length or angle of vectors.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(IDENTITY)EA(, )A(UNIFORM_SCALE)EA(, )A(GENERAL_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(, )A(getType)EA(
)LD(
)LD(
o )WB()EA(
)BD(UNIFORM_SCALE)ES(
)PR(
public static final int UNIFORM_SCALE
)RP(
)DL(
)DD( This flag bit indicates that the transform defined by this object
performs a uniform scale in addition to the conversions indicated
by other flag bits.
A uniform scale multiplies the length of vectors by the same amount
in both the x and y directions without changing the angle between
vectors.
This flag bit is mutually exclusive with the GENERAL_SCALE flag.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(IDENTITY)EA(, )A(TRANSLATION)EA(, )A(GENERAL_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(, )A(getType)EA(
)LD(
)LD(
o )WB()EA(
)BD(GENERAL_SCALE)ES(
)PR(
public static final int GENERAL_SCALE
)RP(
)DL(
)DD( This flag bit indicates that the transform defined by this object
performs a general scale in addition to the conversions indicated
by other flag bits.
A general scale multiplies the length of vectors by different
amounts in the x and y directions without changing the angle
between vectors.
This flag bit is mutually exclusive with the UNIFORM_SCALE flag.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(IDENTITY)EA(, )A(TRANSLATION)EA(, )A(UNIFORM_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(, )A(getType)EA(
)LD(
)LD(
o )WB()EA(
)BD(ANY_SCALE_MASK)ES(
)PR(
public static final int ANY_SCALE_MASK
)RP(
)DL(
)DD( This flag is a bit mask for any of the scale flag bits.)0 P(
)LD(
o )WB()EA(
)BD(QUADRANT_ROTATION)ES(
)PR(
public static final int QUADRANT_ROTATION
)RP(
)DL(
)DD( This flag bit indicates that the transform defined by this object
performs a quadrant rotation by some multiple of 90 degrees in
addition to the conversions indicated by other flag bits.
A rotation changes the angles of vectors by the same amount
regardless of the original direction of the vector without
changing the length of the vector.
This flag bit is mutually exclusive with the GENERAL_ROTATION flag.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(IDENTITY)EA(, )A(TRANSLATION)EA(, )A(UNIFORM_SCALE)EA(, )A(GENERAL_SCALE)EA(, )A(GENERAL_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(, )A(getType)EA(
)LD(
)LD(
o )WB()EA(
)BD(GENERAL_ROTATION)ES(
)PR(
public static final int GENERAL_ROTATION
)RP(
)DL(
)DD( This flag bit indicates that the transform defined by this object
performs a rotation by an arbitrary angle in addition to the
conversions indicated by other flag bits.
A rotation changes the angles of vectors by the same amount
regardless of the original direction of the vector without
changing the length of the vector.
This flag bit is mutually exclusive with the QUADRANT_ROTATION flag.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(IDENTITY)EA(, )A(TRANSLATION)EA(, )A(UNIFORM_SCALE)EA(, )A(GENERAL_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(, )A(getType)EA(
)LD(
)LD(
o )WB()EA(
)BD(ANY_ROTATION_MASK)ES(
)PR(
public static final int ANY_ROTATION_MASK
)RP(
)DL(
)DD( This flag is a bit mask for any of the rotation flag bits.)0 P(
)LD(
o )WB()EA(
)BD(GENERAL_TRANSFORM)ES(
)PR(
public static final int GENERAL_TRANSFORM
)RP(
)DL(
)DD( This flag bit indicates that the transform defined by this object
performs an arbitrary conversion of the input coordinates.
This flag bit is mutually exclusive with any of the other flags.)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(IDENTITY)EA(, )A(TRANSLATION)EA(, )A(UNIFORM_SCALE)EA(, )A(GENERAL_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_ROTATION)EA(, )A(getType)EA(
)LD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201\202
)RP(
)DL(
)DD( Constructs a new AffineTransform representing the Identity
transformation.
)0 P(
)LD(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201float m00,
float m10,
float m01,
float m11,
float m02,
float m12\202
)RP(
)DL(
)DD( Constructs a new AffineTransform from 6 floating point values
representing the 6 specifiable entries of the 3x3 transformation matrix.
)0 P(
)LD(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201float flatmatrix[]\202
)RP(
)DL(
)DD( Constructs a new AffineTransform from an array of floating point
values representing either the 4 non-translation or the 6 specifiable
entries of
the 3x3 transformation matrix. The values are retrieved from the
array as { m00 m10 m01 m11 [m02 m12] }.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( flatmatrix - The float array containing the values to be set
in the new AffineTransform object. The length of the array is
assumed to be at least 4. If the length of the array is
less than 6, only the first 4 values are taken. If the length of
the array is greater than 6, the first 6 values are taken.
)LD(
)LD(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201float matrix[][]\202
)RP(
)DL(
)DD( Constructs a new AffineTransform from a 2-dimensional array of
floating point values representing either the 4 non-translation or the
6 specifiable entries of the 3x3 transformation matrix. The values are
retrieved from the 2-dimensional array using the row index as
the first subscript and the column index as the second.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( matrix - The matrix used to construct the new AffineTransform
object. Matrix is assumed to be at least 2x2. If the matrix
is smaller than 2x3, only the left upper 2x2 matrix is taken. If the
matrix is larger than 2x3, the left upper 2x3 matrix is taken.
)LD(
)LD(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201double m00,
double m10,
double m01,
double m11,
double m02,
double m12\202
)RP(
)DL(
)DD( Constructs a new AffineTransform from 6 double precision values
representing the 6 specifiable entries of the 3x3 transformation matrix.
)0 P(
)LD(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201double flatmatrix[]\202
)RP(
)DL(
)DD( Constructs a new AffineTransform from an array of double precision
values representing either the 4 non-translation or the 6 specifiable
entries of
the 3x3 transformation matrix. The values are retrieved from the
array as { m00 m10 m01 m11 [m02 m12] }.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( flatmatrix - The double array containing the values to be set
in the new AffineTransform object. The length of the array is
assumed to be at least 4. If the length of the array is
less than 6, only the first 4 values are taken. If the length of
the array is greater than 6, the first 6 values are taken.
)LD(
)LD(
o )WB()EA(
)BD(AffineTransform)ES(
)PR(
public AffineTransform\201double matrix[][]\202
)RP(
)DL(
)DD( Constructs a new AffineTransform from a 2-dimensional array of
double precision values representing either the 4 non-translation or the
6 specifiable entries of the 3x3 transformation matrix. The values are
retrieved from the 2-dimensional array using the row index as
the first subscript and the column index as the second.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( matrix - The matrix used to construct the new AffineTransform
object. Matrix is assumed to be at least 2x2. If the matrix
is smaller than 2x3, only the left upper 2x2 matrix is taken. If the
matrix is larger than 2x3, the left upper 2x3 matrix is taken.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getType)ES()EA(
)PR(
public int getType\201\202
)RP(
)DL(
)DD( Retrieves the flag bits describing the conversion properties of
this transform. The return value will be a combination of the
appriopriate conversion flag bits.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the OR combination of any of the indicated flags that
apply to this transform
)DT( )BD(See Also:)ES(
)DD( )A(TRANSLATION)EA(, )A(UNIFORM_SCALE)EA(, )A(GENERAL_SCALE)EA(, )A(QUADRANT_ROTATION)EA(, )A(GENERAL_ROTATION)EA(, )A(GENERAL_TRANSFORM)EA(
)LD(
)LD(
o )WB()EA(
)BD(getMatrix)ES()EA(
)PR(
public void getMatrix\201double flatmatrix[]\202
)RP(
)DL(
)DD( Retrieves the 6 specifiable values in the 3x3 affine transformation
matrix into
an array of double precisions values. The values are stored into
the array as { m00 m10 m01 m11 m02 m12 }.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( flatmatrix - The double array used to store the returned values.
The length of the array is assumed to be at least 6.
)DT( )BD(See Also:)ES(
)DD( )A(getScaleX)EA(, )A(getScaleY)EA(, )A(getShearX)EA(, )A(getShearY)EA(, )A(getTranslateX)EA(, )A(getTranslateY)EA(
)LD(
)LD(
o )WB()EA(
)BD(getMatrix)ES()EA(
)PR(
public void getMatrix\201double matrix[][]\202
)RP(
)DL(
)DD( Retrieves the 6 specifiable values in the 3x3 affine transformation
matrix into
a 2-dimensional array of double precision values. The values are
stored into the 2-dimensional array using the row index as the
first subscript and the column index as the second.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( matrix - The 2-dimensional double array to store the returned
values. The array is assumed to be at least 2x3.
)DT( )BD(See Also:)ES(
)DD( )A(getScaleX)EA(, )A(getScaleY)EA(, )A(getShearX)EA(, )A(getShearY)EA(, )A(getTranslateX)EA(, )A(getTranslateY)EA(
)LD(
)LD(
o )WB()EA(
)BD(getScaleX)ES()EA(
)PR(
public double getScaleX\201\202
)RP(
)DL(
)DD( Returns the X coordinate scaling element \201m00\202 of the 3x3
affine transformation matrix.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getMatrix)EA(
)LD(
)LD(
o )WB()EA(
)BD(getScaleY)ES()EA(
)PR(
public double getScaleY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate scaling element \201m11\202 of the 3x3
affine transformation matrix.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getMatrix)EA(
)LD(
)LD(
o )WB()EA(
)BD(getShearX)ES()EA(
)PR(
public double getShearX\201\202
)RP(
)DL(
)DD( Returns the X coordinate shearing element \201m01\202 of the 3x3
affine transformation matrix.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getMatrix)EA(
)LD(
)LD(
o )WB()EA(
)BD(getShearY)ES()EA(
)PR(
public double getShearY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate shearing element \201m10\202 of the 3x3
affine transformation matrix.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getMatrix)EA(
)LD(
)LD(
o )WB()EA(
)BD(getTranslateX)ES()EA(
)PR(
public double getTranslateX\201\202
)RP(
)DL(
)DD( Returns the X coordinate translation element \201m02\202 of the 3x3
affine transformation matrix.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getMatrix)EA(
)LD(
)LD(
o )WB()EA(
)BD(getTranslateY)ES()EA(
)PR(
public double getTranslateY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate translation element \201m12\202 of the 3x3
affine transformation matrix.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getMatrix)EA(
)LD(
)LD(
o )WB()EA(
)BD(setToIdentity)ES()EA(
)PR(
public void setToIdentity\201\202
)RP(
)DL(
)DD( Resets this transform to the Identity transform.
)0 P(
)LD(
o )WB()EA(
)BD(translate)ES()EA(
)PR(
public void translate\201double tx,
double ty\202
)RP(
)DL(
)DD( Concatenates this transform with a translation transformation.
This is equivalent to calling concatenate\201T\202, where T is an
AffineTransform represented by the following matrix:
)PR(
[ 1 0 tx ]
[ 0 1 ty ]
[ 0 0 1 ]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(rotate)ES()EA(
)PR(
public void rotate\201double theta\202
)RP(
)DL(
)DD( Concatenates this transform with a rotation transformation.
This is equivalent to calling concatenate\201R\202, where R is an
AffineTransform represented by the following matrix:
)PR(
[ cos\201theta\202 -sin\201theta\202 0 ]
[ sin\201theta\202 cos\201theta\202 0 ]
[ 0 0 1 ]
)RP(
Rotating with a positive angle theta rotates points on the positive
x axis toward the positive y axis.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( theta - The angle of rotation in radians.
)LD(
)LD(
o )WB()EA(
)BD(rotate)ES()EA(
)PR(
public void rotate\201double theta,
double x,
double y\202
)RP(
)DL(
)DD( Concatenates this transform with a translated rotation transformation.
This is equivalent to the following sequence of calls:
)PR(
translate\201x, y\202;
rotate\201theta\202;
translate\201-x, -y\202;
)RP(
Rotating with a positive angle theta rotates points on the positive
x axis toward the positive y axis.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( theta - The angle of rotation in radians.
)DD( x - The x coordinate of the origin of the rotation
)DD( y - The x coordinate of the origin of the rotation
)LD(
)LD(
o )WB()EA(
)BD(scale)ES()EA(
)PR(
public void scale\201double sx,
double sy\202
)RP(
)DL(
)DD( Concatenates this transform with a scaling transformation.
This is equivalent to calling concatenate\201S\202, where S is an
AffineTransform represented by the following matrix:
)PR(
[ sx 0 0 ]
[ 0 sy 0 ]
[ 0 0 1 ]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(shear)ES()EA(
)PR(
public void shear\201double shx,
double shy\202
)RP(
)DL(
)DD( Concatenates this transform with a shearing transformation.
This is equivalent to calling concatenate\201SH\202, where SH is an
AffineTransform represented by the following matrix:
)PR(
[ 1 shx 0 ]
[ shy 1 0 ]
[ 0 0 1 ]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( shx - The factor by which coordinates are shifted towards the
positive X axis direction according to their Y coordinate
)DD( shy - The factor by which coordinates are shifted towards the
positive Y axis direction according to their X coordinate
)LD(
)LD(
o )WB()EA(
)BD(setToTranslation)ES()EA(
)PR(
public void setToTranslation\201double tx,
double ty\202
)RP(
)DL(
)DD( Sets this transform to a translation transformation.
The matrix representing this transform becomes:
)PR(
[ 1 0 tx ]
[ 0 1 ty ]
[ 0 0 1 ]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(setToRotation)ES()EA(
)PR(
public void setToRotation\201double theta\202
)RP(
)DL(
)DD( Sets this transform to a rotation transformation.
The matrix representing this transform becomes:
)PR(
[ cos\201theta\202 -sin\201theta\202 0 ]
[ sin\201theta\202 cos\201theta\202 0 ]
[ 0 0 1 ]
)RP(
Rotating with a positive angle theta rotates points on the positive
x axis toward the positive y axis.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( theta - The angle of rotation in radians.
)LD(
)LD(
o )WB()EA(
)BD(setToRotation)ES()EA(
)PR(
public void setToRotation\201double theta,
double x,
double y\202
)RP(
)DL(
)DD( Sets this transform to a translated rotation transformation.
This is equivalent to the following sequence of calls:
)PR(
setToTranslation\201x, y\202;
rotate\201theta\202;
translate\201-x, -y\202;
)RP(
The matrix representing this transform becomes:
)PR(
[ cos\201theta\202 -sin\201theta\202 x-x*cos+y*sin ]
[ sin\201theta\202 cos\201theta\202 y-x*sin-y*cos ]
[ 0 0 1 ]
)RP(
Rotating with a positive angle theta rotates points on the positive
x axis toward the positive y axis.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( theta - The angle of rotation in radians.
)DD( x - The x coordinate of the origin of the rotation
)DD( y - The x coordinate of the origin of the rotation
)LD(
)LD(
o )WB()EA(
)BD(setToScale)ES()EA(
)PR(
public void setToScale\201double sx,
double sy\202
)RP(
)DL(
)DD( Sets this transform to a scaling transformation.
The matrix representing this transform becomes:
)PR(
[ sx 0 0 ]
[ 0 sy 0 ]
[ 0 0 1 ]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(setToShear)ES()EA(
)PR(
public void setToShear\201double shx,
double shy\202
)RP(
)DL(
)DD( Sets this transform to a shearing transformation.
The matrix representing this transform becomes:
)PR(
[ 1 shx 0 ]
[ shy 1 0 ]
[ 0 0 1 ]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( shx - The factor by which coordinates are shifted towards the
positive X axis direction according to their Y coordinate
)DD( shy - The factor by which coordinates are shifted towards the
positive Y axis direction according to their X coordinate
)LD(
)LD(
o )WB()EA(
)BD(concatenate)ES()EA(
)PR(
public void concatenate\201)A(AffineTransform)EA( Tx\202
)RP(
)DL(
)DD( Concatenates an AffineTransform Tx to this AffineTransform Cx
in the most commonly useful way to provide a new user space
which is mapped to the former user space by Tx.
Cx is updated to perform the combined transformation.
Transforming a point p by the updated transform Cx' is
equivalent to first transforming p by Tx and then transforming
the result by the original transform Cx. In other words,
Cx'\201p\202 = Cx\201Tx\201p\202\202. In matrix notation, if this transform Cx
is represented by the matrix [this] and Tx is represented by
the matrix [Tx], then this method does the following:
)PR(
[this] = [this] x [Tx]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( Tx - The AffineTransform object to be concatenated with
this AffineTransform object.
)DT( )BD(See Also:)ES(
)DD( )A(preConcatenate)EA(
)LD(
)LD(
o )WB()EA(
)BD(prepend)ES()EA(
)PR(
public void prepend\201)A(AffineTransform)EA( Tx\202
)RP(
)DL(
)DD()BD( Note: prepend\201\202 is deprecated.)ES(
)I(As of JDK version 1.2beta,
replaced by )SM(concatenate\201AffineTransform\202)ES(.
This method will disappear in the next release.)ES(
)0 P(
)LD(
o )WB()EA(
)BD(preConcatenate)ES()EA(
)PR(
public void preConcatenate\201)A(AffineTransform)EA( Tx\202
)RP(
)DL(
)DD( Concatenates an AffineTransform Tx to this AffineTransform Cx
in a less commonly used way such that Tx modifies the
coordinate transformation relative to the absolute pixel
space rather than relative to the existing user space.
Cx is updated to perform the combined transformation.
Transforming a point p by the updated transform Cx' is
equivalent to first transforming p by the original transform
Cx and then transforming the result by Tx. In other words,
Cx'\201p\202 = Tx\201Cx\201p\202\202. In matrix notation, if this transform Cx
is represented by the matrix [this] and Tx is represented by
the matrix [Tx], then this method does the following:
)PR(
[this] = [Tx] x [this]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( Tx - The AffineTransform object to be concatenated with
this AffineTransform object.
)DT( )BD(See Also:)ES(
)DD( )A(concatenate)EA(
)LD(
)LD(
o )WB()EA(
)BD(append)ES()EA(
)PR(
public void append\201)A(AffineTransform)EA( Tx\202
)RP(
)DL(
)DD()BD( Note: append\201\202 is deprecated.)ES(
)I(As of JDK version 1.2beta,
replaced by )SM(preConcatenate\201AffineTransform\202)ES(.
This method will disappear in the next release.)ES(
)0 P(
)LD(
o )WB()EA(
)BD(createInverse)ES()EA(
)PR(
public )A(AffineTransform)EA( createInverse\201\202 throws )A(NoninvertibleTransformException)EA(
)RP(
)DL(
)DD( Returns a Transform object representing the inverse transformation.
)0 P(
)DD()DL(
)DT( )BD(Throws:)ES( )A(NoninvertibleTransformException)EA(
)DD( if the matrix cannot be
inverted.
)LD(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public )A(Point2D)EA( transform\201)A(Point2D)EA( ptSrc,
)A(Point2D)EA( ptDst\202
)RP(
)DL(
)DD( Transforms the specified ptSrc and stores the result in ptDst.
If ptDst is null, a new Point2D object will be allocated before
storing. In either case, ptDst containing the transformed point
is returned for convenience.
Note that ptSrc and ptDst can the same. In this case, the input
point will be overwritten with the transformed point.
)0 P(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public void transform\201)A(Point2D)EA( ptSrc[],
int srcOff,
)A(Point2D)EA( ptDst[],
int dstOff,
int numPts\202
)RP(
)DL(
)DD( Transforms an array of point objects by this transform.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( ptSrc - The array containing the source point objects.
)DD( ptDst - The array where the transform point objects are returned.
)DD( srcOff - The offset to the first point object to be transformed
in the source array.
)DD( dstOff - The offset to the location where the first transformed
point object is stored in the destination array.
)DD( numPts - The number of point objects to be transformed.
)LD(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public void transform\201float srcPts[],
int srcOff,
float dstPts[],
int dstOff,
int numPts\202
)RP(
)DL(
)DD( Transforms an array of floating point coordinates by this transform.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( ptSrc - The array containing the source point coordinates.
Each point is stored as a pair of x,y coordinates.
)DD( ptDst - The array where the transformed point coordinates are
returned. Each point is stored as a pair of x,y coordinates.
)DD( srcOff - The offset to the first point to be transformed
in the source array.
)DD( dstOff - The offset to the location where the first transformed
point is stored in the destination array.
)DD( numPts - The number of points to be transformed.
)LD(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public void transform\201double srcPts[],
int srcOff,
double dstPts[],
int dstOff,
int numPts\202
)RP(
)DL(
)DD( Transforms an array of double precision coordinates by this transform.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( srcPts - The array containing the source point coordinates.
Each point is stored as a pair of x,y coordinates.
)DD( dstPts - The array where the transformed point coordinates are
returned. Each point is stored as a pair of x,y coordinates.
)DD( srcOff - The offset to the first point to be transformed
in the source array.
)DD( dstOff - The offset to the location where the first transformed
point is stored in the destination array.
)DD( numPts - The number of point objects to be transformed.
)LD(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public void transform\201float srcPts[],
int srcOff,
double dstPts[],
int dstOff,
int numPts\202
)RP(
)DL(
)DD( Transforms an array of floating point coordinates by this transform,
storing the results into an array of doubles.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( ptSrc - The array containing the source point coordinates.
Each point is stored as a pair of x,y coordinates.
)DD( ptDst - The array where the transformed point coordinates are
returned. Each point is stored as a pair of x,y coordinates.
)DD( srcOff - The offset to the first point to be transformed
in the source array.
)DD( dstOff - The offset to the location where the first transformed
point is stored in the destination array.
)DD( numPts - The number of points to be transformed.
)LD(
)LD(
o )WB()EA(
)BD(transform)ES()EA(
)PR(
public void transform\201double srcPts[],
int srcOff,
float dstPts[],
int dstOff,
int numPts\202
)RP(
)DL(
)DD( Transforms an array of double precision coordinates by this transform,
storing the results into an array of floats.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( srcPts - The array containing the source point coordinates.
Each point is stored as a pair of x,y coordinates.
)DD( dstPts - The array where the transformed point coordinates are
returned. Each point is stored as a pair of x,y coordinates.
)DD( srcOff - The offset to the first point to be transformed
in the source array.
)DD( dstOff - The offset to the location where the first transformed
point is stored in the destination array.
)DD( numPts - The number of point objects to be transformed.
)LD(
)LD(
o )WB()EA(
)BD(inverseTransform)ES()EA(
)PR(
public )A(Point2D)EA( inverseTransform\201)A(Point2D)EA( ptSrc,
)A(Point2D)EA( ptDst\202 throws )A(NoninvertibleTransformException)EA(
)RP(
)DL(
)DD( Inverse transforms the specified ptSrc and stores the result in ptDst.
If ptDst is null, a new Point2D object will be allocated before
storing. In either case, ptDst containing the transformed point
is returned for convenience.
Note that ptSrc and ptDst can the same. In this case, the input
point will be overwritten with the transformed point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( ptSrc - The point to be inverse transformed.
)DD( ptDst - The resulting transformed point.
)DT( )BD(Throws:)ES( )A(NoninvertibleTransformException)EA(
)DD( if the matrix cannot be
inverted.
)LD(
)LD(
o )WB()EA(
)BD(inverseTransform)ES()EA(
)PR(
public void inverseTransform\201double srcPts[],
int srcOff,
double dstPts[],
int dstOff,
int numPts\202 throws )A(NoninvertibleTransformException)EA(
)RP(
)DL(
)DD( Inverse transforms an array of double precision coordinates by
this transform.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( srcPts - The array containing the source point coordinates.
Each point is stored as a pair of x,y coordinates.
)DD( dstPts - The array where the transformed point coordinates are
returned. Each point is stored as a pair of x,y coordinates.
)DD( srcOff - The offset to the first point to be transformed
in the source array.
)DD( dstOff - The offset to the location where the first transformed
point is stored in the destination array.
)DD( numPts - The number of point objects to be transformed.
)DT( )BD(Throws:)ES( )A(NoninvertibleTransformException)EA(
)DD( if the matrix cannot be
inverted.
)LD(
)LD(
o )WB()EA(
)BD(createTransformedShape)ES()EA(
)PR(
public )A(Shape)EA( createTransformedShape\201)A(Shape)EA( pSrc\202
)RP(
)DL(
)DD( Transforms a shape object by this transform.
)0 P(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns a String that represents the value of this Object.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(isIdentity)ES()EA(
)PR(
public boolean isIdentity\201\202
)RP(
)DL(
)DD( Returns the boolean true value if this AffineTransform is an
identity transform. Returns false otherwise.
)0 P(
)LD(
o )WB()EA(
)BD(clone)ES()EA(
)PR(
public Object clone\201\202
)RP(
)DL(
)DD( Returns a copy of this AffineTransform object.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(clone)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Arc2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Arc2D
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----java.awt.geom.Arc2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Arc2D)ES(
)DT( extends )A(RectangularShape)EA(
)DT( super class of:
)DD( )A(Arc2D.Float)EA(
)LD(
An arc defined by a bounding rectangle, start angle and angular extent,
and a closure type \201one of OPEN, CHORD, or PIE\202.
The bounding rectangle defines the outer boundary of the full ellipse
of which this arc is a partial section.
The angles are specified relative to the non-square extents of the
bounding rectangle such that 45 degrees always falls on the line from
the center of the ellipse to the upper right corner of the bounding
rectangle.
As a result, if the bounding rectangle is noticeably longer in one
axis than the other, the angles to the start and end of the arc segment
will be skewed farther along the longer axis of the bounds.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D arc.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Arc2D.Float)ES()EA(
)DD( An arc specified in float precision,
)LD(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CHORD)ES()EA(
)DD( The closure type for an arc closed by drawing a straight
line segment from the start to the end of the arc segment.
)DT( o )WB(
)A()BD(OPEN)ES()EA(
)DD( The closure type for an open arc with no path segments
connecting the two ends of the arc segment.
)DT( o )WB(
)A()BD(PIE)ES()EA(
)DD( The closure type for an arc closed by drawing straight line
segments from the start of the arc segment to the center
of the full ellipse and back to the end of the arc segment.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Arc2D)ES()EA(\201int\202
)DD( Constructs a new arc of the specified closure type.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(containsAngle)ES()EA(\201double\202
)DD( Tests if a given angle is within the angular extents of the arc.
)DT( o )WB(
)A()BD(getAngleExtent)ES()EA(\201\202
)DD( Returns the arc length \201angular extent\202 of the arc \201in degrees\202.
)DT( o )WB(
)A()BD(getAngleStart)ES()EA(\201\202
)DD( Returns the starting angle of the arc \201in degrees\202.
)DT( o )WB(
)A()BD(getArcType)ES()EA(\201\202
)DD( Returns the arc closure type of the arc.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getEndPoint)ES()EA(\201\202
)DD( Returns the ending point of the arc.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(getStartPoint)ES()EA(\201\202
)DD( Returns the starting point of the arc.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(makeBounds)ES()EA(\201double, double, double, double\202
)DD( Construct a rectangle object of the appropriate precision
to hold the parameters calculated to be the bounding box
of this arc.
)DT( o )WB(
)A()BD(normalizeDegrees)ES()EA(\201double\202
)DD(
)DT( o )WB(
)A()BD(setAngleExtent)ES()EA(\201double\202
)DD( Sets the angular extent of this arc to the specified double
value \201in degrees\202.
)DT( o )WB(
)A()BD(setAngles)ES()EA(\201double, double, double, double\202
)DD( Sets the angular extents of this arc to the angles that the
specified point coordinates define relative to the center of
this arc.
)DT( o )WB(
)A()BD(setAngles)ES()EA(\201Point2D, Point2D\202
)DD( Sets the angular extents of this arc to the angles that the
specified Point objects define relative to the center of this
arc.
)DT( o )WB(
)A()BD(setAngleStart)ES()EA(\201double\202
)DD( Sets the starting angle of this arc to the specified double
value \201in degrees\202.
)DT( o )WB(
)A()BD(setAngleStart)ES()EA(\201Point2D\202
)DD( Sets the starting angle of this arc to the angle that the
specified point defines relative to the center of this arc.
)DT( o )WB(
)A()BD(setArc)ES()EA(\201Arc2D\202
)DD( Sets this arc to be the same as the specified Arc.
)DT( o )WB(
)A()BD(setArc)ES()EA(\201double, double, double, double, double, double, int\202
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified double values.
)DT( o )WB(
)A()BD(setArc)ES()EA(\201Point2D, Dimension2D, double, double, int\202
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified Point and Dimension and double values.
)DT( o )WB(
)A()BD(setArc)ES()EA(\201Rectangle2D, double, double, int\202
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified Rectangle and double values.
)DT( o )WB(
)A()BD(setArcByCenter)ES()EA(\201double, double, double, double, double, int\202
)DD( Sets the position, bounds, angular extents, and closure type of
this arc to the specified double values based on a center point
and a radius rather than a bounding box for the full ellipse.
)DT( o )WB(
)A()BD(setArcByTangent)ES()EA(\201Point2D, Point2D, Point2D, double\202
)DD( Sets the position, bounds, and angular extents of this arc
so that the starting angle is tangent to the line specified
by points \201p1, p2\202 and the ending angle is tangent to the
line specified by points \201p2, p3\202 with the given radius.
)DT( o )WB(
)A()BD(setArcType)ES()EA(\201int\202
)DD( Sets the closure type of this arc to the specified value.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)DT( o )WB(
)A()BD(toDegrees)ES()EA(\201double\202
)DD(
)DT( o )WB(
)A()BD(toRadians)ES()EA(\201double\202
)DD(
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(OPEN)ES(
)PR(
public static final int OPEN
)RP(
)DL(
)DD( The closure type for an open arc with no path segments
connecting the two ends of the arc segment.)0 P(
)LD(
o )WB()EA(
)BD(CHORD)ES(
)PR(
public static final int CHORD
)RP(
)DL(
)DD( The closure type for an arc closed by drawing a straight
line segment from the start to the end of the arc segment.)0 P(
)LD(
o )WB()EA(
)BD(PIE)ES(
)PR(
public static final int PIE
)RP(
)DL(
)DD( The closure type for an arc closed by drawing straight line
segments from the start of the arc segment to the center
of the full ellipse and back to the end of the arc segment.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Arc2D)ES(
)PR(
protected Arc2D\201int type\202
)RP(
)DL(
)DD( Constructs a new arc of the specified closure type.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getAngleStart)ES()EA(
)PR(
public abstract double getAngleStart\201\202
)RP(
)DL(
)DD( Returns the starting angle of the arc \201in degrees\202.
)0 P(
)LD(
o )WB()EA(
)BD(getAngleExtent)ES()EA(
)PR(
public abstract double getAngleExtent\201\202
)RP(
)DL(
)DD( Returns the arc length \201angular extent\202 of the arc \201in degrees\202.
)0 P(
)LD(
o )WB()EA(
)BD(getArcType)ES()EA(
)PR(
public int getArcType\201\202
)RP(
)DL(
)DD( Returns the arc closure type of the arc.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( OPEN, CHORD, PIE
)LD(
)LD(
o )WB()EA(
)BD(getStartPoint)ES()EA(
)PR(
public )A(Point2D)EA( getStartPoint\201\202
)RP(
)DL(
)DD( Returns the starting point of the arc. This point is the
intersection of the ray from the center defined by the
starting angle and the elliptical boundary of the arc.
)0 P(
)LD(
o )WB()EA(
)BD(getEndPoint)ES()EA(
)PR(
public )A(Point2D)EA( getEndPoint\201\202
)RP(
)DL(
)DD( Returns the ending point of the arc. This point is the
intersection of the ray from the center defined by the
starting angle plus the angular extent of the arc and the
elliptical boundary of the arc.
)0 P(
)LD(
o )WB()EA(
)BD(setArc)ES()EA(
)PR(
public abstract void setArc\201double x,
double y,
double w,
double h,
double angSt,
double angExt,
int closure\202
)RP(
)DL(
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified double values.
)0 P(
)LD(
o )WB()EA(
)BD(setArc)ES()EA(
)PR(
public void setArc\201)A(Point2D)EA( loc,
)A(Dimension2D)EA( size,
double angSt,
double angExt,
int closure\202
)RP(
)DL(
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified Point and Dimension and double values.
)0 P(
)LD(
o )WB()EA(
)BD(setArc)ES()EA(
)PR(
public void setArc\201)A(Rectangle2D)EA( rect,
double angSt,
double angExt,
int closure\202
)RP(
)DL(
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified Rectangle and double values.
)0 P(
)LD(
o )WB()EA(
)BD(setArc)ES()EA(
)PR(
public void setArc\201)A(Arc2D)EA( a\202
)RP(
)DL(
)DD( Sets this arc to be the same as the specified Arc.
)0 P(
)LD(
o )WB()EA(
)BD(setArcByCenter)ES()EA(
)PR(
public void setArcByCenter\201double x,
double y,
double radius,
double angSt,
double angExt,
int closure\202
)RP(
)DL(
)DD( Sets the position, bounds, angular extents, and closure type of
this arc to the specified double values based on a center point
and a radius rather than a bounding box for the full ellipse.
)0 P(
)LD(
o )WB()EA(
)BD(setArcByTangent)ES()EA(
)PR(
public void setArcByTangent\201)A(Point2D)EA( p1,
)A(Point2D)EA( p2,
)A(Point2D)EA( p3,
double radius\202
)RP(
)DL(
)DD( Sets the position, bounds, and angular extents of this arc
so that the starting angle is tangent to the line specified
by points \201p1, p2\202 and the ending angle is tangent to the
line specified by points \201p2, p3\202 with the given radius.
)0 P(
)LD(
o )WB()EA(
)BD(setAngleStart)ES()EA(
)PR(
public abstract void setAngleStart\201double angSt\202
)RP(
)DL(
)DD( Sets the starting angle of this arc to the specified double
value \201in degrees\202.
)0 P(
)LD(
o )WB()EA(
)BD(setAngleExtent)ES()EA(
)PR(
public abstract void setAngleExtent\201double angExt\202
)RP(
)DL(
)DD( Sets the angular extent of this arc to the specified double
value \201in degrees\202.
)0 P(
)LD(
o )WB()EA(
)BD(setAngleStart)ES()EA(
)PR(
public void setAngleStart\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Sets the starting angle of this arc to the angle that the
specified point defines relative to the center of this arc.
The angular extent of the arc will remain the same.
)0 P(
)LD(
o )WB()EA(
)BD(setAngles)ES()EA(
)PR(
public void setAngles\201double x1,
double y1,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the angular extents of this arc to the angles that the
specified point coordinates define relative to the center of
this arc.
The arc will always be non-empty and extend counterclockwise
from the first point around to the second point.
)0 P(
)LD(
o )WB()EA(
)BD(setAngles)ES()EA(
)PR(
public void setAngles\201)A(Point2D)EA( p1,
)A(Point2D)EA( p2\202
)RP(
)DL(
)DD( Sets the angular extents of this arc to the angles that the
specified Point objects define relative to the center of this
arc.
The arc will always be non-empty and extend counterclockwise
from the first point around to the second point.
)0 P(
)LD(
o )WB()EA(
)BD(setArcType)ES()EA(
)PR(
public void setArcType\201int type\202
)RP(
)DL(
)DD( Sets the closure type of this arc to the specified value.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( OPEN, CHORD, PIE
)LD(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setBounds)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(makeBounds)ES()EA(
)PR(
protected abstract )A(Rectangle2D)EA( makeBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Construct a rectangle object of the appropriate precision
to hold the parameters calculated to be the bounding box
of this arc.
)0 P(
)LD(
o )WB()EA(
)BD(toDegrees)ES()EA(
)PR(
protected static double toDegrees\201double angrad\202
)RP(
o )WB()EA(
)BD(toRadians)ES()EA(
)PR(
protected static double toRadians\201double angdeg\202
)RP(
o )WB()EA(
)BD(normalizeDegrees)ES()EA(
)PR(
protected static double normalizeDegrees\201double angle\202
)RP(
o )WB()EA(
)BD(containsAngle)ES()EA(
)PR(
public boolean containsAngle\201double angle\202
)RP(
)DL(
)DD( Tests if a given angle is within the angular extents of the arc.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(contains)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Arc2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Arc2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----)A(java.awt.geom.Arc2D)EA(
|
+----java.awt.geom.Arc2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(Arc2D.Float)ES(
)DT( extends )A(Arc2D)EA(
)LD(
An arc specified in float precision,
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(extent)ES()EA(
)DD( The angular extent of the arc in degrees.
)DT( o )WB(
)A()BD(height)ES()EA(
)DD( The overall height of the full ellipse \201not considering the
angular extents\202.
)DT( o )WB(
)A()BD(start)ES()EA(
)DD( The starting angle of the arc in degrees.
)DT( o )WB(
)A()BD(width)ES()EA(
)DD( The overall width of the full ellipse \201not considering the
angular extents\202.
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The x coordinate of the upper left corner of the arc.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The y coordinate of the upper left corner of the arc.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Arc2D.Float)ES()EA(\201\202
)DD( Constructs a new OPEN arc, initialized to location \2010, 0\202,
size \2010, 0\202, angular extents \201start = 0, extent = 0\202.
)DT( o )WB(
)A()BD(Arc2D.Float)ES()EA(\201float, float, float, float, float, float, int\202
)DD( Constructs a new arc, initialized to the specified location,
size, angular extents, and closure type.
)DT( o )WB(
)A()BD(Arc2D.Float)ES()EA(\201int\202
)DD( Constructs a new arc, initialized to location \2010, 0\202,
size \2010, 0\202, angular extents \201start = 0, extent = 0\202, and
the specified closure type.
)DT( o )WB(
)A()BD(Arc2D.Float)ES()EA(\201Rectangle2D, float, float, int\202
)DD( Constructs a new arc, initialized to the specified location,
size, angular extents, and closure type.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getAngleExtent)ES()EA(\201\202
)DD( Returns the arc length \201angular extent\202 of the arc \201in degrees\202.
)DT( o )WB(
)A()BD(getAngleStart)ES()EA(\201\202
)DD( Returns the starting angle of the arc \201in degrees\202.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the overall height of the arc in double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the overall width of the arc in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the upper left corner of the arc
in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the upper left corner of the arc
in double precision.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether the rectangular shape is empty.
)DT( o )WB(
)A()BD(makeBounds)ES()EA(\201double, double, double, double\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(setAngleExtent)ES()EA(\201double\202
)DD( Sets the angular extent of this arc to the specified double
value \201in degrees\202.
)DT( o )WB(
)A()BD(setAngleStart)ES()EA(\201double\202
)DD( Sets the starting angle of this arc to the specified double
value \201in degrees\202.
)DT( o )WB(
)A()BD(setArc)ES()EA(\201double, double, double, double, double, double, int\202
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified double values.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public float x
)RP(
)DL(
)DD( The x coordinate of the upper left corner of the arc.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public float y
)RP(
)DL(
)DD( The y coordinate of the upper left corner of the arc.)0 P(
)LD(
o )WB()EA(
)BD(width)ES(
)PR(
public float width
)RP(
)DL(
)DD( The overall width of the full ellipse \201not considering the
angular extents\202.)0 P(
)LD(
o )WB()EA(
)BD(height)ES(
)PR(
public float height
)RP(
)DL(
)DD( The overall height of the full ellipse \201not considering the
angular extents\202.)0 P(
)LD(
o )WB()EA(
)BD(start)ES(
)PR(
public float start
)RP(
)DL(
)DD( The starting angle of the arc in degrees.)0 P(
)LD(
o )WB()EA(
)BD(extent)ES(
)PR(
public float extent
)RP(
)DL(
)DD( The angular extent of the arc in degrees.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Arc2D.Float)ES(
)PR(
public Arc2D.Float\201\202
)RP(
)DL(
)DD( Constructs a new OPEN arc, initialized to location \2010, 0\202,
size \2010, 0\202, angular extents \201start = 0, extent = 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Arc2D.Float)ES(
)PR(
public Arc2D.Float\201int type\202
)RP(
)DL(
)DD( Constructs a new arc, initialized to location \2010, 0\202,
size \2010, 0\202, angular extents \201start = 0, extent = 0\202, and
the specified closure type.
)0 P(
)LD(
o )WB()EA(
)BD(Arc2D.Float)ES(
)PR(
public Arc2D.Float\201float x,
float y,
float w,
float h,
float start,
float extent,
int type\202
)RP(
)DL(
)DD( Constructs a new arc, initialized to the specified location,
size, angular extents, and closure type.
)0 P(
)LD(
o )WB()EA(
)BD(Arc2D.Float)ES(
)PR(
public Arc2D.Float\201)A(Rectangle2D)EA( ellipseBounds,
float start,
float extent,
int type\202
)RP(
)DL(
)DD( Constructs a new arc, initialized to the specified location,
size, angular extents, and closure type.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the upper left corner of the arc
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the upper left corner of the arc
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public double getWidth\201\202
)RP(
)DL(
)DD( Returns the overall width of the arc in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public double getHeight\201\202
)RP(
)DL(
)DD( Returns the overall height of the arc in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAngleStart)ES()EA(
)PR(
public double getAngleStart\201\202
)RP(
)DL(
)DD( Returns the starting angle of the arc \201in degrees\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAngleStart)EA( in class )A(Arc2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAngleExtent)ES()EA(
)PR(
public double getAngleExtent\201\202
)RP(
)DL(
)DD( Returns the arc length \201angular extent\202 of the arc \201in degrees\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAngleExtent)EA( in class )A(Arc2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether the rectangular shape is empty.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(setArc)ES()EA(
)PR(
public void setArc\201double x,
double y,
double w,
double h,
double angSt,
double angExt,
int closure\202
)RP(
)DL(
)DD( Sets the location, size, angular extents, and closure type of
this arc to the specified double values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setArc)EA( in class )A(Arc2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setAngleStart)ES()EA(
)PR(
public void setAngleStart\201double angSt\202
)RP(
)DL(
)DD( Sets the starting angle of this arc to the specified double
value \201in degrees\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setAngleStart)EA( in class )A(Arc2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setAngleExtent)ES()EA(
)PR(
public void setAngleExtent\201double angExt\202
)RP(
)DL(
)DD( Sets the angular extent of this arc to the specified double
value \201in degrees\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setAngleExtent)EA( in class )A(Arc2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(makeBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( makeBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(makeBounds)EA( in class )A(Arc2D)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Area
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Area
)EH(
)PR(
java.lang.Object
|
+----sun.awt.Albert.Area
|
+----java.awt.geom.Area
)RP(
)HR(
)DL(
)DT( public class )BD(Area)ES(
)DT( extends Area
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(EmptyArea)ES()EA(
)DD( Constant area geometry that is empty.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Area)ES()EA(\201\202
)DD( Default constructor which creates an empty area.
)DT( o )WB(
)A()BD(Area)ES()EA(\201Ellipse2D\202
)DD( Creates an area geometry of a ellipse inside the specified rectangle.
)DT( o )WB(
)A()BD(Area)ES()EA(\201Polygon\202
)DD( Creates an area geometry from the specified polygon.
)DT( o )WB(
)A()BD(Area)ES()EA(\201Rectangle2D\202
)DD( Creates an area geometry from the specified rectangle.
)DT( o )WB(
)A()BD(Area)ES()EA(\201Shape\202
)DD( Creates an area geometry from the specified Shape object.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(add)ES()EA(\201Area\202
)DD( Adds the shape of the specified Area to the current shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(exclusiveOr)ES()EA(\201Area\202
)DD( Sets the shape to the combined area of the current shape
and the shape of the specified Area, minus their intersection.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to the geometry of the outline
of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to a flattened view of the
geometry of the outline of the shape.
)DT( o )WB(
)A()BD(intersect)ES()EA(\201Area\202
)DD( Sets the shape to the intersection of the current shape with
the shape of the specified Area.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Tests whether this area contains any geometries.
)DT( o )WB(
)A()BD(isPolygonal)ES()EA(\201\202
)DD( Tests whether the area comprises completely of horizontal
and vertical edges.
)DT( o )WB(
)A()BD(isRectangular)ES()EA(\201\202
)DD( Tests whether the area is rectangular in shape.
)DT( o )WB(
)A()BD(isSingular)ES()EA(\201\202
)DD( Tests whether the area is comprised of a single basic geometry.
)DT( o )WB(
)A()BD(reset)ES()EA(\201\202
)DD( Removes all the basic geometries from this area and results
in an empty area.
)DT( o )WB(
)A()BD(subtract)ES()EA(\201Area\202
)DD( Subtracts the shape of the specified Area from the current shape.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(EmptyArea)ES(
)PR(
public static )A(Area)EA( EmptyArea
)RP(
)DL(
)DD( Constant area geometry that is empty.
Rendering such geometry will have no effect \201NOP\202.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Area)ES(
)PR(
public Area\201\202
)RP(
)DL(
)DD( Default constructor which creates an empty area.
)0 P(
)LD(
o )WB()EA(
)BD(Area)ES(
)PR(
public Area\201)A(Shape)EA( g\202
)RP(
)DL(
)DD( Creates an area geometry from the specified Shape object.
The shape is explicitly closed, if it is not closed.
The fill option \201even-odd or winding\202 specified by the shape
geometry is used to determined the resulting area.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( g - The shape from which the area is to be constructed.
)LD(
)LD(
o )WB()EA(
)BD(Area)ES(
)PR(
public Area\201Polygon p\202
)RP(
)DL(
)DD( Creates an area geometry from the specified polygon.
Even-odd fill option is assumed \201because that is how awt Polygon
is defined\202.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( p - The polygon from which the area is to be constructed.
)LD(
)LD(
o )WB()EA(
)BD(Area)ES(
)PR(
public Area\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Creates an area geometry from the specified rectangle.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( r - The rectangle from which the area is to be constructed.
)LD(
)LD(
o )WB()EA(
)BD(Area)ES(
)PR(
public Area\201)A(Ellipse2D)EA( e\202
)RP(
)DL(
)DD( Creates an area geometry of a ellipse inside the specified rectangle.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( e - The ellipse geometry from which the area is to be constructed
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBounds)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBounds2D)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(contains)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(contains)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(intersects)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(intersects)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(contains)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(contains)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to the geometry of the outline
of the shape.
An optional affine transform can be specified in which case
the coordinates returned in the iteration will be transformed
accordingly.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( at - an optional AffineTransform to be applied to the
coordinates as they are returned in the iteration, or null
if the untransformed coordinates are desired.
)DT( )BD(Overrides:)ES(
)DD( )A(getPathIterator)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to a flattened view of the
geometry of the outline of the shape.
Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types will
be returned by the iterator.
The amount of subdivision of the curved segments is controlled
by the )SM(flatness)ES( parameter which specifies ?REMIND?.
An optional affine transform can be specified in which case
the coordinates returned in the iteration will be transformed
accordingly.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( at - an optional AffineTransform to be applied to the
coordinates as they are returned in the iteration, or null
if the untransformed coordinates are desired.
)DD( flatness - the maximum amount that the control points
for a given curve can vary from colinear before a subdivided
curve is replaced by a straight line connecting the endpoints.
)DT( )BD(Overrides:)ES(
)DD( )A(getPathIterator)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(reset)ES()EA(
)PR(
public void reset\201\202
)RP(
)DL(
)DD( Removes all the basic geometries from this area and results
in an empty area.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(reset)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Tests whether this area contains any geometries.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( True if this area contains no basic geometries,
or is an empty area.
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(isPolygonal)ES()EA(
)PR(
public boolean isPolygonal\201\202
)RP(
)DL(
)DD( Tests whether the area comprises completely of horizontal
and vertical edges.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( True if the area comprises completely of
horizontal and vertical edges.
)DT( )BD(Overrides:)ES(
)DD( )A(isPolygonal)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(isRectangular)ES()EA(
)PR(
public boolean isRectangular\201\202
)RP(
)DL(
)DD( Tests whether the area is rectangular in shape.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( True if the area is rectangular in shape.
)DT( )BD(Overrides:)ES(
)DD( )A(isRectangular)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(isSingular)ES()EA(
)PR(
public boolean isSingular\201\202
)RP(
)DL(
)DD( Tests whether the area is comprised of a single basic geometry.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( True if the area is comprised of a single
basic geometry.
)DT( )BD(Overrides:)ES(
)DD( )A(isSingular)EA( in class Area
)LD(
)LD(
o )WB()EA(
)BD(add)ES()EA(
)PR(
public void add\201)A(Area)EA( rhs\202
)RP(
)DL(
)DD( Adds the shape of the specified Area to the current shape.
Addition is achieved through union.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rhs - The shape to be added to the current area.
)LD(
)LD(
o )WB()EA(
)BD(subtract)ES()EA(
)PR(
public void subtract\201)A(Area)EA( rhs\202
)RP(
)DL(
)DD( Subtracts the shape of the specified Area from the current shape.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rhs - The shape to be subtracted from the current area.
)LD(
)LD(
o )WB()EA(
)BD(intersect)ES()EA(
)PR(
public void intersect\201)A(Area)EA( rhs\202
)RP(
)DL(
)DD( Sets the shape to the intersection of the current shape with
the shape of the specified Area.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rhs - The area to be intersected with this one.
)LD(
)LD(
o )WB()EA(
)BD(exclusiveOr)ES()EA(
)PR(
public void exclusiveOr\201)A(Area)EA( rhs\202
)RP(
)DL(
)DD( Sets the shape to the combined area of the current shape
and the shape of the specified Area, minus their intersection.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rhs - The area to be exclusive ORed with this one.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.CubicCurve2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.CubicCurve2D
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.CubicCurve2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(CubicCurve2D)ES(
)DT( extends Object
)DT( implements )A(Shape)EA(
)DT( super class of:
)DD( )A(CubicCurve2D.Float)EA(
)LD(
A cubic parametric curve segment in \201x, y\202 coordinate space.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D cubic curve segment.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CubicCurve2D.Float)ES()EA(
)DD( A cubic parametric curve segment specified with float coordinates.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CubicCurve2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getCtrlX1)ES()EA(\201\202
)DD( Returns the X coordinate of the first control point in double precision.
)DT( o )WB(
)A()BD(getCtrlX2)ES()EA(\201\202
)DD( Returns the X coordinate of the second control point
in double precision.
)DT( o )WB(
)A()BD(getCtrlY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the first control point in double precision.
)DT( o )WB(
)A()BD(getCtrlY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the second control point
in double precision.
)DT( o )WB(
)A()BD(getFlatness)ES()EA(\201\202
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)DT( o )WB(
)A()BD(getFlatness)ES()EA(\201double, double, double, double, double, double, double, double\202
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the indicated controlpoints.
)DT( o )WB(
)A()BD(getFlatness)ES()EA(\201double[], int\202
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)DT( o )WB(
)A()BD(getFlatnessSq)ES()EA(\201\202
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)DT( o )WB(
)A()BD(getFlatnessSq)ES()EA(\201double, double, double, double, double, double, double, double\202
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the indicated controlpoints.
)DT( o )WB(
)A()BD(getFlatnessSq)ES()EA(\201double[], int\202
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)DT( o )WB(
)A()BD(getX1)ES()EA(\201\202
)DD( Returns the X coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getX2)ES()EA(\201\202
)DD( Returns the X coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(getY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201CubicCurve2D\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the same as those in the specified CubicCurve.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201double, double, double, double, double, double, double, double\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the specified double coordinates.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201double[], int\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the double coordinates at the specified offset in the specified
array.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201Point2D, Point2D, Point2D, Point2D\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the specified Point coordinates.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201Point2D[], int\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the coordinates of the Point objects at the specified offset in
the specified array.
)DT( o )WB(
)A()BD(solveCubic)ES()EA(\201double[]\202
)DD( Solve the cubic whose coefficients are in the eqn array and
place the non-complex roots back into the array, returning the
number of roots.
)DT( o )WB(
)A()BD(subdivide)ES()EA(\201CubicCurve2D, CubicCurve2D\202
)DD( Subdivides this cubic curve and stores the resulting two
subdivided curves into the left and right curve parameters.
)DT( o )WB(
)A()BD(subdivide)ES()EA(\201CubicCurve2D, CubicCurve2D, CubicCurve2D\202
)DD( Subdivides the cubic curve specified by the src parameter
and stores the resulting two subdivided curves into the left
and right curve parameters.
)DT( o )WB(
)A()BD(subdivide)ES()EA(\201double[], int, double[], int, double[], int\202
)DD( Subdivides the cubic curve specified by the the coordinates
stored in the src array at indices \201srcoff\202 through \201srcoff + 7\202
and stores the resulting two subdivided curves into the two
result arrays at the corresponding indices.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(CubicCurve2D)ES(
)PR(
protected CubicCurve2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX1)ES()EA(
)PR(
public abstract double getX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the start point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY1)ES()EA(
)PR(
public abstract double getY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the start point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCtrlX1)ES()EA(
)PR(
public abstract double getCtrlX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the first control point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCtrlY1)ES()EA(
)PR(
public abstract double getCtrlY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the first control point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCtrlX2)ES()EA(
)PR(
public abstract double getCtrlX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the second control point
in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCtrlY2)ES()EA(
)PR(
public abstract double getCtrlY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the second control point
in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getX2)ES()EA(
)PR(
public abstract double getX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the end point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY2)ES()EA(
)PR(
public abstract double getY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the end point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public abstract void setCurve\201double x1,
double y1,
double ctrlx1,
double ctrly1,
double ctrlx2,
double ctrly2,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the specified double coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201double coords[],
int offset\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the double coordinates at the specified offset in the specified
array.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201)A(Point2D)EA( p1,
)A(Point2D)EA( cp1,
)A(Point2D)EA( cp2,
)A(Point2D)EA( p2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the specified Point coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201)A(Point2D)EA( pts[],
int offset\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the coordinates of the Point objects at the specified offset in
the specified array.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201)A(CubicCurve2D)EA( c\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the same as those in the specified CubicCurve.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatnessSq)ES()EA(
)PR(
public static double getFlatnessSq\201double x1,
double y1,
double ctrlx1,
double ctrly1,
double ctrlx2,
double ctrly2,
double x2,
double y2\202
)RP(
)DL(
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the indicated controlpoints.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatness)ES()EA(
)PR(
public static double getFlatness\201double x1,
double y1,
double ctrlx1,
double ctrly1,
double ctrlx2,
double ctrly2,
double x2,
double y2\202
)RP(
)DL(
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the indicated controlpoints.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatnessSq)ES()EA(
)PR(
public static double getFlatnessSq\201double coords[],
int offset\202
)RP(
)DL(
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatness)ES()EA(
)PR(
public static double getFlatness\201double coords[],
int offset\202
)RP(
)DL(
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
cubic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatnessSq)ES()EA(
)PR(
public double getFlatnessSq\201\202
)RP(
)DL(
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatness)ES()EA(
)PR(
public double getFlatness\201\202
)RP(
)DL(
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)0 P(
)LD(
o )WB()EA(
)BD(subdivide)ES()EA(
)PR(
public void subdivide\201)A(CubicCurve2D)EA( left,
)A(CubicCurve2D)EA( right\202
)RP(
)DL(
)DD( Subdivides this cubic curve and stores the resulting two
subdivided curves into the left and right curve parameters.
Either or both of the left and right objects may be the same
as this object or null.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( left - the cubic curve object for storing for the left or
first half of the subdivided curve
)DD( right - the cubic curve object for storing for the right or
second half of the subdivided curve
)LD(
)LD(
o )WB()EA(
)BD(subdivide)ES()EA(
)PR(
public static void subdivide\201)A(CubicCurve2D)EA( src,
)A(CubicCurve2D)EA( left,
)A(CubicCurve2D)EA( right\202
)RP(
)DL(
)DD( Subdivides the cubic curve specified by the src parameter
and stores the resulting two subdivided curves into the left
and right curve parameters.
Either or both of the left and right objects may be the same
as the src object or null.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - the cubic curve to be subdivided
)DD( left - the cubic curve object for storing for the left or
first half of the subdivided curve
)DD( right - the cubic curve object for storing for the right or
second half of the subdivided curve
)LD(
)LD(
o )WB()EA(
)BD(subdivide)ES()EA(
)PR(
public static void subdivide\201double src[],
int srcoff,
double left[],
int leftoff,
double right[],
int rightoff\202
)RP(
)DL(
)DD( Subdivides the cubic curve specified by the the coordinates
stored in the src array at indices \201srcoff\202 through \201srcoff + 7\202
and stores the resulting two subdivided curves into the two
result arrays at the corresponding indices.
Either or both of the left and right arrays may be null or a
reference to the same array as the src array.
Note that the last point in the first subdivided curve is the
same as the first point in the second subdivided curve and thus
it is possible to pass the same array for left and right and
to use offsets such that rightoff equals \201leftoff + 6\202 in order
to avoid allocating extra storage for this common point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - the array holding the coordinates for the source curve
)DD( srcoff - the offset into the array of the beginning of the
the 6 source coordinates
)DD( left - the array for storing the coordinates for the first
half of the subdivided curve
)DD( leftoff - the offset into the array of the beginning of the
the 6 left coordinates
)DD( right - the array for storing the coordinates for the second
half of the subdivided curve
)DD( rightoff - the offset into the array of the beginning of the
the 6 right coordinates
)LD(
)LD(
o )WB()EA(
)BD(solveCubic)ES()EA(
)PR(
public static int solveCubic\201double eqn[]\202
)RP(
)DL(
)DD( Solve the cubic whose coefficients are in the eqn array and
place the non-complex roots back into the array, returning the
number of roots. The quadratic solved is represented by the
equation:
eqn = {c, b, a, d}
dx^3 + ax^2 + bx + c = 0
A return value of -1 is used to distinguish a constant equation,
which may be always 0 or never 0, from an equation which has no
zeroes.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the number of roots, or -1 if the equation is a constant
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.CubicCurve2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.CubicCurve2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.CubicCurve2D)EA(
|
+----java.awt.geom.CubicCurve2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(CubicCurve2D.Float)ES(
)DT( extends )A(CubicCurve2D)EA(
)LD(
A cubic parametric curve segment specified with float coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ctrlx1)ES()EA(
)DD( The X coordinate of the first control point
of the cubic curve segment.
)DT( o )WB(
)A()BD(ctrlx2)ES()EA(
)DD( The X coordinate of the second control point
of the cubic curve segment.
)DT( o )WB(
)A()BD(ctrly1)ES()EA(
)DD( The Y coordinate of the first control point
of the cubic curve segment.
)DT( o )WB(
)A()BD(ctrly2)ES()EA(
)DD( The Y coordinate of the second control point
of the cubic curve segment.
)DT( o )WB(
)A()BD(x1)ES()EA(
)DD( The X coordinate of the start point
of the cubic curve segment.
)DT( o )WB(
)A()BD(x2)ES()EA(
)DD( The X coordinate of the end point
of the cubic curve segment.
)DT( o )WB(
)A()BD(y1)ES()EA(
)DD( The Y coordinate of the start point
of the cubic curve segment.
)DT( o )WB(
)A()BD(y2)ES()EA(
)DD( The Y coordinate of the end point
of the cubic curve segment.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(CubicCurve2D.Float)ES()EA(\201\202
)DD( Constructs and initializes a CubicCurve with coordinates
\2010, 0, 0, 0, 0, 0\202.
)DT( o )WB(
)A()BD(CubicCurve2D.Float)ES()EA(\201float, float, float, float, float, float, float, float\202
)DD( Constructs and initializes a CubicCurve from
the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getCtrlX1)ES()EA(\201\202
)DD( Returns the X coordinate of the first control point
in double precision.
)DT( o )WB(
)A()BD(getCtrlX2)ES()EA(\201\202
)DD( Returns the X coordinate of the second control point
in double precision.
)DT( o )WB(
)A()BD(getCtrlY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the first control point
in double precision.
)DT( o )WB(
)A()BD(getCtrlY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the second control point
in double precision.
)DT( o )WB(
)A()BD(getX1)ES()EA(\201\202
)DD( Returns the X coordinate of the start point
in double precision.
)DT( o )WB(
)A()BD(getX2)ES()EA(\201\202
)DD( Returns the X coordinate of the end point
in double precision.
)DT( o )WB(
)A()BD(getY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the start point
in double precision.
)DT( o )WB(
)A()BD(getY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the end point
in double precision.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201double, double, double, double, double, double, double, double\202
)DD( Sets the location of the endpoints and controlpoints
of this curve to the specified double coordinates.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201float, float, float, float, float, float, float, float\202
)DD( Sets the location of the endpoints and controlpoints
of this curve to the specified float coordinates.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x1)ES(
)PR(
public float x1
)RP(
)DL(
)DD( The X coordinate of the start point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(y1)ES(
)PR(
public float y1
)RP(
)DL(
)DD( The Y coordinate of the start point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(ctrlx1)ES(
)PR(
public float ctrlx1
)RP(
)DL(
)DD( The X coordinate of the first control point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(ctrly1)ES(
)PR(
public float ctrly1
)RP(
)DL(
)DD( The Y coordinate of the first control point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(ctrlx2)ES(
)PR(
public float ctrlx2
)RP(
)DL(
)DD( The X coordinate of the second control point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(ctrly2)ES(
)PR(
public float ctrly2
)RP(
)DL(
)DD( The Y coordinate of the second control point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(x2)ES(
)PR(
public float x2
)RP(
)DL(
)DD( The X coordinate of the end point
of the cubic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(y2)ES(
)PR(
public float y2
)RP(
)DL(
)DD( The Y coordinate of the end point
of the cubic curve segment.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(CubicCurve2D.Float)ES(
)PR(
public CubicCurve2D.Float\201\202
)RP(
)DL(
)DD( Constructs and initializes a CubicCurve with coordinates
\2010, 0, 0, 0, 0, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(CubicCurve2D.Float)ES(
)PR(
public CubicCurve2D.Float\201float x1,
float y1,
float ctrlx1,
float ctrly1,
float ctrlx2,
float ctrly2,
float x2,
float y2\202
)RP(
)DL(
)DD( Constructs and initializes a CubicCurve from
the specified coordinates.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX1)ES()EA(
)PR(
public double getX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the start point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX1)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY1)ES()EA(
)PR(
public double getY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the start point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY1)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getCtrlX1)ES()EA(
)PR(
public double getCtrlX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the first control point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getCtrlX1)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getCtrlY1)ES()EA(
)PR(
public double getCtrlY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the first control point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getCtrlY1)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getCtrlX2)ES()EA(
)PR(
public double getCtrlX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the second control point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getCtrlX2)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getCtrlY2)ES()EA(
)PR(
public double getCtrlY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the second control point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getCtrlY2)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getX2)ES()EA(
)PR(
public double getX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the end point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX2)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY2)ES()EA(
)PR(
public double getY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the end point
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY2)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201double x1,
double y1,
double ctrlx1,
double ctrly1,
double ctrlx2,
double ctrly2,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints
of this curve to the specified double coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setCurve)EA( in class )A(CubicCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201float x1,
float y1,
float ctrlx1,
float ctrly1,
float ctrlx2,
float ctrly2,
float x2,
float y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints
of this curve to the specified float coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Dimension2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Dimension2D
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.Dimension2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Dimension2D)ES(
)DT( extends Object
)LD(
A class to encapsulate a width and a height Dimension.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D dimension.
The actual storage representation of the sizes is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Dimension2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of this dimension in double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of this dimension in double precision.
)DT( o )WB(
)A()BD(setSize)ES()EA(\201Dimension2D\202
)DD( Set the size of this Dimension object to match the specified size.
)DT( o )WB(
)A()BD(setSize)ES()EA(\201double, double\202
)DD( Set the size of this Dimension object to the specified width
and height.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Dimension2D)ES(
)PR(
protected Dimension2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public abstract double getWidth\201\202
)RP(
)DL(
)DD( Returns the width of this dimension in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public abstract double getHeight\201\202
)RP(
)DL(
)DD( Returns the height of this dimension in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(setSize)ES()EA(
)PR(
public abstract void setSize\201double width,
double height\202
)RP(
)DL(
)DD( Set the size of this Dimension object to the specified width
and height.
This method is included for completeness, to parallel the
getSize method of Component.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - the new width for the Dimension object
)DD( height - the new height for the Dimension object
)LD(
)LD(
o )WB()EA(
)BD(setSize)ES()EA(
)PR(
public void setSize\201)A(Dimension2D)EA( d\202
)RP(
)DL(
)DD( Set the size of this Dimension object to match the specified size.
This method is included for completeness, to parallel the
getSize method of Component.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( d - the new size for the Dimension object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Ellipse2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Ellipse2D
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----java.awt.geom.Ellipse2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Ellipse2D)ES(
)DT( extends )A(RectangularShape)EA(
)DT( super class of:
)DD( )A(Ellipse2D.Float)EA(
)LD(
An ellipse defined by a bounding rectangle.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D ellipse.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Ellipse2D.Float)ES()EA(
)DD( An ellipse specified in float precision.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Ellipse2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Ellipse2D)ES(
)PR(
protected Ellipse2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Ellipse2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Ellipse2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----)A(java.awt.geom.Ellipse2D)EA(
|
+----java.awt.geom.Ellipse2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(Ellipse2D.Float)ES(
)DT( extends )A(Ellipse2D)EA(
)LD(
An ellipse specified in float precision.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(height)ES()EA(
)DD( The overall height of the ellipse.
)DT( o )WB(
)A()BD(width)ES()EA(
)DD( The overall width of the ellipse.
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The x coordinate of the upper left corner of the ellipse.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The y coordinate of the upper left corner of the ellipse.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Ellipse2D.Float)ES()EA(\201\202
)DD( Constructs a new ellipse, initialized to location \2010, 0\202 and
size \2010, 0\202.
)DT( o )WB(
)A()BD(Ellipse2D.Float)ES()EA(\201float, float, float, float\202
)DD( Constructs and initializes an ellipse from the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the overall height of the ellipse in double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the overall width of the ellipse in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the upper left corner of the ellipse
in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the upper left corner of the ellipse
in double precision.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether the rectangular shape is empty.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of this ellipse to the specified
float values.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201float, float, float, float\202
)DD( Sets the location and size of this ellipse to the specified
float values.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public float x
)RP(
)DL(
)DD( The x coordinate of the upper left corner of the ellipse.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public float y
)RP(
)DL(
)DD( The y coordinate of the upper left corner of the ellipse.)0 P(
)LD(
o )WB()EA(
)BD(width)ES(
)PR(
public float width
)RP(
)DL(
)DD( The overall width of the ellipse.)0 P(
)LD(
o )WB()EA(
)BD(height)ES(
)PR(
public float height
)RP(
)DL(
)DD( The overall height of the ellipse.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Ellipse2D.Float)ES(
)PR(
public Ellipse2D.Float\201\202
)RP(
)DL(
)DD( Constructs a new ellipse, initialized to location \2010, 0\202 and
size \2010, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Ellipse2D.Float)ES(
)PR(
public Ellipse2D.Float\201float x,
float y,
float w,
float h\202
)RP(
)DL(
)DD( Constructs and initializes an ellipse from the specified coordinates.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the x coordinate
)DD( y - the y coordinate
)DD( width - the width of the rectangle
)DD( height - the height of the rectangle
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the upper left corner of the ellipse
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the upper left corner of the ellipse
in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public double getWidth\201\202
)RP(
)DL(
)DD( Returns the overall width of the ellipse in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public double getHeight\201\202
)RP(
)DL(
)DD( Returns the overall height of the ellipse in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether the rectangular shape is empty.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201float x,
float y,
float w,
float h\202
)RP(
)DL(
)DD( Sets the location and size of this ellipse to the specified
float values.
)0 P(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of this ellipse to the specified
float values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setBounds)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.FlatteningPathIterator
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.FlatteningPathIterator
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.FlatteningPathIterator
)RP(
)HR(
)DL(
)DT( public class )BD(FlatteningPathIterator)ES(
)DT( extends Object
)DT( implements )A(PathIterator)EA(
)LD(
This class returns a flattened view of another PathIterator object.
Other Shape classes can use this class to provide flattening
behavior for their paths without having to perform the interpolation
calculations themselves.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(FlatteningPathIterator)ES()EA(\201PathIterator, double\202
)DD( Constructs a new FlatteningPathIterator object that flattens
a path as it iterates over it.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(currentSegment)ES()EA(\201double[]\202
)DD( Returns the coordinates and type of the current path segment in
the iteration.
)DT( o )WB(
)A()BD(currentSegment)ES()EA(\201float[]\202
)DD( Returns the coordinates and type of the current path segment in
the iteration.
)DT( o )WB(
)A()BD(getWindingRule)ES()EA(\201\202
)DD( Return the winding rule for determining the interior of the
path.
)DT( o )WB(
)A()BD(isDone)ES()EA(\201\202
)DD( Tests if there are more points to read.
)DT( o )WB(
)A()BD(next)ES()EA(\201\202
)DD( Moves the iterator to the next segment of the path forwards
along the primary direction of traversal as long as there are
more points in that direction.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(FlatteningPathIterator)ES(
)PR(
public FlatteningPathIterator\201)A(PathIterator)EA( src,
double flatness\202
)RP(
)DL(
)DD( Constructs a new FlatteningPathIterator object that flattens
a path as it iterates over it.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - the original unflattened path being iterated over
)DD( flatness - the maximum allowable distance between the
control points
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getWindingRule)ES()EA(
)PR(
public int getWindingRule\201\202
)RP(
)DL(
)DD( Return the winding rule for determining the interior of the
path.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(WIND_EVEN_ODD)EA(, )A(WIND_NON_ZERO)EA(
)LD(
)LD(
o )WB()EA(
)BD(isDone)ES()EA(
)PR(
public boolean isDone\201\202
)RP(
)DL(
)DD( Tests if there are more points to read.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( true if there are more points to read
)LD(
)LD(
o )WB()EA(
)BD(next)ES()EA(
)PR(
public void next\201\202
)RP(
)DL(
)DD( Moves the iterator to the next segment of the path forwards
along the primary direction of traversal as long as there are
more points in that direction.
)0 P(
)LD(
o )WB()EA(
)BD(currentSegment)ES()EA(
)PR(
public int currentSegment\201float coords[]\202
)RP(
)DL(
)DD( Returns the coordinates and type of the current path segment in
the iteration.
The return value is the path segment type:
SEG_MOVETO, SEG_LINETO, or SEG_CLOSE.
A float array of length 6 must be passed in and may be used to
store the coordinates of the point\201s\202.
Each point is stored as a pair of float x,y coordinates.
SEG_MOVETO and SEG_LINETO types will return one point,
and SEG_CLOSE will not return any points.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SEG_MOVETO)EA(, )A(SEG_LINETO)EA(, )A(SEG_CLOSE)EA(
)LD(
)LD(
o )WB()EA(
)BD(currentSegment)ES()EA(
)PR(
public int currentSegment\201double coords[]\202
)RP(
)DL(
)DD( Returns the coordinates and type of the current path segment in
the iteration.
The return value is the path segment type:
SEG_MOVETO, SEG_LINETO, or SEG_CLOSE.
A double array of length 6 must be passed in and may be used to
store the coordinates of the point\201s\202.
Each point is stored as a pair of double x,y coordinates.
SEG_MOVETO and SEG_LINETO types will return one point,
and SEG_CLOSE will not return any points.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SEG_MOVETO)EA(, )A(SEG_LINETO)EA(, )A(SEG_CLOSE)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.GeneralPath
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.GeneralPath
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.GeneralPath
)RP(
)HR(
)DL(
)DT( public final class )BD(GeneralPath)ES(
)DT( extends Object
)DT( implements )A(Shape)EA(
)LD(
This class represents a geometric path constructed from straight
lines, quadratic and cubic \201Bezier\202 curves. It can contain multiple
subpaths.
)0 P(
The winding rule specifies how the interior of a path will be
determined. There are two types of winding rules: EVEN_ODD and
NON_ZERO. An EVEN-ODD winding rule means that enclosed regions
of the path alternate between interior and exterior areas as
traversed from the outside of the path towards a point inside
the region. For a NON_ZERO winding rule, we start by conceptually
drawing a ray from a given point to infinity in any direction
and then by examining all of the places where the path intersects
the ray. We now traverse the path in one direction and keep
track of the number of times that the path crosses the ray from
left to right, and the number of times that the path crosses the
ray from right to left. If these numbers are equal, the point
is outside of the path. If they are not equal, the point is
inside.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(EVEN_ODD)ES()EA(
)DD( An even-odd winding rule for determining the interior of
a path.
)DT( o )WB(
)A()BD(NON_ZERO)ES()EA(
)DD( A non-zero winding rule for determining the interior of a
path.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(GeneralPath)ES()EA(\201int\202
)DD( Constructs a new GeneralPath object.
)DT( o )WB(
)A()BD(GeneralPath)ES()EA(\201int, int\202
)DD( Constructs a new GeneralPath object with the specified initial
capacity to store path coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(append)ES()EA(\201PathIterator, boolean\202
)DD( Appends the geometry of the specified PathIterator object to the
path, possibly connecting the geometry to the existing path
segments with a line segment.
)DT( o )WB(
)A()BD(append)ES()EA(\201Shape, boolean\202
)DD( Appends the geometry of the specified Shape object to the
path, possibly connecting the geometry to the existing path
segments with a line segment.
)DT( o )WB(
)A()BD(closePath)ES()EA(\201\202
)DD( Closes the current subpath by drawing a straight line back to
the coordinates of the last moveTo.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(createTransformedShape)ES()EA(\201AffineTransform\202
)DD( Returns a new transformed Path.
)DT( o )WB(
)A()BD(curveTo)ES()EA(\201float, float, float, float, float, float\202
)DD( Adds 3 points to the path by drawing a Bezier curve from the
current coordinates through the third set of specified
coordinates, using the first and second sets of specified
coordinates as Bezier control points.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Returns the bounding box of the path.
)DT( o )WB(
)A()BD(getCurrentPoint)ES()EA(\201\202
)DD( Returns the most recent point added to the end of the path.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to the geometry of the outline
of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iterator object that iterates along the boundary of
the flattened shape and provides access to the geometry of the
outline of the shape.
)DT( o )WB(
)A()BD(getWindingRule)ES()EA(\201\202
)DD( Returns the fill style winding rule.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(lineTo)ES()EA(\201float, float\202
)DD( Adds a point to the path by drawing a straight line from the
current coordinates to the new specified coordinates.
)DT( o )WB(
)A()BD(moveTo)ES()EA(\201float, float\202
)DD( Adds a point to the path by moving to the specified
coordinates.
)DT( o )WB(
)A()BD(quadTo)ES()EA(\201float, float, float, float\202
)DD( Adds 2 points to the path by drawing a Quadratic curve from
the current coordinates through the second set of specified
coordinates, using the first set of specified coordinates as
a quadratic parametric control point.
)DT( o )WB(
)A()BD(reset)ES()EA(\201\202
)DD( Resets the path to empty.
)DT( o )WB(
)A()BD(setWindingRule)ES()EA(\201int\202
)DD( Sets the winding rule for this path to the specified value.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(EVEN_ODD)ES(
)PR(
public static final byte EVEN_ODD
)RP(
)DL(
)DD( An even-odd winding rule for determining the interior of
a path.)0 P(
)LD(
o )WB()EA(
)BD(NON_ZERO)ES(
)PR(
public static final byte NON_ZERO
)RP(
)DL(
)DD( A non-zero winding rule for determining the interior of a
path.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(GeneralPath)ES(
)PR(
public GeneralPath\201int rule\202
)RP(
)DL(
)DD( Constructs a new GeneralPath object.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rule - The winding rule.
)LD(
)LD(
o )WB()EA(
)BD(GeneralPath)ES(
)PR(
public GeneralPath\201int rule,
int initialCapacity\202
)RP(
)DL(
)DD( Constructs a new GeneralPath object with the specified initial
capacity to store path coordinates.
This number is an initial guess as to how many coordinates will
be in the path, but the storage will be expanded as needed to
store whatever path segments are added to this path.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( rule - The winding rule.
)DD( initialCapacity - The estimate for the number of coordinates
in the path.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(moveTo)ES()EA(
)PR(
public synchronized void moveTo\201float x,
float y\202
)RP(
)DL(
)DD( Adds a point to the path by moving to the specified
coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(lineTo)ES()EA(
)PR(
public synchronized void lineTo\201float x,
float y\202
)RP(
)DL(
)DD( Adds a point to the path by drawing a straight line from the
current coordinates to the new specified coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(quadTo)ES()EA(
)PR(
public synchronized void quadTo\201float x1,
float y1,
float x2,
float y2\202
)RP(
)DL(
)DD( Adds 2 points to the path by drawing a Quadratic curve from
the current coordinates through the second set of specified
coordinates, using the first set of specified coordinates as
a quadratic parametric control point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x1 - the X coordinate of the first quadratic control point
)DD( y1 - the Y coordinate of the first quadratic control point
)DD( x2 - the X coordinate of the final endpoint
)DD( y2 - the Y coordinate of the final endpoint
)LD(
)LD(
o )WB()EA(
)BD(curveTo)ES()EA(
)PR(
public synchronized void curveTo\201float x1,
float y1,
float x2,
float y2,
float x3,
float y3\202
)RP(
)DL(
)DD( Adds 3 points to the path by drawing a Bezier curve from the
current coordinates through the third set of specified
coordinates, using the first and second sets of specified
coordinates as Bezier control points.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x1 - the X coordinate of the first Bezier control point
)DD( y1 - the Y coordinate of the first Bezier control point
)DD( x2 - the X coordinate of the second Bezier control point
)DD( y2 - the Y coordinate of the second Bezier control point
)DD( x3 - the X coordinate of the final endpoint
)DD( y3 - the Y coordinate of the final endpoint
)LD(
)LD(
o )WB()EA(
)BD(closePath)ES()EA(
)PR(
public synchronized void closePath\201\202
)RP(
)DL(
)DD( Closes the current subpath by drawing a straight line back to
the coordinates of the last moveTo. If the path is already
closed, then this method has no effect.
)0 P(
)LD(
o )WB()EA(
)BD(append)ES()EA(
)PR(
public void append\201)A(Shape)EA( s,
boolean connect\202
)RP(
)DL(
)DD( Appends the geometry of the specified Shape object to the
path, possibly connecting the geometry to the existing path
segments with a line segment.
If the connect parameter is true and the path is not empty,
then any initial moveTo in the geometry of the appended Shape
will be turned into a lineTo segment.
If the destination coordinates of such a connecting lineTo
segment match the ending coordinates of a currently open
subpath, then the segment will be omitted as superfluous.
The winding rule of the specified Shape will be ignored
and the appended geometry will be governed by the winding
rule specified for this path.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - the shape whose geometry will be appended to this path
)DD( connect - a boolean to control whether or not to turn an
initial moveTo segment into a lineTo segment to connect the
new geometry to the existing path
)LD(
)LD(
o )WB()EA(
)BD(append)ES()EA(
)PR(
public void append\201)A(PathIterator)EA( pi,
boolean connect\202
)RP(
)DL(
)DD( Appends the geometry of the specified PathIterator object to the
path, possibly connecting the geometry to the existing path
segments with a line segment.
If the connect parameter is true and the path is not empty,
then any initial moveTo in the geometry of the appended Shape
will be turned into a lineTo segment.
If the destination coordinates of such a connecting lineTo
segment match the ending coordinates of a currently open
subpath, then the segment will be omitted as superfluous.
The winding rule of the specified Shape will be ignored
and the appended geometry will be governed by the winding
rule specified for this path.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( s - the shape whose geometry will be appended to this path
)DD( connect - a boolean to control whether or not to turn an
initial moveTo segment into a lineTo segment to connect the
new geometry to the existing path
)LD(
)LD(
o )WB()EA(
)BD(getWindingRule)ES()EA(
)PR(
public synchronized int getWindingRule\201\202
)RP(
)DL(
)DD( Returns the fill style winding rule.
)0 P(
)LD(
o )WB()EA(
)BD(setWindingRule)ES()EA(
)PR(
public void setWindingRule\201int rule\202
)RP(
)DL(
)DD( Sets the winding rule for this path to the specified value.
)0 P(
)LD(
o )WB()EA(
)BD(getCurrentPoint)ES()EA(
)PR(
public synchronized )A(Point2D)EA( getCurrentPoint\201\202
)RP(
)DL(
)DD( Returns the most recent point added to the end of the path.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a Point object containing the ending coordinate of the
path or null if there are no points in the path.
)LD(
)LD(
o )WB()EA(
)BD(reset)ES()EA(
)PR(
public synchronized void reset\201\202
)RP(
)DL(
)DD( Resets the path to empty. The append position is set back to the
beginning of the path and all coordinates and point types are
forgotten.
)0 P(
)LD(
o )WB()EA(
)BD(createTransformedShape)ES()EA(
)PR(
public synchronized )A(Shape)EA( createTransformedShape\201)A(AffineTransform)EA( t\202
)RP(
)DL(
)DD( Returns a new transformed Path.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public synchronized )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Returns the bounding box of the path.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to the geometry of the outline
of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the flattened shape and provides access to the geometry of the
outline of the shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.GeneralPathIterator
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.GeneralPathIterator
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.GeneralPathIterator
)RP(
)HR(
)DL(
)DT( public class )BD(GeneralPathIterator)ES(
)DT( extends Object
)DT( implements )A(PathIterator)EA(
)LD(
This class represents the iterator for General Paths.
It can be used to retrieve all of the elements in a GeneralPath.
The )A(
GeneralPath.getPathIterator\201\202 )EA( method is used to create a
GeneralPathIterator for a particular GeneralPath.
The iterator can be used to iterator the path only once.
Subsequent iterations require a new iterator.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(GeneralPath)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(currentSegment)ES()EA(\201double[]\202
)DD( Returns the coordinates and type of the current path segment in
the iteration.
)DT( o )WB(
)A()BD(currentSegment)ES()EA(\201float[]\202
)DD( Returns the coordinates and type of the current path segment in
the iteration.
)DT( o )WB(
)A()BD(getWindingRule)ES()EA(\201\202
)DD( Return the winding rule for determining the interior of the
path.
)DT( o )WB(
)A()BD(isDone)ES()EA(\201\202
)DD( Tests if there are more points to read.
)DT( o )WB(
)A()BD(next)ES()EA(\201\202
)DD( Moves the iterator to the next segment of the path forwards
along the primary direction of traversal as long as there are
more points in that direction.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getWindingRule)ES()EA(
)PR(
public int getWindingRule\201\202
)RP(
)DL(
)DD( Return the winding rule for determining the interior of the
path.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(WIND_EVEN_ODD)EA(, )A(WIND_NON_ZERO)EA(
)LD(
)LD(
o )WB()EA(
)BD(isDone)ES()EA(
)PR(
public boolean isDone\201\202
)RP(
)DL(
)DD( Tests if there are more points to read.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( true if there are more points to read
)LD(
)LD(
o )WB()EA(
)BD(next)ES()EA(
)PR(
public void next\201\202
)RP(
)DL(
)DD( Moves the iterator to the next segment of the path forwards
along the primary direction of traversal as long as there are
more points in that direction.
)0 P(
)LD(
o )WB()EA(
)BD(currentSegment)ES()EA(
)PR(
public int currentSegment\201float coords[]\202
)RP(
)DL(
)DD( Returns the coordinates and type of the current path segment in
the iteration.
The return value is the path segment type:
SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE.
A float array of length 6 must be passed in and may be used to
store the coordinates of the point\201s\202.
Each point is stored as a pair of float x,y coordinates.
SEG_MOVETO and SEG_LINETO types will return one point,
SEG_QUADTO will return two points,
SEG_CUBICTO will return 3 points
and SEG_CLOSE will not return any points.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SEG_MOVETO)EA(, )A(SEG_LINETO)EA(, )A(SEG_QUADTO)EA(, )A(SEG_CUBICTO)EA(, )A(SEG_CLOSE)EA(
)LD(
)LD(
o )WB()EA(
)BD(currentSegment)ES()EA(
)PR(
public int currentSegment\201double coords[]\202
)RP(
)DL(
)DD( Returns the coordinates and type of the current path segment in
the iteration.
The return value is the path segment type:
SEG_MOVETO, SEG_LINETO, SEG_QUADTO, SEG_CUBICTO, or SEG_CLOSE.
A double array of length 6 must be passed in and may be used to
store the coordinates of the point\201s\202.
Each point is stored as a pair of double x,y coordinates.
SEG_MOVETO and SEG_LINETO types will return one point,
SEG_QUADTO will return two points,
SEG_CUBICTO will return 3 points
and SEG_CLOSE will not return any points.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(SEG_MOVETO)EA(, )A(SEG_LINETO)EA(, )A(SEG_QUADTO)EA(, )A(SEG_CUBICTO)EA(, )A(SEG_CLOSE)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Line2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Line2D
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.Line2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Line2D)ES(
)DT( extends Object
)DT( implements )A(Shape)EA(
)DT( super class of:
)DD( )A(Line2D.Float)EA(
)LD(
A line segment in \201x, y\202 coordinate space.
For the purposes of the Shape interface, a coordinate is considered
to be inside or contained by this line segment if the coordinate
lies exactly on the line segment.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D line segment.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Line2D.Float)ES()EA(
)DD( A line segment specified with float coordinates.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Line2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(colinear)ES()EA(\201double, double\202
)DD( Test if a given \201x, y\202 coordinate is colinear with the line segment.
)DT( o )WB(
)A()BD(colinear)ES()EA(\201Point2D\202
)DD( Test if a given Point is colinear with the line segment.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)DT( o )WB(
)A()BD(getX1)ES()EA(\201\202
)DD( Returns the X coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getX2)ES()EA(\201\202
)DD( Returns the X coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(getY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(intersectsLine)ES()EA(\201double, double, double, double\202
)DD( Tests if the line segment from \201x1, y1\202 to \201x2, y2\202 intersects
this line segment.
)DT( o )WB(
)A()BD(intersectsLine)ES()EA(\201Line2D\202
)DD( Tests if the given line segment intersects this line segment.
)DT( o )WB(
)A()BD(linesIntersect)ES()EA(\201double, double, double, double, double, double, double, double\202
)DD( Tests if the line segment from \201x1, y1\202 to \201x2, y2\202 intersects
the line segment from \201x3, y3\202 to \201x4, y4\202.
)DT( o )WB(
)A()BD(ptSegDist)ES()EA(\201double, double, double, double, double, double\202
)DD( Returns the distance from a point to a line segment.
)DT( o )WB(
)A()BD(ptSegDistSq)ES()EA(\201double, double, double, double, double, double\202
)DD( Returns the square of the distance from a point to a line segment.
)DT( o )WB(
)A()BD(relativeCCW)ES()EA(\201double, double\202
)DD( Return an indicator of where the specified point \201x, y\202 lies
with respect to this line segment.
)DT( o )WB(
)A()BD(relativeCCW)ES()EA(\201double, double, double, double, double, double\202
)DD( Return an indicator of where the specified point \201px, py\202 lies
with respect to the line segment from \201x1, y1\202 to \201x2, y2\202.
)DT( o )WB(
)A()BD(relativeCCW)ES()EA(\201Point2D\202
)DD( Return an indicator of where the specified point lies
with respect to this line segment.
)DT( o )WB(
)A()BD(setLine)ES()EA(\201double, double, double, double\202
)DD( Sets the location of the endpoints of this line to the specified
double coordinates.
)DT( o )WB(
)A()BD(setLine)ES()EA(\201Line2D\202
)DD( Sets the location of the endpoints of this line to the same
as those in the specified Line.
)DT( o )WB(
)A()BD(setLine)ES()EA(\201Point2D, Point2D\202
)DD( Sets the location of the endpoints of this line to the specified
Point coordinates.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Line2D)ES(
)PR(
protected Line2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX1)ES()EA(
)PR(
public abstract double getX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the start point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY1)ES()EA(
)PR(
public abstract double getY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the start point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getX2)ES()EA(
)PR(
public abstract double getX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the end point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY2)ES()EA(
)PR(
public abstract double getY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the end point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(setLine)ES()EA(
)PR(
public abstract void setLine\201double x1,
double y1,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints of this line to the specified
double coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setLine)ES()EA(
)PR(
public void setLine\201)A(Point2D)EA( p1,
)A(Point2D)EA( p2\202
)RP(
)DL(
)DD( Sets the location of the endpoints of this line to the specified
Point coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setLine)ES()EA(
)PR(
public void setLine\201)A(Line2D)EA( l\202
)RP(
)DL(
)DD( Sets the location of the endpoints of this line to the same
as those in the specified Line.
)0 P(
)LD(
o )WB()EA(
)BD(colinear)ES()EA(
)PR(
public boolean colinear\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given \201x, y\202 coordinate is colinear with the line segment.
)0 P(
)LD(
o )WB()EA(
)BD(colinear)ES()EA(
)PR(
public boolean colinear\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is colinear with the line segment.
)0 P(
)LD(
o )WB()EA(
)BD(relativeCCW)ES()EA(
)PR(
public static int relativeCCW\201double x1,
double y1,
double x2,
double y2,
double px,
double py\202
)RP(
)DL(
)DD( Return an indicator of where the specified point \201px, py\202 lies
with respect to the line segment from \201x1, y1\202 to \201x2, y2\202.
The value will be 1 if the line segment must turn counterclockwise
to point at the specified point, -1 if it must turn clockwise,
or 0 if the point lies exactly on the line segment.
If the point is colinear with the line segment, but not between
the endpoints, then the value will be -1 if the point lies
"beyond \201x1, y1\202" or 1 if the point lies "beyond \201x2, y2\202".
)0 P(
)LD(
o )WB()EA(
)BD(relativeCCW)ES()EA(
)PR(
public int relativeCCW\201double x,
double y\202
)RP(
)DL(
)DD( Return an indicator of where the specified point \201x, y\202 lies
with respect to this line segment.
The value will be 1 if the line segment must turn counterclockwise
to point at the specified point, -1 if it must turn clockwise,
or 0 if the point lies exactly on the line segment.
If the point is colinear with the line segment, but not between
the endpoints, then the value will be -1 if the point lies
"beyond \201x1, y1\202" or 1 if the point lies "beyond \201x2, y2\202".
)0 P(
)LD(
o )WB()EA(
)BD(relativeCCW)ES()EA(
)PR(
public int relativeCCW\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Return an indicator of where the specified point lies
with respect to this line segment.
The value will be 1 if the line segment must turn counterclockwise
to point at the specified point, -1 if it must turn clockwise,
or 0 if the point lies exactly on the line segment.
If the point is colinear with the line segment, but not between
the endpoints, then the value will be -1 if the point lies
"beyond \201x1, y1\202" or 1 if the point lies "beyond \201x2, y2\202".
)0 P(
)LD(
o )WB()EA(
)BD(linesIntersect)ES()EA(
)PR(
public static boolean linesIntersect\201double x1,
double y1,
double x2,
double y2,
double x3,
double y3,
double x4,
double y4\202
)RP(
)DL(
)DD( Tests if the line segment from \201x1, y1\202 to \201x2, y2\202 intersects
the line segment from \201x3, y3\202 to \201x4, y4\202.
)0 P(
)LD(
o )WB()EA(
)BD(intersectsLine)ES()EA(
)PR(
public boolean intersectsLine\201double x1,
double y1,
double x2,
double y2\202
)RP(
)DL(
)DD( Tests if the line segment from \201x1, y1\202 to \201x2, y2\202 intersects
this line segment.
)0 P(
)LD(
o )WB()EA(
)BD(intersectsLine)ES()EA(
)PR(
public boolean intersectsLine\201)A(Line2D)EA( l\202
)RP(
)DL(
)DD( Tests if the given line segment intersects this line segment.
)0 P(
)LD(
o )WB()EA(
)BD(ptSegDistSq)ES()EA(
)PR(
public static double ptSegDistSq\201double x0,
double y0,
double x1,
double y1,
double px,
double py\202
)RP(
)DL(
)DD( Returns the square of the distance from a point to a line segment.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x0 - the x coordinate of the beginning of the line segment
)DD( y0 - the y coordinate of the beginning of the line segment
)DD( x1 - the x coordinate of the end of the line segment
)DD( y1 - the y coordinate of the end of the line segment
)DD( px - the x coordinate of the point being measured
)DD( py - the y coordinate of the point being measured
)LD(
)LD(
o )WB()EA(
)BD(ptSegDist)ES()EA(
)PR(
public static double ptSegDist\201double x0,
double y0,
double x1,
double y1,
double px,
double py\202
)RP(
)DL(
)DD( Returns the distance from a point to a line segment.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x0 - the x coordinate of the beginning of the line segment
)DD( y0 - the y coordinate of the beginning of the line segment
)DD( x1 - the x coordinate of the end of the line segment
)DD( y1 - the y coordinate of the end of the line segment
)DD( px - the x coordinate of the point being measured
)DD( py - the y coordinate of the point being measured
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Line2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Line2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.Line2D)EA(
|
+----java.awt.geom.Line2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(Line2D.Float)ES(
)DT( extends )A(Line2D)EA(
)LD(
A line segment specified with float coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(x1)ES()EA(
)DD( The X coordinate of the start point of the line segment.
)DT( o )WB(
)A()BD(x2)ES()EA(
)DD( The X coordinate of the end point of the line segment.
)DT( o )WB(
)A()BD(y1)ES()EA(
)DD( The Y coordinate of the start point of the line segment.
)DT( o )WB(
)A()BD(y2)ES()EA(
)DD( The Y coordinate of the end point of the line segment.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Line2D.Float)ES()EA(\201\202
)DD( Constructs and initializes a Line with coordinates \2010, 0\202 -> \2010, 0\202.
)DT( o )WB(
)A()BD(Line2D.Float)ES()EA(\201float, float, float, float\202
)DD( Constructs and initializes a Line from the specified coordinates.
)DT( o )WB(
)A()BD(Line2D.Float)ES()EA(\201Point2D, Point2D\202
)DD( Constructs and initializes a Line from the specified Points.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getX1)ES()EA(\201\202
)DD( Returns the X coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getX2)ES()EA(\201\202
)DD( Returns the X coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(getY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(setLine)ES()EA(\201double, double, double, double\202
)DD( Sets the location of the endpoints of this line to the specified
double coordinates.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x1)ES(
)PR(
public float x1
)RP(
)DL(
)DD( The X coordinate of the start point of the line segment.)0 P(
)LD(
o )WB()EA(
)BD(y1)ES(
)PR(
public float y1
)RP(
)DL(
)DD( The Y coordinate of the start point of the line segment.)0 P(
)LD(
o )WB()EA(
)BD(x2)ES(
)PR(
public float x2
)RP(
)DL(
)DD( The X coordinate of the end point of the line segment.)0 P(
)LD(
o )WB()EA(
)BD(y2)ES(
)PR(
public float y2
)RP(
)DL(
)DD( The Y coordinate of the end point of the line segment.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Line2D.Float)ES(
)PR(
public Line2D.Float\201\202
)RP(
)DL(
)DD( Constructs and initializes a Line with coordinates \2010, 0\202 -> \2010, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Line2D.Float)ES(
)PR(
public Line2D.Float\201float x1,
float y1,
float x2,
float y2\202
)RP(
)DL(
)DD( Constructs and initializes a Line from the specified coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(Line2D.Float)ES(
)PR(
public Line2D.Float\201)A(Point2D)EA( p1,
)A(Point2D)EA( p2\202
)RP(
)DL(
)DD( Constructs and initializes a Line from the specified Points.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX1)ES()EA(
)PR(
public double getX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the start point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX1)EA( in class )A(Line2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY1)ES()EA(
)PR(
public double getY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the start point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY1)EA( in class )A(Line2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getX2)ES()EA(
)PR(
public double getX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the end point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX2)EA( in class )A(Line2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY2)ES()EA(
)PR(
public double getY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the end point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY2)EA( in class )A(Line2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setLine)ES()EA(
)PR(
public void setLine\201double x1,
double y1,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints of this line to the specified
double coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setLine)EA( in class )A(Line2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Point2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Point2D
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.Point2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Point2D)ES(
)DT( extends Object
)DT( super class of:
)DD( )A(Point2D.Double)EA(, )A(Point2D.Float)EA(
)LD(
A point representing a location in \201x, y\202 coordinate space.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D coordinate.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Point2D.Double)ES()EA(
)DD( A point specified in double precision.
)DT( o )WB(
)A()BD(Point2D.Float)ES()EA(
)DD( A point specified in float precision.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Point2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Determines whether two points are equal.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the point in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the point in double precision.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201double, double\202
)DD( Sets the location of this point to the specified float coordinates.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201Point2D\202
)DD( Sets the location of this point to the same coordinates as the
specified Point object.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Point2D)ES(
)PR(
protected Point2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public abstract double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public abstract double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public abstract void setLocation\201double x,
double y\202
)RP(
)DL(
)DD( Sets the location of this point to the specified float coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public void setLocation\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Sets the location of this point to the same coordinates as the
specified Point object.
)0 P(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD( Determines whether two points are equal. Two instances of
)SM(Point2D)ES( are equal if the values of their
)SM(x)ES( and )SM(y)ES( member fields, representing
their position in the coordinate space, are the same.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( obj - an object to be compared with this point.
)DT( )BD(Returns:)ES(
)DD( )SM(true)ES( if the object to be compared is
an instance of )SM(Point2D)ES( and has
the same values; )SM(false)ES( otherwise.
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Point2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Point2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.Point2D)EA(
|
+----java.awt.geom.Point2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(Point2D.Float)ES(
)DT( extends )A(Point2D)EA(
)LD(
A point specified in float precision.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The X coordinate.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The Y coordinate.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Point2D.Float)ES()EA(\201\202
)DD( Constructs and initializes a Point with coordinates \2010, 0\202.
)DT( o )WB(
)A()BD(Point2D.Float)ES()EA(\201float, float\202
)DD( Constructs and initializes a Point with the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the point in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the point in double precision.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201double, double\202
)DD( Sets the location of this point to the specified double coordinates.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201float, float\202
)DD( Sets the location of this point to the specified float coordinates.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns a String that represents the value of this Object.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public float x
)RP(
)DL(
)DD( The X coordinate.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public float y
)RP(
)DL(
)DD( The Y coordinate.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Point2D.Float)ES(
)PR(
public Point2D.Float\201\202
)RP(
)DL(
)DD( Constructs and initializes a Point with coordinates \2010, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Point2D.Float)ES(
)PR(
public Point2D.Float\201float x,
float y\202
)RP(
)DL(
)DD( Constructs and initializes a Point with the specified coordinates.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(Point2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(Point2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public void setLocation\201double x,
double y\202
)RP(
)DL(
)DD( Sets the location of this point to the specified double coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setLocation)EA( in class )A(Point2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public void setLocation\201float x,
float y\202
)RP(
)DL(
)DD( Sets the location of this point to the specified float coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns a String that represents the value of this Object.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Point2D.Double
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Point2D.Double
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.Point2D)EA(
|
+----java.awt.geom.Point2D.Double
)RP(
)HR(
)DL(
)DT( public static class )BD(Point2D.Double)ES(
)DT( extends )A(Point2D)EA(
)LD(
A point specified in double precision.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The x coordinate of the point.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The y coordinate of the point.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Point2D.Double)ES()EA(\201\202
)DD( Constructs and initializes a Point with coordinates \2010, 0\202.
)DT( o )WB(
)A()BD(Point2D.Double)ES()EA(\201double, double\202
)DD( Constructs and initializes a Point with the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the point in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the point in double precision.
)DT( o )WB(
)A()BD(setLocation)ES()EA(\201double, double\202
)DD( Sets the location of this point to the specified double coordinates.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns a String that represents the value of this Object.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public double x
)RP(
)DL(
)DD( The x coordinate of the point.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public double y
)RP(
)DL(
)DD( The y coordinate of the point.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Point2D.Double)ES(
)PR(
public Point2D.Double\201\202
)RP(
)DL(
)DD( Constructs and initializes a Point with coordinates \2010, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Point2D.Double)ES(
)PR(
public Point2D.Double\201double x,
double y\202
)RP(
)DL(
)DD( Constructs and initializes a Point with the specified coordinates.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(Point2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(Point2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setLocation)ES()EA(
)PR(
public void setLocation\201double x,
double y\202
)RP(
)DL(
)DD( Sets the location of this point to the specified double coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setLocation)EA( in class )A(Point2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns a String that represents the value of this Object.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.QuadCurve2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.QuadCurve2D
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.QuadCurve2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(QuadCurve2D)ES(
)DT( extends Object
)DT( implements )A(Shape)EA(
)DT( super class of:
)DD( )A(QuadCurve2D.Float)EA(
)LD(
A quadratic parametric curve segment in \201x, y\202 coordinate space.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D quadratic curve segment.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(QuadCurve2D.Float)ES()EA(
)DD( A quadratic parametric curve segment specified with float coordinates.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(QuadCurve2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getCtrlX)ES()EA(\201\202
)DD( Returns the X coordinate of the control point in double precision.
)DT( o )WB(
)A()BD(getCtrlY)ES()EA(\201\202
)DD( Returns the Y coordinate of the control point in double precision.
)DT( o )WB(
)A()BD(getFlatness)ES()EA(\201\202
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)DT( o )WB(
)A()BD(getFlatness)ES()EA(\201double, double, double, double, double, double\202
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the indicated controlpoints.
)DT( o )WB(
)A()BD(getFlatness)ES()EA(\201double[], int\202
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)DT( o )WB(
)A()BD(getFlatnessSq)ES()EA(\201\202
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)DT( o )WB(
)A()BD(getFlatnessSq)ES()EA(\201double, double, double, double, double, double\202
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the indicated controlpoints.
)DT( o )WB(
)A()BD(getFlatnessSq)ES()EA(\201double[], int\202
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)DT( o )WB(
)A()BD(getX1)ES()EA(\201\202
)DD( Returns the X coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getX2)ES()EA(\201\202
)DD( Returns the X coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(getY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201double, double, double, double, double, double\202
)DD( Sets the location of the endpoints and controlpoint of this curve
to the specified double coordinates.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201double[], int\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the double coordinates at the specified offset in the specified
array.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201Point2D, Point2D, Point2D\202
)DD( Sets the location of the endpoints and controlpoint of this curve
to the specified Point coordinates.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201Point2D[], int\202
)DD( Sets the location of the endpoints and controlpoints of this curve
to the coordinates of the Point objects at the specified offset in
the specified array.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201QuadCurve2D\202
)DD( Sets the location of the endpoints and controlpoint of this curve
to the same as those in the specified QuadCurve.
)DT( o )WB(
)A()BD(solveQuadratic)ES()EA(\201double[]\202
)DD( Solve the quadratic whose coefficients are in the eqn array and
place the non-complex roots back into the array, returning the
number of roots.
)DT( o )WB(
)A()BD(subdivide)ES()EA(\201double[], int, double[], int, double[], int\202
)DD( Subdivides the quadratic curve specified by the the coordinates
stored in the src array at indices \201srcoff\202 through \201srcoff + 5\202
and stores the resulting two subdivided curves into the two
result arrays at the corresponding indices.
)DT( o )WB(
)A()BD(subdivide)ES()EA(\201QuadCurve2D, QuadCurve2D\202
)DD( Subdivides this quadratic curve and stores the resulting two
subdivided curves into the left and right curve parameters.
)DT( o )WB(
)A()BD(subdivide)ES()EA(\201QuadCurve2D, QuadCurve2D, QuadCurve2D\202
)DD( Subdivides the quadratic curve specified by the src parameter
and stores the resulting two subdivided curves into the left
and right curve parameters.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(QuadCurve2D)ES(
)PR(
protected QuadCurve2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX1)ES()EA(
)PR(
public abstract double getX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the start point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY1)ES()EA(
)PR(
public abstract double getY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the start point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCtrlX)ES()EA(
)PR(
public abstract double getCtrlX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the control point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCtrlY)ES()EA(
)PR(
public abstract double getCtrlY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the control point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getX2)ES()EA(
)PR(
public abstract double getX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the end point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY2)ES()EA(
)PR(
public abstract double getY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the end point in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public abstract void setCurve\201double x1,
double y1,
double ctrlx,
double ctrly,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoint of this curve
to the specified double coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201double coords[],
int offset\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the double coordinates at the specified offset in the specified
array.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201)A(Point2D)EA( p1,
)A(Point2D)EA( cp,
)A(Point2D)EA( p2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoint of this curve
to the specified Point coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201)A(Point2D)EA( pts[],
int offset\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoints of this curve
to the coordinates of the Point objects at the specified offset in
the specified array.
)0 P(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201)A(QuadCurve2D)EA( c\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoint of this curve
to the same as those in the specified QuadCurve.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatnessSq)ES()EA(
)PR(
public static double getFlatnessSq\201double x1,
double y1,
double ctrlx,
double ctrly,
double x2,
double y2\202
)RP(
)DL(
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the indicated controlpoints.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatness)ES()EA(
)PR(
public static double getFlatness\201double x1,
double y1,
double ctrlx,
double ctrly,
double x2,
double y2\202
)RP(
)DL(
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the indicated controlpoints.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatnessSq)ES()EA(
)PR(
public static double getFlatnessSq\201double coords[],
int offset\202
)RP(
)DL(
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatness)ES()EA(
)PR(
public static double getFlatness\201double coords[],
int offset\202
)RP(
)DL(
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of the
quadratic curve specified by the controlpoints stored in the
indicated array at the indicated index.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatnessSq)ES()EA(
)PR(
public double getFlatnessSq\201\202
)RP(
)DL(
)DD( Returns the square of the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)0 P(
)LD(
o )WB()EA(
)BD(getFlatness)ES()EA(
)PR(
public double getFlatness\201\202
)RP(
)DL(
)DD( Returns the flatness, or maximum distance of a
controlpoint from the line connecting the endpoints, of this curve.
)0 P(
)LD(
o )WB()EA(
)BD(subdivide)ES()EA(
)PR(
public void subdivide\201)A(QuadCurve2D)EA( left,
)A(QuadCurve2D)EA( right\202
)RP(
)DL(
)DD( Subdivides this quadratic curve and stores the resulting two
subdivided curves into the left and right curve parameters.
Either or both of the left and right objects may be the same
as this object or null.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( left - the quadratic curve object for storing for the left or
first half of the subdivided curve
)DD( right - the quadratic curve object for storing for the right or
second half of the subdivided curve
)LD(
)LD(
o )WB()EA(
)BD(subdivide)ES()EA(
)PR(
public static void subdivide\201)A(QuadCurve2D)EA( src,
)A(QuadCurve2D)EA( left,
)A(QuadCurve2D)EA( right\202
)RP(
)DL(
)DD( Subdivides the quadratic curve specified by the src parameter
and stores the resulting two subdivided curves into the left
and right curve parameters.
Either or both of the left and right objects may be the same
as the src object or null.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - the quadratic curve to be subdivided
)DD( left - the quadratic curve object for storing for the left or
first half of the subdivided curve
)DD( right - the quadratic curve object for storing for the right or
second half of the subdivided curve
)LD(
)LD(
o )WB()EA(
)BD(subdivide)ES()EA(
)PR(
public static void subdivide\201double src[],
int srcoff,
double left[],
int leftoff,
double right[],
int rightoff\202
)RP(
)DL(
)DD( Subdivides the quadratic curve specified by the the coordinates
stored in the src array at indices \201srcoff\202 through \201srcoff + 5\202
and stores the resulting two subdivided curves into the two
result arrays at the corresponding indices.
Either or both of the left and right arrays may be null or a
reference to the same array and offset as the src array.
Note that the last point in the first subdivided curve is the
same as the first point in the second subdivided curve and thus
it is possible to pass the same array for left and right and
to use offsets such that rightoff equals \201leftoff + 4\202 in order
to avoid allocating extra storage for this common point.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - the array holding the coordinates for the source curve
)DD( srcoff - the offset into the array of the beginning of the
the 6 source coordinates
)DD( left - the array for storing the coordinates for the first
half of the subdivided curve
)DD( leftoff - the offset into the array of the beginning of the
the 6 left coordinates
)DD( right - the array for storing the coordinates for the second
half of the subdivided curve
)DD( rightoff - the offset into the array of the beginning of the
the 6 right coordinates
)LD(
)LD(
o )WB()EA(
)BD(solveQuadratic)ES()EA(
)PR(
public static int solveQuadratic\201double eqn[]\202
)RP(
)DL(
)DD( Solve the quadratic whose coefficients are in the eqn array and
place the non-complex roots back into the array, returning the
number of roots. The quadratic solved is represented by the
equation:
eqn = {C, B, A};
ax^2 + bx + c = 0
A return value of -1 is used to distinguish a constant equation,
which may be always 0 or never 0, from an equation which has no
zeroes.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the number of roots, or -1 if the equation is a constant
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.QuadCurve2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.QuadCurve2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.QuadCurve2D)EA(
|
+----java.awt.geom.QuadCurve2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(QuadCurve2D.Float)ES(
)DT( extends )A(QuadCurve2D)EA(
)LD(
A quadratic parametric curve segment specified with float coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ctrlx)ES()EA(
)DD( The X coordinate of the control point of the quadratic curve segment.
)DT( o )WB(
)A()BD(ctrly)ES()EA(
)DD( The Y coordinate of the control point of the quadratic curve segment.
)DT( o )WB(
)A()BD(x1)ES()EA(
)DD( The X coordinate of the start point of the quadratic curve segment.
)DT( o )WB(
)A()BD(x2)ES()EA(
)DD( The X coordinate of the end point of the quadratic curve segment.
)DT( o )WB(
)A()BD(y1)ES()EA(
)DD( The Y coordinate of the start point of the quadratic curve segment.
)DT( o )WB(
)A()BD(y2)ES()EA(
)DD( The Y coordinate of the end point of the quadratic curve segment.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(QuadCurve2D.Float)ES()EA(\201\202
)DD( Constructs and initializes a QuadCurve with coordinates
\2010, 0, 0, 0, 0, 0\202.
)DT( o )WB(
)A()BD(QuadCurve2D.Float)ES()EA(\201float, float, float, float, float, float\202
)DD( Constructs and initializes a QuadCurve from the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getCtrlX)ES()EA(\201\202
)DD( Returns the X coordinate of the control point in double precision.
)DT( o )WB(
)A()BD(getCtrlY)ES()EA(\201\202
)DD( Returns the Y coordinate of the control point in double precision.
)DT( o )WB(
)A()BD(getX1)ES()EA(\201\202
)DD( Returns the X coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getX2)ES()EA(\201\202
)DD( Returns the X coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(getY1)ES()EA(\201\202
)DD( Returns the Y coordinate of the start point in double precision.
)DT( o )WB(
)A()BD(getY2)ES()EA(\201\202
)DD( Returns the Y coordinate of the end point in double precision.
)DT( o )WB(
)A()BD(setCurve)ES()EA(\201double, double, double, double, double, double\202
)DD( Sets the location of the endpoints and controlpoint of this curve
to the specified double coordinates.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x1)ES(
)PR(
public float x1
)RP(
)DL(
)DD( The X coordinate of the start point of the quadratic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(y1)ES(
)PR(
public float y1
)RP(
)DL(
)DD( The Y coordinate of the start point of the quadratic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(ctrlx)ES(
)PR(
public float ctrlx
)RP(
)DL(
)DD( The X coordinate of the control point of the quadratic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(ctrly)ES(
)PR(
public float ctrly
)RP(
)DL(
)DD( The Y coordinate of the control point of the quadratic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(x2)ES(
)PR(
public float x2
)RP(
)DL(
)DD( The X coordinate of the end point of the quadratic curve segment.)0 P(
)LD(
o )WB()EA(
)BD(y2)ES(
)PR(
public float y2
)RP(
)DL(
)DD( The Y coordinate of the end point of the quadratic curve segment.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(QuadCurve2D.Float)ES(
)PR(
public QuadCurve2D.Float\201\202
)RP(
)DL(
)DD( Constructs and initializes a QuadCurve with coordinates
\2010, 0, 0, 0, 0, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(QuadCurve2D.Float)ES(
)PR(
public QuadCurve2D.Float\201float x1,
float y1,
float ctrlx,
float ctrly,
float x2,
float y2\202
)RP(
)DL(
)DD( Constructs and initializes a QuadCurve from the specified coordinates.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX1)ES()EA(
)PR(
public double getX1\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the start point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX1)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY1)ES()EA(
)PR(
public double getY1\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the start point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY1)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getCtrlX)ES()EA(
)PR(
public double getCtrlX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the control point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getCtrlX)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getCtrlY)ES()EA(
)PR(
public double getCtrlY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the control point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getCtrlY)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getX2)ES()EA(
)PR(
public double getX2\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the end point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX2)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY2)ES()EA(
)PR(
public double getY2\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the end point in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY2)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setCurve)ES()EA(
)PR(
public void setCurve\201double x1,
double y1,
double ctrlx,
double ctrly,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the location of the endpoints and controlpoint of this curve
to the specified double coordinates.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setCurve)EA( in class )A(QuadCurve2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Rectangle2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Rectangle2D
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----java.awt.geom.Rectangle2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Rectangle2D)ES(
)DT( extends )A(RectangularShape)EA(
)DT( super class of:
)DD( )A(Rectangle)EA(, )A(Rectangle2D.Double)EA(, )A(Rectangle2D.Float)EA(
)LD(
A rectangle defined by a location \201x, y\202 and dimension \201w x h\202.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D rectangle.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Rectangle2D.Double)ES()EA(
)DD( A rectangle specified in double coordinates.
)DT( o )WB(
)A()BD(Rectangle2D.Float)ES()EA(
)DD( A rectangle specified in float coordinates.
)LD(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(OUT_BOTTOM)ES()EA(
)DD( The bitmask which indicates that a point lies below
this Rectangle.
)DT( o )WB(
)A()BD(OUT_LEFT)ES()EA(
)DD( The bitmask which indicates that a point lies to the left of
this Rectangle.
)DT( o )WB(
)A()BD(OUT_RIGHT)ES()EA(
)DD( The bitmask which indicates that a point lies to the right of
this Rectangle.
)DT( o )WB(
)A()BD(OUT_TOP)ES()EA(
)DD( The bitmask which indicates that a point lies above
this Rectangle.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Rectangle2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(intersectsLine)ES()EA(\201double, double, double, double\202
)DD( Tests if the given line segment intersects the interior of this
Rectangle.
)DT( o )WB(
)A()BD(intersectsLine)ES()EA(\201Line2D\202
)DD( Tests if the given line segment intersects the interior of this
Rectangle.
)DT( o )WB(
)A()BD(outcode)ES()EA(\201double, double\202
)DD( Determines where the specified coordinates lie with respect
to this Rectangle.
)DT( o )WB(
)A()BD(outcode)ES()EA(\201Point2D\202
)DD( Determines where the specified point lies with respect to this
Rectangle.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of this rectangle to the specified
double values.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201Rectangle2D\202
)DD( Sets this rectangle to be the same as the specified Rectangle.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(OUT_LEFT)ES(
)PR(
public static final int OUT_LEFT
)RP(
)DL(
)DD( The bitmask which indicates that a point lies to the left of
this Rectangle.)0 P(
)LD(
o )WB()EA(
)BD(OUT_TOP)ES(
)PR(
public static final int OUT_TOP
)RP(
)DL(
)DD( The bitmask which indicates that a point lies above
this Rectangle.)0 P(
)LD(
o )WB()EA(
)BD(OUT_RIGHT)ES(
)PR(
public static final int OUT_RIGHT
)RP(
)DL(
)DD( The bitmask which indicates that a point lies to the right of
this Rectangle.)0 P(
)LD(
o )WB()EA(
)BD(OUT_BOTTOM)ES(
)PR(
public static final int OUT_BOTTOM
)RP(
)DL(
)DD( The bitmask which indicates that a point lies below
this Rectangle.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Rectangle2D)ES(
)PR(
protected Rectangle2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public abstract void setRect\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of this rectangle to the specified
double values.
)0 P(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Sets this rectangle to be the same as the specified Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(intersectsLine)ES()EA(
)PR(
public boolean intersectsLine\201double x1,
double y1,
double x2,
double y2\202
)RP(
)DL(
)DD( Tests if the given line segment intersects the interior of this
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(intersectsLine)ES()EA(
)PR(
public boolean intersectsLine\201)A(Line2D)EA( l\202
)RP(
)DL(
)DD( Tests if the given line segment intersects the interior of this
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(outcode)ES()EA(
)PR(
public abstract int outcode\201double x,
double y\202
)RP(
)DL(
)DD( Determines where the specified coordinates lie with respect
to this Rectangle.
This method computes a binary OR of the appropriate mask values
indicating which sides of the rectangle the given point is
outside of.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the logical OR of all appropriate out codes
)DT( )BD(See Also:)ES(
)DD( )A(OUT_LEFT)EA(, )A(OUT_TOP)EA(, )A(OUT_RIGHT)EA(, )A(OUT_BOTTOM)EA(
)LD(
)LD(
o )WB()EA(
)BD(outcode)ES()EA(
)PR(
public int outcode\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Determines where the specified point lies with respect to this
Rectangle.
This method computes a binary OR of the appropriate mask values
indicating which sides of the rectangle the given point is
outside of.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the logical OR of all appropriate out codes
)DT( )BD(See Also:)ES(
)DD( )A(OUT_LEFT)EA(, )A(OUT_TOP)EA(, )A(OUT_RIGHT)EA(, )A(OUT_BOTTOM)EA(
)LD(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setBounds)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
flattened shape.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getPathIterator)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Rectangle2D.Double
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Rectangle2D.Double
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----)A(java.awt.geom.Rectangle2D)EA(
|
+----java.awt.geom.Rectangle2D.Double
)RP(
)HR(
)DL(
)DT( public static class )BD(Rectangle2D.Double)ES(
)DT( extends )A(Rectangle2D)EA(
)LD(
A rectangle specified in double coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(height)ES()EA(
)DD( The height of the rectangle.
)DT( o )WB(
)A()BD(width)ES()EA(
)DD( The width of the rectangle.
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The x coordinate of the rectangle.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The y coordinate of the rectangle.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Rectangle2D.Double)ES()EA(\201\202
)DD( Constructs a new rectangle, initialized to location \2010, 0\202 and
size \2010, 0\202.
)DT( o )WB(
)A()BD(Rectangle2D.Double)ES()EA(\201double, double, double, double\202
)DD( Constructs and initializes a rectangle from the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of the rectangle in double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of the rectangle in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the rectangle in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the rectangle in double precision.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether the rectangle is empty.
)DT( o )WB(
)A()BD(outcode)ES()EA(\201double, double\202
)DD( Determines where the specified double coordinates lie with respect
to this Rectangle.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of this rectangle to the specified
double values.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201Rectangle2D\202
)DD( Sets this rectangle to be the same as the specified Rectangle.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns the String representation of this Rectangle.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public double x
)RP(
)DL(
)DD( The x coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public double y
)RP(
)DL(
)DD( The y coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(width)ES(
)PR(
public double width
)RP(
)DL(
)DD( The width of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(height)ES(
)PR(
public double height
)RP(
)DL(
)DD( The height of the rectangle.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Rectangle2D.Double)ES(
)PR(
public Rectangle2D.Double\201\202
)RP(
)DL(
)DD( Constructs a new rectangle, initialized to location \2010, 0\202 and
size \2010, 0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Rectangle2D.Double)ES(
)PR(
public Rectangle2D.Double\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Constructs and initializes a rectangle from the specified coordinates.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the x coordinate
)DD( y - the y coordinate
)DD( width - the width of the rectangle
)DD( height - the height of the rectangle
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public double getWidth\201\202
)RP(
)DL(
)DD( Returns the width of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public double getHeight\201\202
)RP(
)DL(
)DD( Returns the height of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether the rectangle is empty.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of this rectangle to the specified
double values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setRect)EA( in class )A(Rectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Sets this rectangle to be the same as the specified Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setRect)EA( in class )A(Rectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(outcode)ES()EA(
)PR(
public int outcode\201double x,
double y\202
)RP(
)DL(
)DD( Determines where the specified double coordinates lie with respect
to this Rectangle.
This method computes a binary OR of the appropriate mask values
indicating which sides of the rectangle the given point is
outside of.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the logical OR of all appropriate out codes
)DT( )BD(Overrides:)ES(
)DD( )A(outcode)EA( in class )A(Rectangle2D)EA(
)DT( )BD(See Also:)ES(
)DD( )A(OUT_LEFT)EA(, )A(OUT_TOP)EA(, )A(OUT_RIGHT)EA(, )A(OUT_BOTTOM)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns the String representation of this Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.Rectangle2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.Rectangle2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----)A(java.awt.geom.Rectangle2D)EA(
|
+----java.awt.geom.Rectangle2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(Rectangle2D.Float)ES(
)DT( extends )A(Rectangle2D)EA(
)LD(
A rectangle specified in float coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(height)ES()EA(
)DD( The height of the rectangle.
)DT( o )WB(
)A()BD(width)ES()EA(
)DD( The width of the rectangle.
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The x coordinate of the rectangle.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The y coordinate of the rectangle.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Rectangle2D.Float)ES()EA(\201\202
)DD( Constructs a new rectangle, initialized to location \2010.0, 0.0\202 and
size \2010.0, 0.0\202.
)DT( o )WB(
)A()BD(Rectangle2D.Float)ES()EA(\201float, float, float, float\202
)DD( Constructs and initializes a rectangle from the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of the rectangle in double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of the rectangle in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the rectangle in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the rectangle in double precision.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether the rectangle is empty.
)DT( o )WB(
)A()BD(outcode)ES()EA(\201double, double\202
)DD( Determines where the specified float coordinates lie with respect
to this Rectangle.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of this rectangle to the specified
double values.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201float, float, float, float\202
)DD( Sets the location and size of this rectangle to the specified
float values.
)DT( o )WB(
)A()BD(setRect)ES()EA(\201Rectangle2D\202
)DD( Sets this rectangle to be the same as the specified Rectangle.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Returns the String representation of this Rectangle.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public float x
)RP(
)DL(
)DD( The x coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public float y
)RP(
)DL(
)DD( The y coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(width)ES(
)PR(
public float width
)RP(
)DL(
)DD( The width of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(height)ES(
)PR(
public float height
)RP(
)DL(
)DD( The height of the rectangle.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Rectangle2D.Float)ES(
)PR(
public Rectangle2D.Float\201\202
)RP(
)DL(
)DD( Constructs a new rectangle, initialized to location \2010.0, 0.0\202 and
size \2010.0, 0.0\202.
)0 P(
)LD(
o )WB()EA(
)BD(Rectangle2D.Float)ES(
)PR(
public Rectangle2D.Float\201float x,
float y,
float w,
float h\202
)RP(
)DL(
)DD( Constructs and initializes a rectangle from the specified coordinates.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the x coordinate
)DD( y - the y coordinate
)DD( width - the width of the rectangle
)DD( height - the height of the rectangle
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public double getWidth\201\202
)RP(
)DL(
)DD( Returns the width of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public double getHeight\201\202
)RP(
)DL(
)DD( Returns the height of the rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether the rectangle is empty.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201float x,
float y,
float w,
float h\202
)RP(
)DL(
)DD( Sets the location and size of this rectangle to the specified
float values.
)0 P(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of this rectangle to the specified
double values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setRect)EA( in class )A(Rectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRect)ES()EA(
)PR(
public void setRect\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Sets this rectangle to be the same as the specified Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setRect)EA( in class )A(Rectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(outcode)ES()EA(
)PR(
public int outcode\201double x,
double y\202
)RP(
)DL(
)DD( Determines where the specified float coordinates lie with respect
to this Rectangle.
This method computes a binary OR of the appropriate mask values
indicating which sides of the rectangle the given point is
outside of.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( the logical OR of all appropriate out codes
)DT( )BD(Overrides:)ES(
)DD( )A(outcode)EA( in class )A(Rectangle2D)EA(
)DT( )BD(See Also:)ES(
)DD( )A(OUT_LEFT)EA(, )A(OUT_TOP)EA(, )A(OUT_RIGHT)EA(, )A(OUT_BOTTOM)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Returns the String representation of this Rectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.RectangularShape
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.RectangularShape
)EH(
)PR(
java.lang.Object
|
+----java.awt.geom.RectangularShape
)RP(
)HR(
)DL(
)DT( public abstract class )BD(RectangularShape)ES(
)DT( extends Object
)DT( implements )A(Shape)EA(
)DT( super class of:
)DD( )A(Arc2D)EA(, )A(Ellipse2D)EA(, )A(Rectangle2D)EA(, )A(RoundRectangle2D)EA(
)LD(
The base class for a number of shapes which inscribe a rectangular
set of outer bounds. This class provides common manipulation
routines for operating on a shape by querying and modifying its
bounding rectangle.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(RectangularShape)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201Point2D\202
)DD( Test if a given Point is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)DT( o )WB(
)A()BD(getBottom)ES()EA(\201\202
)DD( Returns the Y coordinate of the bottom edge of the shape in
double precision.
)DT( o )WB(
)A()BD(getBounds)ES()EA(\201\202
)DD( Return the bounding box of the shape.
)DT( o )WB(
)A()BD(getCenterX)ES()EA(\201\202
)DD( Returns the X coordinate of the center of the shape in
double precision.
)DT( o )WB(
)A()BD(getCenterY)ES()EA(\201\202
)DD( Returns the Y coordinate of the center of the shape in
double precision.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(getLeft)ES()EA(\201\202
)DD( Returns the X coordinate of the left edge of the shape in
double precision.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform, double\202
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to a flattened view of the
geometry of the outline of the shape.
)DT( o )WB(
)A()BD(getRight)ES()EA(\201\202
)DD( Returns the X coordinate of the right edge of the shape in
double precision.
)DT( o )WB(
)A()BD(getTop)ES()EA(\201\202
)DD( Returns the Y coordinate of the top edge of the shape in
double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the bounding rectangle in double precision.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201Rectangle2D\202
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether the rectangular shape is empty.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201Point2D, Dimension2D\202
)DD( Sets the outer bounds of this shape to be the same as the specified
Point and Dimension objects.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201Rectangle2D\202
)DD( Sets the outer bounds of this shape to be the same as the specified
Rectangle.
)DT( o )WB(
)A()BD(setBoundsFromCenter)ES()EA(\201double, double, double, double\202
)DD( Sets the outer bounds of this shape based on a center point
and a corner point.
)DT( o )WB(
)A()BD(setBoundsFromCenter)ES()EA(\201Point2D, Point2D\202
)DD( Sets the outer bounds of this shape based on a center point
and a corner point.
)DT( o )WB(
)A()BD(setBoundsFromDiagonal)ES()EA(\201double, double, double, double\202
)DD( Sets the outer bounds of this shape based on two points along
one of its diagonals.
)DT( o )WB(
)A()BD(setBoundsFromDiagonal)ES()EA(\201Point2D, Point2D\202
)DD( Sets the outer bounds of this shape based on two Point objects
along one of its diagonals.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(RectangularShape)ES(
)PR(
protected RectangularShape\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public abstract double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the bounding rectangle in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public abstract double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the bounding rectangle in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public abstract double getWidth\201\202
)RP(
)DL(
)DD( Returns the width of the bounding rectangle in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public abstract double getHeight\201\202
)RP(
)DL(
)DD( Returns the height of the bounding rectangle in double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getLeft)ES()EA(
)PR(
public double getLeft\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the left edge of the shape in
double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getTop)ES()EA(
)PR(
public double getTop\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the top edge of the shape in
double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getRight)ES()EA(
)PR(
public double getRight\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the right edge of the shape in
double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getBottom)ES()EA(
)PR(
public double getBottom\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the bottom edge of the shape in
double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCenterX)ES()EA(
)PR(
public double getCenterX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the center of the shape in
double precision.
)0 P(
)LD(
o )WB()EA(
)BD(getCenterY)ES()EA(
)PR(
public double getCenterY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the center of the shape in
double precision.
)0 P(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public abstract boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether the rectangular shape is empty.
)0 P(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public abstract void setBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)0 P(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201)A(Point2D)EA( loc,
)A(Dimension2D)EA( size\202
)RP(
)DL(
)DD( Sets the outer bounds of this shape to be the same as the specified
Point and Dimension objects.
)0 P(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Sets the outer bounds of this shape to be the same as the specified
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(setBoundsFromDiagonal)ES()EA(
)PR(
public void setBoundsFromDiagonal\201double x1,
double y1,
double x2,
double y2\202
)RP(
)DL(
)DD( Sets the outer bounds of this shape based on two points along
one of its diagonals.
)0 P(
)LD(
o )WB()EA(
)BD(setBoundsFromDiagonal)ES()EA(
)PR(
public void setBoundsFromDiagonal\201)A(Point2D)EA( p1,
)A(Point2D)EA( p2\202
)RP(
)DL(
)DD( Sets the outer bounds of this shape based on two Point objects
along one of its diagonals.
)0 P(
)LD(
o )WB()EA(
)BD(setBoundsFromCenter)ES()EA(
)PR(
public void setBoundsFromCenter\201double centerX,
double centerY,
double cornerX,
double cornerY\202
)RP(
)DL(
)DD( Sets the outer bounds of this shape based on a center point
and a corner point.
)0 P(
)LD(
o )WB()EA(
)BD(setBoundsFromCenter)ES()EA(
)PR(
public void setBoundsFromCenter\201)A(Point2D)EA( center,
)A(Point2D)EA( corner\202
)RP(
)DL(
)DD( Sets the outer bounds of this shape based on a center point
and a corner point.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Point2D)EA( p\202
)RP(
)DL(
)DD( Test if a given Point is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201)A(Rectangle2D)EA( r\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
Rectangle.
)0 P(
)LD(
o )WB()EA(
)BD(getBounds)ES()EA(
)PR(
public )A(Rectangle)EA( getBounds\201\202
)RP(
)DL(
)DD( Return the bounding box of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at,
double flatness\202
)RP(
)DL(
)DD( Return an iterator object that iterates along the boundary of
the shape and provides access to a flattened view of the
geometry of the outline of the shape.
Only SEG_MOVETO, SEG_LINETO, and SEG_CLOSE point types will
be returned by the iterator.
The amount of subdivision of the curved segments is controlled
by the )SM(flatness)ES( parameter which specifies ?REMIND?.
An optional affine transform can be specified in which case
the coordinates returned in the iteration will be transformed
accordingly.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( at - an optional AffineTransform to be applied to the
coordinates as they are returned in the iteration, or null
if the untransformed coordinates are desired.
)DD( flatness - the maximum amount that the control points
for a given curve can vary from colinear before a subdivided
curve is replaced by a straight line connecting the endpoints.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.RoundRectangle2D
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.RoundRectangle2D
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----java.awt.geom.RoundRectangle2D
)RP(
)HR(
)DL(
)DT( public abstract class )BD(RoundRectangle2D)ES(
)DT( extends )A(RectangularShape)EA(
)DT( super class of:
)DD( )A(RoundRectangle2D.Float)EA(
)LD(
A rectangle with rounded corners defined by a location \201x, y\202, a
dimension \201w x h\202, and the width and height of an arc to round the
corners with.
)0 P(
This class is only the abstract superclass for all objects which
store a 2D rounded rectangle.
The actual storage representation of the coordinates is left to
the subclass.
)0 P(
)HR(
)EA(
)0 2 H(
Class Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(RoundRectangle2D.Float)ES()EA(
)DD( A rectangle with rounded corners all specified in float coordinates.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(RoundRectangle2D)ES()EA(\201\202
)DD(
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double\202
)DD( Test if a given coordinate is inside the boundary of the shape.
)DT( o )WB(
)A()BD(contains)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(getArcHeight)ES()EA(\201\202
)DD( Gets the height of the arc that rounds off the corners.
)DT( o )WB(
)A()BD(getArcWidth)ES()EA(\201\202
)DD( Gets the width of the arc that rounds off the corners.
)DT( o )WB(
)A()BD(getPathIterator)ES()EA(\201AffineTransform\202
)DD( Return an iteration object that defines the boundary of the
shape.
)DT( o )WB(
)A()BD(intersects)ES()EA(\201double, double, double, double\202
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)DT( o )WB(
)A()BD(setBounds)ES()EA(\201double, double, double, double\202
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)DT( o )WB(
)A()BD(setRoundRect)ES()EA(\201double, double, double, double, double, double\202
)DD( Sets the location, size, and corner radii of this rounded
rectangle to the specified double values.
)DT( o )WB(
)A()BD(setRoundRect)ES()EA(\201RoundRectangle2D\202
)DD( Sets this rounded rectangle to be the same as the specified
RoundRectangle.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(RoundRectangle2D)ES(
)PR(
protected RoundRectangle2D\201\202
)RP(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getArcWidth)ES()EA(
)PR(
public abstract double getArcWidth\201\202
)RP(
)DL(
)DD( Gets the width of the arc that rounds off the corners.
)0 P(
)LD(
o )WB()EA(
)BD(getArcHeight)ES()EA(
)PR(
public abstract double getArcHeight\201\202
)RP(
)DL(
)DD( Gets the height of the arc that rounds off the corners.
)0 P(
)LD(
o )WB()EA(
)BD(setRoundRect)ES()EA(
)PR(
public abstract void setRoundRect\201double x,
double y,
double w,
double h,
double arcWidth,
double arcHeight\202
)RP(
)DL(
)DD( Sets the location, size, and corner radii of this rounded
rectangle to the specified double values.
)0 P(
)LD(
o )WB()EA(
)BD(setRoundRect)ES()EA(
)PR(
public void setRoundRect\201)A(RoundRectangle2D)EA( rr\202
)RP(
)DL(
)DD( Sets this rounded rectangle to be the same as the specified
RoundRectangle.
)0 P(
)LD(
o )WB()EA(
)BD(setBounds)ES()EA(
)PR(
public void setBounds\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Sets the location and size of the outer bounds of this shape
to the specified rectangular values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setBounds)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y\202
)RP(
)DL(
)DD( Test if a given coordinate is inside the boundary of the shape.
)0 P(
)LD(
o )WB()EA(
)BD(intersects)ES()EA(
)PR(
public boolean intersects\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape intersects the interior of a given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(contains)ES()EA(
)PR(
public boolean contains\201double x,
double y,
double w,
double h\202
)RP(
)DL(
)DD( Test if the interior of the Shape entirely contains the given
set of rectangular coordinates.
)0 P(
)LD(
o )WB()EA(
)BD(getPathIterator)ES()EA(
)PR(
public )A(PathIterator)EA( getPathIterator\201)A(AffineTransform)EA( at\202
)RP(
)DL(
)DD( Return an iteration object that defines the boundary of the
shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.RoundRectangle2D.Float
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.RoundRectangle2D.Float
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.geom.RectangularShape)EA(
|
+----)A(java.awt.geom.RoundRectangle2D)EA(
|
+----java.awt.geom.RoundRectangle2D.Float
)RP(
)HR(
)DL(
)DT( public static class )BD(RoundRectangle2D.Float)ES(
)DT( extends )A(RoundRectangle2D)EA(
)LD(
A rectangle with rounded corners all specified in float coordinates.
)0 P(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(archeight)ES()EA(
)DD( The height of the arc that rounds off the corners.
)DT( o )WB(
)A()BD(arcwidth)ES()EA(
)DD( The width of the arc that rounds off the corners.
)DT( o )WB(
)A()BD(height)ES()EA(
)DD( The height of the rectangle.
)DT( o )WB(
)A()BD(width)ES()EA(
)DD( The width of the rectangle.
)DT( o )WB(
)A()BD(x)ES()EA(
)DD( The x coordinate of the rectangle.
)DT( o )WB(
)A()BD(y)ES()EA(
)DD( The y coordinate of the rectangle.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(RoundRectangle2D.Float)ES()EA(\201\202
)DD( Constructs a new rounded rectangle, initialized to location \2010.0, 0.0\202,
size \2010.0, 0.0\202, and corner arcs of radius 0.0.
)DT( o )WB(
)A()BD(RoundRectangle2D.Float)ES()EA(\201float, float, float, float, float, float\202
)DD( Constructs and initializes a rectangle from the specified coordinates.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getArcHeight)ES()EA(\201\202
)DD( Gets the height of the arc that rounds off the corners.
)DT( o )WB(
)A()BD(getArcWidth)ES()EA(\201\202
)DD( Gets the width of the arc that rounds off the corners.
)DT( o )WB(
)A()BD(getBounds2D)ES()EA(\201\202
)DD( Return the high precision bounding box of the shape.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of the rounded rectangle in double precision.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of the rounded rectangle in double precision.
)DT( o )WB(
)A()BD(getX)ES()EA(\201\202
)DD( Returns the X coordinate of the rounded rectangle in double precision.
)DT( o )WB(
)A()BD(getY)ES()EA(\201\202
)DD( Returns the Y coordinate of the rounded rectangle in double precision.
)DT( o )WB(
)A()BD(isEmpty)ES()EA(\201\202
)DD( Determines whether the rounded rectangle is empty.
)DT( o )WB(
)A()BD(setRoundRect)ES()EA(\201double, double, double, double, double, double\202
)DD( Sets the location, size, and arc radii of this rectangle to the
specified double values.
)DT( o )WB(
)A()BD(setRoundRect)ES()EA(\201float, float, float, float, float, float\202
)DD( Sets the location, size, and arc radii of this rectangle to the
specified float values.
)DT( o )WB(
)A()BD(setRoundRect)ES()EA(\201RoundRectangle2D\202
)DD( Sets this rounded rectangle to be the same as the specified
RoundRectangle.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(x)ES(
)PR(
public float x
)RP(
)DL(
)DD( The x coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(y)ES(
)PR(
public float y
)RP(
)DL(
)DD( The y coordinate of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(width)ES(
)PR(
public float width
)RP(
)DL(
)DD( The width of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(height)ES(
)PR(
public float height
)RP(
)DL(
)DD( The height of the rectangle.)0 P(
)LD(
o )WB()EA(
)BD(arcwidth)ES(
)PR(
public float arcwidth
)RP(
)DL(
)DD( The width of the arc that rounds off the corners.)0 P(
)LD(
o )WB()EA(
)BD(archeight)ES(
)PR(
public float archeight
)RP(
)DL(
)DD( The height of the arc that rounds off the corners.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(RoundRectangle2D.Float)ES(
)PR(
public RoundRectangle2D.Float\201\202
)RP(
)DL(
)DD( Constructs a new rounded rectangle, initialized to location \2010.0, 0.0\202,
size \2010.0, 0.0\202, and corner arcs of radius 0.0.
)0 P(
)LD(
o )WB()EA(
)BD(RoundRectangle2D.Float)ES(
)PR(
public RoundRectangle2D.Float\201float x,
float y,
float w,
float h,
float arcw,
float arch\202
)RP(
)DL(
)DD( Constructs and initializes a rectangle from the specified coordinates.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - the x coordinate
)DD( y - the y coordinate
)DD( width - the width of the rectangle
)DD( height - the height of the rectangle
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getX)ES()EA(
)PR(
public double getX\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the rounded rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getX)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getY)ES()EA(
)PR(
public double getY\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the rounded rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getY)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public double getWidth\201\202
)RP(
)DL(
)DD( Returns the width of the rounded rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public double getHeight\201\202
)RP(
)DL(
)DD( Returns the height of the rounded rectangle in double precision.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(getArcWidth)ES()EA(
)PR(
public double getArcWidth\201\202
)RP(
)DL(
)DD( Gets the width of the arc that rounds off the corners.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getArcWidth)EA( in class )A(RoundRectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getArcHeight)ES()EA(
)PR(
public double getArcHeight\201\202
)RP(
)DL(
)DD( Gets the height of the arc that rounds off the corners.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getArcHeight)EA( in class )A(RoundRectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(isEmpty)ES()EA(
)PR(
public boolean isEmpty\201\202
)RP(
)DL(
)DD( Determines whether the rounded rectangle is empty.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(isEmpty)EA( in class )A(RectangularShape)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRoundRect)ES()EA(
)PR(
public void setRoundRect\201float x,
float y,
float w,
float h,
float arcw,
float arch\202
)RP(
)DL(
)DD( Sets the location, size, and arc radii of this rectangle to the
specified float values.
)0 P(
)LD(
o )WB()EA(
)BD(setRoundRect)ES()EA(
)PR(
public void setRoundRect\201double x,
double y,
double w,
double h,
double arcw,
double arch\202
)RP(
)DL(
)DD( Sets the location, size, and arc radii of this rectangle to the
specified double values.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setRoundRect)EA( in class )A(RoundRectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(setRoundRect)ES()EA(
)PR(
public void setRoundRect\201)A(RoundRectangle2D)EA( rr\202
)RP(
)DL(
)DD( Sets this rounded rectangle to be the same as the specified
RoundRectangle.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(setRoundRect)EA( in class )A(RoundRectangle2D)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBounds2D)ES()EA(
)PR(
public )A(Rectangle2D)EA( getBounds2D\201\202
)RP(
)DL(
)DD( Return the high precision bounding box of the shape.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.IncompatibleTransformException
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.IncompatibleTransformException
)EH(
)PR(
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----java.lang.RuntimeException
|
+----java.awt.geom.IncompatibleTransformException
)RP(
)HR(
)DL(
)DT( public class )BD(IncompatibleTransformException)ES(
)DT( extends RuntimeException
)LD(
This exception is thrown if an operation is attempted with incompatible
Transform objects.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(IncompatibleTransformException)ES()EA(\201String\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(IncompatibleTransformException)ES(
)PR(
public IncompatibleTransformException\201String s\202
)RP(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.geom.NoninvertibleTransformException
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.geom.NoninvertibleTransformException
)EH(
)PR(
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----java.awt.geom.NoninvertibleTransformException
)RP(
)HR(
)DL(
)DT( public class )BD(NoninvertibleTransformException)ES(
)DT( extends Exception
)LD(
This exception is thrown if an operation is performed requiring
the inverse of a Transform object and the Transform is not invertible.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(NoninvertibleTransformException)ES()EA(\201String\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(NoninvertibleTransformException)ES(
)PR(
public NoninvertibleTransformException\201String s\202
)RP(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.image.BufferedImageOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.image.BufferedImageOp
)EH(
)DL(
)DT( public interface )BD(BufferedImageOp)ES(
)LD(
This is an interface that describes single-input/single-output
operations performed on BufferedImage objects.
This is implemented by such classes as AffineTransformOp, ConvolveOp,
BandCombineOp, and LookupOp. These objects can be passed into
a BufferedImageFilter to operate on a BufferedImage in the
ImageProducer-ImageFilter-ImageConsumer paradigm.
This interface cannot be used to describe more sophisticated Ops
such as ones that take multiple sources. Each class implementing this
interface will specify whether or not it will allow an in-place filtering
operation \201i.e. source object equal to the destination object\202. Note
that the restriction to single-input operations means that the
values of destination pixels prior to the operation are not used
as input to the filter operation.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(BufferedImage)EA(, )A(BufferedImageFilter)EA(, )A(AffineTransformOp)EA(, )A(BandCombineOp)EA(, )A(ColorConvertOp)EA(, )A(ConvolveOp)EA(, )A(LookupOp)EA(, )A(RescaleOp)EA(, )A(ThresholdOp)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number of
components.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Perform a single-input/single-output operation on a BufferedImage.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the filtered destination image.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public abstract )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dest\202
)RP(
)DL(
)DD( Perform a single-input/single-output operation on a BufferedImage.
If the color models for the two images do not match, a color
conversion into the destination color model will be performed.
If the destination image is null,
a BufferedImage with an appropriate ColorModel will be created.
The IllegalArgumentException may be thrown if the source and/or
destination image is incompatible with the types of images allowed
by the subclass implementing this filter.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public abstract )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the filtered destination image.
The IllegalArgumentException may be thrown if the source
image is incompatible with the types of images allowed
by the subclass implementing this filter.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public abstract )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number of
components.
The IllegalArgumentException may be thrown if the source
image is incompatible with the types of images allowed
by the subclass implementing this filter.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public abstract )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it
will be used to hold the return value.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.image.TileImageConsumer
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.image.TileImageConsumer
)EH(
)DL(
)DT( public interface )BD(TileImageConsumer)ES(
)DT( extends ImageConsumer
)LD(
The interface for objects expressing interest in image data through
the ImageProducer interfaces. When a consumer is added to an image
producer, the producer delivers all of the data about the image
using the method calls defined in this interface.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( ImageProducer
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(setPixels)ES()EA(\201int, int, ColorModel, Tile\202
)DD( The pixels of the image are delivered using one or more calls
to the setPixels method.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(setPixels)ES()EA(
)PR(
public abstract void setPixels\201int x,
int y,
)A(ColorModel)EA( model,
)A(Tile)EA( tile\202
)RP(
)DL(
)DD( The pixels of the image are delivered using one or more calls
to the setPixels method. x and y specify the location and
tile.getWidth\201\202 and tile.getHeight\201\202 specify the size
of the rectangle of source pixels that are contained in the
tile. The specified ColorModel object should
be used to convert the pixels into their corresponding color
and alpha components. Pixels in the tile can be accessed by
using the )A(getData)EA( method:
)PR(
int[] pixel = tile.getData\201tx, ty\202;
)RP(
The variable pixel will contain one channel element for the specified
location from each channel in the tile.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorModel)EA(, )A(Tile)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Interface java.awt.image.TileOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Interface java.awt.image.TileOp
)EH(
)DL(
)DT( public interface )BD(TileOp)ES(
)LD(
This is an interface that describes single-input/single-output
operations performed on Tile objects. This is implemented by such
classes as AffineTransformOp, ConvolveOp, and LookupOp. The Source
and Destination objects must contain the appropriate number
of channels for the particular classes implementing this interface.
Otherwise, an exception is thrown. This interface cannot be used to
describe more sophisticated Ops such as ones that take multiple sources.
Each class implementing this interface will specify whether or not it
will allow an in-place filtering operation \201i.e. source object equal
to the destination object\202. Note that the restriction to single-input
operations means that the values of destination pixels prior to the
operation are not used as input to the filter operation.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(AffineTransformOp)EA(, )A(BandCombineOp)EA(, )A(ColorConvertOp)EA(, )A(ConvolveOp)EA(, )A(LookupOp)EA(, )A(RescaleOp)EA(, )A(ThresholdOp)EA(
)LD(
)HR(
)EA(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number of
channels.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Performs a single-input/single-output operation from a source Tile
to a destination Tile.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the filtered destination Tile.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source tile.
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public abstract )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( Performs a single-input/single-output operation from a source Tile
to a destination Tile. If the destination Tile does not exist, a
new tile will be created. The IllegalArgumentException may be thrown
if the source and/or destination tile is incompatible with the types
of tiles allowed by the subclass implementing this filter.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public abstract )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the filtered destination Tile.
The IllegalArgumentException may be thrown if the source tile
is incompatible with the types of tiles allowed
by the subclass implementing this filter.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public abstract )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number of
channels.
The IllegalArgumentException may be thrown if the source tile
is incompatible with the types of tiles allowed
by the subclass implementing this filter.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public abstract )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source tile. If dstPt is non-null, it
will be used to hold the return value.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.AffineTransformOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.AffineTransformOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.AffineTransformOp
)RP(
)HR(
)DL(
)DT( public abstract class )BD(AffineTransformOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)DT( super class of:
)DD( )A(BilinearAffineTransformOp)EA(, )A(NearestNeighborAffineTransformOp)EA(
)LD(
This abstract class uses an affine transform to perform a
linear mapping from 2D coordinates in the source image or tile to
2D coordinates in the destination image or tile.
The subclasses define what kind of interpolation will be done when
the image is transformed. These subclasses include:
BilinearAffineTransformOp and NearestNeighborAffineTransformOp.
This class of objects can be passed into a BufferedImageFilter to
operate on a BufferedImage within the Image Producer/
Consumer model.
)0 P(
Note that the following constraints have to be met:
)LI(Source and Destination must be different.
)LI(For Tiles, the number of Channels in the Source must be equal
to the number of Channels in the Destination.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(AffineTransform)EA(, )A(BilinearAffineTransformOp)EA(, )A(NearestNeighborAffineTransformOp)EA(, )A(BufferedImageFilter)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(AffineTransformOp)ES()EA(\201AffineTransform\202
)DD( Constructs an AffineTransformOp given an affine transform.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number of
components.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number of
channels.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Abstract method to transform the BufferedImage.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Abstract method to transform the Tile.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the transformed destination.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the transformed destination.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getTransform)ES()EA(\201\202
)DD( Returns the current transform.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(AffineTransformOp)ES(
)PR(
protected AffineTransformOp\201)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Constructs an AffineTransformOp given an affine transform.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public abstract )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dest\202
)RP(
)DL(
)DD( Abstract method to transform the BufferedImage.
If the color models for the two images do not match, a color
conversion into the destination color model will be performed.
If the destination image is null,
a BufferedImage will be created with the source ColorModel.
The IllegalArgumentException may be thrown if the source is
the same as the destination.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public abstract )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( Abstract method to transform the Tile. This operation will
perform the transform channel by channel.
If the destination Tile is null, a new Tile will be created.
The IllegalArgumentException may be thrown if the source is
the same as the destination or if the number of channels in
the source is not equal to the number of channels in the
destination.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the transformed destination.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the transformed destination.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number of
components.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number of
channels.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value.
)0 P(
)LD(
o )WB()EA(
)BD(getTransform)ES()EA(
)PR(
public )A(AffineTransform)EA( getTransform\201\202
)RP(
)DL(
)DD( Returns the current transform.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.BandCombineOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.BandCombineOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.BandCombineOp
)RP(
)HR(
)DL(
)DT( public class )BD(BandCombineOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)LD(
This class performs an arbitrary linear combination of image components
in an image or bands in a tile, using a specified matrix.
)0 P(
For operations with a BufferedImage,
the width of the matrix must be equal to the number of components
in the source, or this number plus or minus one. If the width of the
matrix is equal to the number of components in the source plus
one, then there is an
implied 1 at the end of the pixel vector. For example, an RGB image
without alpha might have the following transformation applied to
each pixel in order to invert the second band of the image.
)PR(
[ 1.0 0.0 0.0 0.0 ] [ r ]
[ 0.0 -1.0 0.0 255.0 ] x [ g ]
[ 0.0 0.0 0.0 0.0 ] [ b ]
[ 1 ]
)RP(
If the width of the matrix is equal to the number of components in the
source minus one, there must be an alpha component in the image and that
component will be ignored in this operation. The height of the matrix
must be equal to the number of components in the destination.
Thus, the source and destination can have a different number of components.
For instance, one could select the third component from an image with
4 components using the following matrix:
)PR(
[ 0.0 0.0 1.0 0.0 ]
)RP(
For operations with a Tile, the width of the matrix must be equal to
the number of bands, optionally plus one. If there is one more column
in the matrix than the number of bands, there is an implied 1 at the
end of the pixel vector. The height of the matrix must be equal to
the number of bands in the destination.
)0 P(
Note that the source and destination can be the same object.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BandCombineOp)ES()EA(\201float[][]\202
)DD( This constructs a BandCombineOp with the specified matrix.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and
number of components.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and
number of bands.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Transforms the BufferedImage using the matrix in the constructor.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Transforms the Tile using the matrix in the constructor.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the transformed destination.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the transformed destination.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getMatrix)ES()EA(\201\202
)DD( Returns the matrix.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(BandCombineOp)ES(
)PR(
public BandCombineOp\201float matrix[][]\202
)RP(
)DL(
)DD( This constructs a BandCombineOp with the specified matrix.
See the class comments for restrictions on the size of the
matrix. The first subscript is the row index and the second
is the column index.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getMatrix)ES()EA(
)PR(
public float[][] getMatrix\201\202
)RP(
)DL(
)DD( Returns the matrix.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dst\202
)RP(
)DL(
)DD( Transforms the BufferedImage using the matrix in the constructor.
This method will throw an IllegalArgumentException if the number of
components in the source or destination is incompatible with
the matrix. See the class comments for more details.
If the destination image is null,
a BufferedImage will be created with the source ColorModel. This
filtering operation will not color convert the pixels from the
source to the destination color model.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dst\202
)RP(
)DL(
)DD( Transforms the Tile using the matrix in the constructor.
The IllegalArgumentException may be thrown if the number of
bands in the source or destination is incompatible with the
matrix. See the class comments for more details. If
the destination
is null, it will be created with a number of bands equalling
the number of rows in the matrix.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the transformed destination. Since
this is not a geometric operation, the bounding box does not
change.
The IllegalArgumentException may be thrown if the number of
components in the source is incompatible with the matrix. See
the class comments for more details.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the transformed destination. Since
this is not a geometric operation, the bounding box does not
change.
The IllegalArgumentException may be thrown if the number of
bands in the source is incompatible with the matrix. See
the class comments for more details.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and
number of bands.
The IllegalArgumentException may be thrown if the number of
bands in the source is incompatible with the matrix. See
the class comments for more details.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source tile for the filter operation
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and
number of components.
The IllegalArgumentException may be thrown if the number of
components in the source is incompatible with the matrix, or if
the number of components in the destination color model does not
equal the number of rows in the matrix. See
the class comments for more details.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value. Since this is not a geometric
operation, the srcPt will equal the dstPt.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.BilinearAffineTransformOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.BilinearAffineTransformOp
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.AffineTransformOp)EA(
|
+----java.awt.image.BilinearAffineTransformOp
)RP(
)HR(
)DL(
)DT( public class )BD(BilinearAffineTransformOp)ES(
)DT( extends )A(AffineTransformOp)EA(
)LD(
This class uses an affine transformation with bilinear interpolation
to transform an image or tile.
)0 P(
Note that the following constraints have to be met:
)LI(Source and Destination must be different.
)LI(For Tiles, the number of Channels in the Source must be equal
to the number of Channels in the Destination.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BilinearAffineTransformOp)ES()EA(\201AffineTransform\202
)DD( Constructs a BilinearAffineTransformOp given an affine
transform.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Transforms the BufferedImage using the stored affine transform.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Transforms the Tile using the stored affine transform.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(BilinearAffineTransformOp)ES(
)PR(
public BilinearAffineTransformOp\201)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Constructs a BilinearAffineTransformOp given an affine
transform.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dst\202
)RP(
)DL(
)DD( Transforms the BufferedImage using the stored affine transform.
If the color models for the two images do not match, a color
conversion into the destination color model will be performed.
If the destination image is null,
a BufferedImage will be created with the source ColorModel.
The IllegalArgumentException may be thrown if the source is
the same as the destination.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(filter)EA( in class )A(AffineTransformOp)EA(
)LD(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( Transforms the Tile using the stored affine transform.
This operation will perform the transform channel by channel.
If the destination Tile is null, a new Tile will be created.
The IllegalArgumentException may be thrown if the source is
the same as the destination or if the number of channels in
the source is not equal to the number of channels in the
destination.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(filter)EA( in class )A(AffineTransformOp)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.BufferedImage
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.BufferedImage
)EH(
)PR(
java.lang.Object
|
+----java.awt.Image
|
+----java.awt.image.BufferedImage
)RP(
)HR(
)DL(
)DT( public class )BD(BufferedImage)ES(
)DT( extends Image
)LD(
This subclass describes an Image with an accessible buffer of image data.
A BufferedImage is comprised of a ColorModel and a Tile of image data.
The number and types of Channel objects in the Tile must match the number
and types required by the ColorModel to represent its color and alpha
components. See the class comments in the Tile class for further
discussion of how to manipulate multi-channelled data.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorModel)EA(, )A(Tile)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TYPE_3BYTE_BGR)ES()EA(
)DD( Represents an image with 8-bit RGB color components \201corresponds to
a Windows-style BGR color model\202 with the colors Blue, Green,
and Red stored in 3 bytes.
)DT( o )WB(
)A()BD(TYPE_4BYTE_ABGR)ES()EA(
)DD( Represents an image with 8-bit RGBA color components with the colors
Blue, Green, and Red stored in 3 bytes and 1 byte of alpha.
)DT( o )WB(
)A()BD(TYPE_4BYTE_ABGR_PRE)ES()EA(
)DD( Represents an image with 8-bit RGBA color components with the colors
Blue, Green, and Red stored in 3 bytes and 1 byte of alpha.
)DT( o )WB(
)A()BD(TYPE_BINARY)ES()EA(
)DD( Represents an opaque binary image.
)DT( o )WB(
)A()BD(TYPE_CUSTOM)ES()EA(
)DD( Image type is not recognized so it must be a customized
image.
)DT( o )WB(
)A()BD(TYPE_INT_ARGB)ES()EA(
)DD( Represents an image with 8-bit RGBA color components packed into
an integer.
)DT( o )WB(
)A()BD(TYPE_INT_ARGB_PRE)ES()EA(
)DD( Represents an image with 8-bit RGBA color components packed into
an integer.
)DT( o )WB(
)A()BD(TYPE_INT_RGB)ES()EA(
)DD( Represents an image with 8-bit RGB color components packed into
an integer.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BufferedImage)ES()EA(\201ColorModel, Tile, boolean\202
)DD( Constructs a new BufferedImage with a given ColorModel
and Tile.
)DT( o )WB(
)A()BD(BufferedImage)ES()EA(\201int, int, int\202
)DD( Constructs a BufferedImage of one of the predefined image types.
)DT( o )WB(
)A()BD(BufferedImage)ES()EA(\201int, int, int, IndexColorModel\202
)DD( Constructs a BufferedImage of one of the predefined image types:
TYPE_BINARY
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(coerceData)ES()EA(\201boolean\202
)DD( Forces the data to match the state specified in the
isAlphaPremultiplied variable.
)DT( o )WB(
)A()BD(createGraphics)ES()EA(\201\202
)DD( Creates a Graphics2D, which can be used to draw into this
BufferedImage.
)DT( o )WB(
)A()BD(flush)ES()EA(\201\202
)DD( Flushes all resources being used to cache optimization information.
)DT( o )WB(
)A()BD(getAlphaTile)ES()EA(\201\202
)DD( Returns the alpha channel for ColorModel objects that support
a separate spatial alpha channel
\201such as ComponentColorModel, PackedColorModel, and some instances
of IndexColorModel\202.
)DT( o )WB(
)A()BD(getColorModel)ES()EA(\201\202
)DD( Returns the ColorModel.
)DT( o )WB(
)A()BD(getGraphics)ES()EA(\201\202
)DD( This method will actually return a Graphics2D but is here
for backwards compatibility.
)BD(Deprecated.)ES(
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height of the BufferedImage.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201ImageObserver\202
)DD( Returns the actual height of the image.
)DT( o )WB(
)A()BD(getProperty)ES()EA(\201String\202
)DD( Returns a property of the image by name.
)DT( o )WB(
)A()BD(getProperty)ES()EA(\201String, ImageObserver\202
)DD( Returns a property of the image by name.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int, int\202
)DD( Returns an integer pixel in the default RGB color model
\201TYPE_INT_ARGB\202 and default sRGB colorspace.
)DT( o )WB(
)A()BD(getRGBArray)ES()EA(\201int, int, int, int, int[], int, int\202
)DD( Returns an array of integer pixels in the default RGB color model
\201TYPE_INT_ARGB\202 and default sRGB color space,
from a portion of the image data.
)DT( o )WB(
)A()BD(getSource)ES()EA(\201\202
)DD( Returns the object that produces the pixels for the image.
)DT( o )WB(
)A()BD(getSubimage)ES()EA(\201int, int, int, int\202
)DD( Returns a subimage given a rectangular region.
)DT( o )WB(
)A()BD(getTile)ES()EA(\201\202
)DD( Returns the Tile.
)DT( o )WB(
)A()BD(getType)ES()EA(\201\202
)DD( Returns the image type.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width of the BufferedImage.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201ImageObserver\202
)DD( Returns the actual width of the image.
)DT( o )WB(
)A()BD(isAlphaPremultiplied)ES()EA(\201\202
)DD( Returns whether or not the alpha has been premultiplied.
)DT( o )WB(
)A()BD(setRGB)ES()EA(\201int, int, int\202
)DD( Set a pixel in a BufferedImage.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(TYPE_CUSTOM)ES(
)PR(
public static final int TYPE_CUSTOM
)RP(
)DL(
)DD( Image type is not recognized so it must be a customized
image. This type is only used as a return value for the getType\201\202
method.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_INT_RGB)ES(
)PR(
public static final int TYPE_INT_RGB
)RP(
)DL(
)DD( Represents an image with 8-bit RGB color components packed into
an integer. The image has an IntDiscreteChannel and
a DirectColorModel \201without alpha\202.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_INT_ARGB)ES(
)PR(
public static final int TYPE_INT_ARGB
)RP(
)DL(
)DD( Represents an image with 8-bit RGBA color components packed into
an integer.
The has an IntDiscreteChannel and
a DirectColorModel \201with alpha\202. The color data in this image
is considered not to be premultiplied with alpha. When
this type is used as the imageType argument to a BufferedImage
constructor, the image created will be
consistent with images created in the JDK1.1 and earlier releases.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_INT_ARGB_PRE)ES(
)PR(
public static final int TYPE_INT_ARGB_PRE
)RP(
)DL(
)DD( Represents an image with 8-bit RGBA color components packed into
an integer. The image has an IntDiscreteChannel
and a DirectColorModel \201with alpha\202.
The color data in this image is considered to be premultiplied
with alpha.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_3BYTE_BGR)ES(
)PR(
public static final int TYPE_3BYTE_BGR
)RP(
)DL(
)DD( Represents an image with 8-bit RGB color components \201corresponds to
a Windows-style BGR color model\202 with the colors Blue, Green,
and Red stored in 3 bytes. There is no alpha. The
image has 3 ByteDiscreteChannel objects and
a ComponentColorModel.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_4BYTE_ABGR)ES(
)PR(
public static final int TYPE_4BYTE_ABGR
)RP(
)DL(
)DD( Represents an image with 8-bit RGBA color components with the colors
Blue, Green, and Red stored in 3 bytes and 1 byte of alpha. The
image has 4 ByteDiscreteChannel objects and a
ComponentColorModel \201with alpha\202. The color data in this image
will be considered not to be premultiplied with alpha. The byte
data is interleaved in a single byte array in the order A, B, G, R
from lower to higher byte addresses within each pixel.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_4BYTE_ABGR_PRE)ES(
)PR(
public static final int TYPE_4BYTE_ABGR_PRE
)RP(
)DL(
)DD( Represents an image with 8-bit RGBA color components with the colors
Blue, Green, and Red stored in 3 bytes and 1 byte of alpha. The
image has 4 ByteDiscreteChannel objects and
a ComponentColorModel \201with alpha\202. The color
data in this image will be considered to be premultiplied with alpha.
The byte data is interleaved in a single byte array in the order
A, B, G, R from lower to higher byte addresses within each pixel.)0 P(
)LD(
o )WB()EA(
)BD(TYPE_BINARY)ES(
)PR(
public static final int TYPE_BINARY
)RP(
)DL(
)DD( Represents an opaque binary image. The
image has one BytePackedChannel object and an IndexColorModel
\201without alpha\202. When this type is used as the imageType argument
to the BufferedImage constructor which takes an imageType argument
but no ColorModel argument, an IndexColorModel will be created with
two colors in the default sRGB ColorSpace: {0, 0, 0} and
{255, 255, 255}.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(BufferedImage)ES(
)PR(
public BufferedImage\201int width,
int height,
int imageType\202
)RP(
)DL(
)DD( Constructs a BufferedImage of one of the predefined image types.
The ColorSpace for the image will be the default sRGB space.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width of the created image.
)DD( height - Height of the created image.
)DD( imageType - Type of the created image.
)DT( )BD(See Also:)ES(
)DD( )A(ColorSpace)EA(, TYPE_INT_RGB, TYPE_INT_ARGB, TYPE_INT_ARGB_PRE, TYPE_3BYTE_BGR, TYPE_4BYTE_ABGR, TYPE_4BYTE_ABGR_PRE, TYPE_BINARY
)LD(
)LD(
o )WB()EA(
)BD(BufferedImage)ES(
)PR(
public BufferedImage\201int width,
int height,
int imageType,
)A(IndexColorModel)EA( cm\202
)RP(
)DL(
)DD( Constructs a BufferedImage of one of the predefined image types:
TYPE_BINARY
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width of the created image.
)DD( height - Height of the created image.
)DD( imageType - Type of the created image.
)DD( cm - IndexColorModel of the created image.
)DT( )BD(See Also:)ES(
)DD( TYPE_BINARY
)LD(
)LD(
o )WB()EA(
)BD(BufferedImage)ES(
)PR(
public BufferedImage\201)A(ColorModel)EA( cm,
)A(Tile)EA( tile,
boolean isTilePremultiplied\202
)RP(
)DL(
)DD( Constructs a new BufferedImage with a given ColorModel
and Tile. If the number and types of channels in the Tile do not
match the requirements of the ColorModel for representing its
color and alpha components,
an exception will be thrown. This method may multiply or divide
the color Tile data by alpha to match the alphaPremultiplied state
in the ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( ColorModel - ColorModel for the new image
)DD( tile - Tile for the data buffer
)DD( isTilePremultiplied - If true, the data in the tile has been
premultiplied with alpha.
)DT( )BD(See Also:)ES(
)DD( )A(ColorModel)EA(, )A(Tile)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getType)ES()EA(
)PR(
public int getType\201\202
)RP(
)DL(
)DD( Returns the image type. If it is not one of the known types,
TYPE_CUSTOM is returned.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( TYPE_INT_RGB, TYPE_INT_ARGB, TYPE_INT_ARGB_PRE, TYPE_3BYTE_BGR, TYPE_4BYTE_ABGR, TYPE_4BYTE_ABGR_PRE, TYPE_BINARY, TYPE_CUSTOM
)LD(
)LD(
o )WB()EA(
)BD(getColorModel)ES()EA(
)PR(
public )A(ColorModel)EA( getColorModel\201\202
)RP(
)DL(
)DD( Returns the ColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(getTile)ES()EA(
)PR(
public )A(Tile)EA( getTile\201\202
)RP(
)DL(
)DD( Returns the Tile.
)0 P(
)LD(
o )WB()EA(
)BD(getAlphaTile)ES()EA(
)PR(
public )A(Tile)EA( getAlphaTile\201\202
)RP(
)DL(
)DD( Returns the alpha channel for ColorModel objects that support
a separate spatial alpha channel
\201such as ComponentColorModel, PackedColorModel, and some instances
of IndexColorModel\202. This may return null if there is no alpha
channel associated with ColorModel in this image. If the image uses
an IndexColorModel which
has alpha in the lookup table, this method will return null since
there is no spatially discrete alpha channel.
This method will create a new channel \201but will share the data
array\202 if the image uses a
DirectColorModel that has alpha since the alpha would be
implicitly packed into an integer.
)0 P(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201int x,
int y\202
)RP(
)DL(
)DD( Returns an integer pixel in the default RGB color model
\201TYPE_INT_ARGB\202 and default sRGB colorspace. Color
conversion will take place if this default model does not match
the image ColorModel. There are only 8-bits of precision
for each color component in the returned data when using this method.
)0 P(
)LD(
o )WB()EA(
)BD(getRGBArray)ES()EA(
)PR(
public int[] getRGBArray\201int startX,
int startY,
int w,
int h,
int rgbArray[],
int offset,
int scansize\202
)RP(
)DL(
)DD( Returns an array of integer pixels in the default RGB color model
\201TYPE_INT_ARGB\202 and default sRGB color space,
from a portion of the image data. Color conversion will take place
if the default model does not match the image ColorModel. There
are only 8-bits of precision for each color component in
the returned data when
using this method. Given a coordinate \201x,y\202 in the image, the
ARGB pixel can be accessed using the following:
)PR(
pixel = rgbArray[offset + \201\201y-startY\202*w + \201x-startX\202\202*scansize];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( startX - Starting x Coordinate
)DD( startY - Starting y Coordinate
)DD( w - Width of region
)DD( h - Height of region
)DD( rgbArray - If non-null, the rgb pixels will be written here
)DD( offset - Offset into the rgbArray
)DD( scansize - Stride for the rgbArray
)DT( )BD(Returns:)ES(
)DD( Array of RGB pixels.
)LD(
)LD(
o )WB()EA(
)BD(setRGB)ES()EA(
)PR(
public synchronized void setRGB\201int x,
int y,
int rgb\202
)RP(
)DL(
)DD( Set a pixel in a BufferedImage. The pixel is assumed
to be in the default RGB color model \201TYPE_INT_ARGB\202 and
default sRGB color space. For images with an
IndexColorModel, the index with the nearest color will be
chosen.
)0 P(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public int getWidth\201\202
)RP(
)DL(
)DD( Returns the width of the BufferedImage.
)0 P(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public int getHeight\201\202
)RP(
)DL(
)DD( Returns the height of the BufferedImage.
)0 P(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public int getWidth\201ImageObserver observer\202
)RP(
)DL(
)DD( Returns the actual width of the image. If the width is not known
yet, then the ImageObserver will be notified later and -1 will
be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getWidth)EA( in class Image
)DT( )BD(See Also:)ES(
)DD( getHeight, ImageObserver
)LD(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public int getHeight\201ImageObserver observer\202
)RP(
)DL(
)DD( Returns the actual height of the image. If the height is not known
yet, then the ImageObserver will be notified later and -1 will
be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getHeight)EA( in class Image
)DT( )BD(See Also:)ES(
)DD( getWidth, ImageObserver
)LD(
)LD(
o )WB()EA(
)BD(getSource)ES()EA(
)PR(
public ImageProducer getSource\201\202
)RP(
)DL(
)DD( Returns the object that produces the pixels for the image. This
may return null.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getSource)EA( in class Image
)DT( )BD(See Also:)ES(
)DD( ImageProducer
)LD(
)LD(
o )WB()EA(
)BD(getProperty)ES()EA(
)PR(
public Object getProperty\201String name,
ImageObserver observer\202
)RP(
)DL(
)DD( Returns a property of the image by name. Individual property names
are defined by the various image formats. If a property is not
defined for a particular image, this method will return the
UndefinedProperty object. If the properties for this image are
not yet known, then this method will return null and the ImageObserver
object will be notified later. The property name "comment" should
be used to store an optional comment which can be presented to
the user as a description of the image, its source, or its author.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getProperty)EA( in class Image
)DT( )BD(See Also:)ES(
)DD( ImageObserver, UndefinedProperty
)LD(
)LD(
o )WB()EA(
)BD(getProperty)ES()EA(
)PR(
public Object getProperty\201String name\202
)RP(
)DL(
)DD( Returns a property of the image by name.
)0 P(
)LD(
o )WB()EA(
)BD(flush)ES()EA(
)PR(
public void flush\201\202
)RP(
)DL(
)DD( Flushes all resources being used to cache optimization information.
The underlying pixel data is unaffected.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(flush)EA( in class Image
)LD(
)LD(
o )WB()EA(
)BD(getGraphics)ES()EA(
)PR(
public Graphics getGraphics\201\202
)RP(
)DL(
)DD()BD( Note: getGraphics\201\202 is deprecated.)ES(
)0 P(
)DD( This method will actually return a Graphics2D but is here
for backwards compatibility.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getGraphics)EA( in class Image
)LD(
)LD(
o )WB()EA(
)BD(createGraphics)ES()EA(
)PR(
public )A(Graphics2D)EA( createGraphics\201\202
)RP(
)DL(
)DD( Creates a Graphics2D, which can be used to draw into this
BufferedImage.
)0 P(
)LD(
o )WB()EA(
)BD(getSubimage)ES()EA(
)PR(
public )A(BufferedImage)EA( getSubimage\201int x,
int y,
int w,
int h\202
)RP(
)DL(
)DD( Returns a subimage given a rectangular region.
The returned BufferedImage will share the same
data array as the original image.
)0 P(
)LD(
o )WB()EA(
)BD(isAlphaPremultiplied)ES()EA(
)PR(
public boolean isAlphaPremultiplied\201\202
)RP(
)DL(
)DD( Returns whether or not the alpha has been premultiplied. It
will return true if there is no alpha since the default alpha
is OPAQUE.
)0 P(
)LD(
o )WB()EA(
)BD(coerceData)ES()EA(
)PR(
public void coerceData\201boolean isAlphaPremultiplied\202
)RP(
)DL(
)DD( Forces the data to match the state specified in the
isAlphaPremultiplied variable. It may multiply or divide the
color Tile data by alpha, or do nothing if the data is
in the correct state.
)0 P(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.BufferedImageFilter
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.BufferedImageFilter
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.ImageFilter
|
+----java.awt.image.BufferedImageFilter
)RP(
)HR(
)DL(
)DT( public class )BD(BufferedImageFilter)ES(
)DT( extends ImageFilter
)DT( implements )A(TileImageConsumer)EA(, Cloneable
)LD(
This class subclasses an ImageFilter to provide a simple means of
using a single-source/single-destination image operator
\201BufferedImageOp\202 to filter
a BufferedImage or Tile in the Image Producer/Consumer/Observer
paradigm. Examples of these image operators are: ConvolveOp,
AffineTransformOp and LookupOp.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( ImageFilter, )A(BufferedImage)EA(, )A(Tile)EA(, )A(BufferedImageOp)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BufferedImageFilter)ES()EA(\201BufferedImageOp\202
)DD( Constructs a BufferedImageFilter with the
specified single-source/single-destination operator.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getBufferedImageOp)ES()EA(\201\202
)DD( Returns the BufferedImageOp.
)DT( o )WB(
)A()BD(getFilterInstance)ES()EA(\201ImageConsumer\202
)DD( Returns a unique instance of a BufferedImageFilter object which will
actually perform the filtering for the specified ImageConsumer.
)DT( o )WB(
)A()BD(setPixels)ES()EA(\201int, int, ColorModel, Tile\202
)DD( Filters the information provided in the setPixels method of the
TileImageConsumer interface which takes a Tile.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(BufferedImageFilter)ES(
)PR(
public BufferedImageFilter\201)A(BufferedImageOp)EA( op\202
)RP(
)DL(
)DD( Constructs a BufferedImageFilter with the
specified single-source/single-destination operator.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getBufferedImageOp)ES()EA(
)PR(
public )A(BufferedImageOp)EA( getBufferedImageOp\201\202
)RP(
)DL(
)DD( Returns the BufferedImageOp.
)0 P(
)LD(
o )WB()EA(
)BD(getFilterInstance)ES()EA(
)PR(
public ImageFilter getFilterInstance\201ImageConsumer ic\202
)RP(
)DL(
)DD( Returns a unique instance of a BufferedImageFilter object which will
actually perform the filtering for the specified ImageConsumer.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getFilterInstance)EA( in class ImageFilter
)LD(
)LD(
o )WB()EA(
)BD(setPixels)ES()EA(
)PR(
public void setPixels\201int x,
int y,
)A(ColorModel)EA( model,
)A(Tile)EA( tile\202
)RP(
)DL(
)DD( Filters the information provided in the setPixels method of the
TileImageConsumer interface which takes a Tile.
The filter used will be the BufferedImageOp that was passed
to the constructor.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( setPixels
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ByteBandedTile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ByteBandedTile
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.Tile)EA(
|
+----java.awt.image.ByteBandedTile
)RP(
)HR(
)DL(
)DT( public class )BD(ByteBandedTile)ES(
)DT( extends )A(Tile)EA(
)LD(
This class defines a tile with pixels consisting of multiple 8-bit
component stored in separate arrays for each component. Operations on
sets of pixels are performed on a given component of each pixel
in the set before moving on to the next component. The arrays used
for storage may be distinct or shared between some or all of
the components.
There is only one pixel stride and one scanline stride for all
channels. This type of tile can be used with a
ComponentColorModel.
)0 P(
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ByteBandedTile)ES()EA(\201int, int, int, int, int, int[], int, int, byte[][]\202
)DD( Constructs a base tile given the tile parameters.
)DT( o )WB(
)A()BD(ByteBandedTile)ES()EA(\201int, int, int, int[], int, int, byte[][]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getByteData)ES()EA(\201int, int, int, int, byte[]\202
)DD( Returns a byte array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getByteData)ES()EA(\201int, int, int, int, int, byte[]\202
)DD( Returns a byte array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getChannelOffset)ES()EA(\201int\202
)DD( Returns channel offset for the specified channel.
)DT( o )WB(
)A()BD(getChannelOffsets)ES()EA(\201\202
)DD( Returns a copy of the channel offsets array.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel elements for all channels at the specified
location.
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns a reference to the entire data array
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201int\202
)DD( Returns a reference to the specific channel data array
)DT( o )WB(
)A()BD(getPixelStride)ES()EA(\201\202
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)DT( o )WB(
)A()BD(getScanlineStride)ES()EA(\201\202
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)DT( o )WB(
)A()BD(putByteData)ES()EA(\201int, int, int, int, byte[]\202
)DD( Stores a byte array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putByteData)ES()EA(\201int, int, int, int, int, byte[]\202
)DD( Stores a byte array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ByteBandedTile)ES(
)PR(
public ByteBandedTile\201int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
byte data[][]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
The tile data will start at x=0, y=0 in the data array of each
channel.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
width and height.
)LD(
)LD(
o )WB()EA(
)BD(ByteBandedTile)ES(
)PR(
public ByteBandedTile\201int x,
int y,
int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
byte data[][]\202
)RP(
)DL(
)DD( Constructs a base tile given the tile parameters.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffset - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getChannelOffsets)ES()EA(
)PR(
public int[] getChannelOffsets\201\202
)RP(
)DL(
)DD( Returns a copy of the channel offsets array.
)0 P(
)LD(
o )WB()EA(
)BD(getChannelOffset)ES()EA(
)PR(
public int getChannelOffset\201int channel\202
)RP(
)DL(
)DD( Returns channel offset for the specified channel. The channel offset
is the index into the channel data array
in which the first channel element of the first scanline is stored.
)0 P(
)LD(
o )WB()EA(
)BD(getScanlineStride)ES()EA(
)PR(
public int getScanlineStride\201\202
)RP(
)DL(
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelStride)ES()EA(
)PR(
public int getPixelStride\201\202
)RP(
)DL(
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public byte[][] getDataStorage\201\202
)RP(
)DL(
)DD( Returns a reference to the entire data array
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public byte[] getDataStorage\201int channel\202
)RP(
)DL(
)DD( Returns a reference to the specific channel data array
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel elements for all channels at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel elements for all channels
at the specified location are returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
int[] pixel = new int[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getByteData)ES()EA(
)PR(
public byte[] getByteData\201int x,
int y,
int w,
int h,
int channel,
byte outData[]\202
)RP(
)DL(
)DD( Returns a byte array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
byte[] channelData = tile.getByteData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
byte chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(getByteData)ES()EA(
)PR(
public byte[] getByteData\201int x,
int y,
int w,
int h,
byte outData[]\202
)RP(
)DL(
)DD( Returns a byte array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
byte[] channelData = tile.getByteData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
byte[] pixel = new byte[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DD( inData - Channel element.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putByteData)ES()EA(
)PR(
public void putByteData\201int x,
int y,
int w,
int h,
int channel,
byte inData[]\202
)RP(
)DL(
)DD( Stores a byte array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putByteData)ES()EA(
)PR(
public void putByteData\201int x,
int y,
int w,
int h,
byte inData[]\202
)RP(
)DL(
)DD( Stores a byte array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width of the subtile.
)DD( height - Height of the subtile.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the parent tile's channels may be
specified. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Parameters that are guaranteed to remain the same are:
)UL(
)LI( number of channels
)LI( pixel stride
)LU(
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays. If
the tile is a subtile, this will call
createCompatibleTile\201width, height\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ByteComponentTile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ByteComponentTile
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.Tile)EA(
|
+----java.awt.image.ByteComponentTile
)RP(
)HR(
)DL(
)DT( public class )BD(ByteComponentTile)ES(
)DT( extends )A(Tile)EA(
)LD(
This class defines a tile with pixels consisting of one or more 8-bit
channels stored in close proximity to each other in a byte array.
The bit precision per channel element is that
of the data type \201that is, the bit precision for this tile is 8\202.
There is only one pixel stride and one scanline stride for all
channels.This type of tile can be used with a
ComponentColorModel if there are multiple channels, or a
IndexColorModel if there is only one channel.
)0 P(
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ByteComponentTile)ES()EA(\201int, int, int, int, int, int, byte[]\202
)DD( Constructs a base tile with 1 channel and a pixel stride of 1.
)DT( o )WB(
)A()BD(ByteComponentTile)ES()EA(\201int, int, int, int, int, int[], int, int, byte[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)DT( o )WB(
)A()BD(ByteComponentTile)ES()EA(\201int, int, int, int[], int, int, byte[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getByteData)ES()EA(\201int, int, int, int, byte[]\202
)DD( Returns a byte array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getByteData)ES()EA(\201int, int, int, int, int, byte[]\202
)DD( Returns a byte array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getChannelOffset)ES()EA(\201int\202
)DD( Returns channel offset for the specified channel.
)DT( o )WB(
)A()BD(getChannelOffsets)ES()EA(\201\202
)DD( Returns a copy of the channel offsets array.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel elements for all channels at the specified
location.
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns a reference to the entire data array
)DT( o )WB(
)A()BD(getPixelStride)ES()EA(\201\202
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)DT( o )WB(
)A()BD(getScanlineStride)ES()EA(\201\202
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)DT( o )WB(
)A()BD(print)ES()EA(\201int, int, int, int\202
)DD( For debugging...
)DT( o )WB(
)A()BD(putByteData)ES()EA(\201int, int, int, int, byte[]\202
)DD( Stores a byte array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putByteData)ES()EA(\201int, int, int, int, int, byte[]\202
)DD( Stores a byte array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ByteComponentTile)ES(
)PR(
public ByteComponentTile\201int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
byte data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
The tile data will start at x=0, y=0 in the data array of each
channel.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
width and height.
)LD(
)LD(
o )WB()EA(
)BD(ByteComponentTile)ES(
)PR(
public ByteComponentTile\201int x,
int y,
int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
byte data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
o )WB()EA(
)BD(ByteComponentTile)ES(
)PR(
public ByteComponentTile\201int x,
int y,
int width,
int height,
int channelOffset,
int scanlineStride,
byte data[]\202
)RP(
)DL(
)DD( Constructs a base tile with 1 channel and a pixel stride of 1.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( channelOffset - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getChannelOffsets)ES()EA(
)PR(
public int[] getChannelOffsets\201\202
)RP(
)DL(
)DD( Returns a copy of the channel offsets array.
)0 P(
)LD(
o )WB()EA(
)BD(getChannelOffset)ES()EA(
)PR(
public int getChannelOffset\201int channel\202
)RP(
)DL(
)DD( Returns channel offset for the specified channel. The channel offset
is the index into the channel data array
in which the first channel element of the first scanline is stored.
)0 P(
)LD(
o )WB()EA(
)BD(getScanlineStride)ES()EA(
)PR(
public int getScanlineStride\201\202
)RP(
)DL(
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelStride)ES()EA(
)PR(
public int getPixelStride\201\202
)RP(
)DL(
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public byte[] getDataStorage\201\202
)RP(
)DL(
)DD( Returns a reference to the entire data array
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel elements for all channels at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel elements for all channels
at the specified location are returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
int[] pixel = new int[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getByteData)ES()EA(
)PR(
public byte[] getByteData\201int x,
int y,
int w,
int h,
int channel,
byte outData[]\202
)RP(
)DL(
)DD( Returns a byte array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
byte[] channelData = tile.getByteData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
byte chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(getByteData)ES()EA(
)PR(
public byte[] getByteData\201int x,
int y,
int w,
int h,
byte outData[]\202
)RP(
)DL(
)DD( Returns a byte array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
byte[] channelData = tile.getByteData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
byte[] pixel = new byte[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DD( inData - Channel element.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putByteData)ES()EA(
)PR(
public void putByteData\201int x,
int y,
int w,
int h,
int channel,
byte inData[]\202
)RP(
)DL(
)DD( Stores a byte array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202 + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putByteData)ES()EA(
)PR(
public void putByteData\201int x,
int y,
int w,
int h,
byte inData[]\202
)RP(
)DL(
)DD( Stores a byte array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the channels of the parent tile may
be specified. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Parameters that are guaranteed to remain the same are:
)UL(
)LI( number of channels
)LI( pixel stride
)LU(
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays. If
the tile is a subtile, this will call
createCompatibleTile\201width, height\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(print)ES()EA(
)PR(
public void print\201int x,
int y,
int w,
int h\202
)RP(
)DL(
)DD( For debugging... prints a region of a one-band ByteComponentTile
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ByteLookupTable
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ByteLookupTable
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.LookupTable)EA(
|
+----java.awt.image.ByteLookupTable
)RP(
)HR(
)DL(
)DT( public class )BD(ByteLookupTable)ES(
)DT( extends )A(LookupTable)EA(
)LD(
This class defines a lookup table object. The lookup table
contains byte data for one or more tile channels or image components
\201for example, separate arrays for R, G, and B\202,
and it contains an offset which will be subtracted from the
input value before indexing the array. This allows an array
smaller than the native data size to be constructed for a
constrained input. If there is only one array in the lookup
table, it will be applied to all channels.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ShortLookupTable)EA(, )A(LookupOp)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ByteLookupTable)ES()EA(\201int, byte[]\202
)DD( Create a LookupTable object from an array
of bytes representing a lookup table for each tile
channel.
)DT( o )WB(
)A()BD(ByteLookupTable)ES()EA(\201int, byte[][]\202
)DD( Create a LookupTable object from an array of byte
arrays representing a lookup table for each tile
channel.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns the lookup table data.
)DT( o )WB(
)A()BD(lookupPixel)ES()EA(\201byte[], byte[]\202
)DD( Returns an array of components of a pixel, translated with the lookup
table.
)DT( o )WB(
)A()BD(lookupPixel)ES()EA(\201int[], int[]\202
)DD( Returns an array of components of a pixel, translated with the lookup
table.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ByteLookupTable)ES(
)PR(
public ByteLookupTable\201int offset,
byte data[][]\202
)RP(
)DL(
)DD( Create a LookupTable object from an array of byte
arrays representing a lookup table for each tile
channel. The offset will be subtracted from the input
value before indexing into the arrays. The number of
components is the length of the data argument. The
data array for each component stored as a reference.
)0 P(
)LD(
o )WB()EA(
)BD(ByteLookupTable)ES(
)PR(
public ByteLookupTable\201int offset,
byte data[]\202
)RP(
)DL(
)DD( Create a LookupTable object from an array
of bytes representing a lookup table for each tile
channel. The offset will be subtracted from the input
value before indexing into the array. The number of
components is one. The data array will be stored internally.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public byte[][] getDataStorage\201\202
)RP(
)DL(
)DD( Returns the lookup table data.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( LookupTable data array.
)LD(
)LD(
o )WB()EA(
)BD(lookupPixel)ES()EA(
)PR(
public int[] lookupPixel\201int src[],
int dst[]\202
)RP(
)DL(
)DD( Returns an array of components of a pixel, translated with the lookup
table. The source and destination can be equal. If dst is null,
a new array will be allocated. The dst array is returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( an int array of components.
)DT( )BD(Overrides:)ES(
)DD( )A(lookupPixel)EA( in class )A(LookupTable)EA(
)LD(
)LD(
o )WB()EA(
)BD(lookupPixel)ES()EA(
)PR(
public byte[] lookupPixel\201byte src[],
byte dst[]\202
)RP(
)DL(
)DD( Returns an array of components of a pixel, translated with the lookup
table. The source and destination can be equal. If dst is null,
a new array will be allocated. The dst array is returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a byte array of components.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.BytePackedTile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.BytePackedTile
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.Tile)EA(
|
+----java.awt.image.BytePackedTile
)RP(
)HR(
)DL(
)DT( public class )BD(BytePackedTile)ES(
)DT( extends )A(Tile)EA(
)LD(
This class is most useful for describing 1, 2 and 4 bit image tiles.
This tile has one channel whose pixels are less than 8-bits and are
packed together into individual bytes in a byte array. This type of
tile can be used with an IndexColorModel.
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(BytePackedTile)ES()EA(\201int, int, int, byte[]\202
)DD( Constructs a tile given the width, height, and number of bits
per pixel.
)DT( o )WB(
)A()BD(BytePackedTile)ES()EA(\201int, int, int, int, int, int, int, int, byte[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getByteData)ES()EA(\201int, int, int, int, byte[]\202
)DD( Returns an array containing the specified channel elements
from the data array.
)DT( o )WB(
)A()BD(getByteData)ES()EA(\201int, int, int, int, int, byte[]\202
)DD( Returns an array containing the specified channel elements
from the data array.
)DT( o )WB(
)A()BD(getChannelBitOffset)ES()EA(\201\202
)DD( Returns channel bit offset for the specified channel.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel element at the specified
location.
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns a reference to the entire data array
)DT( o )WB(
)A()BD(getNumberOfBits)ES()EA(\201\202
)DD( Returns the total number of bits per channel element.
)DT( o )WB(
)A()BD(getPixelBitStride)ES()EA(\201\202
)DD( Returns pixel bit stride -- the number of bits between two
channel elements on the same scanline.
)DT( o )WB(
)A()BD(getScanlineStride)ES()EA(\201\202
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)DT( o )WB(
)A()BD(putByteData)ES()EA(\201int, int, int, int, byte[]\202
)DD( Stores a byte array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putByteData)ES()EA(\201int, int, int, int, int, byte[]\202
)DD( Stores a byte array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(BytePackedTile)ES(
)PR(
public BytePackedTile\201int width,
int height,
int numberOfBits,
byte data[]\202
)RP(
)DL(
)DD( Constructs a tile given the width, height, and number of bits
per pixel. The data is assumed to be packed as tightly as
numberOfBits allows, with no initial offset and with the smallest
scanline stride to satisfy the constraint that adjacent rows
differ by an integer number of byte array elements.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numberOfBits - Bits per pixel of the data
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
width and height. The verify\201\202 method is
used to check consistency.
)DT( )BD(See Also:)ES(
)DD( )A(verify)EA(
)LD(
)LD(
o )WB()EA(
)BD(BytePackedTile)ES(
)PR(
public BytePackedTile\201int x,
int y,
int width,
int height,
int numberOfBits,
int channelBitOffset,
int pixelBitStride,
int scanlineStride,
byte data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numberOfBits - Bit precision of the data
)DD( channelBitOffset - Bit index into the data array in
which the first channel element of the first scanline is accessed.
)DD( pixelBitStride - Number of bits between two channel elements
on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getNumberOfBits)ES()EA(
)PR(
public int getNumberOfBits\201\202
)RP(
)DL(
)DD( Returns the total number of bits per channel element.
)0 P(
)LD(
o )WB()EA(
)BD(getChannelBitOffset)ES()EA(
)PR(
public int getChannelBitOffset\201\202
)RP(
)DL(
)DD( Returns channel bit offset for the specified channel. The channel
bit offset is the bit index into the channel data array
in which the first channel element of the first scanline is stored.
)0 P(
)LD(
o )WB()EA(
)BD(getScanlineStride)ES()EA(
)PR(
public int getScanlineStride\201\202
)RP(
)DL(
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelBitStride)ES()EA(
)PR(
public int getPixelBitStride\201\202
)RP(
)DL(
)DD( Returns pixel bit stride -- the number of bits between two
channel elements on the same scanline.
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public byte[] getDataStorage\201\202
)RP(
)DL(
)DD( Returns a reference to the entire data array
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index is ignored..
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel element at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel element
at the specified location is returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel element
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region. The channel index will be ignored.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region. The channel index will be ignored.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int pixel;
// To find a pixel at location \201x2, y2\202
pixel = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getByteData)ES()EA(
)PR(
public byte[] getByteData\201int x,
int y,
int w,
int h,
int channel,
byte outData[]\202
)RP(
)DL(
)DD( Returns an array containing the specified channel elements
from the data array. The channel index will be ignored.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
byte[] channelData = getByteData\201x, y, channel, w, h, null\202;
// To find an element at location \201x2, y2\202
byte element = channelData[\201y2-y\202*w + \201x2-x\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(getByteData)ES()EA(
)PR(
public byte[] getByteData\201int x,
int y,
int w,
int h,
byte outData[]\202
)RP(
)DL(
)DD( Returns an array containing the specified channel elements
from the data array.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
byte[] channelData = tile.getByteData\201x, y, w, h, null\202;
byte pixel;
// To find a pixel at location \201x2, y2\202
pixel = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index is ignored.
)DD( inData - Channel element.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region. The channel is ignored.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putByteData)ES()EA(
)PR(
public void putByteData\201int x,
int y,
int w,
int h,
int channel,
byte inData[]\202
)RP(
)DL(
)DD( Stores a byte array of pixels into the specified rectangular
region. The channel index will be ignored.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putByteData)ES()EA(
)PR(
public void putByteData\201int x,
int y,
int w,
int h,
byte inData[]\202
)RP(
)DL(
)DD( Stores a byte array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the channels of the parent tile may be
specified. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Parameters that are guaranteed to remain the same are:
)UL(
)LI( number of bits
)LI( pixel bit stride
)LU(
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ColorConvertOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ColorConvertOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.ColorConvertOp
)RP(
)HR(
)DL(
)DT( public class )BD(ColorConvertOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)LD(
This class performs a pixel-by-pixel color conversion of the data in
the source image. The resulting color values are scaled to the precision
of the destination image data type. Color conversion can be specified
via an array of ColorSpace objects or an array of ICC_Profile objects.
)0 P(
If the source is a BufferedImage with premultiplied alpha, the
color components are divided by the alpha component before color conversion.
If the destination is a BufferedImage with premultiplied alpha, the
color components are multiplied by the alpha component after conversion.
Tiles are treated as having no alpha channel, i.e. all channels are
color channels.
)0 P(
Note Source and Destination may be the same object.
)0 P(
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ColorConvertOp)ES()EA(\201ColorSpace[]\202
)DD( Constructs a new ColorConvertOp from an array of ColorSpaces.
)DT( o )WB(
)A()BD(ColorConvertOp)ES()EA(\201ICC_Profile[]\202
)DD( Constructs a new ColorConvertOp from an array of ICC_Profiles.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number of
components, given this source.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number of
channels, given this source.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( ColorConvert the BufferedImage.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( ColorConvert the channel data in the Tile.
)DT( o )WB(
)A()BD(getColorSpaces)ES()EA(\201\202
)DD( Returns the array of ColorSpaces used to construct this ColorConvertOp.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the destination, given this source.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the destination, given this source.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getICC_Profiles)ES()EA(\201\202
)DD( Returns the array of ICC_Profiles used to construct this ColorConvertOp.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ColorConvertOp)ES(
)PR(
public ColorConvertOp\201)A(ColorSpace)EA( cspaces[]\202
)RP(
)DL(
)DD( Constructs a new ColorConvertOp from an array of ColorSpaces.
The semantics is that source pixels are converted in sequence between
successive ColorSpaces in the array, i.e. from cspaces[0] to cspaces[1],
then from cspaces[1] to cspaces[2], etc.
)0 P(For BufferedImages, if the ColorSpace
of the source BufferedImage does not match the first ColorSpace in the
array, the first conversion is to the first ColorSpace in the array.
If the last ColorSpace in the array does not match the ColorSpace of the
destination BufferedImage, the last conversion is to the destination's
ColorSpace. For BufferedImages, the semantics are well-defined for
ColorConvertOps constructed from an array of any length.
)0 P(For Tiles, the number of channels in the source Tile must match the
number of components of the first ColorSpace in the array, and the
number of channels in the destination Tile must match the number of
components in the last ColorSpace in the array. For arrays of length
zero or one, the ColorConvertOp is a NoOp for Tiles.
)0 P(
)LD(
o )WB()EA(
)BD(ColorConvertOp)ES(
)PR(
public ColorConvertOp\201)A(ICC_Profile)EA( profiles[]\202
)RP(
)DL(
)DD( Constructs a new ColorConvertOp from an array of ICC_Profiles.
The sequence of profiles may include profiles that represent color
spaces, profiles that represent effects, etc. If the whole sequence
does not represent a well-defined color conversion, an exception is
thrown.
)0 P(For BufferedImages, if the ColorSpace
of the source BufferedImage does not match the requirements of the
first profile in the array,
the first conversion is to an appropriate ColorSpace.
If the requirements of the last profile in the array are not met
by the ColorSpace of the destination BufferedImage,
the last conversion is to the destination's ColorSpace.
)0 P(For Tiles, the number of channels in the source Tile must match the
requirements of the first profile in the array, and the
number of channels in the destination Tile must match the requirements
of the last profile in the array.
)0 P(
)DD()DL(
)DT( )BD(Throws:)ES( IllegalArgumentException
)DD( when the profile sequence does not
specify a well-defined color conversion
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getColorSpaces)ES()EA(
)PR(
public )A(ColorSpace)EA([] getColorSpaces\201\202
)RP(
)DL(
)DD( Returns the array of ColorSpaces used to construct this ColorConvertOp.
Returns null if the ColorConvertOp was constructed from an array of
ICC_Profiles.
)0 P(
)LD(
o )WB()EA(
)BD(getICC_Profiles)ES()EA(
)PR(
public )A(ICC_Profile)EA([] getICC_Profiles\201\202
)RP(
)DL(
)DD( Returns the array of ICC_Profiles used to construct this ColorConvertOp.
Returns null if the ColorConvertOp was constructed from an array of
ColorSpaces.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dest\202
)RP(
)DL(
)DD( ColorConvert the BufferedImage.
If the destination image is null,
a BufferedImage will be created with an appropriate ColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( ColorConvert the channel data in the Tile.
If the destination Tile is null, a new Tile will be created.
The number of channels in the source and destination Tiles must
meet the requirements explained above.
Otherwise, an exception is thrown.
)0 P(
)DD()DL(
)DT( )BD(Throws:)ES( IllegalArgumentException
)DD( if the number of source or
destination channels is incorrect
)LD(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the destination, given this source.
Note that this will be the same as the the bounding box of the
source.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the destination, given this source.
Note that this will be the same as the the bounding box of the
source.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number of
components, given this source.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation
)DD( destCM - ColorModel of the destination. If null, an
appropriate ColorModel will be used.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number of
channels, given this source.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ColorModel
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ColorModel
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.ColorModel
)RP(
)HR(
)DL(
)DT( public abstract class )BD(ColorModel)ES(
)DT( extends Object
)DT( implements )A(Transparency)EA(
)DT( super class of:
)DD( )A(ComponentColorModel)EA(, )A(IndexColorModel)EA(, )A(PackedColorModel)EA(
)LD(
An abstract class that encapsulates the methods for translating from pixel
values to color components \201e.g. red, green, blue\202 for an image.
Pixels may be represented as 32-bit ints or as arrays of 32-bit ints.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(IndexColorModel)EA(, )A(ComponentColorModel)EA(, )A(PackedColorModel)EA(, )A(DirectColorModel)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(pixel_bits)ES()EA(
)DD(
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ColorModel)ES()EA(\201int\202
)DD( Constructs a ColorModel which describes a pixel of the specified
number of bits.
)DT( o )WB(
)A()BD(ColorModel)ES()EA(\201int, ColorSpace, boolean, boolean, int\202
)DD( Constructs a ColorModel which describes a pixel of the specified
number of bits in the color space of the specified ColorSpace.
)DT( o )WB(
)A()BD(ColorModel)ES()EA(\201int[], ColorSpace, boolean, boolean, int\202
)DD( Constructs a ColorModel which describes a pixel
in the color space of the specified ColorSpace.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(coerceData)ES()EA(\201Tile, boolean\202
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(finalize)ES()EA(\201\202
)DD(
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int\202
)DD( Returns the alpha
component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int[]\202
)DD( Returns the alpha
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int\202
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int[]\202
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getColorSpace)ES()EA(\201\202
)DD( Returns the ColorSpace associated with this ColorModel
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201float[], int[]\202
)DD( Returns an array of all of the components given a normalized
component array.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int, int[]\202
)DD( Returns an array of all of the components given a pixel
in the current color model.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int[], int[]\202
)DD( Returns an array of all of the components given a pixel array
in the current color model.
)DT( o )WB(
)A()BD(getComponentSize)ES()EA(\201\202
)DD( Returns an array of the number of bits per component.
)DT( o )WB(
)A()BD(getComponentSize)ES()EA(\201int\202
)DD( Returns the number of bits for the given component.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int\202
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int[]\202
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getNormalizedComponents)ES()EA(\201int[], float[]\202
)DD( Returns an array of normalized components given an array of all
components.
)DT( o )WB(
)A()BD(getNumColorComponents)ES()EA(\201\202
)DD( Returns the number of color components in this color model.
)DT( o )WB(
)A()BD(getNumComponents)ES()EA(\201\202
)DD( Returns the number of components \201including alpha\202 in this color model.
)DT( o )WB(
)A()BD(getPixel)ES()EA(\201int, int[]\202
)DD( Returns a pixel array given a pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getPixelSize)ES()EA(\201\202
)DD( Returns the number of bits per pixel described by this ColorModel.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int\202
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int[]\202
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int\202
)DD( Returns the color of the pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int[]\202
)DD( Returns a pixel in the default RGB color model given a pixel array
in the current color model.
)DT( o )WB(
)A()BD(getRGBdefault)ES()EA(\201\202
)DD( Return a DirectColorModel that describes the default format for
integer RGB values used in many of the methods in the
AWT image interfaces for the convenience of the programmer.
)DT( o )WB(
)A()BD(getTransparency)ES()EA(\201\202
)DD( Returns the transparency.
)DT( o )WB(
)A()BD(hasAlpha)ES()EA(\201\202
)DD( Returns whether or not alpha is supported in this ColorModel.
)DT( o )WB(
)A()BD(isAlphaPremultiplied)ES()EA(\201\202
)DD( Returns whether or not the alpha has been premultiplied in the
Tile associated with this ColorModel.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Prints the contents of this object
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(pixel_bits)ES(
)PR(
protected int pixel_bits
)RP(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ColorModel)ES(
)PR(
protected ColorModel\201int bits\202
)RP(
)DL(
)DD( Constructs a ColorModel which describes a pixel of the specified
number of bits. The color space is the default RGB ColorSpace,
which is sRGB.
)0 P(
)LD(
o )WB()EA(
)BD(ColorModel)ES(
)PR(
protected ColorModel\201int bits,
)A(ColorSpace)EA( cspace,
boolean hasAlpha,
boolean isAlphaPremultiplied,
int transparency\202
)RP(
)DL(
)DD( Constructs a ColorModel which describes a pixel of the specified
number of bits in the color space of the specified ColorSpace.
The boolean, isAlphaPremultiplied, specifies how to interpret color
data that are passed to this ColorModel. If the boolean is true, the
color data have been multiplied with alpha. The transparency
specifies what alpha values can be represented by this color model.
Any ColorModel object that uses this constructor should override
the getComponentArray\201\202 method to return the actual bits per
component array. This constructor is here to support legacy
code.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Transparency)EA(
)LD(
)LD(
o )WB()EA(
)BD(ColorModel)ES(
)PR(
protected ColorModel\201int bits[],
)A(ColorSpace)EA( cspace,
boolean hasAlpha,
boolean isAlphaPremultiplied,
int transparency\202
)RP(
)DL(
)DD( Constructs a ColorModel which describes a pixel
in the color space of the specified ColorSpace. The bits array
specifies the number of significant bits per component in the
color model \201color components and alpha\202.
The boolean, isAlphaPremultiplied, specifies how to
interpret color data that
are passed to this ColorModel. If the boolean is true, the
color data have been multiplied with alpha. The transparency
specifies what alpha values can be represented by this color model.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Transparency)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getRGBdefault)ES()EA(
)PR(
public static )A(ColorModel)EA( getRGBdefault\201\202
)RP(
)DL(
)DD( Return a DirectColorModel that describes the default format for
integer RGB values used in many of the methods in the
AWT image interfaces for the convenience of the programmer.
The color space is the default ColorSpace, sRGB.
The format for the RGB values is an integer with 8 bits
each of alpha, red, green, and blue color components ordered
correspondingly from the most significant byte to the least
significant byte, as in: 0xAARRGGBB. Color components are
not premultiplied by the alpha component. This format does not
necessarily represent the native or the most efficient
ColorModel for a particular device or for all images. It is
merely used as a common color model format.
)0 P(
)LD(
o )WB()EA(
)BD(hasAlpha)ES()EA(
)PR(
public boolean hasAlpha\201\202
)RP(
)DL(
)DD( Returns whether or not alpha is supported in this ColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(isAlphaPremultiplied)ES()EA(
)PR(
public boolean isAlphaPremultiplied\201\202
)RP(
)DL(
)DD( Returns whether or not the alpha has been premultiplied in the
Tile associated with this ColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelSize)ES()EA(
)PR(
public int getPixelSize\201\202
)RP(
)DL(
)DD( Returns the number of bits per pixel described by this ColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(getComponentSize)ES()EA(
)PR(
public int getComponentSize\201int componentIdx\202
)RP(
)DL(
)DD( Returns the number of bits for the given component.
)0 P(
)LD(
o )WB()EA(
)BD(getComponentSize)ES()EA(
)PR(
public int[] getComponentSize\201\202
)RP(
)DL(
)DD( Returns an array of the number of bits per component.
)0 P(
)LD(
o )WB()EA(
)BD(getTransparency)ES()EA(
)PR(
public int getTransparency\201\202
)RP(
)DL(
)DD( Returns the transparency. Returns either OPAQUE, BITMASK,
or TRANSLUCENT
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(OPAQUE)EA(, )A(BITMASK)EA(, )A(TRANSLUCENT)EA(
)LD(
)LD(
o )WB()EA(
)BD(getNumComponents)ES()EA(
)PR(
public int getNumComponents\201\202
)RP(
)DL(
)DD( Returns the number of components \201including alpha\202 in this color model.
This is equal to the number of color components, optionally plus
one, if there is an alpha component.
)0 P(
)LD(
o )WB()EA(
)BD(getNumColorComponents)ES()EA(
)PR(
public int getNumColorComponents\201\202
)RP(
)DL(
)DD( Returns the number of color components in this color model.
This is the number of components returned by
ColorSpace.getNumComponents\201\202.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getNumComponents)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public abstract int getRed\201int pixel\202
)RP(
)DL(
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel. The returned value will
be a non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public abstract int getGreen\201int pixel\202
)RP(
)DL(
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel. The returned value will be
a non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public abstract int getBlue\201int pixel\202
)RP(
)DL(
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel. The returned value will be
a non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public abstract int getAlpha\201int pixel\202
)RP(
)DL(
)DD( Returns the alpha
component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201int pixel\202
)RP(
)DL(
)DD( Returns the color of the pixel in the default RGB color model.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel. The returned value will be
a non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public int getRed\201int pixel[]\202
)RP(
)DL(
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public int getGreen\201int pixel[]\202
)RP(
)DL(
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public int getBlue\201int pixel[]\202
)RP(
)DL(
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public int getAlpha\201int pixel[]\202
)RP(
)DL(
)DD( Returns the alpha
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel.
)0 P(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201int pixel[]\202
)RP(
)DL(
)DD( Returns a pixel in the default RGB color model given a pixel array
in the current color model.
The pixel is described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(
)LD(
)LD(
o )WB()EA(
)BD(getPixel)ES()EA(
)PR(
public int[] getPixel\201int rgb,
int pixel[]\202
)RP(
)DL(
)DD( Returns a pixel array given a pixel in the default RGB color model.
This pixel array can then be passed to the putData method of
a Tile object. If the pixel variable is null, a new array will
be allocated. The pixel array will be returned.
)0 P(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201int pixel,
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel
in the current color model. If the color model is not
an IndexColorModel or DirectColorModel, an IllegalArgumentException
will be thrown. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201int pixel[],
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel array
in the current color model. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201float normComponents[],
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a normalized
component array.
)0 P(
)LD(
o )WB()EA(
)BD(getNormalizedComponents)ES()EA(
)PR(
public float[] getNormalizedComponents\201int components[],
float normComponents[]\202
)RP(
)DL(
)DD( Returns an array of normalized components given an array of all
components.
)0 P(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(finalize)ES()EA(
)PR(
public void finalize\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(finalize)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(getColorSpace)ES()EA(
)PR(
public )A(ColorSpace)EA( getColorSpace\201\202
)RP(
)DL(
)DD( Returns the ColorSpace associated with this ColorModel
)0 P(
)LD(
o )WB()EA(
)BD(coerceData)ES()EA(
)PR(
public )A(ColorModel)EA( coerceData\201)A(Tile)EA( tile,
boolean isAlphaPremultiplied\202
)RP(
)DL(
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel. It may multiply or divide
the color Tile data by alpha, or do nothing if the data is
in the correct state. If the data needs to be coerced, this
method will also return an instance of this ColorModel with
the isAlphaPremultiplied flag set appropriately.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Prints the contents of this object
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ComponentColorModel
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ComponentColorModel
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.ColorModel)EA(
|
+----java.awt.image.ComponentColorModel
)RP(
)HR(
)DL(
)DT( public class )BD(ComponentColorModel)ES(
)DT( extends )A(ColorModel)EA(
)LD(
A ColorModel class that can handle an arbitrary ColorSpace and
an array of color components to match the ColorSpace. This
class can be used to represent most color models on most
types of GraphicsDevices.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorModel)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ComponentColorModel)ES()EA(\201ColorSpace, int[], boolean, boolean, int\202
)DD( Constructs a ComponentColorModel from the specified parameters.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(coerceData)ES()EA(\201Tile, boolean\202
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD( Compares this color model with another for equality.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int\202
)DD( Returns the alpha
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int[]\202
)DD( Returns the alpha component for the specified pixel, scaled from
0 to 255.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int\202
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int[]\202
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int, int[]\202
)DD( Returns an array of all of the components given a pixel
in the current color model.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int[], int[]\202
)DD( Returns an array of all of the components given a pixel array
in the current color model.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int\202
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int[]\202
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getPixel)ES()EA(\201int, int[]\202
)DD( Returns a pixel array given a pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int\202
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int[]\202
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int\202
)DD( Returns the color of the pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int[]\202
)DD( Returns a pixel in the default RGB color model given a pixel array
in the current color model.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ComponentColorModel)ES(
)PR(
public ComponentColorModel\201)A(ColorSpace)EA( colorSpace,
int bits[],
boolean hasAlpha,
boolean isAlphaPremultiplied,
int transparency\202
)RP(
)DL(
)DD( Constructs a ComponentColorModel from the specified parameters.
The bits array specifies the number of significant bits per
component in the color model \201color components and alpha\202. An
IllegalArgumentException will be thrown if the length of the
array does not match the number of components.
If hasAlpha is true, then the boolean, isAlphaPremultiplied, specifies
how to interpret color data that are passed to this ColorModel. If
it is true, the color data will have been multiplied with alpha.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( colorSpace - ColorSpace associated with this color model
)DD( bits - Number of significant bits per component
)DD( hasAlpha - If true, this color model supports alpha.
)DD( isAlphaPremultiplied - If true, alpha is premultiplied.
)DD( transparency - Specifies what alpha values can be represented
by this color model.
)DT( )BD(See Also:)ES(
)DD( )A(ColorSpace)EA(, )A(Transparency)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public int getRed\201int pixel\202
)RP(
)DL(
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRed)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public int getGreen\201int pixel\202
)RP(
)DL(
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getGreen)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public int getBlue\201int pixel\202
)RP(
)DL(
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBlue)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public int getAlpha\201int pixel\202
)RP(
)DL(
)DD( Returns the alpha
color component for the specified pixel, scaled from 0 to 255
in the default RGB ColorSpace, sRGB.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAlpha)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201int pixel\202
)RP(
)DL(
)DD( Returns the color of the pixel in the default RGB color model.
An IllegalArgumentException will be thrown if there is more than
one component in this ColorModel.
This method will throw an IllegalArgumentException since this
ColorModel is unable to extract alpha and color components from
a single integer pixel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRGB)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public int getRed\201int pixel[]\202
)RP(
)DL(
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRed)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public int getGreen\201int pixel[]\202
)RP(
)DL(
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getGreen)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public int getBlue\201int pixel[]\202
)RP(
)DL(
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBlue)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public int getAlpha\201int pixel[]\202
)RP(
)DL(
)DD( Returns the alpha component for the specified pixel, scaled from
0 to 255. The pixel is described by a discrete array of
channel elements, one per channel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAlpha)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201int pixels[]\202
)RP(
)DL(
)DD( Returns a pixel in the default RGB color model given a pixel array
in the current color model.
The pixel is described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRGB)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(
)LD(
)LD(
o )WB()EA(
)BD(getPixel)ES()EA(
)PR(
public int[] getPixel\201int rgb,
int pixel[]\202
)RP(
)DL(
)DD( Returns a pixel array given a pixel in the default RGB color model.
This pixel array can then be passed to the putData method of
a Tile object. If the pixel variable is null, a new array will
be allocated. The pixel array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getPixel)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201int pixel,
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel
in the current color model. If the color model is not
an IndexColorModel or DirectColorModel, an IllegalArgumentException
will be thrown. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponents)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201int pixel[],
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel array
in the current color model. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponents)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(coerceData)ES()EA(
)PR(
public )A(ColorModel)EA( coerceData\201)A(Tile)EA( tile,
boolean isAlphaPremultiplied\202
)RP(
)DL(
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel. It may multiply or divide
the color Tile data by alpha, or do nothing if the data is
in the correct state. If the data needs to be coerced, this
method will also return an instance of this ColorModel with
the isAlphaPremultiplied flag set appropriately.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(coerceData)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD( Compares this color model with another for equality.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class )A(ColorModel)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ConvolveOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ConvolveOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.ConvolveOp
)RP(
)HR(
)DL(
)DT( public class )BD(ConvolveOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)LD(
This class implements a convolution from the source
to the destination.
Convolution using a convolution kernel is a spatial operation that
computes the output pixel from an input pixel by multiplying the kernel
with the surround of the input pixel.
This allows the output pixel to be affected by the immediate neighborhood
in a way that can be mathematically specified with a kernel.
)0 P(
This class operates with BufferedImage data that are premultiplied with
alpha. If the Source BufferedImage has an alpha component, and the
color components are not premultiplied with the alpha component, then
the data are premultiplied before being convolved. If the Destination
has alpha components which are not premultiplied, then alpha is divided
out before storing into the Destination. If the Destination has no
alpha component, then the resulting alpha is discarded after first
dividing it out of the color components.
)0 P(
Tiles are treated as having no alpha channel.
)0 P(
Note that the Source and the Destination may not be the same object.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(Kernel)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(EDGE_EXTEND)ES()EA(
)DD( The convolution operator temporarily extends the width and
height of the source image by replicating the pixels at the edge
of the image.
)DT( o )WB(
)A()BD(EDGE_NO_OP)ES()EA(
)DD( Values of pixels at the edge of the source image are copied to
the corresponding pixels in the destination without modification.
)DT( o )WB(
)A()BD(EDGE_ZERO_FILL)ES()EA(
)DD( Pixels at the edge of the destination image are set to zero.
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ConvolveOp)ES()EA(\201Kernel, int\202
)DD( Constructs a ConvolveOp given a Kernel and an edge hint.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number
of channels.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number
of channels.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Perform a convolution on BufferedImages.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Perform a convolution on Tiles.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the filtered destination image.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the filtered destination tile.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getEdgeHint)ES()EA(\201\202
)DD( Return the edge hint.
)DT( o )WB(
)A()BD(getKernel)ES()EA(\201\202
)DD( Return the Kernel.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(EDGE_NO_OP)ES(
)PR(
public static final int EDGE_NO_OP
)RP(
)DL(
)DD( Values of pixels at the edge of the source image are copied to
the corresponding pixels in the destination without modification.
Thus the edge of the source is not filtered.)0 P(
)LD(
o )WB()EA(
)BD(EDGE_ZERO_FILL)ES(
)PR(
public static final int EDGE_ZERO_FILL
)RP(
)DL(
)DD( Pixels at the edge of the destination image are set to zero.)0 P(
)LD(
o )WB()EA(
)BD(EDGE_EXTEND)ES(
)PR(
public static final int EDGE_EXTEND
)RP(
)DL(
)DD( The convolution operator temporarily extends the width and
height of the source image by replicating the pixels at the edge
of the image. This strategy enables the operator to filter the
pixels that were originally at the edge of the image.)0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ConvolveOp)ES(
)PR(
public ConvolveOp\201)A(Kernel)EA( kernel,
int edgeHint\202
)RP(
)DL(
)DD( Constructs a ConvolveOp given a Kernel and an edge hint.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(Kernel)EA(, )A(EDGE_NO_OP)EA(, )A(EDGE_ZERO_FILL)EA(, )A(EDGE_EXTEND)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getEdgeHint)ES()EA(
)PR(
public int getEdgeHint\201\202
)RP(
)DL(
)DD( Return the edge hint.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(EDGE_NO_OP)EA(, )A(EDGE_ZERO_FILL)EA(, )A(EDGE_EXTEND)EA(
)LD(
)LD(
o )WB()EA(
)BD(getKernel)ES()EA(
)PR(
public )A(Kernel)EA( getKernel\201\202
)RP(
)DL(
)DD( Return the Kernel.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dst\202
)RP(
)DL(
)DD( Perform a convolution on BufferedImages. Each component of the
source image will be convolved.
If the color model in the source image is not the same as that
in the destination image, the pixels will be converted
in the destination. If the destination image is null,
a BufferedImage will be created with the source ColorModel.
The IllegalArgumentException may be thrown if the source is the
same as the destination.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dst\202
)RP(
)DL(
)DD( Perform a convolution on Tiles. Each channel of the source tile
will be convolved.
The source and destination must have the same number of channels.
If the destination Tile is null, a new Tile will be created.
The IllegalArgumentException may be thrown if the source is
the same as the destination.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number
of channels.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number
of channels.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the filtered destination image. Since
this is not a geometric operation, the bounding box does not
change.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the filtered destination tile. Since
this is not a geometric operation, the bounding box does not
change.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value. Since this is not a geometric
operation, the srcPt will equal the dstPt.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.DirectColorModel
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.DirectColorModel
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.ColorModel)EA(
|
+----)A(java.awt.image.PackedColorModel)EA(
|
+----java.awt.image.DirectColorModel
)RP(
)HR(
)DL(
)DT( public class )BD(DirectColorModel)ES(
)DT( extends )A(PackedColorModel)EA(
)LD(
A ColorModel class that represents pixel values
that have RGB color components embedded directly in the bits of the
pixel itself. This color model is similar to an X11 TrueColor visual.
The default RGB ColorModel specified by the ColorModel.getRGBdefault
method is a DirectColorModel with the following parameters:
)PR(
Number of bits: 32
Red mask: 0x00ff0000
Green mask: 0x0000ff00
Blue mask: 0x000000ff
Alpha mask: 0xff000000
Color space: sRGB
isAlphaPremultiplied: False
)RP(
)0 P(Many of the methods in this class are final. This is because the
underlying native graphics code makes assumptions about the layout
and operation of this class and those assumptions are reflected in
the implementations of the methods here that are marked final. You
can subclass this class for other reasons, but you cannot override
or modify the behaviour of those methods.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorModel)EA(, )A(ColorSpace)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(DirectColorModel)ES()EA(\201ColorSpace, int, int, int, int, int, boolean\202
)DD( Constructs a DirectColorModel from the specified parameters.
)DT( o )WB(
)A()BD(DirectColorModel)ES()EA(\201int, int, int, int\202
)DD( Constructs a DirectColorModel from the given masks specifying
which bits in the pixel contain the red, green and blue color
components.
)DT( o )WB(
)A()BD(DirectColorModel)ES()EA(\201int, int, int, int, int\202
)DD( Constructs a DirectColorModel from the given masks specifying
which bits in the pixel contain the alpha, red, green and blue
color components.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(coerceData)ES()EA(\201Tile, boolean\202
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int\202
)DD( Return the alpha transparency value for the specified pixel in the
range 0-255.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int[]\202
)DD( Returns the alpha color component for the specified pixel,
scaled from 0 to 255.
)DT( o )WB(
)A()BD(getAlphaMask)ES()EA(\201\202
)DD( Returns the mask indicating which bits in a pixel contain the alpha
transparency component.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int\202
)DD( Returns the blue color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int[]\202
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getBlueMask)ES()EA(\201\202
)DD( Returns the mask indicating which bits in a pixel contain the blue
color component.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int, int[]\202
)DD( Returns an array of all of the components given a pixel
in the current color model.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int[], int[]\202
)DD( Returns an array of all of the components given a pixel array
in the current color model.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int\202
)DD( Returns the green color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int[]\202
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getGreenMask)ES()EA(\201\202
)DD( Returns the mask indicating which bits in a pixel contain the green
color component.
)DT( o )WB(
)A()BD(getPixel)ES()EA(\201int, int[]\202
)DD( Returns a pixel array given a pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int\202
)DD( Returns the red color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int[]\202
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getRedMask)ES()EA(\201\202
)DD( Returns the mask indicating which bits in a pixel contain the red
color component.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int\202
)DD( Returns the color of the pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int[]\202
)DD( Returns a pixel in the default RGB color model given a pixel array
in the current color model.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD( Prints the contents of this object
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(DirectColorModel)ES(
)PR(
public DirectColorModel\201int bits,
int rmask,
int gmask,
int bmask\202
)RP(
)DL(
)DD( Constructs a DirectColorModel from the given masks specifying
which bits in the pixel contain the red, green and blue color
components. Pixels described by this color model will all
have alpha components of 255 \201fully opaque\202. All of the bits
in each mask must be contiguous and fit in the specified number
of least significant bits of the integer.
)0 P(
)LD(
o )WB()EA(
)BD(DirectColorModel)ES(
)PR(
public DirectColorModel\201int bits,
int rmask,
int gmask,
int bmask,
int amask\202
)RP(
)DL(
)DD( Constructs a DirectColorModel from the given masks specifying
which bits in the pixel contain the alpha, red, green and blue
color components. All of the bits in each mask must be contiguous
and fit in the specified number of least significant bits of the
integer. The ColorSpace will be the default sRGB space, and
alpha, if present, will not be premultiplied.
)0 P(
)LD(
o )WB()EA(
)BD(DirectColorModel)ES(
)PR(
public DirectColorModel\201)A(ColorSpace)EA( space,
int bits,
int rmask,
int gmask,
int bmask,
int amask,
boolean isAlphaPremultiplied\202
)RP(
)DL(
)DD( Constructs a DirectColorModel from the specified parameters.
The masks specify
which bits in the pixel contain the alpha, red, green and blue
color components. All of the bits in each mask must be contiguous
and fit in the specified number of least significant bits of the
integer. The ColorSpace of the color model is specified by
space and must be of ColorSpace.TYPE_RGB. If there is alpha, the
boolean,
isAlphaPremultiplied, specifies how to interpret color data that
are passed to this ColorModel. If it is true, the color data will
have been multiplied with alpha.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getRedMask)ES()EA(
)PR(
public final int getRedMask\201\202
)RP(
)DL(
)DD( Returns the mask indicating which bits in a pixel contain the red
color component.
)0 P(
)LD(
o )WB()EA(
)BD(getGreenMask)ES()EA(
)PR(
public final int getGreenMask\201\202
)RP(
)DL(
)DD( Returns the mask indicating which bits in a pixel contain the green
color component.
)0 P(
)LD(
o )WB()EA(
)BD(getBlueMask)ES()EA(
)PR(
public final int getBlueMask\201\202
)RP(
)DL(
)DD( Returns the mask indicating which bits in a pixel contain the blue
color component.
)0 P(
)LD(
o )WB()EA(
)BD(getAlphaMask)ES()EA(
)PR(
public final int getAlphaMask\201\202
)RP(
)DL(
)DD( Returns the mask indicating which bits in a pixel contain the alpha
transparency component.
)0 P(
)LD(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public final int getRed\201int pixel\202
)RP(
)DL(
)DD( Returns the red color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRed)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public final int getGreen\201int pixel\202
)RP(
)DL(
)DD( Returns the green color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB. The
returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getGreen)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public final int getBlue\201int pixel\202
)RP(
)DL(
)DD( Returns the blue color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB. The
returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBlue)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public final int getAlpha\201int pixel\202
)RP(
)DL(
)DD( Return the alpha transparency value for the specified pixel in the
range 0-255.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAlpha)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public final int getRGB\201int pixel\202
)RP(
)DL(
)DD( Returns the color of the pixel in the default RGB color model.
The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRGB)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public int getRed\201int pixel[]\202
)RP(
)DL(
)DD( Returns the red
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRed)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public int getGreen\201int pixel[]\202
)RP(
)DL(
)DD( Returns the green
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getGreen)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public int getBlue\201int pixel[]\202
)RP(
)DL(
)DD( Returns the blue
color component for the specified pixel, scaled from 0 to 255 in
the default RGB ColorSpace, sRGB. The pixel is
described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBlue)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public int getAlpha\201int pixel[]\202
)RP(
)DL(
)DD( Returns the alpha color component for the specified pixel,
scaled from 0 to 255.
The pixel is described by a discrete array of
channel elements, one per channel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAlpha)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public int getRGB\201int pixels[]\202
)RP(
)DL(
)DD( Returns a pixel in the default RGB color model given a pixel array
in the current color model.
The pixel is described by a discrete array of
channel elements, one per channel. The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRGB)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(
)LD(
)LD(
o )WB()EA(
)BD(getPixel)ES()EA(
)PR(
public int[] getPixel\201int rgb,
int pixel[]\202
)RP(
)DL(
)DD( Returns a pixel array given a pixel in the default RGB color model.
This pixel array can then be passed to the putData method of
a Tile object. If the pixel variable is null, a new array will
be allocated. The pixel array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getPixel)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public final int[] getComponents\201int pixel,
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel
in the current color model. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponents)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public final int[] getComponents\201int pixel[],
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel array
in the current color model. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponents)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public final )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(coerceData)ES()EA(
)PR(
public final )A(ColorModel)EA( coerceData\201)A(Tile)EA( tile,
boolean isAlphaPremultiplied\202
)RP(
)DL(
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel. It may multiply or divide
the color Tile data by alpha, or do nothing if the data is
in the correct state. If the data needs to be coerced, this
method will also return an instance of this ColorModel with
the isAlphaPremultiplied flag set appropriately.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(coerceData)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD( Prints the contents of this object
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class )A(ColorModel)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.IndexColorModel
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.IndexColorModel
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.ColorModel)EA(
|
+----java.awt.image.IndexColorModel
)RP(
)HR(
)DL(
)DT( public class )BD(IndexColorModel)ES(
)DT( extends )A(ColorModel)EA(
)LD(
A ColorModel class that represents pixel values which are
indices into a fixed colormap in the ColorModel's color space.
An optional transparent
pixel value can be supplied which indicates a completely transparent
pixel, regardless of any alpha value recorded for that pixel value.
This color model is similar to an X11 PseudoColor visual. Note
that alpha values in IndexColorModels are never premultiplied.
)0 P(Many of the methods in this class are final. The reason for
this is that the underlying native graphics code makes assumptions
about the layout and operation of this class and those assumptions
are reflected in the implementations of the methods here that are
marked final. You can subclass this class for other reaons, but
you cannot override or modify the behaviour of those methods.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorModel)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(IndexColorModel)ES()EA(\201int, int, byte[], byte[], byte[]\202
)DD( Constructs an IndexColorModel from the given arrays of red,
green, and blue components.
)DT( o )WB(
)A()BD(IndexColorModel)ES()EA(\201int, int, byte[], byte[], byte[], byte[]\202
)DD( Constructs an IndexColorModel from the given arrays of red,
green, blue and alpha components.
)DT( o )WB(
)A()BD(IndexColorModel)ES()EA(\201int, int, byte[], byte[], byte[], int\202
)DD( Constructs an IndexColorModel from the given arrays of red,
green, and blue components.
)DT( o )WB(
)A()BD(IndexColorModel)ES()EA(\201int, int, byte[], int, boolean\202
)DD( Constructs an IndexColorModel from a single array of packed
red, green, blue and optional alpha components.
)DT( o )WB(
)A()BD(IndexColorModel)ES()EA(\201int, int, byte[], int, boolean, int\202
)DD( Constructs an IndexColorModel from a single array of packed
red, green, blue and optional alpha components.
)DT( o )WB(
)A()BD(IndexColorModel)ES()EA(\201int, int, int[], int, boolean, int\202
)DD( Constructs an IndexColorModel from an array of integers
where each integer is comprised of
red, green, blue, and optional alpha components in the default
RGB color model packing.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(coerceData)ES()EA(\201Tile, boolean\202
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel.
)DT( o )WB(
)A()BD(convertToIntDiscrete)ES()EA(\201Tile, boolean\202
)DD( Returns a new BufferedImage of TYPE_INT_ARGB or TYPE_INT_RGB that
matches the lookup tables.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)DT( o )WB(
)A()BD(getAlpha)ES()EA(\201int\202
)DD( Return the alpha transparency value for the specified pixel in the
range 0-255.
)DT( o )WB(
)A()BD(getAlphas)ES()EA(\201byte[]\202
)DD( Copies the array of alpha transparency values into the given array.
)DT( o )WB(
)A()BD(getBlue)ES()EA(\201int\202
)DD( Returns the blue color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getBlues)ES()EA(\201byte[]\202
)DD( Copies the array of blue color components into the given array.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int, int[]\202
)DD( Returns an array of all of the components given a pixel
in the current color model.
)DT( o )WB(
)A()BD(getComponents)ES()EA(\201int[], int[]\202
)DD( Returns an array of all of the components given a pixel array
in the current color model.
)DT( o )WB(
)A()BD(getComponentSize)ES()EA(\201\202
)DD( Returns an array of the number of bits per component.
)DT( o )WB(
)A()BD(getDataArray)ES()EA(\201int, byte[]\202
)DD( Copies the nth data array \201color or alpha component\202 into
the given array.
)DT( o )WB(
)A()BD(getGreen)ES()EA(\201int\202
)DD( Returns the green color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getGreens)ES()EA(\201byte[]\202
)DD( Copies the array of green color components into the given array.
)DT( o )WB(
)A()BD(getMapSize)ES()EA(\201\202
)DD( Returns the size of the color component arrays in this
IndexColorModel.
)DT( o )WB(
)A()BD(getPixel)ES()EA(\201int, int[]\202
)DD( Returns a pixel array given a pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRed)ES()EA(\201int\202
)DD( Returns the red color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
)DT( o )WB(
)A()BD(getReds)ES()EA(\201byte[]\202
)DD( Copies the array of red color components into the given array.
)DT( o )WB(
)A()BD(getRGB)ES()EA(\201int\202
)DD( Returns the color of the pixel in the default RGB color model.
)DT( o )WB(
)A()BD(getRGBs)ES()EA(\201int[]\202
)DD( Converts the arrays color and alpha components to the default
RGB ColorModel \201if necessary\202 and copies the resulting array
of 32-bit ARGB values into the given array.
)DT( o )WB(
)A()BD(getTransparency)ES()EA(\201\202
)DD( Returns the transparency.
)DT( o )WB(
)A()BD(getTransparentPixel)ES()EA(\201\202
)DD( Returns the index of the transparent pixel in this IndexColorModel
or -1 if there is no transparent pixel.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(IndexColorModel)ES(
)PR(
public IndexColorModel\201int bits,
int size,
byte r[],
byte g[],
byte b[]\202
)RP(
)DL(
)DD( Constructs an IndexColorModel from the given arrays of red,
green, and blue components. Pixels described by this color
model will all have alpha components of 255 \201fully opaque\202.
All of the arrays specifying the color components must have
at least the specified number of entries. Uses the default
sRGB ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( bits - The number of bits each pixel occupies.
)DD( size - The size of the color component arrays.
)DD( r - The array of red color components.
)DD( g - The array of green color components.
)DD( b - The array of blue color components.
)LD(
)LD(
o )WB()EA(
)BD(IndexColorModel)ES(
)PR(
public IndexColorModel\201int bits,
int size,
byte r[],
byte g[],
byte b[],
int trans\202
)RP(
)DL(
)DD( Constructs an IndexColorModel from the given arrays of red,
green, and blue components. Pixels described by this color
model will all have alpha components of 255 \201fully opaque\202,
except for the indicated transparent pixel. All of the arrays
specifying the color components must have at least the specified
number of entries. Uses the default sRGB ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( bits - The number of bits each pixel occupies.
)DD( size - The size of the color component arrays.
)DD( r - The array of red color components.
)DD( g - The array of green color components.
)DD( b - The array of blue color components.
)DD( trans - The index of the transparent pixel.
)LD(
)LD(
o )WB()EA(
)BD(IndexColorModel)ES(
)PR(
public IndexColorModel\201int bits,
int size,
byte r[],
byte g[],
byte b[],
byte a[]\202
)RP(
)DL(
)DD( Constructs an IndexColorModel from the given arrays of red,
green, blue and alpha components. All of the arrays specifying
the color components must have at least the specified number
of entries. Uses the default sRGB ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( bits - The number of bits each pixel occupies.
)DD( size - The size of the color component arrays.
)DD( r - The array of red color components.
)DD( g - The array of green color components.
)DD( b - The array of blue color components.
)DD( a - The array of alpha value components.
)LD(
)LD(
o )WB()EA(
)BD(IndexColorModel)ES(
)PR(
public IndexColorModel\201int bits,
int size,
byte cmap[],
int start,
boolean hasalpha\202
)RP(
)DL(
)DD( Constructs an IndexColorModel from a single array of packed
red, green, blue and optional alpha components. The array
must have enough values in it to fill all of the needed
component arrays of the specified size. Uses the default
sRGB ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( bits - The number of bits each pixel occupies.
)DD( size - The size of the color component arrays.
)DD( cmap - The array of color components.
)DD( start - The starting offset of the first color component.
)DD( hasalpha - Indicates whether alpha values are contained in
the cmap array.
)LD(
)LD(
o )WB()EA(
)BD(IndexColorModel)ES(
)PR(
public IndexColorModel\201int bits,
int size,
byte cmap[],
int start,
boolean hasalpha,
int trans\202
)RP(
)DL(
)DD( Constructs an IndexColorModel from a single array of packed
red, green, blue and optional alpha components. The specified
transparent index represents a pixel that will be considered
entirely transparent regardless of any alpha value specified
for it. The array must have enough values in it to fill all
of the needed component arrays of the specified size.
Uses the default sRGB ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( bits - The number of bits each pixel occupies.
)DD( size - The size of the color component arrays.
)DD( cmap - The array of color components.
)DD( start - The starting offset of the first color component.
)DD( hasalpha - Indicates whether alpha values are contained in
the cmap array.
)DD( trans - The index of the fully transparent pixel.
)LD(
)LD(
o )WB()EA(
)BD(IndexColorModel)ES(
)PR(
public IndexColorModel\201int bits,
int size,
int cmap[],
int start,
boolean hasalpha,
int trans\202
)RP(
)DL(
)DD( Constructs an IndexColorModel from an array of integers
where each integer is comprised of
red, green, blue, and optional alpha components in the default
RGB color model packing.
The specified
transparent index represents a pixel that will be considered
entirely transparent regardless of any alpha value specified
for it. The array must have enough values in it to fill all
of the needed component arrays of the specified size.
Uses the default sRGB ColorSpace.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( bits - The number of bits each pixel occupies.
)DD( size - The size of the color component arrays.
)DD( cmap - The array of color components.
)DD( start - The starting offset of the first color component.
)DD( hasalpha - Indicates whether alpha values are contained in
the cmap array.
)DD( trans - The index of the fully transparent pixel.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getTransparency)ES()EA(
)PR(
public int getTransparency\201\202
)RP(
)DL(
)DD( Returns the transparency. Returns either OPAQUE, BITMASK,
or TRANSLUCENT
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getTransparency)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(OPAQUE)EA(, )A(BITMASK)EA(, )A(TRANSLUCENT)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponentSize)ES()EA(
)PR(
public int[] getComponentSize\201\202
)RP(
)DL(
)DD( Returns an array of the number of bits per component.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponentSize)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getMapSize)ES()EA(
)PR(
public final int getMapSize\201\202
)RP(
)DL(
)DD( Returns the size of the color component arrays in this
IndexColorModel.
)0 P(
)LD(
o )WB()EA(
)BD(getTransparentPixel)ES()EA(
)PR(
public final int getTransparentPixel\201\202
)RP(
)DL(
)DD( Returns the index of the transparent pixel in this IndexColorModel
or -1 if there is no transparent pixel.
)0 P(
)LD(
o )WB()EA(
)BD(getReds)ES()EA(
)PR(
public final void getReds\201byte r[]\202
)RP(
)DL(
)DD( Copies the array of red color components into the given array. Only
the initial entries of the array as specified by getMapSize\201\202 are
written. If the color space is not sRGB, then the entries are
converted to sRGB and the red components are extracted.
)0 P(
)LD(
o )WB()EA(
)BD(getGreens)ES()EA(
)PR(
public final void getGreens\201byte g[]\202
)RP(
)DL(
)DD( Copies the array of green color components into the given array. Only
the initial entries of the array as specified by getMapSize\201\202 are
written. If the color space is not sRGB, then the entries are
converted to sRGB and the green components are extracted.
)0 P(
)LD(
o )WB()EA(
)BD(getBlues)ES()EA(
)PR(
public final void getBlues\201byte b[]\202
)RP(
)DL(
)DD( Copies the array of blue color components into the given array. Only
the initial entries of the array as specified by getMapSize\201\202 will
be written. If the color space is not sRGB, then the entries are
converted to sRGB and the green components are extracted.
)0 P(
)LD(
o )WB()EA(
)BD(getAlphas)ES()EA(
)PR(
public final void getAlphas\201byte a[]\202
)RP(
)DL(
)DD( Copies the array of alpha transparency values into the given array.
Only
the initial entries of the array as specified by getMapSize\201\202 will
be written.
)0 P(
)LD(
o )WB()EA(
)BD(getRGBs)ES()EA(
)PR(
public final void getRGBs\201int rgb[]\202
)RP(
)DL(
)DD( Converts the arrays color and alpha components to the default
RGB ColorModel \201if necessary\202 and copies the resulting array
of 32-bit ARGB values into the given array. Only
the initial entries of the array as specified by getMapSize\201\202 will
be written.
)0 P(
)LD(
o )WB()EA(
)BD(getRed)ES()EA(
)PR(
public final int getRed\201int pixel\202
)RP(
)DL(
)DD( Returns the red color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB.
The returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRed)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getGreen)ES()EA(
)PR(
public final int getGreen\201int pixel\202
)RP(
)DL(
)DD( Returns the green color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB. The
returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getGreen)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getBlue)ES()EA(
)PR(
public final int getBlue\201int pixel\202
)RP(
)DL(
)DD( Returns the blue color component for the specified pixel in the
range 0-255 in the default RGB ColorSpace, sRGB. The
returned value will be a
non pre-multiplied color \201i.e. if the alpha is premultiplied,
this method will divide it out before it is returned\202. If the
alpha value is 0, the color will be 0.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getBlue)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getAlpha)ES()EA(
)PR(
public final int getAlpha\201int pixel\202
)RP(
)DL(
)DD( Return the alpha transparency value for the specified pixel in the
range 0-255.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getAlpha)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getRGB)ES()EA(
)PR(
public final int getRGB\201int pixel\202
)RP(
)DL(
)DD( Returns the color of the pixel in the default RGB color model.
If the ColorSpace is not sRGB, it will be converted to sRGB.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getRGB)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(getRGBdefault)EA(
)LD(
)LD(
o )WB()EA(
)BD(getPixel)ES()EA(
)PR(
public int[] getPixel\201int rgb,
int pixel[]\202
)RP(
)DL(
)DD( Returns a pixel array given a pixel in the default RGB color model.
This pixel array can then be passed to the putData method of
a Tile object. If the pixel variable is null, a new array will
be allocated. The pixel array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getPixel)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201int pixel,
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel
in the current color model.
This can be used to retrieve the
components for a specific pixel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponents)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getComponents)ES()EA(
)PR(
public int[] getComponents\201int pixel[],
int components[]\202
)RP(
)DL(
)DD( Returns an array of all of the components given a pixel array
in the current color model. This can be used to retrieve the
components for a specific pixel in a PackedColorModel. If the
components array is null, a new array will be allocated. The
components array will be returned.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getComponents)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(getDataArray)ES()EA(
)PR(
public void getDataArray\201int n,
byte data_array[]\202
)RP(
)DL(
)DD( Copies the nth data array \201color or alpha component\202 into
the given array. Only the initial entries of the array as specified
by getMapSize\201\202 will be written.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a Tile with the specified width and height, that has a
channel layout compatible with this ColorModel.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(ColorModel)EA(
)DT( )BD(See Also:)ES(
)DD( )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(coerceData)ES()EA(
)PR(
public )A(ColorModel)EA( coerceData\201)A(Tile)EA( tile,
boolean isAlphaPremultiplied\202
)RP(
)DL(
)DD( Forces the Tile data to match the state specified in the
isAlphaPremultiplied variable, assuming the data is currently
correctly described by this ColorModel. It may multiply or divide
the color Tile data by alpha, or do nothing if the data is
in the correct state. If the data needs to be coerced, this
method will also return an instance of this ColorModel with
the isAlphaPremultiplied flag set appropriately.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(coerceData)EA( in class )A(ColorModel)EA(
)LD(
)LD(
o )WB()EA(
)BD(convertToIntDiscrete)ES()EA(
)PR(
public )A(BufferedImage)EA( convertToIntDiscrete\201)A(Tile)EA( tile,
boolean forceARGB\202
)RP(
)DL(
)DD( Returns a new BufferedImage of TYPE_INT_ARGB or TYPE_INT_RGB that
matches the lookup tables.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.IntegerComponentTile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.IntegerComponentTile
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.Tile)EA(
|
+----java.awt.image.IntegerComponentTile
)RP(
)HR(
)DL(
)DT( public class )BD(IntegerComponentTile)ES(
)DT( extends )A(Tile)EA(
)LD(
This class defines a tile with pixels consisting of one or more 32-bit
channels stored in close proximity to each other in a integer array.
The bit precision per channel element is that
of the data type \201that is, the bit precision for this tile is 32\202.
There is only one pixel stride and one scanline stride for all
channels. This type of tile can be used with a
ComponentColorModel if there are multiple channels, or a
PackedColorModel \201including a DirectColorModel\202 if there is only
one channel.
)0 P(
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(IntegerComponentTile)ES()EA(\201int, int, int, int, int, int, int[]\202
)DD( Constructs a base tile with 1 channel and a pixel stride of 1.
)DT( o )WB(
)A()BD(IntegerComponentTile)ES()EA(\201int, int, int, int, int, int[], int, int, int[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)DT( o )WB(
)A()BD(IntegerComponentTile)ES()EA(\201int, int, int, int[], int, int, int[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getChannelOffset)ES()EA(\201int\202
)DD( Returns channel offset for the specified channel.
)DT( o )WB(
)A()BD(getChannelOffsets)ES()EA(\201\202
)DD( Returns a copy of the channel offsets array.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel elements for all channels at the specified
location.
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns a reference to the entire data array
)DT( o )WB(
)A()BD(getPixelStride)ES()EA(\201\202
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)DT( o )WB(
)A()BD(getScanlineStride)ES()EA(\201\202
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)DT( o )WB(
)A()BD(print)ES()EA(\201int, int, int, int\202
)DD( For debugging...
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(IntegerComponentTile)ES(
)PR(
public IntegerComponentTile\201int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
int data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
The tile data will start at x=0, y=0 in the data array of each
channel.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
width and height.
)LD(
)LD(
o )WB()EA(
)BD(IntegerComponentTile)ES(
)PR(
public IntegerComponentTile\201int x,
int y,
int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
int data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
o )WB()EA(
)BD(IntegerComponentTile)ES(
)PR(
public IntegerComponentTile\201int x,
int y,
int width,
int height,
int channelOffset,
int scanlineStride,
int data[]\202
)RP(
)DL(
)DD( Constructs a base tile with 1 channel and a pixel stride of 1.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( channelOffset - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getChannelOffsets)ES()EA(
)PR(
public int[] getChannelOffsets\201\202
)RP(
)DL(
)DD( Returns a copy of the channel offsets array.
)0 P(
)LD(
o )WB()EA(
)BD(getChannelOffset)ES()EA(
)PR(
public int getChannelOffset\201int channel\202
)RP(
)DL(
)DD( Returns channel offset for the specified channel. The channel offset
is the index into the channel data array
in which the first channel element of the first scanline is stored.
)0 P(
)LD(
o )WB()EA(
)BD(getScanlineStride)ES()EA(
)PR(
public int getScanlineStride\201\202
)RP(
)DL(
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelStride)ES()EA(
)PR(
public int getPixelStride\201\202
)RP(
)DL(
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public int[] getDataStorage\201\202
)RP(
)DL(
)DD( Returns a reference to the entire data array
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel elements for all channels at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel elements for all channels
at the specified location are returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
int[] pixel = new int[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DD( inData - Channel element.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayIndexOutOfBoundsException will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the channels of the parent tile may
be specified. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Parameters that are guaranteed to remain the same are:
)UL(
)LI( number of channels
)LI( pixel stride
)LU(
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays. If
the tile is a subtile, this will call
createCompatibleTile\201width, height\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
o )WB()EA(
)BD(print)ES()EA(
)PR(
public void print\201int x,
int y,
int w,
int h\202
)RP(
)DL(
)DD( For debugging... prints a region of a one-band IntegerComponentTile
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.Kernel
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.Kernel
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.Kernel
)RP(
)HR(
)DL(
)DT( public class )BD(Kernel)ES(
)DT( extends Object
)LD(
This class defines a Kernel object. A kernel is a matrix describing
how a given pixel and its surrounding pixels affect the value of the
given pixel in a filtering operation.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ConvolveOp)EA(
)LD(
)HR(
)EA(
)0 2 H(
Variable Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(SHARPEN3x3_1)ES()EA(
)DD( 3x3 Sharpening kernel:)PR(
-1 -1 -1
-1 9 -1
-1 -1 -1)RP(
)DT( o )WB(
)A()BD(SHARPEN3x3_2)ES()EA(
)DD( 3x3 Sharpening kernel:)PR(
1 -2 1
-2 5 -2
1 -2 1)RP(
)DT( o )WB(
)A()BD(SHARPEN3x3_3)ES()EA(
)DD( 3x3 Sharpening kernel:)PR(
0 -1 0
-1 5 -1
0 -1 0)RP(
)LD(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Kernel)ES()EA(\201int, int, int, int, float[]\202
)DD( Create a Kernel object from an array of floats.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height
)DT( o )WB(
)A()BD(getKernelData)ES()EA(\201float[]\202
)DD( Returns the kernel data in row major order.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width
)DT( o )WB(
)A()BD(getXOrigin)ES()EA(\201\202
)DD( Returns the X origin.
)DT( o )WB(
)A()BD(getYOrigin)ES()EA(\201\202
)DD( Returns the Y origin.
)LD(
)EA(
)0 2 H(
Variables )WB(
)EH(
o )WB()EA(
)BD(SHARPEN3x3_1)ES(
)PR(
public static final float SHARPEN3x3_1[]
)RP(
)DL(
)DD( 3x3 Sharpening kernel:)PR(
-1 -1 -1
-1 9 -1
-1 -1 -1)RP()0 P(
)LD(
o )WB()EA(
)BD(SHARPEN3x3_2)ES(
)PR(
public static final float SHARPEN3x3_2[]
)RP(
)DL(
)DD( 3x3 Sharpening kernel:)PR(
1 -2 1
-2 5 -2
1 -2 1)RP()0 P(
)LD(
o )WB()EA(
)BD(SHARPEN3x3_3)ES(
)PR(
public static final float SHARPEN3x3_3[]
)RP(
)DL(
)DD( 3x3 Sharpening kernel:)PR(
0 -1 0
-1 5 -1
0 -1 0)RP()0 P(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Kernel)ES(
)PR(
public Kernel\201int width,
int height,
int xOrigin,
int yOrigin,
float data[]\202
)RP(
)DL(
)DD( Create a Kernel object from an array of floats. The data array
is copied.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width of the kernel.
)DD( height - Height of the kernel.
)DD( xOrigin - X origin of the kernel \201usually the center\202
with respect to the upper-left corner.
)DD( yOrigin - Y origin of the kernel \201usually the center\202
with respect to the upper-left corner.
)DD( data - Kernel data in row major order.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getXOrigin)ES()EA(
)PR(
public int getXOrigin\201\202
)RP(
)DL(
)DD( Returns the X origin.
)0 P(
)LD(
o )WB()EA(
)BD(getYOrigin)ES()EA(
)PR(
public int getYOrigin\201\202
)RP(
)DL(
)DD( Returns the Y origin.
)0 P(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public int getWidth\201\202
)RP(
)DL(
)DD( Returns the width
)0 P(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public int getHeight\201\202
)RP(
)DL(
)DD( Returns the height
)0 P(
)LD(
o )WB()EA(
)BD(getKernelData)ES()EA(
)PR(
public float[] getKernelData\201float data[]\202
)RP(
)DL(
)DD( Returns the kernel data in row major order.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( data - If non-null, will contain the returned kernel data.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.LookupOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.LookupOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.LookupOp
)RP(
)HR(
)DL(
)DT( public class )BD(LookupOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)LD(
This class implements a lookup operation from the source
to the destination. The LookupTable object may contain a single array
or multiple arrays, subject to the restrictions below.
)0 P(
For Tiles, the lookup operates on channel elements. The number of
lookup arrays may be one, in which case the same array is
applied to all channels, or it must equal the number of Source
tile channels.
)0 P(
For BufferedImages, the lookup operates on color and alpha components.
The number of lookup arrays may be one, in which case the
same array is applied to all color and alpha components, or it
must equal the number of Source color components, in which case no
lookup of the alpha component \201if present\202 is performed, or it
must equal the number of Source color components plus alpha components,
in which case lookup is performed for all color and alpha components.
This allows non-uniform rescaling of multi-channelled BufferedImages.
)0 P(
This class allows the Source to be the same as Destination.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(LookupTable)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(LookupOp)ES()EA(\201LookupTable\202
)DD( Constructs a LookupOp object given the lookup table.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number of
channels.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number of
channels.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Performs a lookup operation on a BufferedImage.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Performs a lookup operation on a Tile.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the destination.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the destination.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getLookupTable)ES()EA(\201\202
)DD( Returns the LookupTable.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(LookupOp)ES(
)PR(
public LookupOp\201)A(LookupTable)EA( lookup\202
)RP(
)DL(
)DD( Constructs a LookupOp object given the lookup table.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getLookupTable)ES()EA(
)PR(
public )A(LookupTable)EA( getLookupTable\201\202
)RP(
)DL(
)DD( Returns the LookupTable.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dst\202
)RP(
)DL(
)DD( Performs a lookup operation on a BufferedImage.
If the color model in the source image is not the same as that
in the destination image, the pixels will be converted
in the destination. If the destination image is null,
a BufferedImage will be created with the source ColorModel.
The IllegalArgumentException may be thrown if the number of
arrays in the LookupTable does not meet the restrictions
stated in the class comment above.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dst\202
)RP(
)DL(
)DD( Performs a lookup operation on a Tile. If the destination Tile is
null, a new Tile will be created.
The IllegalArgumentException may be thrown if the source and
destination tiles have different number of channels or if
the number of arrays in the LookupTable does not meet the
restrictions stated in the class comment above.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the destination. Since
this is not a geometric operation, the bounding box does not
change.
The IllegalArgumentException may be thrown if the number of
arrays in the LookupTable does not meet the restrictions
stated in the class comment above.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the destination. Since
this is not a geometric operation, the bounding box does not
change.
The IllegalArgumentException may be thrown if the number of
arrays in the LookupTable does not meet the restrictions
stated in the class comment above.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number of
channels.
The IllegalArgumentException may be thrown if the number of
arrays in the LookupTable does not meet the restrictions
stated in the class comment above.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation.
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number of
channels.
The IllegalArgumentException may be thrown if the number of
arrays in the LookupTable does not meet the restrictions
stated in the class comment above.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value. Since this is not a geometric
operation, the srcPt will equal the dstPt.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.NearestNeighborAffineTransformOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.NearestNeighborAffineTransformOp
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.AffineTransformOp)EA(
|
+----java.awt.image.NearestNeighborAffineTransformOp
)RP(
)HR(
)DL(
)DT( public class )BD(NearestNeighborAffineTransformOp)ES(
)DT( extends )A(AffineTransformOp)EA(
)LD(
This class uses an affine transformation with nearest neighbor interpolation
to transform an image or tile.
)0 P(
Note that the following constraints have to be met:
)LI(Source and Destination must be different.
)LI(For Tiles, the number of Channels in the Source must be equal
to the number of Channels in the Destination.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(NearestNeighborAffineTransformOp)ES()EA(\201AffineTransform\202
)DD( Constructs a NearestNeighborAffineTransformOp given an affine
transform.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Transforms the BufferedImage using the stored affine transform.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Transforms the Tile using the stored affine transform.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(NearestNeighborAffineTransformOp)ES(
)PR(
public NearestNeighborAffineTransformOp\201)A(AffineTransform)EA( xform\202
)RP(
)DL(
)DD( Constructs a NearestNeighborAffineTransformOp given an affine
transform.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dst\202
)RP(
)DL(
)DD( Transforms the BufferedImage using the stored affine transform.
If the color models for the two images do not match, a color
conversion into the destination color model will be performed.
If the destination image is null,
a BufferedImage will be created with the source ColorModel.
The IllegalArgumentException may be thrown if the source is
the same as the destination.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(filter)EA( in class )A(AffineTransformOp)EA(
)LD(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( Transforms the Tile using the stored affine transform.
This operation will perform the transform channel by channel.
If the destination Tile is null, a new Tile will be created.
The IllegalArgumentException may be thrown if the source is
the same as the destination or if the number of channels in
the source is not equal to the number of channels in the
destination.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(filter)EA( in class )A(AffineTransformOp)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.PackedColorModel
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.PackedColorModel
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.ColorModel)EA(
|
+----java.awt.image.PackedColorModel
)RP(
)HR(
)DL(
)DT( public abstract class )BD(PackedColorModel)ES(
)DT( extends )A(ColorModel)EA(
)DT( super class of:
)DD( )A(DirectColorModel)EA(
)LD(
An abstract ColorModel class that represents pixel values
that have the color components embedded directly in the bits of an
integer pixel. A subclass is the DirectColorModel, which
is similar to an X11 TrueColor visual.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(DirectColorModel)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(PackedColorModel)ES()EA(\201ColorSpace, int, int, int, int, int, boolean, int\202
)DD( Constructs a PackedColorModel from the given masks specifying
which bits in the pixel contain the alpha, red, green and blue
color components.
)DT( o )WB(
)A()BD(PackedColorModel)ES()EA(\201ColorSpace, int, int[], int, boolean, int\202
)DD( Constructs a PackedColorModel from a mask array, which specifies
which bits in the integer pixel contain each of the color
components in the ColorSpace.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(equals)ES()EA(\201Object\202
)DD(
)DT( o )WB(
)A()BD(getMask)ES()EA(\201int\202
)DD( Returns the mask indicating which bits in a pixel contain the
color component.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(PackedColorModel)ES(
)PR(
public PackedColorModel\201)A(ColorSpace)EA( space,
int bits,
int colorMaskArray[],
int alphaMask,
boolean isAlphaPremultiplied,
int trans\202
)RP(
)DL(
)DD( Constructs a PackedColorModel from a mask array, which specifies
which bits in the integer pixel contain each of the color
components in the ColorSpace. All of the bits in each mask
must be contiguous and fit in the specified number of least
significant bits of the integer. If the alphaMask is 0,
there is no alpha. If there is alpha, the boolean,
isAlphaPremultiplied, specifies how to interpret color data that
are passed to this ColorModel. If it is true, the color data will
have been multiplied with alpha.
)0 P(
)LD(
o )WB()EA(
)BD(PackedColorModel)ES(
)PR(
public PackedColorModel\201)A(ColorSpace)EA( space,
int bits,
int rmask,
int gmask,
int bmask,
int amask,
boolean isAlphaPremultiplied,
int trans\202
)RP(
)DL(
)DD( Constructs a PackedColorModel from the given masks specifying
which bits in the pixel contain the alpha, red, green and blue
color components. All of the bits in each mask must be contiguous
and fit in the specified number of least significant bits of the
integer. The boolean,
isAlphaPremultiplied, specifies how to interpret color data that
are passed to this ColorModel. If it is true, the color data will
have been multiplied with alpha.
The ColorSpace should be of type ColorSpace.TYPE_RGB.
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(ColorSpace)EA(
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getMask)ES()EA(
)PR(
public int getMask\201int index\202
)RP(
)DL(
)DD( Returns the mask indicating which bits in a pixel contain the
color component. The index corresponds to the placement of
color component names in the color space. Thus, index 0 for
a CMYK ColorSpace would correspond to Cyan and index 1 would
correspond to Magenta. If there is alpha, the alpha index
would be:
)PR(
alphaIndex = numComponents\201\202 - 1;
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(equals)ES()EA(
)PR(
public boolean equals\201Object obj\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(equals)EA( in class )A(ColorModel)EA(
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.RescaleOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.RescaleOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.RescaleOp
)RP(
)HR(
)DL(
)DT( public class )BD(RescaleOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)LD(
This class performs a pixel-by-pixel rescaling of the data in
the source image by multiplying each pixel value by a scale factor
and then adding an offset. The pixel values are clipped to the
minimum/maximum of the destination image data type.
)0 P(
For Tiles, rescaling operates on channel elements. The number of
sets of scaling constants may be one, in which case the same constants
are applied to all channels, or it must equal the number of Source
tile channels.
)0 P(
For BufferedImages, rescaling operates on color and alpha components.
The number of sets of scaling constants may be one, in which case the
same constants are applied to all color and alpha components, or it
must equal the number of Source color components, in which case no
scaling of the alpha component \201if present\202 is performed, or it
must equal the number of Source color components plus alpha components,
in which case all color and alpha components are scaled.
)0 P(
The pseudo code for the rescaling operation is as follows:
)PR(
for each pixel from Source object {
for each channel/component of the pixel {
dstElement = \201srcElement*scaleFactor\202 + offset
}
}
)RP(
Note that in-place operation is allowed \201i.e. the source and destination can
be the same object\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(RescaleOp)ES()EA(\201float, float\202
)DD( Constructs a new RescaleOp with the desired scale factor
and offset.
)DT( o )WB(
)A()BD(RescaleOp)ES()EA(\201float[], float[]\202
)DD( Constructs a new RescaleOp with the desired scale factors
and offsets.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number of
channels.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number
of channels.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Rescales the BufferedImage.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Rescales the channel data in the Tile.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the rescaled destination.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the rescaled destination.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getNumFactors)ES()EA(\201\202
)DD( Returns the number of scaling factors used in this object.
)DT( o )WB(
)A()BD(getOffsets)ES()EA(\201float[]\202
)DD( Returns the offsets in the given array.
)DT( o )WB(
)A()BD(getScaleFactors)ES()EA(\201float[]\202
)DD(
Returns the scale factors in the given array.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(RescaleOp)ES(
)PR(
public RescaleOp\201float scaleFactors[],
float offsets[]\202
)RP(
)DL(
)DD( Constructs a new RescaleOp with the desired scale factors
and offsets. The length of the scaleFactor and offset arrays
must meet the restrictions stated in the class comments above.
)0 P(
)LD(
o )WB()EA(
)BD(RescaleOp)ES(
)PR(
public RescaleOp\201float scaleFactor,
float offset\202
)RP(
)DL(
)DD( Constructs a new RescaleOp with the desired scale factor
and offset. The scaleFactor and offset will be applied to
all channels/components in the source Tile/BufferedImage.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getScaleFactors)ES()EA(
)PR(
public float[] getScaleFactors\201float scaleFactors[]\202
)RP(
)DL(
)DD( Returns the scale factors in the given array. The array is also
returned for convenience.
)0 P(
)LD(
o )WB()EA(
)BD(getOffsets)ES()EA(
)PR(
public float[] getOffsets\201float offsets[]\202
)RP(
)DL(
)DD( Returns the offsets in the given array. The array is also returned
for convenience.
)0 P(
)LD(
o )WB()EA(
)BD(getNumFactors)ES()EA(
)PR(
public int getNumFactors\201\202
)RP(
)DL(
)DD( Returns the number of scaling factors used in this object.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dst\202
)RP(
)DL(
)DD( Rescales the BufferedImage.
If the color model in the source image is not the same as that
in the destination image, the pixels will be converted
in the destination. If the destination image is null,
a BufferedImage will be created with the source ColorModel.
Note that the number of scaling factors in this object must
meet the restrictions stated in the class comments above.
Otherwise, an exception is thrown.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( Rescales the channel data in the Tile.
If the destination Tile is null, a new Tile will be created.
The source and destination must have the same number of channels.
Otherwise, an exception is thrown.
Note that the number of scaling factors in this object must
meet the restrictions stated in the class comments above.
Otherwise, an exception is thrown.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the rescaled destination. Since
this is not a geometric operation, the bounding box does not
change. Note that the number of scaling factors in this object must
meet the restrictions stated in the class comments above.
Otherwise, an exception is thrown.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the rescaled destination. Since
this is not a geometric operation, the bounding box does not
change. Note that the number of scaling factors in this object must
meet the restrictions stated in the class comments above.
Otherwise, an exception is thrown.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number of
channels.
Note that the number of scaling factors in this object must
meet the restrictions stated in the class comments above.
Otherwise, an exception is thrown.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation.
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number
of channels.
Note that the number of scaling factors in this object must
meet the restrictions stated in the class comments above.
Otherwise, an exception is thrown.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value. Since this is not a geometric
operation, the srcPt will equal the dstPt.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ShortBandedTile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ShortBandedTile
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.Tile)EA(
|
+----java.awt.image.ShortBandedTile
)RP(
)HR(
)DL(
)DT( public class )BD(ShortBandedTile)ES(
)DT( extends )A(Tile)EA(
)LD(
This class defines a tile with pixels consisting of multiple 16-bit
component stored in separate arrays for each component. Operations on
sets of pixels are performed on a given component of each pixel
in the set before moving on to the next component. The arrays used
for storage may be distinct or shared between some or all of
the components.
There is only one pixel stride and one scanline stride for all
channels. This type of tile can be used with a
ComponentColorModel.
)0 P(
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ShortBandedTile)ES()EA(\201int, int, int, int, int, int[], int, int, short[][]\202
)DD( Constructs a base tile given the tile parameters.
)DT( o )WB(
)A()BD(ShortBandedTile)ES()EA(\201int, int, int, int[], int, int, short[][]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getChannelOffset)ES()EA(\201int\202
)DD( Returns channel offset for the specified channel.
)DT( o )WB(
)A()BD(getChannelOffsets)ES()EA(\201\202
)DD( Returns a copy of the channel offsets array.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel elements for all channels at the specified
location.
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns a reference to the entire data array
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201int\202
)DD( Returns a reference to the specific channel data array
)DT( o )WB(
)A()BD(getPixelStride)ES()EA(\201\202
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)DT( o )WB(
)A()BD(getScanlineStride)ES()EA(\201\202
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)DT( o )WB(
)A()BD(getShortData)ES()EA(\201int, int, int, int, int, short[]\202
)DD( Returns a short integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getShortData)ES()EA(\201int, int, int, int, short[]\202
)DD( Returns a short integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(putShortData)ES()EA(\201int, int, int, int, int, short[]\202
)DD( Stores a short integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putShortData)ES()EA(\201int, int, int, int, short[]\202
)DD( Stores a short integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ShortBandedTile)ES(
)PR(
public ShortBandedTile\201int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
short data[][]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
The tile data will start at x=0, y=0 in the data array of each
channel.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
width and height.
)LD(
)LD(
o )WB()EA(
)BD(ShortBandedTile)ES(
)PR(
public ShortBandedTile\201int x,
int y,
int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
short data[][]\202
)RP(
)DL(
)DD( Constructs a base tile given the tile parameters.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffset - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getChannelOffsets)ES()EA(
)PR(
public int[] getChannelOffsets\201\202
)RP(
)DL(
)DD( Returns a copy of the channel offsets array.
)0 P(
)LD(
o )WB()EA(
)BD(getChannelOffset)ES()EA(
)PR(
public int getChannelOffset\201int channel\202
)RP(
)DL(
)DD( Returns channel offset for the specified channel. The channel offset
is the index into the channel data array
in which the first channel element of the first scanline is stored.
)0 P(
)LD(
o )WB()EA(
)BD(getScanlineStride)ES()EA(
)PR(
public int getScanlineStride\201\202
)RP(
)DL(
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelStride)ES()EA(
)PR(
public int getPixelStride\201\202
)RP(
)DL(
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public short[][] getDataStorage\201\202
)RP(
)DL(
)DD( Returns a reference to the entire data array
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public short[] getDataStorage\201int channel\202
)RP(
)DL(
)DD( Returns a reference to the specific channel data array
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel elements for all channels at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel elements for all channels
at the specified location are returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
int[] pixel = new int[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getShortData)ES()EA(
)PR(
public short[] getShortData\201int x,
int y,
int w,
int h,
int channel,
short outData[]\202
)RP(
)DL(
)DD( Returns a short integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
short[] channelData = tile.getShortData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
short chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(getShortData)ES()EA(
)PR(
public short[] getShortData\201int x,
int y,
int w,
int h,
short outData[]\202
)RP(
)DL(
)DD( Returns a short integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
short[] channelData = tile.getShortData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
short[] pixel = new short[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DD( inData - Channel element.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putShortData)ES()EA(
)PR(
public void putShortData\201int x,
int y,
int w,
int h,
int channel,
short inData[]\202
)RP(
)DL(
)DD( Stores a short integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putShortData)ES()EA(
)PR(
public void putShortData\201int x,
int y,
int w,
int h,
short inData[]\202
)RP(
)DL(
)DD( Stores a short integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the parent tile's channels may be
specified. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Parameters that are guaranteed to remain the same are:
)UL(
)LI( number of channels
)LI( pixel stride
)LU(
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays. If
the tile is a subtile, this will call
createCompatibleTile\201width, height\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ShortComponentTile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ShortComponentTile
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.Tile)EA(
|
+----java.awt.image.ShortComponentTile
)RP(
)HR(
)DL(
)DT( public class )BD(ShortComponentTile)ES(
)DT( extends )A(Tile)EA(
)LD(
This class defines a tile with pixels consisting of one or more 16-bit
channels stored in close proximity to each other in a short integer array.
The bit precision per channel element is that
of the data type \201that is, the bit precision for this tile is 16\202.
There is only one pixel stride and one scanline stride for all
channels. This type of tile can be used with a
ComponentColorModel if there are multiple channels, or a
IndexColorModel if there is only one channel.
)0 P(
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ShortComponentTile)ES()EA(\201int, int, int, int, int, int, short[]\202
)DD( Constructs a base tile with 1 channel and a pixel stride of 1.
)DT( o )WB(
)A()BD(ShortComponentTile)ES()EA(\201int, int, int, int, int, int[], int, int, short[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)DT( o )WB(
)A()BD(ShortComponentTile)ES()EA(\201int, int, int, int[], int, int, short[]\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getChannelOffset)ES()EA(\201int\202
)DD( Returns channel offset for the specified channel.
)DT( o )WB(
)A()BD(getChannelOffsets)ES()EA(\201\202
)DD( Returns a copy of the channel offsets array.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel elements for all channels at the specified
location.
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns a reference to the entire data array
)DT( o )WB(
)A()BD(getPixelStride)ES()EA(\201\202
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)DT( o )WB(
)A()BD(getScanlineStride)ES()EA(\201\202
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)DT( o )WB(
)A()BD(getShortData)ES()EA(\201int, int, int, int, int, short[]\202
)DD( Returns a short integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getShortData)ES()EA(\201int, int, int, int, short[]\202
)DD( Returns a short integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(putShortData)ES()EA(\201int, int, int, int, int, short[]\202
)DD( Stores a short integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putShortData)ES()EA(\201int, int, int, int, short[]\202
)DD( Stores a short integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(toString)ES()EA(\201\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ShortComponentTile)ES(
)PR(
public ShortComponentTile\201int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
short data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
The tile data will start at x=0, y=0 in the data array of each
channel.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
width and height.
)LD(
)LD(
o )WB()EA(
)BD(ShortComponentTile)ES(
)PR(
public ShortComponentTile\201int x,
int y,
int width,
int height,
int numChannels,
int channelOffsets[],
int pixelStride,
int scanlineStride,
short data[]\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( numChannels - Number of channels in this tile.
)DD( channelOffsets - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( pixelStride - Number of data array elements between two
channel elements for the same channel on the same scanline.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
o )WB()EA(
)BD(ShortComponentTile)ES(
)PR(
public ShortComponentTile\201int x,
int y,
int width,
int height,
int channelOffset,
int scanlineStride,
short data[]\202
)RP(
)DL(
)DD( Constructs a base tile with 1 channel and a pixel stride of 1.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( channelOffset - Index into the channel data array in which the
first channel element of the first scanline of this channel is stored.
)DD( scanlineStride - Number of data array elements between a given
channel element and the channel element in the same column of the
next row.
)DD( data - The data array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getChannelOffsets)ES()EA(
)PR(
public int[] getChannelOffsets\201\202
)RP(
)DL(
)DD( Returns a copy of the channel offsets array.
)0 P(
)LD(
o )WB()EA(
)BD(getChannelOffset)ES()EA(
)PR(
public int getChannelOffset\201int channel\202
)RP(
)DL(
)DD( Returns channel offset for the specified channel. The channel offset
is the index into the channel data array
in which the first channel element of the first scanline is stored.
)0 P(
)LD(
o )WB()EA(
)BD(getScanlineStride)ES()EA(
)PR(
public int getScanlineStride\201\202
)RP(
)DL(
)DD( Returns the scanline stride -- the number of data array elements between
a given channel element and the channel element in the same column
of the next row.
)0 P(
)LD(
o )WB()EA(
)BD(getPixelStride)ES()EA(
)PR(
public int getPixelStride\201\202
)RP(
)DL(
)DD( Returns pixel stride -- the number of data array elements between two
channel elements for the same channel on the same scanline.
)0 P(
)LD(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public short[] getDataStorage\201\202
)RP(
)DL(
)DD( Returns a reference to the entire data array
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel elements for all channels at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel elements for all channels
at the specified location are returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
int[] pixel = new int[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(getData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(getShortData)ES()EA(
)PR(
public short[] getShortData\201int x,
int y,
int w,
int h,
int channel,
short outData[]\202
)RP(
)DL(
)DD( Returns a short integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
short[] channelData = tile.getShortData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
short chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(getShortData)ES()EA(
)PR(
public short[] getShortData\201int x,
int y,
int w,
int h,
short outData[]\202
)RP(
)DL(
)DD( Returns a short integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
short[] channelData = tile.getShortData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
short[] pixel = new short[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DD( inData - Channel element.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements for all channels.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(putData)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(putShortData)ES()EA(
)PR(
public void putShortData\201int x,
int y,
int w,
int h,
int channel,
short inData[]\202
)RP(
)DL(
)DD( Stores a short integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putShortData)ES()EA(
)PR(
public void putShortData\201int x,
int y,
int w,
int h,
short inData[]\202
)RP(
)DL(
)DD( Stores a short integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the channels of the parent tile may
be specified. Note that the subtile will reference the same
channel objects as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width \201in pixels\202 of the subtile
)DD( height - Height \201in pixels\202 of the subtile
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)DT( )BD(Overrides:)ES(
)DD( )A(createSubtile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Parameters that are guaranteed to remain the same are:
)UL(
)LI( number of channels
)LI( pixel stride
)LU(
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays. If
the tile is a subtile, this will call
createCompatibleTile\201width, height\202.
)0 P(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(createCompatibleTile)EA( in class )A(Tile)EA(
)LD(
)LD(
o )WB()EA(
)BD(toString)ES()EA(
)PR(
public String toString\201\202
)RP(
)DL(
)DD()DL(
)DT( )BD(Overrides:)ES(
)DD( )A(toString)EA( in class Object
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ShortLookupTable
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ShortLookupTable
)EH(
)PR(
java.lang.Object
|
+----)A(java.awt.image.LookupTable)EA(
|
+----java.awt.image.ShortLookupTable
)RP(
)HR(
)DL(
)DT( public class )BD(ShortLookupTable)ES(
)DT( extends )A(LookupTable)EA(
)LD(
This class defines a lookup table object. The lookup table
contains short data for one or more tile channels or image components
\201for example, separate arrays for R, G, and B\202,
and it contains an offset which will be subtracted from the
input value before indexing the array. This allows an array
smaller than the native data size to be constructed for a
constrained input. If there is only one array in the lookup
table, it will be applied to all channels.
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(ByteLookupTable)EA(, )A(LookupOp)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ShortLookupTable)ES()EA(\201int, short[]\202
)DD( Creates a LookupTable object from an array
of short ints representing a lookup table for each tile
channel.
)DT( o )WB(
)A()BD(ShortLookupTable)ES()EA(\201int, short[][]\202
)DD( Creates a LookupTable object from an array of short
int arrays representing a lookup table for each tile
channel.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(getDataStorage)ES()EA(\201\202
)DD( Returns the lookup table data.
)DT( o )WB(
)A()BD(lookupPixel)ES()EA(\201int[], int[]\202
)DD( Returns an array of components of a pixel, translated with the lookup
table.
)DT( o )WB(
)A()BD(lookupPixel)ES()EA(\201short[], short[]\202
)DD( Returns an array of components of a pixel, translated with the lookup
table.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ShortLookupTable)ES(
)PR(
public ShortLookupTable\201int offset,
short data[][]\202
)RP(
)DL(
)DD( Creates a LookupTable object from an array of short
int arrays representing a lookup table for each tile
channel. The offset will be subtracted from the input
value before indexing into the arrays. The number of
components is the length of the data argument. The
data array for each component is stored as a reference.
)0 P(
)LD(
o )WB()EA(
)BD(ShortLookupTable)ES(
)PR(
public ShortLookupTable\201int offset,
short data[]\202
)RP(
)DL(
)DD( Creates a LookupTable object from an array
of short ints representing a lookup table for each tile
channel. The offset will be subtracted from the input
value before indexing into the array. The number of
components is one. The data is copied to internal tables.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getDataStorage)ES()EA(
)PR(
public short[][] getDataStorage\201\202
)RP(
)DL(
)DD( Returns the lookup table data.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( LookupTable data array.
)LD(
)LD(
o )WB()EA(
)BD(lookupPixel)ES()EA(
)PR(
public int[] lookupPixel\201int src[],
int dst[]\202
)RP(
)DL(
)DD( Returns an array of components of a pixel, translated with the lookup
table. The source and destination can be equal. If dst is null,
a new array will be allocated. The dst array is returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( an int array of components.
)DT( )BD(Overrides:)ES(
)DD( )A(lookupPixel)EA( in class )A(LookupTable)EA(
)LD(
)LD(
o )WB()EA(
)BD(lookupPixel)ES()EA(
)PR(
public short[] lookupPixel\201short src[],
short dst[]\202
)RP(
)DL(
)DD( Returns an array of components of a pixel, translated with the lookup
table. The source and destination can be equal. If dst is null,
a new array will be allocated. The dst array is returned.
)0 P(
)DD()DL(
)DT( )BD(Returns:)ES(
)DD( a byte array of components.
)LD(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.ThresholdOp
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.ThresholdOp
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.ThresholdOp
)RP(
)HR(
)DL(
)DT( public class )BD(ThresholdOp)ES(
)DT( extends Object
)DT( implements )A(BufferedImageOp)EA(, )A(TileOp)EA(
)LD(
This class performs thresholding on the source image by mapping
the value of each image component \201for BufferedImages\202 or
channel element \201for Tiles\202 that falls between a low and
a high value, to a constant.
)0 P(
For Tiles, the number of sets of threshold constants may be one, in which
case the same constants are applied to all channels, or it must equal
the number of Source tile channels.
)0 P(
For BufferedImages, the number of sets of threshold constants may be
one, in which case the same constants are applied to all color and
alpha components, or it must equal the number of Source color components,
in which case no thresholding of the alpha component \201if present\202 is
performed, or it must equal the number of Source color components plus
alpha components, in which case all color and alpha components are
thresholded.
)0 P(
The pseudo code for the thresholding operation is as follows:
)PR(
for each pixel from Source object {
for each channel/component of the pixel {
if \201useLow\202 {
if \201srcElement <= thresholdValue\202 {
destElement = lowValue;
}
}
if \201useHigh\202 {
if \201srcElement > thresholdValue\202 {
destElement = highValue;
}
}
}
}
)RP(
Note that in-place operation is allowed \201i.e. the source and destination can
be the same object\202.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(ThresholdOp)ES()EA(\201float, float, float\202
)DD( Constructs a new ThresholdOp with the desired mapping.
)DT( o )WB(
)A()BD(ThresholdOp)ES()EA(\201float, float[], float[]\202
)DD( Constructs a new ThresholdOp with the desired per channel/component
mappings.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleDestImage)ES()EA(\201BufferedImage, ColorModel\202
)DD( Creates an empty destination image with the correct size and number of
channels.
)DT( o )WB(
)A()BD(createCompatibleDestTile)ES()EA(\201Tile\202
)DD( Creates an empty destination tile with the correct size and number
of channels.
)DT( o )WB(
)A()BD(filter)ES()EA(\201BufferedImage, BufferedImage\202
)DD( Performs thresholding on the BufferedImage.
)DT( o )WB(
)A()BD(filter)ES()EA(\201Tile, Tile\202
)DD( Performs thresholding on the Tile.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201BufferedImage\202
)DD( Returns the bounding box of the thresholded destination.
)DT( o )WB(
)A()BD(getDestBounds)ES()EA(\201Tile\202
)DD( Returns the bounding box of the thresholded destination.
)DT( o )WB(
)A()BD(getDestPoint)ES()EA(\201Point2D, Point2D\202
)DD( Returns the location of the destination point given a
point in the source image.
)DT( o )WB(
)A()BD(getHighs)ES()EA(\201\202
)DD( Returns the high value array.
)DT( o )WB(
)A()BD(getLows)ES()EA(\201\202
)DD( Returns the low value array.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(ThresholdOp)ES(
)PR(
public ThresholdOp\201float threshold,
float low[],
float high[]\202
)RP(
)DL(
)DD( Constructs a new ThresholdOp with the desired per channel/component
mappings. The number of sets of mapping constants is subject
to the restrictions given in the class comments above.
)0 P(
)LD(
o )WB()EA(
)BD(ThresholdOp)ES(
)PR(
public ThresholdOp\201float threshold,
float low,
float high\202
)RP(
)DL(
)DD( Constructs a new ThresholdOp with the desired mapping. The same set
of thresholding constants will be applied to all channels/components
of the Tile/BufferedImage.
)0 P(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getLows)ES()EA(
)PR(
public float[] getLows\201\202
)RP(
)DL(
)DD( Returns the low value array. Can be null.
)0 P(
)LD(
o )WB()EA(
)BD(getHighs)ES()EA(
)PR(
public float[] getHighs\201\202
)RP(
)DL(
)DD( Returns the high value array.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(BufferedImage)EA( filter\201)A(BufferedImage)EA( src,
)A(BufferedImage)EA( dest\202
)RP(
)DL(
)DD( Performs thresholding on the BufferedImage.
If the color model in the source image is not the same as that
in the destination image, the pixels will be converted
in the destination. If the destination image is null,
a BufferedImage will be created with the source ColorModel.
The number of sets of threshold constants in this object may be
one, in which case the same constants are applied to all color and
alpha components, or it must equal the number of Source color
components, in which case no thresholding of the alpha component
\201if present\202 is performed, or it must equal the number of Source
color components plus alpha components, in which case all color
and alpha components are thresholded. Otherwise an
IllegalArgumentException will be thrown.
)0 P(
)LD(
o )WB()EA(
)BD(filter)ES()EA(
)PR(
public )A(Tile)EA( filter\201)A(Tile)EA( src,
)A(Tile)EA( dest\202
)RP(
)DL(
)DD( Performs thresholding on the Tile.
If the destination Tile is null, a new Tile will be created.
The source and destination must have the same number of channels.
The number of sets of threshold constants in this object may be
one, in which case the same constants are applied to all channels,
or it must equal the number of Source tile channels.
An IllegalArgumentException will be thrown if the number of channels
in the source does not match the destination, or if the above
restrictions on the number of sets of threshold constants are
not met.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(BufferedImage)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the thresholded destination. Since
this is not a geometric operation, the bounding box does not
change. An IllegalArgumentException will be thrown if the
number of sets of threshold constants does not meet the restrictions
stated in the class comments above.
)0 P(
)LD(
o )WB()EA(
)BD(getDestBounds)ES()EA(
)PR(
public )A(Rectangle2D)EA( getDestBounds\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Returns the bounding box of the thresholded destination. Since
this is not a geometric operation, the bounding box does not
change. An IllegalArgumentException will be thrown if the
number of sets of threshold constants does not meet the restrictions
stated in the class comments above.
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleDestImage)ES()EA(
)PR(
public )A(BufferedImage)EA( createCompatibleDestImage\201)A(BufferedImage)EA( src,
)A(ColorModel)EA( destCM\202
)RP(
)DL(
)DD( Creates an empty destination image with the correct size and number of
channels. An IllegalArgumentException will be thrown if the
number of sets of threshold constants does not meet the restrictions
stated in the class comments above.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( src - Source image for the filter operation.
)DD( destCM - ColorModel of the destination. If null, the
ColorModel of the source will be used.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleDestTile)ES()EA(
)PR(
public )A(Tile)EA( createCompatibleDestTile\201)A(Tile)EA( src\202
)RP(
)DL(
)DD( Creates an empty destination tile with the correct size and number
of channels.
An IllegalArgumentException will be thrown if the
number of sets of threshold constants does not meet the restrictions
stated in the class comments above.
)0 P(
)LD(
o )WB()EA(
)BD(getDestPoint)ES()EA(
)PR(
public )A(Point2D)EA( getDestPoint\201)A(Point2D)EA( srcPt,
)A(Point2D)EA( dstPt\202
)RP(
)DL(
)DD( Returns the location of the destination point given a
point in the source image. If dstPt is non-null, it will
be used to hold the return value. Since this is not a geometric
operation, the srcPt will equal the dstPt.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.Tile
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.Tile
)EH(
)PR(
java.lang.Object
|
+----java.awt.image.Tile
)RP(
)HR(
)DL(
)DT( public abstract class )BD(Tile)ES(
)DT( extends Object
)DT( super class of:
)DD( )A(ByteBandedTile)EA(, )A(ByteComponentTile)EA(, )A(BytePackedTile)EA(, )A(IntegerComponentTile)EA(, )A(ShortBandedTile)EA(, )A(ShortComponentTile)EA(
)LD(
This class defines a tile, which is a collection of channels in an
image. A channel is a collection of data and layout parameters for
one band of an image. There is no explicit channel object.
The tile also holds subtiling information, such as the
width, height, and data offsets of the subregion. All tiles
have a base tile, which is the ancestor of a subtile whose base tile is
itself.
The data offsets are the same for all channels in a tile and
are absolute pixel offsets into the channel data arrays \201i.e. the offsets
in a subtile are not relative to the offsets in the parent of that
subtile\202.
)0 P(
Tile objects can be classified into two major categories: ComponentTiles,
BandedTiles
and PackedTiles. Both ComponentTiles and BandedTiles have only
one channel element per data array element in each channel.
ComponentTiles have only one data array for all channels whereas
BandedTiles have n arrays for n channels. When accessing regions
of pixels, the methods on ComponentTiles will tend to access the
data channel-interleaved while methods on BandedTiles will access
the data channel-sequential.
PackedTiles have only one channel but more than one channel element
may be packed into a data array element.
)0 P(
)BD( Glossary:)ES(
)DL(
)DT( channel
)DD( a collection of data and data layout parameters for one band
of an image
)DT( tile
)DD( a collection of channels in an image
)DT( data array
)DD( a collection of Java primitive types \201byte, short, int\202.
)DT( data array element
)DD( one primitive type datum out of the data array for a channel
)DT( channel element
)DD( Datum at an x,y location for one channel.
For ComponentTile or BandedTile classes, there is only
one channel element in one data
array element. For PackedTile classes, there may be multiple
channel elements packed in one data array element.
)DT( pixel
)DD( a collection of channel elements for a given x,y location
)LD(
)0 P(
)DL(
)DT( )BD(See Also:)ES(
)DD( )A(IntegerComponentTile)EA(, )A(ShortComponentTile)EA(, )A(ByteComponentTile)EA(, )A(ShortBandedTile)EA(, )A(ByteBandedTile)EA(, )A(BytePackedTile)EA(
)LD(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(Tile)ES()EA(\201int, int, int, int, int\202
)DD( Constructs a base tile given the channel array and tile dimensions.
)LD(
)0 2 H(
Method Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201\202
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createCompatibleTile)ES()EA(\201int, int\202
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(createSubtile)ES()EA(\201int, int, int, int, int[]\202
)DD( Creates a subtile given a region of the tile.
)DT( o )WB(
)A()BD(getBaseTile)ES()EA(\201\202
)DD( Returns the base tile, which is the topmost tile from which
any subtiles are created..
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int\202
)DD( Returns the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int, int, int[]\202
)DD( Returns an integer array of pixels from the specified rectangular
region.
)DT( o )WB(
)A()BD(getData)ES()EA(\201int, int, int[]\202
)DD( Returns the channel elements for all channels at the specified
location.
)DT( o )WB(
)A()BD(getHeight)ES()EA(\201\202
)DD( Returns the height \201in pixels\202 of this tile.
)DT( o )WB(
)A()BD(getNumChannels)ES()EA(\201\202
)DD( Returns the number of channels.
)DT( o )WB(
)A()BD(getWidth)ES()EA(\201\202
)DD( Returns the width \201in pixels\202 of this tile.
)DT( o )WB(
)A()BD(getXOffset)ES()EA(\201\202
)DD( Returns the X coordinate of the offset into the channel
data arrays.
)DT( o )WB(
)A()BD(getYOffset)ES()EA(\201\202
)DD( Returns the Y coordinate of the offset into the channel
data arrays.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int\202
)DD( Stores the channel element
for the specified channel at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int, int, int[]\202
)DD( Stores an integer array of pixels into the specified rectangular
region.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, int[]\202
)DD( Stores the channel elements for all channels at the specified location.
)DT( o )WB(
)A()BD(putData)ES()EA(\201int, int, Tile\202
)DD( Stores the Tile data at the specified location.
)DT( o )WB(
)A()BD(setBaseTile)ES()EA(\201Tile\202
)DD( Set the base tile.
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(Tile)ES(
)PR(
protected Tile\201int x,
int y,
int width,
int height,
int numChannels\202
)RP(
)DL(
)DD( Constructs a base tile given the channel array and tile dimensions.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset in the data array of each channel.
)DD( y - Y offset in the data array of each channel.
)DD( width - Width \201in pixels\202 of the tile
)DD( height - Height \201in pixels\202 of the tile
)DD( channels - Channel array.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the channel parameters are incompatible with the tile
x offset, y offset,
width and height.
)LD(
)LD(
)EA(
)0 2 H(
Methods )WB(
)EH(
o )WB()EA(
)BD(getXOffset)ES()EA(
)PR(
public int getXOffset\201\202
)RP(
)DL(
)DD( Returns the X coordinate of the offset into the channel
data arrays. Offsets for subtiles are not relative to the
parent tile but are absolute offsets with respect to the
base tile's data arrays.
)0 P(
)LD(
o )WB()EA(
)BD(getYOffset)ES()EA(
)PR(
public int getYOffset\201\202
)RP(
)DL(
)DD( Returns the Y coordinate of the offset into the channel
data arrays. Offsets for subtiles are not relative to the
parent tile but are absolute offsets with respect to the
base tile's data arrays.
)0 P(
)LD(
o )WB()EA(
)BD(getWidth)ES()EA(
)PR(
public int getWidth\201\202
)RP(
)DL(
)DD( Returns the width \201in pixels\202 of this tile.
)0 P(
)LD(
o )WB()EA(
)BD(getHeight)ES()EA(
)PR(
public int getHeight\201\202
)RP(
)DL(
)DD( Returns the height \201in pixels\202 of this tile.
)0 P(
)LD(
o )WB()EA(
)BD(getNumChannels)ES()EA(
)PR(
public int getNumChannels\201\202
)RP(
)DL(
)DD( Returns the number of channels.
)0 P(
)LD(
o )WB()EA(
)BD(getBaseTile)ES()EA(
)PR(
public )A(Tile)EA( getBaseTile\201\202
)RP(
)DL(
)DD( Returns the base tile, which is the topmost tile from which
any subtiles are created..
\201On creation of a tile, the base tile is set to itself.\202
)0 P(
)DD()DL(
)DT( )BD(See Also:)ES(
)DD( )A(createSubtile)EA(, )A(createSubtile)EA(
)LD(
)LD(
o )WB()EA(
)BD(setBaseTile)ES()EA(
)PR(
protected void setBaseTile\201)A(Tile)EA( baseTile\202
)RP(
)DL(
)DD( Set the base tile.
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public abstract int getData\201int x,
int y,
int channel\202
)RP(
)DL(
)DD( Returns the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public abstract int[] getData\201int x,
int y,
int outData[]\202
)RP(
)DL(
)DD( Returns the channel elements for all channels at the specified
location. There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( outData - If non-null, channel elements for all channels
at the specified location are returned in this array.
)DT( )BD(Returns:)ES(
)DD( Data array with channel elements for all channels.
)LD(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public abstract int[] getData\201int x,
int y,
int w,
int h,
int channel,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
// To find the channel element at location \201x2, y2\202
int chanElement = channelData[\201\201y2-y\202*w + \201x2-x\202\202];
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(getData)ES()EA(
)PR(
public abstract int[] getData\201int x,
int y,
int w,
int h,
int outData[]\202
)RP(
)DL(
)DD( Returns an integer array of pixels from the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)PR(
int[] channelData = tile.getData\201x, y, w, h, null\202;
int numChannels = tile.getNumChannels\201\202;
int[] pixel = new int[numChannels];
// To find a pixel at location \201x2, y2\202
System.arraycopy\201channelData, \201\201y2-y\202*w + \201x2-x\202\202*numChannels,
pixel, 0, numChannels\202;
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public abstract void putData\201int x,
int y,
int channel,
int inData\202
)RP(
)DL(
)DD( Stores the channel element
for the specified channel at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( channel - Channel index.
)DD( inData - Channel element.
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public abstract void putData\201int x,
int y,
int inData[]\202
)RP(
)DL(
)DD( Stores the channel elements for all channels at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inData - Channel elements for all channels.
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public void putData\201int x,
int y,
)A(Tile)EA( inTile\202
)RP(
)DL(
)DD( Stores the Tile data at the specified location.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X coordinate.
)DD( y - Y coordinate.
)DD( inTile - Tile of data to place at x,y location.
)LD(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public abstract void putData\201int x,
int y,
int w,
int h,
int channel,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(putData)ES()EA(
)PR(
public abstract void putData\201int x,
int y,
int w,
int h,
int inData[]\202
)RP(
)DL(
)DD( Stores an integer array of pixels into the specified rectangular
region.
There will be no explicit bounds checking on the parameters.
An ArrayOutOfBounds exception will be thrown at runtime
if data outside of the array is accessed.
The channel elements in the
data array are assumed to be packed. That is, a channel element
for the nth channel at location \201x2, y2\202 would be found at:
)PR(
inData[\201\201y2-y\202*w + \201x2-x\202\202*numChannels + n]
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public abstract )A(Tile)EA( createSubtile\201int x,
int y,
int width,
int height\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. Note that the subtile will reference the same
data arrays as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width of the subtile.
)DD( height - Height of the subtile.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)LD(
)LD(
o )WB()EA(
)BD(createSubtile)ES()EA(
)PR(
public abstract )A(Tile)EA( createSubtile\201int x,
int y,
int w,
int h,
int channelList[]\202
)RP(
)DL(
)DD( Creates a subtile given a region of the tile. The x and y
coordinates specify the horizontal and vertical offsets
from the upper-left corner of this tile to the upper-left corner
of the subtile. A subset of the parent tile's channels may be
specified. Note that the subtile will reference the same
data arrays as the parent tile, but using different offsets.
)0 P(
)DD()DL(
)DT( )BD(Parameters:)ES(
)DD( x - X offset.
)DD( y - Y offset.
)DD( width - Width of the data.
)DD( height - Height of the data.
)DD( channelList - Array of channel indices.
)DT( )BD(Throws:)ES( )A(TileFormatException)EA(
)DD( if the specified bounding box is outside of the parent tile.
)LD(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public abstract )A(Tile)EA( createCompatibleTile\201int w,
int h\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout but using a different
width and height, and with new zeroed data arrays.
Note that given a GraphicsConfiguration object, gc,
)PR(
gc.createCompatibleTile\201w1, h1\202.createCompatibleTile\201w2, h2\202
may not be equal to:
gc.createCompatibleTile\201w2, h2\202
)RP(
)0 P(
)LD(
o )WB()EA(
)BD(createCompatibleTile)ES()EA(
)PR(
public abstract )A(Tile)EA( createCompatibleTile\201\202
)RP(
)DL(
)DD( Creates a tile with the same channel layout and the same
width and height, and with new zeroed data arrays.
)0 P(
)LD(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL NP(
Class java.awt.image.TileFormatException
)EA(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)HR(
)0 1 H(
Class java.awt.image.TileFormatException
)EH(
)PR(
java.lang.Object
|
+----java.lang.Throwable
|
+----java.lang.Exception
|
+----java.lang.RuntimeException
|
+----java.awt.image.TileFormatException
)RP(
)HR(
)DL(
)DT( public class )BD(TileFormatException)ES(
)DT( extends RuntimeException
)LD(
This exception is thrown if there is invalid layout information
in the Tile.
)0 P(
)HR(
)EA(
)0 2 H(
Constructor Index )WB(
)EH(
)DL(
)DT( o )WB(
)A()BD(TileFormatException)ES()EA(\201String\202
)DD(
)LD(
)EA(
)0 2 H(
Constructors )WB(
)EH(
)EA(
o )WB()EA(
)BD(TileFormatException)ES(
)PR(
public TileFormatException\201String s\202
)RP(
)HR(
)PR(
)A(All Packages)EA( )A(Class Hierarchy)EA( )A(This Package)EA( )A(Previous)EA( )A(Next)EA( )A(Index)EA()RP(
)WB NL showpage end restore
.