GrafPort

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

maclib
Class GrafPort

java.lang.Object
  maclib.GrafPort

public final class GrafPort
extends java.lang.Object
extends java.lang.Object

A GrafPort object implements QuickDraw-like drawing and event routines onto an object of class DrawingApplet, used for a drawing panel. The DrawingApplet provides automatic repaint, using an off-screen image, and also listeners for keyboard and mouse events. Usual GrafPort constructors initialize a DrawingFrame, which contains this DrawingApplet.

Version:: 01 mar 2005
Author:: Philippe Chassignet, Ecole Polytechnique
See Also:: DrawingFrame, DrawingApplet, MacLib

Field Summary
`static int`	`BLACK_COLOR` Used to specify one of the standard painting color.
`static int`	`BLUE_COLOR` Used to specify one of the standard painting color.
`static int`	`BOLD` Used to specify a text style.
`static int`	`CONTROL` Used to encode the control modifier in the button state.
`static int`	`CYAN_COLOR` Used to specify one of the standard painting color.
`static java.lang.String`	`DIALOG` Used to specify one of the standard text font.
`static java.lang.String`	`DIALOG_INPUT` Used to specify one of the standard text font.
`static int`	`GREEN_COLOR` Used to specify one of the standard painting color.
`static int`	`ITALIC` Used to specify a text style.
`static int`	`MAGENTA_COLOR` Used to specify one of the standard painting color.
`static int`	`META` Used to encode the meta modifier in the button state.
`static java.lang.String`	`MONOSPACED` Used to specify one of the standard text font.
`static int`	`NONE` Used to specify no modifier in the button state.
`static int`	`PAT_COPY` Used to specify the normal painting mode.
`static int`	`PAT_XOR` Used to specify the normal painting mode.
`static int`	`PLAIN` Used to specify a text style.
`static int`	`RED_COLOR` Used to specify one of the standard painting color.
`static java.lang.String`	`SANS_SERIF` Used to specify one of the standard text font.
`static java.lang.String`	`SERIF` Used to specify one of the standard text font.
`static int`	`SHIFT` Used to encode the shift modifier in the button state.
`static int`	`WHITE_COLOR` Used to specify one of the standard painting color.
`static int`	`YELLOW_COLOR` Used to specify one of the standard painting color.

Constructor Summary
`GrafPort()` Constructs and initializes a `GrafPort` and an attached `DrawingFrame` having : the title `"Drawing"`, the default initial size for the frame, the default size for the off-screen image
`GrafPort(java.lang.String title)` Constructs and initializes a `GrafPort` and an attached `DrawingFrame` having : the specified title, the default initial size for the frame, the default size for the off-screen image
`GrafPort(java.lang.String title, int width, int height)` Constructs and initializes a `GrafPort` and an attached `DrawingFrame` having : the specified title, the specified initial size for the frame, the default final size for the off-screen image
`GrafPort(java.lang.String title, int width, int height, int fullWidth, int fullHeight)` Constructs and initializes a `GrafPort` and an attached `DrawingFrame` having : the specified title, the specified initial size for the frame, the specified final size for the off-screen image

Method Summary
`void`	`backColor(java.awt.Color color)` Sets the current background color, used when erasing or inverting, as specified by the given `java.awt.Color` object.
`void`	`backColor(int color)` Sets the current background color, used when erasing or inverting, as specified by one of the height constant flags : `BLACK_COLOR`, `WHITE_COLOR`, `RED_COLOR`, `GREEN_COLOR`, `BLUE_COLOR`, `CYAN_COLOR`, `MAGENTA_COLOR` or `YELLOW_COLOR`.
`boolean`	`button()` Returns the state of the mouse button for the attached drawing panel.
`int`	`buttonState()` Returns the `int` value that describes the modifier keys state at the time of the last mouse pressed event.
`int`	`charWidth(char c)` Returns the width in pixels of the given character.
`java.awt.Image`	`createImage(java.awt.image.ImageProducer producer)` Creates an image from the specified image producer.
`java.awt.Image`	`createImage(int width, int height)` Creates an off-screen drawable image to be used for double buffering.
`void`	`dispose()` Disposes of this `GrafPort` and attached objects.
`void`	`drawChar(char c)` Draws the given character.
`boolean`	`drawImage(java.awt.Image img)` Draws the given image, starting at location `(0,0)`.
`void`	`drawLine(int x1, int y1, int x2, int y2)` Draws a line from the location that is specified by x1 and y1 to the location that is specified by x2 and y2 (in coordinates relative to the drawing panel).
`void`	`drawString(java.lang.String s)` Draws the given text string.
`void`	`drawText(char[] textBuf, int firstByte, int byteCount)` Draws the specified text.
`void`	`eraseArc(Rect r, int startAngle, int arcAngle)` Paints inside a wedge of the oval that fits inside the specified rectangle, using the background color.
`void`	`eraseOval(Rect r)` Paints inside the oval that fits inside the specified rectangle, using the background color.
`void`	`erasePolygon(Point[] points, int pCount)` Paints inside the specified polygon, using the background color.
`void`	`eraseRect(Rect r)` Paints inside the specified rectangle, using the background color.
`void`	`eraseRoundRect(Rect r, int arcWidth, int arcHeight)` Paints inside the specified rounded-corner rectangle, using the background color.
`void`	`finalize()` Called by the garbage collector when there are no more reference to this `GrafPort`.
`void`	`foreColor(java.awt.Color color)` Sets the current pen color, used for drawing lines or text and painting shapes, as specified by the given `java.awt.Color` object.
`void`	`foreColor(int color)` Sets the current pen color, used for drawing lines or text and painting shapes, as specified by one of the height constant flags : `BLACK_COLOR`, `WHITE_COLOR`, `RED_COLOR`, `GREEN_COLOR`, `BLUE_COLOR`, `CYAN_COLOR`, `MAGENTA_COLOR` or `YELLOW_COLOR`.
`void`	`frameArc(Rect r, int startAngle, int arcAngle)` Draws an arc of outline just inside the oval that fits inside the specified rectangle.
`void`	`frameOval(Rect r)` Draws an outline just inside the oval that fits inside the specified rectangle.
`void`	`framePolygon(Point[] points, int pCount)` Draws an outline of the specified polygon.
`void`	`frameRect(Rect r)` Draws an outline just inside the specified rectangle.
`void`	`frameRoundRect(Rect r, int arcWidth, int arcHeight)` Draws an outline just inside the specified rounded-corner rectangle.
`Point`	`getClick()` Waits until the mouse button is pressed and then released in the attached drawing panel.
`Rect`	`getDrawingRect()` Gets the drawing bounds of the attached drawing panel.
`FontInfo`	`getFontInfo()` Returns the metric informations about the current font as a `FontInfo` object.
`char`	`getKey()` Returns the char corresponding to the last keyboard event in the drawing panel.
`Point`	`getMouse()` Returns the current mouse location (relative to the attached drawing panel) as a `Point`Point object.
`DrawingApplet`	`getPanel()` Returns the drawing panel attached to this `GrafPort`.
`Point`	`getPen()` Returns the current pen location (relative to the attached drawing panel) as a Point object.
`void`	`hideDrawing()` Hides the attached drawing panel.
`void`	`invertArc(Rect r, int startAngle, int arcAngle)` Inverts pixels inside a wedge of the oval that fits inside the specified rectangle.
`void`	`invertCircle(int x, int y, int r)` Inverts pixels inside the specified circle.
`void`	`invertOval(Rect r)` Inverts pixels inside the oval that fits inside the specified rectangle.
`void`	`invertPolygon(Point[] points, int pCount)` Inverts pixels inside the specified polygon.
`void`	`invertRect(Rect r)` Inverts pixels inside the specified rectangle.
`void`	`invertRoundRect(Rect r, int arcWidth, int arcHeight)` Inverts pixels inside the specified rounded-corner rectangle.
`boolean`	`keyPressed()` Checks whether the char, corresponding to the last keyboard event occured in the drawing panel, is still available.
`void`	`line(int dh, int dv)` Draws a line from the current pen location to the location that is at distance of dh horizontally and dv vertically.
`void`	`lineTo(int h, int v)` Draws a line from the current pen location to the location that is specified by h and v (in coordinates relative to the drawing panel).
`void`	`move(int dh, int dv)` Translates the coordinates of the pen by the specified displacement vector.
`void`	`moveTo(int h, int v)` Sets the coordinates of the pen (relative to the drawing panel) to the specified location.
`void`	`paintArc(Rect r, int startAngle, int arcAngle)` Paints inside a wedge of the oval that fits inside the specified rectangle.
`void`	`paintCircle(int x, int y, int r)` Paints inside the specified circle.
`void`	`paintOval(Rect r)` Paints inside the oval that fits inside the specified rectangle.
`void`	`paintPolygon(Point[] points, int pCount)` Paints inside the specified polygon.
`void`	`paintRect(Rect r)` Paints inside the specified rectangle.
`void`	`paintRoundRect(Rect r, int arcWidth, int arcHeight)` Paints inside the specified rounded-corner rectangle.
`void`	`penMode(int mode)` Sets the current transfer mode, used for drawing lines and painting shapes, to be one of the two constant flags `PAT_COPY` or `PAT_XOR`.
`void`	`penNormal()` Resets the initial state, that is the mode and size, of the pen.
`void`	`penSize(int width, int height)` Sets the dimensions of the rectangular pen, used for drawing lines and framed shapes.
`void`	`reset()` Resets the drawing context attached to this `GrafPort`.
`void`	`resize(int width, int height)` Sets the size of the attached drawing panel as specified.
`void`	`setDrawingRect(Rect r)` Sets the bounds of the attached drawing panel as specified by the given `Rect` object.
`void`	`showDrawing()` Makes the attached drawing panel visible and brings it to the front.
`void`	`showStatus(java.lang.String s)` Prints a string of text (for user information).
`int`	`stringWidth(java.lang.String s)` Returns the width in pixels of the given text string.
`void`	`textFace(int face)` Sets the style of the font used for drawing text, it should be one of the followings constants : `PLAIN`, `BOLD`, `ITALIC` or `BOLD+ITALIC`.
`void`	`textFont(java.lang.String name)` Sets the name of the font used for drawing text.
`void`	`textSize(int size)` Sets the size of the font used for drawing text.
`int`	`textWidth(char[] textBuf, int firstByte, int byteCount)` Returns the width in pixels of the specified text.
`java.lang.String`	`toString()` Returns a string representation of the state of this `GrafPort`.
`boolean`	`trackMouse(Point p)` Waits until the mouse button is released, after being pressed, or until the mouse location is dragged.
`void`	`waitClickDown()` Waits until the mouse button is pressed in the attached drawing panel.
`void`	`waitClickUp()` Waits until the mouse button is released after being pressed in the attached drawing panel.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

PAT_COPY

public static final int PAT_COPY

Used to specify the normal painting mode.

See Also:: penMode(int), Constant Field Values

PAT_XOR

public static final int PAT_XOR

Used to specify the normal painting mode.

See Also:: penMode(int), Constant Field Values