Previous
Contents
Index
Next
| Package com.ms.fx |
Previous |
Contents |
Index |
Next |
public class FxGraphics extends Graphics implements IFxGraphicsConstants, IFxTextConstants, PeerConstants
{
// Constructors
public FxGraphics(FxGraphics g);
public FxGraphics(Graphics g);
// Methods
public final static boolean isRunningAFCNative();
public Rectangle getClipBounds();
public void fillRect(int X, int Y, int W, int H);
public void drawRect(int X, int Y, int W, int H);
public void drawPixels(int pels[], int len);
public void drawLine(int x1, int y1, int x2, int y2);
public void drawOval(int x, int y, int w, int h);
public void fillOval(int x, int y, int w, int h);
public void drawArc(int x, int y, int w, int h,int startAngle,int endAngle);
public void fillArc(int x, int y, int w, int h,int startAngle,int endAngle);
public void copyArea(int X, int Y, int W, int H, int dx, int dy);
public void copyArea(int x, int y, int w, int h, Graphics g, int srcX, int srcY, int srcW, int srcH);
public void setXORMode(Color c1);
public void drawRoundRect(int x, int y, int w, int h,int arcWidth, int arcHeight);
public void fillRoundRect(int x, int y, int w, int h,int arcWidth, int arcHeight);
public void drawPolygon(int xPoints[], int yPoints[], int nPoints);
public void drawScanLines(boolean xChanging, int points[], int offset, int nPoints);
public void fillPolygon(int xPoints[], int yPoints[], int nPoints);
public Graphics create();
public static FxGraphics getExtendedGraphics(Graphics g);
public void setFont(Font font);
protected void nativeSetFont(Font font);
public void drawChars(char data[], int offset, int length, int x, int y);
public void drawChars(char data[], int offset, int length, int x, int y,
Rectangle optionRect, int options, int dx[], int dy[]);
public void drawString(String str, int x, int y, Rectangle optionRect,
int options, int dx[], int dy[]);
public void drawString(String str, int x, int y, Rectangle optionRect,
int options, int meta[]);
public void drawString(String str, int x, int y);
public void drawBytes(byte data[], int offset, int length, int x, int y);
public void drawOutlineChar(int xOrig, int yOrig, GlyphOutline go);
public boolean drawBorder(Rectangle rect, int edge, int flags);
public void drawOutlinePolygon(int xOrig, int yOrig, OutlinePolygon op);
public boolean drawEdge(Rectangle inRect, int edge, int flags);
public GlyphOutline getGlyphOutline(char ch);
public FontMetrics getFontMetrics(Font font);
public Color getTextBackgroundColor();
public void setTextBackgroundColor(Color c);
public void setColor(Color c);
public FxFormattedText drawStringFormatted(String s, Rectangle r, int hta, int vta, int ww, boolean bordered,
int tabOrigin, int tabs[], IFxShape outline);
public void drawTabbedString(String s, int x, int y, int iTabOrigin, int tabs[]);
public void drawTabbedChars(char s[], int off, int len, int x, int y, int iTabOrigin, int tabs[]);
public int stringTabbedWidth(String s, int iTabbedOrigin, int tabs[]);
public int charsTabbedWidth(char s[], int off, int len, int iTabOrigin, int tabs[]);
public boolean drawImage(Image img, int x, int y, ImageObserver observer);
public boolean drawImage(Image img, int x, int y, int width, int height, ImageObserver observer);
public boolean drawImage(Image img, int x, int y, Color bgcolor, ImageObserver observer);
public boolean drawImage(Image img, int x, int y, int width, int height, Color bgcolor, ImageObserver observer);
public boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1,
int sx2, int sy2, ImageObserver observer);
public boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1,
int sx2, int sy2, Color bgcolor, ImageObserver observer);
public void setClip(int x, int y, int width, int height);
public void setClip(Shape clip);
public void clipRect(int x, int y, int width, int height);
public void translate(int x, int y);
public Color getColor();
public void setPaintMode();
public Font getFont():
public void clearRect(int x, int y, int width, int height);
public void dispose();
public void drawT2Curve(FloatPoint pta, FloatPoint ptb, FloatPoint ptc, int xOrig, int yOrig);
public void drawBezier(int xOrig, int yOrig, int values[], int nPoints);
public Rectangle getClipRect();
public void draw3DRect(int x, int y, int width, int height, boolean raised);
public void fill3DRect(int x, int y, int width, int height, boolean raised);
public Shape getClip();
public void drawPolyLine(int xPoints[], int yPoints[], int nPoints);
}
A class that encapsulates an extended graphics object.
public FxGraphics(FxGraphics g);Creates a graphics object based on another graphics object.
Parameter Description g The graphics object that will be used to create the new object.
public FxGraphics(Graphics g);Creates a graphics object based on another graphics object.
Parameter Description g The non-FxGraphics graphics object that will be used to create the new object.
public final static boolean isRunningAFCNative();Determines if the native layer for the Application Foundation Classes (AFC) graphics is available.
Return Value:
Returns true if the native layer for AFC graphics is available; otherwise, returns false.
public Rectangle getClipBounds();Retrieves the current clipping area.
Return Value:
Returns a Rectangle describing the current clipping area.
public void fillRect(int X, int Y, int W, int H);Fills the specified rectangle with the current color.
Return Value:
No return value.
Parameter Description X The x coordinate of the rectangle's starting point. Y The y coordinate of the rectangle's starting point. W The width of the rectangle. H The height of the rectangle. See Also: drawRect
public void drawRect(int X, int Y, int W, int H);Draws the outline of the specified rectangle using the current color.
Return Value:
No return value.
Parameter Description X The x coordinate of the rectangle's starting point. Y The y coordinate of the rectangle's starting point. W The width of the rectangle. H The height of the rectangle See Also: fillRect
public void drawPixels(int pels[], int len);Draws the listed pixels.
Return Value:
No return value.
Parameter Description pels An array of pixels. len The length of the array.
public void drawLine(int x1, int y1, int x2, int y2);This method draws a line from point(x1, y1) to point(x2, y2).
Return Value:
No return value.
Parameter Description x1 The x coordinate of the starting point of the line. y1 The y coordinate of the starting point of the line. x2 The x coordinate of the ending point of the line. y2 The y coordinate of the ending point of the line.
public void drawOval(int x, int y, int w, int h);This method draws an oval within the specified bounding rectangle.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the bounding rectangle. y The y coordinate of the upper left corner of the bounding rectangle. w The width of the bounding rectangle. h The height of the bounding rectangle.
public void fillOval(int x, int y, int w, int h);This method draws a filled oval within the specified bounding rectangle.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the bounding rectangle. y The y coordinate of the upper left corner of the bounding rectangle. w The width of the bounding rectangle. h The height of the bounding rectangle.
public void drawArc(int x, int y, int w, int h, int startAngle,int endAngle);Draws an arc.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the bounding rectangle. y The y coordinate of the upper left corner of the bounding rectangle. w The width of the bounding rectangle. h The height of the bounding rectangle. startAngle The starting angle of the arc. endAngle The ending angle of the arc.
public void fillArc(int x, int y, int w, int h,int startAngle,int endAngle);Draws a filled arc, which results in a pie shape.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the bounding rectangle. y The y coordinate of the upper left corner of the bounding rectangle. w The width of the bounding rectangle. h The height of the bounding rectangle. startAngle The starting angle of the arc. endAngle The ending angle of the arc.
public void copyArea(int X, int Y, int W, int H, int dx, int dy);Copies an area to a new location.
Return Value:
No return value.
Parameter Description X The x coordinate of the starting point. Y The y coordinate of the starting point. W The area's width. H The area's height. dx The destination x coordinate. dy The destination y coordinate.
public void copyArea(int x, int y, int w, int h, Graphics g, int srcX, int srcY, int srcW, int srcH);Copies an area from a graphics object.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the area. y The y coordinate of the upper left corner of the area. w The area's width. h The area's height. g The graphics object to use. srcX The x coordinate of the upper left corner of the source graphics object. srcY The y coordinate of the upper left corner of the source graphics object. srcW The source graphic's width. srcH The source graphic's height.
public void setXORMode(Color c1);Sets the paint mode of the graphics context to alternate between the current color and the specified color.
Return Value:
No return value.
Parameter Description c1 The color to alternate with.
public void drawRoundRect(int x, int y, int w, int h,int arcWidth, int arcHeight);Draws a rounded rectangle.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the bounding rectangle. y The y coordinate of the upper left corner of the bounding rectangle. w The width of the rectangle. h The height of the rectangle. arcWidth The arc width of the rectangle's rounded edges. arcHeight The arc height of the rectangle's rounded edges.
public void fillRoundRect(int x, int y, int w, int h,int arcWidth, int arcHeight);Draws a filled rounded rectangle using the fill, if one is available.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the bounding rectangle. y The y coordinate of the upper left corner of the bounding rectangle. w The width of the rectangle. h The height of the rectangle. arcWidth The arc width of the rectangle's rounded edges. arcHeight The arc height of the rectangle's rounded edges.
public void drawPolygon(int xPoints[], int yPoints[], int nPoints);Draws a polygon.
Return Value:
No return value.
Parameter Description xPoints An array containing the polygon's x coordinates. yPoints An array containing the polygon's y coordinates. nPoints The number of points in the polygon.
public void drawScanLines(boolean xChanging, int points[], int offset, int nPoints);Draws fast lines, either horizontally or vertically.
Return Value:
No return value.
Parameter Description xChanging The direction the line should be drawn, either vertically or horizontally. points An array of points. offset The offset to use. nPoints The number of points in the array.
public void fillPolygon(int xPoints[], int yPoints[], int nPoints);Draws a polygon filled with the current color.
Return Value:
No return value.
Parameter Description xPoints An array containing the polygon's x coordinates. yPoints An array containing the polygon's y coordinates. nPoints The number of points in the polygon.
public FxGraphics create();Creates an instance of the FxGraphics class that is a copy of the current one.
Return Value:
Returns an FxGraphics object if successful.
public static FxGraphics getExtendedGraphics(Graphics g);Retrieves an extended graphics object. This allows the extended objects to be used with any set of class libraries.
Return Value:
Returns an extended graphics object.
Parameter Description g A base graphics object.
public void setFont(Font font);Sets the font for all subsequent text-drawing operations.
Return Value:
No return value.
Parameter Description font The specified font. See Also: drawString, drawBytes, and drawChars.
protected void nativeSetFont(Font font);Called by setFont and by outlineFont. Outline fonts are outline versions of TrueType fonts, so they need to be able to get to the rasteriser.
Return Value:
No return value.
Parameter Description font The specified font.
public void drawChars(char data[], int offset, int length, int x, int y);Draws the given character array.
Return Value:
No return value.
Parameter Description data The array of characters to be drawn. offset The offset to use. length The length of the array used. x The x coordinate of the location where the characters should be drawn. y The y coordinate of the location where the characters should be drawn.
public void drawChars(char data[], int offset, int length, int x, int y, Rectangle optionRect, int options, int dx[], int dy[]);A complete drawChars method that can specify a clipping rectangle or opaquing rectangle for only the current operation.
Return Value:
No return value.
Parameter Description data The array of characters to be drawn. offset The offset to use. length The length of the array used. x The x coordinate of the location where the characters should be drawn. y The y coordinate of the location where the characters should be drawn. optionRect The optional rectangle for clipping or opaquing. options The options for this method. dx An array of destination x coordinates. dy An array of destination y coordinates.
public void drawString(String str, int x, int y, Rectangle optionRect, int options, int dx[], int dy[]);Draws the given string.
Return Value:
No return value.
Parameter Description str The string to draw. x The x coordinate of the location where the string should be drawn. y The y coordinate of the location where the string should be drawn. optionRect The optional rectangle for clipping and opaquing. options The options for this method. dx An array of destination x coordinates. dy An array of destination y coordinates.
public void drawString(String str, int x, int y, Rectangle optionRect, int options, int meta[]);Draws the given string using a meta advancement list.
Return Value:
No return value.
Parameter Description str The string to draw. x The x coordinate of the location where the string should be drawn. y The y coordinate of the location where the string should be drawn. optionRect The optional rectangle for clipping and opaquing. options The options for this method. meta The meta advance array.
public void drawString(String str, int x, int y);Draws the given string.
Return Value:
No return value.
Parameter Description str The string to draw. x The x coordinate of the location where the string should be drawn. y The y coordinate of the location where the string should be drawn.
public void drawBytes(byte data[], int offset, int length, int x, int y);Draws an array of bytes.
Return Value:
No return value.
Parameter Description data The array of bytes. offset The offset to use. length The length of the array used. x The x coordinate of the location where the bytes should be drawn. y The y coordinate of the location where the bytes should be drawn.
public void drawOutlineChar(int xOrig, int yOrig, GlyphOutline go);Draws an outline character.
Return Value:
No return value.
Parameter Description xOrig The x coordinate of the character. yOrig The y coordinate of the character. go The GlyphOutline to use.
public boolean drawBorder(Rectangle rect, int edge, int flags);Draws the border of a three-dimensional rectangle.
Return Value:
Returns true if successful; otherwise, returns false.
Parameter Description rect The rectangle to use. edge The edge to use. flags The specified border flags. Remarks:
For a complete listing of all border flags, see IFxGraphicsConstants.
public void drawOutlinePolygon(int xOrig, int yOrig, OutlinePolygon op);Draws an outline polygon.
Return Value:
No return value.
Parameter Description xOrig The horizontal starting point for the shape. yOrig The vertical starting point for the shape. op The outline polygon.
public boolean drawEdge(Rectangle inRect, int edge, int flags);Draws the edges of a three-dimensional rectangle.
Return Value:
Returns true if successful; otherwise, returns false.
Parameter Description inRect The rectangle to use. edge The edge to use. flags The specified edge style. Remarks:
For a complete listing of all edge styles, see IFxGraphicsConstants.
public GlyphOutline getGlyphOutline(char ch);Retrieves the outline of the character in the currently selected font.
Return Value:
If the font is not an outline font, null is returned. Otherwise; the method returns an OutlinePolygon object.
Parameter Description ch The character whose outline is requested.
public FontMetrics getFontMetrics(Font font);Retrieves the metrics for the given font.
Return Value:
Returns the font metrics if successful.
Parameter Description font The font to get the metrics for.
public Color getTextBackgroundColor();Retrieves the text background color.
Return Value:
Returns the background color. (This value may be null.)
Remarks:
This method is used for opaquing text.
public void setTextBackgroundColor(Color c);Sets the text background color.
Return Value:
No return value.
Parameter Description c Color to set the background to. Remarks:
This method is used for opaquing text.
public void setColor(Color c);Sets the foreground color (and foreground color type if AFCs are being used).
Return Value:
No return value.
Parameter Description c The color to set the foreground to.
public FxFormattedText drawStringFormatted(String s, Rectangle r, int hta, int vta, int ww, boolean bordered, int tabOrigin, int tabs[], IFxShape outline);Draws a formatted text string.
Return Value:
Returns an FxFormattedText object, which is a formatted text string.
Parameter Description s The string to draw. r The bounding rectangle. hta The horizontal alignment. vta The vertical alignment. ww A word wrap value. bordered Determines whether the string is bordered. tabOrigin Set tabs are in respect to this position in the text string. tabs[] The tab stops. outline The outline for the formatted text (may be null).
public void drawTabbedString(String s, int x, int y, int iTabOrigin, int tabs[]);Draws a tabbed text string.
Return Value:
No return value.
Parameter Description s The string to draw. x The x position of the baseline at which to draw the string. y The y position. iTabOrigin The set tabs are in respect to this position in the text string. tabs[] The tab stops.
public void drawTabbedChars(char s[], int off, int len, int x, int y, int iTabOrigin, int tabs[]);Draws an array of tabbed characters.
Return Value:
No return value.
Parameter Description s[] The array of characters to draw. off The offset to use. len The length of the array. x The x position of the baseline at which to draw the string. y the y position. iTabOrigin The set tabs are in respect to this position in the text string. tabs[] The tab stops.
public int stringTabbedWidth(String s, int iTabbedOrigin, int tabs[]);Retrieves the width of a tabbed string.
Return Value:
Returns the width of a tabbed string.
Parameter Description s The measured string. iTabbedOrigin The set tabs are in respect to this position in the text string. tabs[] The tab stops.
public int charsTabbedWidth(char s[], int off, int len, int iTabOrigin, int tabs[]);Retrieves the width of a tabbed character array.
Return Value:
Returns the width of a tabbed character array.
Parameter Description s[] The character array. off The offset to use. len The length of the array. iTabOrigin The set tabs are in respect to this position in the character array. tabs[] The tab stops.
public boolean drawImage(Image img, int x, int y, ImageObserver observer);Draws the specified image at the given coordinates.
Return Value:
Returns true if successful; otherwise, returns false.
Parameter Description img The image to be drawn. x The target x coordinate. y The target y coordinate. observer An ImageObserver that notifies if an image is complete.
public boolean drawImage(Image img, int x, int y, int width, int height, ImageObserver observer);Draws the specified image within the given rectangle.
Return Value:
Returns true if successful; otherwise, returns false.
Parameter Description img The image to be drawn. x The bounding rectangle's upper left x coordinate. y The bounding rectangle's upper left y coordinate. width The width of the bounding rectangle. height The height of the bounding rectangle. observer An ImageObserver which notifies if an image is complete. Remarks:
The image is scaled if necessary. If the image is incomplete, the ImageObserver will be notified later.
public boolean drawImage(Image img, int x, int y, Color bgcolor, ImageObserver observer);Draws the image with a background color at the given coordinates.
Return Value:
Returns true if successful; otherwise, returns false.
Parameter Description img The image to be drawn. x The target x coordinate. y The target y coordinate. bgcolor The background color to use. observer An ImageObserver which notifies if an image is complete.
public boolean drawImage(Image img, int x, int y, int width, int height, Color bgcolor, ImageObserver observer);Draws the specified image, with a background color, within the given rectangle.
Return Value:
Returns true if successful otherwise, returns false.
Parameter Description img The image to be drawn. x The bounding rectangle's upper left x coordinate. y The bounding rectangle's upper left y coordinate. width The width of the bounding rectangle. height The height of the bounding rectangle. bgcolor The background color to use. observer An ImageObserver which notifies if an image is complete. Remarks:
The image is scaled if necessary. If the image is incomplete, the ImageObserver will be notified later.
public boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, ImageObserver observer);Draws the specified area in the image as is currently available.
Return Value:
Returns immediately in all cases, even if the entire area of the image has not yet been scaled, dithered and converted.
Parameter Description img The image to be drawn. dx1 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. observer The object to be notified as more of the image is scaled and converted.
public boolean drawImage(Image img, int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2, Color bgcolor, ImageObserver observer);Draws the specified area in the image as is currently available, with a given background color.
Return Value:
Returns immediately in all cases, even if the entire area of the image has not yet been scaled, dithered and converted.
Parameter Description img The image to be drawn. dx1 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. bgcolor The background color to use. observer The object to be notified as more of the image is scaled and converted.
public void setClip(int x, int y, int width, int height);Sets the clipping area to the specified rectangle.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the clipping rectangle. y The y coordinate of the upper left corner of the clipping rectangle. width The width of the clipping rectangle. height The height of the clipping rectangle.
public void setClip(Shape clip);Sets the clipping area to the specified Shape.
Return Value:
No return value.
Parameter Description clip The shape of the clipping area.
public void clipRect(int x, int y, int width, int height);Sets a clipping rectangle for the current graphics context.
Return Value:
No return value.
Parameter Description x The x coordinate of the clipping rectangle. y The y coordinate of the clipping rectangle. width The width of the clipping rectangle. height The height of the clipping rectangle.
public void translate(int x, int y);Sets the graphic context's origin to point(x, y) relative to the graphic's original coordinate system.
Return Value:
No return value.
Parameter Description x The x coordinate of the new origin. y The y coordinate of the new origin
public Color getColor();Retrieves the graphic context's current color.
Return Value:
Returns the current Color.
public void setPaintMode();Sets the paint mode of the current graphics context to overwrite the destination with the current color.
Return Value:
No return value.
public Font getFont();Retrieves the graphic context's current font.
Return Value:
Returns the current Font.
public void clearRect(int x, int y, int width, int height);Clears the specified rectangle by filling it with the background color.
Return Value:
No return value.
Parameter Description x The x coordinate of the upper left corner of the rectangle to clear. y The y coordinate of the upper left corner of the rectangle to clear. width The width of the rectangle to clear. height The height of the rectangle to clear.
public void dispose();Disposes the graphics object after it is no longer being referenced.
Return Value:
No return value.
public void drawT2Curve(FloatPoint pta, FloatPoint ptb, FloatPoint ptc, int xOrig, int yOrig);Draws a T2 curve, a three-point Bezier curve using TrueType fonts, for part of a glyph outline.
Return Value:
No return value.
Parameter Description pta Point a on the T2 curve. ptb Point b on the T2 curve. ptc Point c on the T2 curve. xOrig The x coordinate of the origin for the curve. yOrig The y coordinate of the origin for the curve.
public void drawBezier(int xOrig, int yOrig, int values[], int nPoints);Draws a Bezier curve.
Return Value:
No return value.
Parameter Description xOrig The x coordinate of the origin for the curve. yOrig The y coordinate of the origin for the curve. values[] An array of values used to draw the curve. nPoints The number of points in the curve.
public Rectangle getClipRect();Retrieves the current clipping area.
Return Value:
Returns a Rectangle that defines the current clipping area.
public void draw3DRect(int x, int y, int width, int height, boolean raised);Draws a three-dimensional rectangle with a specified edge style.
Return Value:
No return value.
Parameter Description x The x coordinate of the rectangle's upper left corner. y The y coordinate of the rectangle's upper left corner. width The width of the rectangle. height The height of the rectangle. raised Determines either a raised or sunken edge.
public void fill3DRect(int x, int y, int width, int height, boolean raised);Draws a filled three-dimensional rectangle with the specified edge style.
Return Value:
No return value.
Parameter Description x The x coordinate of the rectangle's upper left corner. y The y coordinate of the rectangle's upper left corner. width The width of the rectangle. height The height of the rectangle. raised Determines either a raised or sunken edge.
public Shape getClip();Retrieves the current clipping area.
Return Value:
Returns a Shape that defines the clipping area.
public void drawPolyLine(int xPoints[], int yPoints[], int nPoints);Draws multiple lines at one time.
Return Value:
No return value.
Parameter Description xPoints[] An array of x coordinates. yPoints[] An array of y coordinates. nPoints The number of points used to draw the lines.
© 1997 Microsoft Corporation. All rights reserved. Legal Notices.