Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » usermodel » [javadoc | source]
org.apache.poi.hssf.usermodel
public class: EscherGraphics [javadoc | source]
java.lang.Object
   java.awt.Graphics
      org.apache.poi.hssf.usermodel.EscherGraphics
Translates Graphics calls into escher calls. The translation is lossy so many features are not supported and some just aren't implemented yet. If in doubt test the specific calls you wish to make. Graphics calls are always performed into an EscherGroup so one will need to be created.

Important:

One important concept worth considering is that of font size. One of the difficulties in converting Graphics calls into escher drawing calls is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'characters' and the cell heights in points. Unfortunately it's not defined exactly what a type of character it's measuring. Presumably this is due to the fact that the Excel will be using different fonts on different platforms or even within the same platform.

Because of this constraint we've had to calculate the verticalPointsPerPixel. This the amount the font should be scaled by when you issue commands such as drawString(). A good way to calculate this is to use the follow formula:

multipler = groupHeightInPoints / heightOfGroup

The height of the group is calculated fairly simply by calculating the difference between the y coordinates of the bounding box of the shape. The height of the group can be calculated by using a convenience called HSSFClientAnchor.getAnchorHeightInPoints().

Constructor:
 public EscherGraphics(HSSFShapeGroup escherGroup,
    HSSFWorkbook workbook,
    Color forecolor,
    float verticalPointsPerPixel) 
    Construct an escher graphics object.
    Parameters:
    escherGroup - The escher group to write the graphics calls into.
    workbook - The workbook we are using.
    forecolor - The foreground color to use as default.
    verticalPointsPerPixel - The font multiplier. (See class description for information on how this works.).
 EscherGraphics(HSSFShapeGroup escherGroup,
    HSSFWorkbook workbook,
    Color foreground,
    Font font,
    float verticalPointsPerPixel) 
    Constructs an escher graphics object.
    Parameters:
    escherGroup - The escher group to write the graphics calls into.
    workbook - The workbook we are using.
    foreground - The foreground color to use as default.
    verticalPointsPerPixel - The font multiplier. (See class description for information on how this works.).
    font - The font to use.
Method from org.apache.poi.hssf.usermodel.EscherGraphics Summary:
clearRect,   clipRect,   copyArea,   create,   dispose,   drawArc,   drawImage,   drawImage,   drawImage,   drawImage,   drawImage,   drawImage,   drawLine,   drawLine,   drawOval,   drawPolygon,   drawPolyline,   drawRect,   drawRoundRect,   drawString,   drawString,   fillArc,   fillOval,   fillPolygon,   fillRect,   fillRoundRect,   getBackground,   getClip,   getClipBounds,   getClipRect,   getColor,   getEscherGraphics,   getFont,   getFontMetrics,   setBackground,   setClip,   setClip,   setColor,   setFont,   setPaintMode,   setXORMode,   translate
Methods from java.awt.Graphics:
clearRect,   clipRect,   copyArea,   create,   create,   dispose,   draw3DRect,   drawArc,   drawBytes,   drawChars,   drawImage,   drawImage,   drawImage,   drawImage,   drawImage,   drawImage,   drawLine,   drawOval,   drawPolygon,   drawPolygon,   drawPolyline,   drawRect,   drawRoundRect,   drawString,   drawString,   fill3DRect,   fillArc,   fillOval,   fillPolygon,   fillPolygon,   fillRect,   fillRoundRect,   finalize,   getClip,   getClipBounds,   getClipBounds,   getClipRect,   getColor,   getFont,   getFontMetrics,   getFontMetrics,   hitClip,   setClip,   setClip,   setColor,   setFont,   setPaintMode,   setXORMode,   toString,   translate
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.usermodel.EscherGraphics Detail:
 public  void clearRect(int x,
    int y,
    int width,
    int height) 
 public  void clipRect(int x,
    int y,
    int width,
    int height) 
 public  void copyArea(int x,
    int y,
    int width,
    int height,
    int dx,
    int dy) 
 public Graphics create() 
 public  void dispose() 
 public  void drawArc(int x,
    int y,
    int width,
    int height,
    int startAngle,
    int arcAngle) 
 public boolean drawImage(Image image,
    int i,
    int j,
    ImageObserver imageobserver) 
 public boolean drawImage(Image image,
    int i,
    int j,
    Color color,
    ImageObserver imageobserver) 
 public boolean drawImage(Image image,
    int i,
    int j,
    int k,
    int l,
    ImageObserver imageobserver) 
 public boolean drawImage(Image image,
    int i,
    int j,
    int k,
    int l,
    Color color,
    ImageObserver imageobserver) 
 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 drawLine(int x1,
    int y1,
    int x2,
    int y2) 
 public  void drawLine(int x1,
    int y1,
    int x2,
    int y2,
    int width) 
 public  void drawOval(int x,
    int y,
    int width,
    int height) 
 public  void drawPolygon(int[] xPoints,
    int[] yPoints,
    int nPoints) 
 public  void drawPolyline(int[] xPoints,
    int[] yPoints,
    int nPoints) 
 public  void drawRect(int x,
    int y,
    int width,
    int height) 
 public  void drawRoundRect(int x,
    int y,
    int width,
    int height,
    int arcWidth,
    int arcHeight) 
 public  void drawString(String str,
    int x,
    int y) 
 public  void drawString(AttributedCharacterIterator iterator,
    int x,
    int y) 
 public  void fillArc(int x,
    int y,
    int width,
    int height,
    int startAngle,
    int arcAngle) 
 public  void fillOval(int x,
    int y,
    int width,
    int height) 
 public  void fillPolygon(int[] xPoints,
    int[] yPoints,
    int nPoints) 
    Fills a (closed) polygon, as defined by a pair of arrays, which hold the x and y coordinates.

    This draws the polygon, with nPoint line segments. The first nPoint - 1 line segments are drawn between sequential points (xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]). The final line segment is a closing one, from the last point to the first (assuming they are different).

    The area inside of the polygon is defined by using an even-odd fill rule (also known as the alternating rule), and the area inside of it is filled.

 public  void fillRect(int x,
    int y,
    int width,
    int height) 
 public  void fillRoundRect(int x,
    int y,
    int width,
    int height,
    int arcWidth,
    int arcHeight) 
 public Color getBackground() 
 public Shape getClip() 
 public Rectangle getClipBounds() 
 public Rectangle getClipRect() 
 public Color getColor() 
 HSSFShapeGroup getEscherGraphics() 
 public Font getFont() 
 public FontMetrics getFontMetrics(Font f) 
 public  void setBackground(Color background) 
 public  void setClip(Shape shape) 
 public  void setClip(int x,
    int y,
    int width,
    int height) 
 public  void setColor(Color color) 
 public  void setFont(Font f) 
 public  void setPaintMode() 
 public  void setXORMode(Color color) 
 public  void translate(int x,
    int y)