com.f1j.ss.datarange
Interface DataRangeOptions


public interface DataRangeOptions
extends Lockable

This interface defines the API for setting DataRange characteristics, such as the name.

Since:
12.0.2

Method Summary
 boolean convertNullNumbersToZero()
          Indicates whether null numeric values will be converted and displayed as a zero or left as an empty cell.
 java.lang.String getName()
          Returns the name of the DataRange.
 void setConvertNullNumbersToZero(boolean convertIt)
          Sets whether null numeric values should be converted and displayed as a zero or left as an empty cell.
 void setName(java.lang.String str)
          Sets the name of the DataRange.
 
Methods inherited from interface com.f1j.util.Lockable
getLock, releaseLock
 

Method Detail

convertNullNumbersToZero

public boolean convertNullNumbersToZero()
Indicates whether null numeric values will be converted and displayed as a zero or left as an empty cell.
Returns:
boolean. true if null numeric values will be converted to zero
Since:
12.0.2
See Also:
DataRange

getName

public java.lang.String getName()
Returns the name of the DataRange.
Returns:
The name of the DataRange.
Since:
12.0.2
See Also:
DataRange

setConvertNullNumbersToZero

public void setConvertNullNumbersToZero(boolean convertIt)
Sets whether null numeric values should be converted and displayed as a zero or left as an empty cell.
Parameters:
convertIt - true if null numeric values should be converted to zero
Since:
12.0.2
See Also:
DataRange

setName

public void setName(java.lang.String str)
             throws DuplicateNameException,
                    com.f1j.ss.datarange.InvalidNameException
Sets the name of the DataRange.
Parameters:
str - The name of the DataRange.
Throws:
DuplicateNameException - if DataRange with this name exists.
com.f1j.ss.datarange.InvalidNameException - if name is invalid.
Since:
12.0.2
See Also:
DataRange