FeatHeadr (OpenXLS Java Spreadsheet SDK 11.0.4 API)

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

All Implemented Interfaces:

BlockByteConsumer, BiffRec, XLSConstants, Serializable
```
public class FeatHeadr
extends XLSRecord
```
FEATHEADR Shared Feature Header (867h) Introduced in Excel 10 (2002) the FEATHEADR record describes the common information (header) for shared features such as Protection and SmartTag. For example, if you have a worksheet that contains Protection, a Shared Feature Header (FEATHEADER) record is created for all Protections which may include Sheet Protection or Book Protection. Though Sheet Protection and Book Protection may have specific data that are different and are saved in the Feature Data (see FEAT record for detail) portion, their common settings are stored in this header block record. A worksheet may contain one or more different types of Shared Feature and each type of Shared Feature has its own Shared Feature Header (FEATHEADER) record to store common information across all Shared Feature of the same type. This FEATHEADER record will have different data structure layout according to the Shared Feature type (the isf field flags differentiate Shared Feature types). For example, if a Workbook has both Protection and SmartTag, there is one Shared Feature Header (FEATHEADER) created for Protection, and another Shared Feature Header (FEATHEADER) created for SmartTag. Therefore, the data block of the Shared Feature Header (FEATHEADER) may have a different data structure depending on which Shared Feature Type the record is for. Though Excel currently has many different Shared Features such as Formula Error Checking, Protection, SmartTag etc., only 2 types of Shared Feature are persisted in Excel 2002: Protection and SmartTag. Special note: In Excel 2003, this FEATHEADER is not used for new shared features, such as Tables, since a new record of FEATFEADER11 was introduced for better feature data round-tripping stories through earlier versions of Excel. Contents size 4 rt 2 Record type; this matches the BIFF rt in the first two bytes of the record; =0867h 6 grbitFrt 2 FRT cell reference flag =0 currently 8 (Reserved) 8 Currently not used and set to 0. 16 isf 2 Shared feature type index =2 for Enhanced Protection =4 for SmatTag 18 fHdr 1 =1 since this is a feat header 19 cbHdrData 4 Size of rgbHdrSData =4 for simple feature headers =0 there is no rgbHdrData =-1 for complex feature headers, the size of rgbHdrData depends on the isf type. (prior to Excel 2003, all features saved using FEATHEAER use complex features.) 23 rgbHdrData var Byte array of extra info, including from future versions of Excel The rgbHdrData block for Enhanced Protection Contents size 0 grbit 4 Bit flag for protection rules setting (see table below for detail bit settings) The bit settings for protection rules settings in the grbit: Bits Mask Bit Name Description 0 00000001h iprotObject Edit object 1 00000002h iprotScenario Edit scenario 2 00000004h iprotFormatCells Format cells 3 00000008h iprotFormatColumns Format columns 4 00000010h iprotFormatrows Format rows 5 00000020h iprotInsertColumns Insert columns 6 00000040h iprotInsertRows Insert rows 7 00000080h iprotInsertHyperlinks Insert hyperlinks 8 00000100h iprotDeleteColumns Delete columns 9 00000200h iprotDeleteRows Delete rows 10 00000400h iprotSelLockedCells Select locked cells 11 00000800h iprotSort Sort 12 00001000h iprotAutoFilter Use Autofilter 13 00002000h iprotPivotTables Use PivotTable reports 14 00004000h iprotSelUnlockedCells Select unlocked cells The rgbHdrData block for SmartTag Offset Field Name Size Contents 0 cSmartTag 4 Count of SmartTags 4 rgbSmartTag var Array of SmartTag header data (see table below). var cbPropBagData 2 Count of bytes in Property Bag store plus unknown data, i.e., rest of the data size including this count bit var sVersion 2 Version number var (Reserved) 4 Currently not used. var Cste 4 String table entry var cbUnknown 2 Count of bytes of unknown data var pvUnknoan var The Unknown data Where the rgbSmartTag, the array of SmartTag header data block, has the fields: Offset Field Name Size Contents 0 cbSmartTag 4 Count of Byte of the SmartTag data 4 id 4 Id of this SmartTag 8 cbUri 2 Count of bytes of rgbUri 10 rgbUri var Character string of URI (Universal Resource Identifier) which is the name space portion of the SmartTag, of length cbUri e.g., urn:schemas-microsoft-com:office:smarttags var cbTag 2 Count of bytes of the SmartTag tag name rgbTag var rgbTag var Character string of the SmartTag tag name, of length cbTag e.g., Stockticker var cbDownLoadURL 2 Count of bytes of Download URL address string: rgbDownLoadURL var rgbDownLoadURL var Character string of downloading URL Var pvUnknown var Additional data in pvUnknown, of length cbSmartTag – cbUri – cbTag – cbDownLoadURL – 10 In Excel 2003, only book level SmartTags‘ headers are saved. Sheet level SmatTag headers are not persisted.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`ALLOWAUTOFILTER`
`static short`	`ALLOWDELETECOLUMNS`
`static short`	`ALLOWDELETEROWS`
`static short`	`ALLOWFORMATCELLS`
`static short`	`ALLOWFORMATCOLUMNS`
`static short`	`ALLOWFORMATROWS`
`static short`	`ALLOWINSERTCOLUMNS`
`static short`	`ALLOWINSERTHYPERLINKS`
`static short`	`ALLOWINSERTROWS`
`static short`	`ALLOWOBJECTS`
`static short`	`ALLOWPIVOTTABLES`
`static short`	`ALLOWSCENARIOS`
`static short`	`ALLOWSELLOCKEDCELLS`
`static short`	`ALLOWSELUNLOCKEDCELLS`
`static short`	`ALLOWSORT`

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

FeatHeadr()

Constructors
Constructor and Description
`FeatHeadr()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getProtectionOption(int protectionOption)` returns the desired set of enhanced protection setting
`protected static XLSRecord`	`getPrototype()` Create a FeatHeadr record, default defines enhanced protection features
`void`	`init()` init the record - as of now, only enhanced protection is supported
`void`	`setProtectionOption(int protectionOption, boolean set)` sets or clears the set of enhanced protection option

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, 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, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump, toString

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

- Field Detail
  - ALLOWOBJECTS
```
public static final short ALLOWOBJECTS
```
    See Also:
    
    Constant Field Values
  - ALLOWSCENARIOS
```
public static final short ALLOWSCENARIOS
```
    See Also:
    
    Constant Field Values
  - ALLOWFORMATCELLS
```
public static final short ALLOWFORMATCELLS
```
    See Also:
    
    Constant Field Values
  - ALLOWFORMATCOLUMNS
```
public static final short ALLOWFORMATCOLUMNS
```
    See Also:
    
    Constant Field Values
  - ALLOWFORMATROWS
```
public static final short ALLOWFORMATROWS
```
    See Also:
    
    Constant Field Values
  - ALLOWINSERTCOLUMNS
```
public static final short ALLOWINSERTCOLUMNS
```
    See Also:
    
    Constant Field Values
  - ALLOWINSERTROWS
```
public static final short ALLOWINSERTROWS
```
    See Also:
    
    Constant Field Values
  - ALLOWINSERTHYPERLINKS
```
public static final short ALLOWINSERTHYPERLINKS
```
    See Also:
    
    Constant Field Values
  - ALLOWDELETECOLUMNS
```
public static final short ALLOWDELETECOLUMNS
```
    See Also:
    
    Constant Field Values
  - ALLOWDELETEROWS
```
public static final short ALLOWDELETEROWS
```
    See Also:
    
    Constant Field Values
  - ALLOWSELLOCKEDCELLS
```
public static final short ALLOWSELLOCKEDCELLS
```
    See Also:
    
    Constant Field Values
  - ALLOWSORT
```
public static final short ALLOWSORT
```
    See Also:
    
    Constant Field Values
  - ALLOWAUTOFILTER
```
public static final short ALLOWAUTOFILTER
```
    See Also:
    
    Constant Field Values
  - ALLOWPIVOTTABLES
```
public static final short ALLOWPIVOTTABLES
```
    See Also:
    
    Constant Field Values
  - ALLOWSELUNLOCKEDCELLS
```
public static final short ALLOWSELUNLOCKEDCELLS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FeatHeadr
```
public FeatHeadr()
```
- Method Detail
  - getPrototype
```
protected static XLSRecord getPrototype()
```
    Create a FeatHeadr record, default defines enhanced protection features
    
    Returns:
  - init
```
public void init()
```
    init the record - as of now, only enhanced protection is supported
    
    Specified by:
    
    init in interface BiffRec
    
    Overrides:
    
    init in class XLSRecord
  - setProtectionOption
```
public void setProtectionOption(int protectionOption,
                                boolean set)
```
    sets or clears the set of enhanced protection option
    
    Parameters:
    
    protectionOption - @see WorkSheetHandle.iprotXXX constants
    
    set -
  - getProtectionOption
```
public boolean getProtectionOption(int protectionOption)
```
    returns the desired set of enhanced protection setting
    
    Parameters:
    
    protectionOption - @see @WorkSheetHandle.iprotXXX constants
    
    Returns:

Class FeatHeadr

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

ALLOWOBJECTS

ALLOWSCENARIOS

ALLOWFORMATCELLS

ALLOWFORMATCOLUMNS

ALLOWFORMATROWS

ALLOWINSERTCOLUMNS

ALLOWINSERTROWS

ALLOWINSERTHYPERLINKS

ALLOWDELETECOLUMNS

ALLOWDELETEROWS

ALLOWSELLOCKEDCELLS

ALLOWSORT

ALLOWAUTOFILTER

ALLOWPIVOTTABLES

ALLOWSELUNLOCKEDCELLS

Constructor Detail

FeatHeadr

Method Detail

getPrototype

init

setProtectionOption

getProtectionOption