|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ViewportGraphics
An adapter that allows uDig and plugin writers to write to AWT components and images or SWT Drawable objects by using this common interface.
Field Summary | |
---|---|
static int |
ALIGN_BOTTOM
ALIGN_BOTTOM field used to align text |
static int |
ALIGN_LEFT
ALIGN_LEFT field used to align text |
static int |
ALIGN_MIDDLE
ALIGN_MIDDLE field used to align text |
static int |
ALIGN_RIGHT
ALIGN_RIGHT field used to align text |
static int |
ALIGN_TOP
ALIGN_TOP field used to align text |
static int |
LINE_DASH
Line drawing style for dashed lines (value is 2). |
static int |
LINE_DASHDOT
Line drawing style for alternating dash-dot lines (value is 4). |
static int |
LINE_DASHDOTDOT
Line drawing style for dash-dot-dot lines (value is 5). |
static int |
LINE_DOT
Line drawing style for dotted lines (value is 3). |
static int |
LINE_SOLID
Line drawing style for solid lines (value is 1). |
Method Summary | |
---|---|
void |
clearRect(int x,
int y,
int width,
int height)
Fills the specified rectangle with the background color. |
void |
dispose()
Disposes of any resources the graphics might be hanging on to. |
void |
draw(java.awt.Shape s)
Draws the outline of shape using the color, clip & transform. |
void |
drawImage(java.awt.Image awtImage,
int x,
int y)
Draws an Image . |
void |
drawImage(java.awt.Image awtImage,
int dx1,
int dy1,
int dx2,
int dy2,
int sx1,
int sy1,
int sx2,
int sy2)
Draws a portion of the image to the target location on the viewport graphics. |
void |
drawImage(java.awt.image.RenderedImage renderedImage,
int x,
int y)
Draws an image. |
void |
drawLine(int x1,
int y1,
int x2,
int y2)
Draws a line from x1,y1 to x2,y2 |
void |
drawOval(int x,
int y,
int width,
int height)
Draws an Oval - only the boundary |
void |
drawPath(Path path)
Draws the outline of the path using the color, clip and transform. |
void |
drawRect(int x,
int y,
int width,
int height)
Draws a rectangle - only the boundary. |
void |
drawRoundRect(int x,
int y,
int width,
int height,
int arcWidth,
int arcHeight)
Draws a round cornered rectangle |
void |
drawString(java.lang.String string,
int x,
int y,
int alignx,
int aligny)
Draws a string. |
void |
fill(java.awt.Shape s)
Fills the interior of a Shape using the foreground color, clip & transform. |
void |
fillOval(int x,
int y,
int width,
int height)
Fills an Oval |
void |
fillPath(Path path)
Fills the interior of the path with the forground color. |
void |
fillRect(int x,
int y,
int width,
int height)
Fills a rectangle. |
void |
fillRoundRect(int x,
int y,
int width,
int height,
int arcWidth,
int arcHeight)
Fills a round cornered rectangle using the foreground color |
java.awt.Color |
getBackgroundColor()
Gets the current background color value |
java.awt.Shape |
getClip()
Gets the area that can be drawn in. |
java.awt.Color |
getColor()
Gets the current Color value |
int |
getFontAscent()
Gets the ascent of the current font, which is the distance the font rises
above its baseline . |
int |
getFontHeight()
Gets the height of the current font TODO at some point maybe this could be broken out to getFontMetrics(), and a create FontMetrics object that maps between SWT and AWT. |
java.awt.geom.Rectangle2D |
getStringBounds(java.lang.String str)
Returns the bounds of a String. |
java.awt.geom.AffineTransform |
getTransform()
|
void |
setBackground(java.awt.Color c)
Sets the background color to draw with. |
void |
setClip(java.awt.Rectangle r)
Sets the clip. |
void |
setClipBounds(java.awt.Rectangle newBounds)
Sets the clip area. |
void |
setColor(java.awt.Color c)
Sets the foreground color to draw with. |
void |
setLineDash(int[] dash)
Sets the line dash pattern |
void |
setLineWidth(int width)
Sets the line width of the graphics |
void |
setStroke(int strokeStyle,
int strokeWidth)
Sets the stroke color to draw with. |
void |
setTransform(java.awt.geom.AffineTransform transform)
Modifies the graphics so that further draws us minX,minY as the origin and maxX and maxY as the width and height of the display area. |
int |
stringWidth(java.lang.String str)
Returns the length in pixels of the given string, or -1 if this operation is not available. |
void |
translate(java.awt.Point offset)
Sets the draw offset. |
Field Detail |
---|
static final int LINE_SOLID
static final int LINE_DASH
static final int LINE_DOT
static final int LINE_DASHDOT
static final int LINE_DASHDOTDOT
static final int ALIGN_TOP
ALIGN_TOP
field used to align text
static final int ALIGN_MIDDLE
ALIGN_MIDDLE
field used to align text
static final int ALIGN_BOTTOM
ALIGN_BOTTOM
field used to align text
static final int ALIGN_LEFT
ALIGN_LEFT
field used to align text
static final int ALIGN_RIGHT
ALIGN_RIGHT
field used to align text
Method Detail |
---|
void fillPath(Path path)
path
- the path to fill.void fill(java.awt.Shape s)
Shape
using the foreground color, clip & transform.
Reference description from Graphics2d:
Shape
using the settings of the Graphics2D
context. The rendering attributes applied
include the Clip
, Transform
, Paint
, and
Composite
.
s
- the Shape
to be filled
s
- the Shape
to be renderedfill
void fillOval(int x, int y, int width, int height)
x
- the starting x coordinatey
- the starting y coordinatewidth
- the width of the Oval.height
- the height of the Oval.void fillRect(int x, int y, int width, int height)
x
- the starting x coordinatey
- the starting y coordinatewidth
- the width of the rectangle.height
- the height of the rectangle.void clearRect(int x, int y, int width, int height)
x
- The starting corner's x-coordinate.y
- The starting corner's y-coordinate.width
- the width of the rectangleheight
- the height of the rectanglevoid drawPath(Path path)
void draw(java.awt.Shape s)
shape
using the color, clip & transform.
Reference description from Graphics2d: Shape
using the settings of the current Graphics2D
context. The rendering attributes
applied include the Clip
, Transform
, Paint
,
Composite
and Stroke
attributes.
s
- the Shape
to be renderedfill
void drawRect(int x, int y, int width, int height)
x
- the starting x coordinatey
- the starting y coordinatewidth
- the width of the rectangle.height
- the height of the rectangle.void drawLine(int x1, int y1, int x2, int y2)
x1
- y1
- x2
- y2
- void drawOval(int x, int y, int width, int height)
x
- the starting x coordinatey
- the starting y coordinatewidth
- the width of the Oval.height
- the height of the Oval.void drawString(java.lang.String string, int x, int y, int alignx, int aligny)
string
- The string to draw.x
- the x coordinate of the location where the of the string will be placed.y
- the y coordinate of the location where the of the string will be placed.alignx
- horizontal alignment, ALIGN_LEFT
, ALIGN_MIDDLE
or ALIGN_RIGHT
aligny
- vertical alignment, ALIGN_BOTTOM
, ALIGN_MIDDLE
or ALIGN_TOP
void setColor(java.awt.Color c)
c
- The new color.void setBackground(java.awt.Color c)
c
- The new color.void setStroke(int strokeStyle, int strokeWidth)
strokeStyle
- The style of line to draw.strokeWidth
- the width, in pixels, to draw lines with.void setClip(java.awt.Rectangle r)
r
- the rectangle to clip to.void translate(java.awt.Point offset)
offset
- The amount the draw is offset in the graphics.void drawImage(java.awt.image.RenderedImage renderedImage, int x, int y)
image
- The image to draw.x
- The x coordinate of the image top left corner of the image.y
- The y coordinate of the image top left corner of the image.void drawImage(java.awt.Image awtImage, int x, int y)
Image
.
image
- The Image
to draw.x
- The x coordinate of the image top left corner of the image.y
- The y coordinate of the image top left corner of the image.void drawImage(java.awt.Image awtImage, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2)
image
- Image
to drawdx1
- - the x coordinate of the first corner of the destination rectangle.dy1
- - the y coordinate of the first corner of the destination rectangle.dx2
- - the x coordinate of the second corner of the destination rectangle.dy2
- - the y coordinate of the second corner of the destination rectangle.sx1
- - the x coordinate of the first corner of the source rectangle.sy1
- - the y coordinate of the first corner of the source rectangle.sx2
- - the x coordinate of the second corner of the source rectangle.sy2
- - the y coordinate of the second corner of the source rectangle.void setTransform(java.awt.geom.AffineTransform transform)
minX
- The x-coord that will be used as the origin.minY
- The y-coord that will be used as the origin.width
- The width that will be used to draws.height
- The height that will be used to draws.int getFontHeight()
int stringWidth(java.lang.String str)
str
-
int getFontAscent()
ascent
of the current font, which is the distance the font rises
above its baseline
.
java.awt.geom.Rectangle2D getStringBounds(java.lang.String str)
str
-
java.awt.geom.AffineTransform getTransform()
void dispose()
java.awt.Shape getClip()
void setClipBounds(java.awt.Rectangle newBounds)
newBounds
- new clip areajava.awt.Color getColor()
java.awt.Color getBackgroundColor()
void drawRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
x
- the x component of the upper left cornery
- the y component of the upper left cornerwidth
- the width of the rectangleheight
- the height of the rectanglearcWidth
- the horizontal diameter of the arc
at the four corners.arcHeight
- the vertical diameter of the arc
at the four cornersvoid fillRoundRect(int x, int y, int width, int height, int arcWidth, int arcHeight)
x
- the x component of the upper left cornery
- the y component of the upper left cornerwidth
- the width of the rectangleheight
- the height of the rectanglearcWidth
- the horizontal diameter of the arc
at the four corners.arcHeight
- the vertical diameter of the arc
at the four cornersvoid setLineWidth(int width)
wdith
- the new line widthvoid setLineDash(int[] dash)
dash
- the pattern of dashes.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |