Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.DVRecord

Field Summary

Modifier and Type	Field and Description
private final UnicodeString	_errorText Text of the error box, cannot be longer than 255 chars
private final UnicodeString	_errorTitle Title of the error box, cannot be longer than 32 chars
private final Formula	_formula1 Formula data for first condition (RPN token array without size field)
private final Formula	_formula2 Formula data for second condition (RPN token array without size field)
private short	_not_used_1 Not used - Excel seems to always write 0x3FE0
private short	_not_used_2 Not used - Excel seems to always write 0x0000
private int	_option_flags Option flags
private final UnicodeString	_promptText Text of the prompt box, cannot be longer than 255 chars
private final UnicodeString	_promptTitle Title of the prompt box, cannot be longer than 32 chars
private final CellRangeAddressList	_regions Cell range address list with all affected ranges
private static final int[]	FLAG_MASKS
private static final String[]	FLAG_NAMES
private static final UnicodeString	NULL_TEXT_STRING the unicode string used for error/prompt title/text when not present
private static final BitField	opt_condition_operator
private static final BitField	opt_data_type Option flags field
private static final BitField	opt_empty_cell_allowed
private static final BitField	opt_error_style
private static final BitField	opt_show_error_on_invalid_value
private static final BitField	opt_show_prompt_on_cell_selected
private static final BitField	opt_string_list_formula
private static final BitField	opt_suppress_dropdown_arrow
public static final short	sid

Constructor Summary

Access	Constructor and Description
public	DVRecord(DVRecord other)
public	DVRecord(int validationType, int operator, int errorStyle, boolean emptyCellAllowed, boolean suppressDropDownArrow, boolean isExplicitList, boolean showPromptBox, String promptTitle, String promptText, boolean showErrorBox, String errorTitle, String errorText, Ptg[] formula1, Ptg[] formula2, CellRangeAddressList regions)
public	DVRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public DVRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Clones the object.
public CellRangeAddressList	getCellRangeAddress()
public int	Returns: the condition operator getConditionOperator() get the condition operator
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public int	Returns: the condition data type getDataType()
public boolean	Returns: `true` if empty values are allowed in cells, `false` otherwise getEmptyCellAllowed()
public int	Returns: the condition error style getErrorStyle()
public String	getErrorText()
public String	getErrorTitle()
public Ptg[]	getFormula1()
public Ptg[]	getFormula2()
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public boolean	Returns: `true` if in list validations the string list is explicitly given in the formula, `false` otherwise getListExplicitFormula()
public String	getPromptText()
public String	getPromptTitle()
public boolean	Returns: `true` if an error window should appear when an invalid value is entered in the cell, `false` otherwise getShowErrorOnInvalidValue()
public boolean	Returns: `true` if a prompt window should appear when cell is selected, `false` otherwise getShowPromptOnCellSelected()
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public boolean	Returns: `true` if drop down arrow should be suppressed when list validation is used, `false` otherwise getSuppressDropdownArrow()
private static int	getUnicodeStringSize(UnicodeString us)
private static UnicodeString	readUnicodeString(RecordInputStream in)
private static String	resolveTitleString(UnicodeString us)
private static UnicodeString	resolveTitleText(String str) When entered via the UI, Excel translates empty string into "\0" While it is possible to encode the title/text as empty string (Excel doesn't exactly crash), the resulting tool-tip text / message box looks wrong.
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
private static void	serializeUnicodeString(UnicodeString us, LittleEndianOutput out)

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

_errorText	back to summary
private final UnicodeString _errorText Text of the error box, cannot be longer than 255 chars

_errorTitle	back to summary
private final UnicodeString _errorTitle Title of the error box, cannot be longer than 32 chars

_formula1	back to summary
private final Formula _formula1 Formula data for first condition (RPN token array without size field)

_formula2	back to summary
private final Formula _formula2 Formula data for second condition (RPN token array without size field)

_not_used_1	back to summary
private short _not_used_1 Not used - Excel seems to always write 0x3FE0

_not_used_2	back to summary
private short _not_used_2 Not used - Excel seems to always write 0x0000 Annotations @SuppressWarnings:RedundantFieldInitialization

_option_flags	back to summary
private int _option_flags Option flags

_promptText	back to summary
private final UnicodeString _promptText Text of the prompt box, cannot be longer than 255 chars

_promptTitle	back to summary
private final UnicodeString _promptTitle Title of the prompt box, cannot be longer than 32 chars

_regions	back to summary
private final CellRangeAddressList _regions Cell range address list with all affected ranges

FLAG_MASKS	back to summary
private static final int[] FLAG_MASKS

FLAG_NAMES	back to summary
private static final String[] FLAG_NAMES

NULL_TEXT_STRING	back to summary
private static final UnicodeString NULL_TEXT_STRING the unicode string used for error/prompt title/text when not present

opt_condition_operator	back to summary
private static final BitField opt_condition_operator

opt_data_type back to summary

opt_data_type	back to summary
private static final BitField opt_data_type Option flags field See Also `utility class`

private static final BitField opt_data_type

Option flags field

See Also: utility class

opt_empty_cell_allowed	back to summary
private static final BitField opt_empty_cell_allowed

opt_error_style	back to summary
private static final BitField opt_error_style

opt_show_error_on_invalid_value	back to summary
private static final BitField opt_show_error_on_invalid_value

opt_show_prompt_on_cell_selected	back to summary
private static final BitField opt_show_prompt_on_cell_selected

opt_string_list_formula	back to summary
private static final BitField opt_string_list_formula

opt_suppress_dropdown_arrow	back to summary
private static final BitField opt_suppress_dropdown_arrow

sid	back to summary
public static final short sid

Constructor Detail

DVRecord	back to summary
public DVRecord(DVRecord other)

DVRecord	back to summary
public DVRecord(int validationType, int operator, int errorStyle, boolean emptyCellAllowed, boolean suppressDropDownArrow, boolean isExplicitList, boolean showPromptBox, String promptTitle, String promptText, boolean showErrorBox, String errorTitle, String errorText, Ptg[] formula1, Ptg[] formula2, CellRangeAddressList regions)

DVRecord	back to summary
public DVRecord(RecordInputStream in)

Method Detail

copy	back to summary
public DVRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Clones the object. Returns:DVRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public DVRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Clones the object.

Returns:DVRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getCellRangeAddress	back to summary
public CellRangeAddressList getCellRangeAddress()

getConditionOperator back to summary

getConditionOperator	back to summary
public int getConditionOperator() get the condition operator Returns:int the condition operator See Also `utility class`

public int getConditionOperator()

get the condition operator

Returns:int: the condition operator
See Also: utility class

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getDataType	back to summary
public int getDataType() Returns:int the condition data type See Also `org.apache.poi.ss.usermodel.DataValidationConstraint.ValidationType`

getEmptyCellAllowed	back to summary
public boolean getEmptyCellAllowed() Returns:boolean `true` if empty values are allowed in cells, `false` otherwise

getErrorStyle	back to summary
public int getErrorStyle() Returns:int the condition error style See Also `org.apache.poi.ss.usermodel.DataValidation.ErrorStyle`

getErrorText	back to summary
public String getErrorText()

getErrorTitle	back to summary
public String getErrorTitle()

getFormula1	back to summary
public Ptg[] getFormula1()

getFormula2	back to summary
public Ptg[] getFormula2()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getListExplicitFormula	back to summary
public boolean getListExplicitFormula() Returns:boolean `true` if in list validations the string list is explicitly given in the formula, `false` otherwise

getPromptText	back to summary
public String getPromptText()

getPromptTitle	back to summary
public String getPromptTitle()

getShowErrorOnInvalidValue	back to summary
public boolean getShowErrorOnInvalidValue() Returns:boolean `true` if an error window should appear when an invalid value is entered in the cell, `false` otherwise

getShowPromptOnCellSelected	back to summary
public boolean getShowPromptOnCellSelected() Returns:boolean `true` if a prompt window should appear when cell is selected, `false` otherwise

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

getSuppressDropdownArrow	back to summary
public boolean getSuppressDropdownArrow() Returns:boolean `true` if drop down arrow should be suppressed when list validation is used, `false` otherwise

getUnicodeStringSize	back to summary
private static int getUnicodeStringSize(UnicodeString us)

readUnicodeString	back to summary
private static UnicodeString readUnicodeString(RecordInputStream in)

resolveTitleString	back to summary
private static String resolveTitleString(UnicodeString us)

resolveTitleText	back to summary
private static UnicodeString resolveTitleText(String str) When entered via the UI, Excel translates empty string into "\0" While it is possible to encode the title/text as empty string (Excel doesn't exactly crash), the resulting tool-tip text / message box looks wrong. It is best to do the same as the Excel UI and encode 'not present' as "\0".

serialize back to summary

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

serializeUnicodeString	back to summary
private static void serializeUnicodeString(UnicodeString us, LittleEndianOutput out)

public final Class DVRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail