Home » JCraft » jxl » biff » drawing » [javadoc | source]
jxl.biff.drawing
public class: Comment [javadoc | source]
java.lang.Object
   jxl.biff.drawing.Comment

All Implemented Interfaces:
    DrawingGroupObject

Contains the various biff records used to insert a cell note into a worksheet
Constructor:
 public Comment(DrawingGroupObject dgo,
    DrawingGroup dg,
    WorkbookSettings ws) 
    Copy constructor used to copy drawings from read to write
    Parameters:
    dgo - the drawing group object
    dg - the drawing group
    ws - the workbook settings
 public Comment(String txt,
    int c,
    int r) 
    Constructor invoked when writing the images
    Parameters:
    txt - the comment text
    c - the column
    r - the row
 public Comment(MsoDrawingRecord msorec,
    ObjRecord obj,
    DrawingData dd,
    DrawingGroup dg,
    WorkbookSettings ws) 
    Constructor used when reading images
    Parameters:
    msorec - the drawing record
    obj - the object record
    dd - the drawing data for all drawings on this sheet
    dg - the drawing group
    ws - the workbook settings
Method from jxl.biff.drawing.Comment Summary:
addMso,   getBlipId,   getColumn,   getDrawingGroup,   getHeight,   getImageBytes,   getImageData,   getImageFilePath,   getMsoDrawingRecord,   getObjectId,   getOrigin,   getReferenceCount,   getRow,   getShapeId,   getSpContainer,   getText,   getType,   getWidth,   getX,   getY,   hashCode,   isFirst,   isFormObject,   setCommentText,   setDrawingGroup,   setFormatting,   setHeight,   setNote,   setObjectId,   setReferenceCount,   setText,   setTextObject,   setWidth,   setX,   setY,   writeAdditionalRecords,   writeTailRecords
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from jxl.biff.drawing.Comment Detail:
 public  void addMso(MsoDrawingRecord d) 
    Adds an mso record to this object
 public final int getBlipId() 
    Accessor for the blip id
 public int getColumn() 
    Accessor for the column
 public DrawingGroup getDrawingGroup() 
    Accessor for the drawing group
 public double getHeight() 
    Accessor for the height of this drawing
 public byte[] getImageBytes() 
    Accessor for the image data
 public byte[] getImageData() 
    Accessor for the image data
 public String getImageFilePath() 
    Accessor for the image file path. Normally this is the absolute path of a file on the directory system, but if this drawing was constructed using an byte[] then the blip id is returned
 public MsoDrawingRecord getMsoDrawingRecord() 
    Gets the drawing record which was read in
 public final int getObjectId() 
    Accessor for the object id
 public Origin getOrigin() 
    Gets the origin of this drawing
 public int getReferenceCount() 
    Accessor for the reference count on this drawing
 public int getRow() 
    Accessor for the row
 public final int getShapeId() 
    Accessor for the shape id
 public EscherContainer getSpContainer() 
    Creates the main Sp container for the drawing
 public String getText() 
    Accessor for the comment text
 public ShapeType getType() 
    Accessor for the type
 public double getWidth() 
    Accessor for the width of this drawing
 public double getX() 
    Accessor for the column of this drawing
 public double getY() 
    Accessor for the row of this drawing
 public int hashCode() 
    Hashing algorithm
 public boolean isFirst() 
    Accessor for the first drawing on the sheet. This is used when copying unmodified sheets to indicate that this drawing contains the first time Escher gubbins
 public boolean isFormObject() 
    Queries whether this object is a form object. Form objects have their drawings records spread over several records and require special handling
 public  void setCommentText(String t) 
    Called when the comment text is changed during the sheet copy process
 public  void setDrawingGroup(DrawingGroup dg) 
    Sets the drawing group for this drawing. Called by the drawing group when this drawing is added to it
 public  void setFormatting(ContinueRecord t) 
    Sets the formatting
 public  void setHeight(double h) 
    Accessor for the height of this drawing
 public  void setNote(NoteRecord t) 
    Sets the note object
 public final  void setObjectId(int objid,
    int bip,
    int sid) 
    Sets the object id. Invoked by the drawing group when the object is added to id
 public  void setReferenceCount(int r) 
    Sets the new reference count on the drawing
 public  void setText(ContinueRecord t) 
    Sets the text data
 public  void setTextObject(TextObjectRecord t) 
    Sets the text object
 public  void setWidth(double w) 
    Accessor for the width
 public  void setX(double x) 
    Sets the column position of this drawing. Used when inserting/removing columns from the spreadsheet
 public  void setY(double y) 
    Accessor for the row of the drawing
 public  void writeAdditionalRecords(File outputFile) throws IOException 
    Writes out the additional comment records
 public  void writeTailRecords(File outputFile) throws IOException 
    Writes any records that need to be written after all the drawing group objects have been written Writes out all the note records