Colinfo (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:: BlockByteConsumer, BiffRec, ColumnRange, XLSConstants, Serializable

public final class Colinfo
extends XLSRecord
implements ColumnRange

Colinfo: Column Formatting Information (7Dh)
Colinfo describes the formatting for a column range

offset name size contents --------------------------------------------------------------- 4 colFirst 2 First formatted column (0) 6 colLast 2 Last formatted column (0) 8 colWidth 2 Column width in 1/256 character units 10 ixfe 2 Index to XF for columns 12 grbit 2 Options 14 reserved 1 Must be zero grib options offset Bits mask name contents --------------------------------------------------------------- 0 0 01h fHidden =1 if the column range is hidden 7-1 FEh UNUSED 1 2-0 07h iOutLevel Outline Level of the column 3 08h Reserved must be zero 4 10h iCollapsed =1 if the col is collapsed in outlining 7-5 E0h Reserved must be zero etc. Note: for a discussion of Column widths see: http://support.microsoft.com/?kbid=214123

See Also:: Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface io.starter.formats.XLS.ColumnRange
  ColumnRange.Comparator, ColumnRange.Reference

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_COLWIDTH
- 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

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_COLWIDTH`

Constructor Summary

Constructors
Constructor and Description

Colinfo()

Constructors
Constructor and Description
`Colinfo()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getColFirst()` Gets the first column in the range.
`int`	`getColLast()` Gets the last column in the range.
`int`	`getColWidth()` Get the width of a column in internal units Internal units are units of (defaultfontwidth/256) Excel column width= default font width/256 * 8.43 More specifically, column width is in 1/256 of the width of the zero character, using default font (first FONT record in the file)
`int`	`getColWidthInChars()` returns Column Width in Chars or Excel-units
`int`	`getGrbit()`
`int`	`getIxfe()` get the ixfe
`int`	`getOutlineLevel()` Returns the Outline level (depth) of the column
`static Colinfo`	`getPrototype(int colF, int colL, int wide, int formatIdx)`
`void`	`init()` perform record initialization
`boolean`	`inrange(int x)` returns whether a given col is referenced by this Colinfo
`boolean`	`isCollapsed()` Returns whether the column is collapsed
`boolean`	`isHidden()` Returns whether the column is hidden
`boolean`	`isSingleCol()` determines if its a single column
`boolean`	`isSingleColColinfo()` Is this colinfo based on a single column format?
`void`	`moveColInfo(int offset)` Shifts the whole colinfo over the amount of the offset
`void`	`setColFirst(int c)` set last/first cols/rows
`void`	`setCollapsed(boolean b)` Flag indicating if the outlining of the affected column(s) is in the collapsed state.
`void`	`setColLast(int c)` set last/first cols/rows
`void`	`setColWidth(int x)` Set the width of a column or columns in internal units Internal units are units of (defaultfontwidth/256) Excel column width= default font width/256 * 8.43 More specifically, column width is in 1/256 of the width of the zero character, using default font (first FONT record in the file)
`void`	`setColWidthInChars(double x)`
`void`	`setGrbit(int grbit)`
`void`	`setHidden(boolean b)` Set whether the column is hidden
`void`	`setIxfe(int i)` Sets the Ixfe for this record.
`void`	`setOutlineLevel(int x)` Set the Outline level (depth) of the column
`String`	`toString()`
`void`	`updateGrbit()` set the grbit to match whatever values have been passed in to modify the grbit functions.

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, 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, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

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

- Field Detail
  - DEFAULT_COLWIDTH
```
public static final int DEFAULT_COLWIDTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Colinfo
```
public Colinfo()
```
- Method Detail
  - setColFirst
```
public void setColFirst(int c)
```
    set last/first cols/rows
  - getColFirst
```
public int getColFirst()
```
    Description copied from interface: ColumnRange
    
    Gets the first column in the range.
    
    Specified by:
    
    getColFirst in interface ColumnRange
  - setColLast
```
public void setColLast(int c)
```
    set last/first cols/rows
  - getColLast
```
public int getColLast()
```
    Description copied from interface: ColumnRange
    
    Gets the last column in the range.
    
    Specified by:
    
    getColLast in interface ColumnRange
  - moveColInfo
```
public void moveColInfo(int offset)
```
    Shifts the whole colinfo over the amount of the offset
  - init
```
public void init()
```
    Description copied from class: XLSRecord
    
    perform record initialization
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - getPrototype
```
public static Colinfo getPrototype(int colF,
                                   int colL,
                                   int wide,
                                   int formatIdx)
```
  - isSingleColColinfo
```
public boolean isSingleColColinfo()
```
    Is this colinfo based on a single column format?
  - inrange
```
public boolean inrange(int x)
```
    returns whether a given col is referenced by this Colinfo
  - setColWidthInChars
```
public void setColWidthInChars(double x)
```
  - setColWidth
```
public void setColWidth(int x)
```
    Set the width of a column or columns in internal units
    Internal units are units of (defaultfontwidth/256)
    Excel column width= default font width/256 * 8.43
    More specifically, column width is in 1/256 of the width of the zero character, using default font (first FONT record in the file)
    
    Parameters:
    
    int - x new column width
  - getColWidth
```
public int getColWidth()
```
    Get the width of a column in internal units
    Internal units are units of (defaultfontwidth/256)
    Excel column width= default font width/256 * 8.43
    More specifically, column width is in 1/256 of the width of the zero character, using default font (first FONT record in the file)
  - getColWidthInChars
```
public int getColWidthInChars()
```
    returns Column Width in Chars or Excel-units
    
    Returns:
  - setCollapsed
```
public void setCollapsed(boolean b)
```
    Flag indicating if the outlining of the affected column(s) is in the collapsed state.
    
    Parameters:
    
    b - boolean true if collapsed
  - setHidden
```
public void setHidden(boolean b)
```
    Set whether the column is hidden
    
    Parameters:
    
    b -
  - setOutlineLevel
```
public void setOutlineLevel(int x)
```
    Set the Outline level (depth) of the column
    
    Parameters:
    
    x -
  - getGrbit
```
public int getGrbit()
```
  - setGrbit
```
public void setGrbit(int grbit)
```
  - updateGrbit
```
public void updateGrbit()
```
    set the grbit to match whatever values have been passed in to modify the grbit functions. It also updates underlying byte record of the XLSRecord.
  - getOutlineLevel
```
public int getOutlineLevel()
```
    Returns the Outline level (depth) of the column
    
    Returns:
  - getIxfe
```
public int getIxfe()
```
    Description copied from class: XLSRecord
    
    get the ixfe
    
    Specified by:
    
    getIxfe in interface BiffRec
    
    Overrides:
    
    getIxfe in class XLSRecord
  - isCollapsed
```
public boolean isCollapsed()
```
    Returns whether the column is collapsed
    
    Returns:
  - isHidden
```
public boolean isHidden()
```
    Returns whether the column is hidden
    
    Returns:
  - setIxfe
```
public void setIxfe(int i)
```
    Sets the Ixfe for this record. For some stupid reason this is the *only* xls record that has it's ixfe in a different place. Intern time at microsoft I guess.
    
    Specified by:
    
    setIxfe in interface BiffRec
    
    Overrides:
    
    setIxfe in class XLSRecord
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class XLSRecord
  - isSingleCol
```
public boolean isSingleCol()
```
    Description copied from interface: ColumnRange
    
    determines if its a single column
    
    Specified by:
    
    isSingleCol in interface ColumnRange

Class Colinfo

Nested Class Summary

Nested classes/interfaces inherited from interface io.starter.formats.XLS.ColumnRange

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

Field Detail

DEFAULT_COLWIDTH

Constructor Detail

Colinfo

Method Detail

setColFirst

getColFirst

setColLast

getColLast

moveColInfo

init

getPrototype

isSingleColColinfo

inrange

setColWidthInChars

setColWidth

getColWidth

getColWidthInChars

setCollapsed

setHidden

setOutlineLevel

getGrbit

setGrbit

updateGrbit

getOutlineLevel

getIxfe

isCollapsed

isHidden

setIxfe

toString

isSingleCol