Note (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.XLSRecord
- - io.starter.formats.XLS.Note

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable
```
public final class Note
extends XLSRecord
```
Note: A cell annotation (1CDh)
Note records contain the row/col position of the annotation, plus an ordinal id that links it to the set of records that define it: Mso/obj/mso/Txo/Continue/Continue. These record sets appear one after another after the DIMENSIONS record and before WINDOW2. After the associated records, all Note records appear, in order. Kaia's notes on notes: The Note record is the last of a set of records necessary to define each note: Mso - shapeType= msosptTextBox. See Msodrawing.createTextBoxStyle for a list of the necessary sub-records Obj containing an ftNts sub-record Mso - odd Mso cotnaining only 8 bytes - see Msodrawing.getAttachedTextPrototype Txo - contains the size of the text + options such as text rotation + size of the formatting runs Continue - 0 + text Continue - formatting runs for text For each note, the above records repeat, then each Note record appears in order after all of the above recs Notes appear to have an ordinal id that is necessary for proper display It's hidden/shown state appears to be defined by byte 5 but there is also other necessary info that I don't know yet The tricky part of Notes is the Mso msosptTextBox plus the Mso msosptClientTextBox; they don't follow the normal rules we are used to - the SPCONTAINERLENGTH of the 1st Mso MUST BE inc by 8, the length of the second Mso ... but when multiple Notes are on the same sheet, that logic doesn't seem to be followed 100% plus the number of shapes of the mso header is NOT incremented by the secondary Mso ... Also, the Mso's don't appear to follow the normal rules for the drawing Id - seem to be repeated ... Lastly, the 1st Mso contains an OPT sub-record msofbtlTxid; this contains the host-defined id for the note; I'm not sure what to set for this so I put a random int. More info: Some templates define notes differently; instead of the above set of records, it goes Obj (ftNts) Continue [00, 00, (byte)0x0D, (byte)0xF0, 00, 00, 00, 00] --> masks the 2nd mso Txo Continue Continue Continue --> masks the 1st mso Also: formatting runs: This is almost finished but - of course - doc on formatting runs format doesn't appear to match reality ((:) Also: There needs to be a good, easy interface for setting formatting runs for a text string offset name size contents --- 0 2 Index to row 2 2 Index to column 4 2 grbit controls hidden state - 0=hidden, 2=shown 6 2 ordinal id MUST MATCH Obj record id 8 1 lenght of author string or /2 if encoding=1 9 1 encoding 0= non-unicode? 1= unicode? 10 (var) 0 + author bytes (author encoding)

See Also:

Note, Serialized Form

Field Summary
- Fields inherited from class io.starter.formats.XLS.XLSRecord
  col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet
- Fields inherited from interface io.starter.formats.XLS.XLSConstants
  AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors
Constructor and Description

Note()

Constructors
Constructor and Description
`Note()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuthor()` return the author of this note, if set
`ArrayList`	`getFormattingRuns()` Method to retrieve formatting runs for this Note (Comment) Formatting Runs are an Internal Structure and are not relavent to the end user
`boolean`	`getHidden()` returns true if this note is hidden (default state)
`int`	`getId()` retrieve the ordinal id of this note
`String`	`getOOXML()` returns the OOXML representation of this Note
`static XLSRecord`	`getPrototype(String author)`
`int`	`getSPID()` get the id of drawing object which defines the text box for this Note For Internal Use Only
`String`	`getText()` returns the Text of this Note or Comment
`short[]`	`getTextBoxBounds()` returns the bounds (size and position) of the Text Box for this Note bounds are relative and based upon rows, columns and offsets within bounds are as follows: bounds[0]= column # of top left position (0-based) of the shape bounds[1]= x offset within the top-left column (0-1023) bounds[2]= row # for top left corner bounds[3]= y offset within the top-left corner (0-1023) bounds[4]= column # of the bottom right corner of the shape bounds[5]= x offset within the cell for the bottom-right corner (0-1023) bounds[6]= row # for bottom-right corner of the shape bounds[7]= y offset within the cell for the bottom-right corner (0-1023)
`void`	`init()` perform record initialization
`void`	`setAuthor(String author)` sets the author of this note
`void`	`setFormattingRuns(ArrayList formattingRuns)` Store formatting runs for this Note (Comment) Formatting Runs are an Internal Structure and are not relavent to the end user
`void`	`setHidden(boolean hidden)` show or hide this note NOTE: this is still experimental
`void`	`setId(int id)` return the ordinal id of this note
`void`	`setRowCol(int row, int col)` set the row and column that this note is attached to
`void`	`setSheet(Sheet bs)` Associate this record with a worksheet.
`void`	`setText(String txt)` sets the Text of this Note or Comment
`void`	`setText(Unicodestring txt)` /** set the text of this Note (Comment) as a unicode string, with formatting information
`void`	`setTextBoxBounds(short[] bounds)` sets the bounds (size and position) of the Text Box for this Note bounds are relative and based upon rows, columns and offsets within bounds are as follows: bounds[0]= column # of top left position (0-based) of the shape bounds[1]= x offset within the top-left column (0-1023) bounds[2]= row # for top left corner bounds[3]= y offset within the top-left corner (0-1023) bounds[4]= column # of the bottom right corner of the shape bounds[5]= x offset within the cell for the bottom-right corner (0-1023) bounds[6]= row # for bottom-right corner of the shape bounds[7]= y offset within the cell for the bottom-right corner (0-1023)
`void`	`setTextBoxHeight(short height)` sets the text box width for the note in pixels
`void`	`setTextBoxWidth(short width)` sets the text box width for the note in pixels
`String`	`toString()` Is this a useful to string? possibly just the note itself, at a minimum include it

Methods inherited from class io.starter.formats.XLS.XLSRecord
addContinue, clone, close, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

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

- Constructor Detail
  - Note
```
public Note()
```
- Method Detail
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - setSheet
```
public void setSheet(Sheet bs)
```
    Description copied from class: XLSRecord
    
    Associate this record with a worksheet. First checks to see if there is already a cell with this address.
    
    Specified by:
    
    setSheet in interface BiffRec
    
    Overrides:
    
    setSheet in class XLSRecord
  - toString
```
public String toString()
```
    Is this a useful to string? possibly just the note itself, at a minimum include it
    
    Overrides:
    
    toString in class XLSRecord
    
    See Also:
    
    XLSRecord.toString()
  - getPrototype
```
public static XLSRecord getPrototype(String author)
```
  - setRowCol
```
public void setRowCol(int row,
                      int col)
```
    set the row and column that this note is attached to
    
    Parameters:
    
    row -
    
    col -
  - setId
```
public void setId(int id)
```
    return the ordinal id of this note
    
    Parameters:
    
    id -
  - getId
```
public int getId()
```
    retrieve the ordinal id of this note
    
    Returns:
  - getHidden
```
public boolean getHidden()
```
    returns true if this note is hidden (default state)
    
    Returns:
  - setHidden
```
public void setHidden(boolean hidden)
```
    show or hide this note
    NOTE: this is still experimental
    
    Parameters:
    
    hidden -
  - getText
```
public String getText()
```
    returns the Text of this Note or Comment
    
    Returns:
    
    String
  - setText
```
public void setText(String txt)
```
    sets the Text of this Note or Comment
    
    Parameters:
    
    txt -
  - setText
```
public void setText(Unicodestring txt)
```
    /** set the text of this Note (Comment) as a unicode string, with formatting information
    
    Parameters:
    
    txt -
  - getAuthor
```
public String getAuthor()
```
    return the author of this note, if set
    
    Returns:
  - setAuthor
```
public void setAuthor(String author)
```
    sets the author of this note
    
    Parameters:
    
    author -
  - getTextBoxBounds
```
public short[] getTextBoxBounds()
```
    returns the bounds (size and position) of the Text Box for this Note
    bounds are relative and based upon rows, columns and offsets within
    bounds are as follows:
    bounds[0]= column # of top left position (0-based) of the shape
    bounds[1]= x offset within the top-left column (0-1023)
    bounds[2]= row # for top left corner
    bounds[3]= y offset within the top-left corner (0-1023)
    bounds[4]= column # of the bottom right corner of the shape
    bounds[5]= x offset within the cell for the bottom-right corner (0-1023)
    bounds[6]= row # for bottom-right corner of the shape
    bounds[7]= y offset within the cell for the bottom-right corner (0-1023)
    
    Returns:
  - setTextBoxBounds
```
public void setTextBoxBounds(short[] bounds)
```
    sets the bounds (size and position) of the Text Box for this Note
    bounds are relative and based upon rows, columns and offsets within
    bounds are as follows:
    bounds[0]= column # of top left position (0-based) of the shape
    bounds[1]= x offset within the top-left column (0-1023)
    bounds[2]= row # for top left corner
    bounds[3]= y offset within the top-left corner (0-1023)
    bounds[4]= column # of the bottom right corner of the shape
    bounds[5]= x offset within the cell for the bottom-right corner (0-1023)
    bounds[6]= row # for bottom-right corner of the shape
    bounds[7]= y offset within the cell for the bottom-right corner (0-1023)
    
    Parameters:
    
    bounds -
  - setTextBoxWidth
```
public void setTextBoxWidth(short width)
```
    sets the text box width for the note in pixels
    
    Parameters:
    
    width -
  - setTextBoxHeight
```
public void setTextBoxHeight(short height)
```
    sets the text box width for the note in pixels
    
    Parameters:
    
    width -
  - setFormattingRuns
```
public void setFormattingRuns(ArrayList formattingRuns)
```
    Store formatting runs for this Note (Comment)
    Formatting Runs are an Internal Structure and are not relavent to the end user
    
    Parameters:
    
    formattingRuns -
  - getFormattingRuns
```
public ArrayList getFormattingRuns()
```
    Method to retrieve formatting runs for this Note (Comment)
    Formatting Runs are an Internal Structure and are not relavent to the end user
    
    Parameters:
    
    formattingRuns -
  - getSPID
```
public int getSPID()
```
    get the id of drawing object which defines the text box for this Note
    For Internal Use Only
    
    Returns:
  - getOOXML
```
public String getOOXML()
```
    returns the OOXML representation of this Note
    
    Returns:

Class Note

Field Summary

Fields inherited from class io.starter.formats.XLS.XLSRecord

Fields inherited from interface io.starter.formats.XLS.XLSConstants

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.XLS.XLSRecord

Methods inherited from class java.lang.Object

Constructor Detail

Note

Method Detail

init

setSheet

toString

getPrototype

setRowCol

setId

getId

getHidden

setHidden

getText

setText

setText

getAuthor

setAuthor

getTextBoxBounds

setTextBoxBounds

setTextBoxWidth

setTextBoxHeight

setFormattingRuns

getFormattingRuns

getSPID

getOOXML