GridWorkbookSettings

Inheritance: java.lang.Object

All Implemented Interfaces: java.io.Serializable

public class GridWorkbookSettings implements Serializable

Represents settings of the workbook.

Example

         GridWeb gridweb = new GridWeb();
         GridWorkbookSettings gsettings = new GridWorkbookSettings();
         gridweb.setSettings(gsettings);
 
         //do your business

Constructors

Constructor	Description
GridWorkbookSettings()	default constructor

Methods

Method	Description
equals(Object arg0)
getAuthor()	Gets the author of the file.
getCheckCustomNumberFormat()	Gets whether checking custom number format when setting Style.Custom.
getClass()
getCreateCalcChain()	Gets whether create calculated formulas chain.
getDate1904()	Gets the value which represents if the workbook uses the 1904 date system.
getEnableMacros()	Gets whether enable macros; Now it only works when copying a worksheet to other worksheet in a workbook.
getForceFullCalculate()	Gets whether fully calculates every time when a calculation is triggered.
getIteration()	Gets whether use iteration to resolve circular references.
getMaxIteration()	Gets the maximum number of iterations to resolve a circular reference,the default value is 100.
getPrecisionAsDisplayed()	True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed
getPreservePaddingSpaces()	Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas.
getReCalculateOnOpen()	Gets whether re-calculate all formulas on opening file.
hashCode()
notify()
notifyAll()
setAuthor(String value)	Sets the author of the file.
setCheckCustomNumberFormat(boolean value)	Sets whether checking custom number format when setting Style.Custom.
setCreateCalcChain(boolean value)	Sets whether create calculated formulas chain.
setDate1904(boolean value)	Sets the value which represents if the workbook uses the 1904 date system.
setEnableMacros(boolean value)	Sets whether enable macros; Now it only works when copying a worksheet to other worksheet in a workbook.
setForceFullCalculate(boolean value)	Sets whether fully calculates every time when a calculation is triggered.
setIteration(boolean value)	Sets whether use iteration to resolve circular references.
setMaxIteration(int value)	Sets the maximum number of iterations to resolve a circular reference,the default value is 100.
setPrecisionAsDisplayed(boolean value)	True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed
setPreservePaddingSpaces(boolean value)	Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas.
setReCalculateOnOpen(boolean value)	Sets whether re-calculate all formulas on opening file.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

GridWorkbookSettings()

public GridWorkbookSettings()

default constructor

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAuthor()

public String getAuthor()

Gets the author of the file.

Returns: java.lang.String

getCheckCustomNumberFormat()

public boolean getCheckCustomNumberFormat()

Gets whether checking custom number format when setting Style.Custom.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCreateCalcChain()

public boolean getCreateCalcChain()

Gets whether create calculated formulas chain. Default is false.

Returns: boolean

getDate1904()

public boolean getDate1904()

Gets the value which represents if the workbook uses the 1904 date system.

Returns: boolean

getEnableMacros()

public boolean getEnableMacros()

Gets whether enable macros; Now it only works when copying a worksheet to other worksheet in a workbook.

Returns: boolean

getForceFullCalculate()

public boolean getForceFullCalculate()

Gets whether fully calculates every time when a calculation is triggered.

Returns: boolean

getIteration()

public boolean getIteration()

Gets whether use iteration to resolve circular references.

Returns: boolean

getMaxIteration()

public int getMaxIteration()

Gets the maximum number of iterations to resolve a circular reference,the default value is 100.

Returns: int

getPrecisionAsDisplayed()

public boolean getPrecisionAsDisplayed()

True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed

Returns: boolean

getPreservePaddingSpaces()

public boolean getPreservePaddingSpaces()

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

Remarks

Generally those spaces and line breaks are jsut for visual purpose, Preserving them or not does not affect the calculated result. For performance consideration, if there is no special requirement, it is better not to preserve them while processing formulas.

Returns: boolean

getReCalculateOnOpen()

public boolean getReCalculateOnOpen()

Gets whether re-calculate all formulas on opening file.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAuthor(String value)

public void setAuthor(String value)

Sets the author of the file.

Parameters:

Parameter	Type	Description
value	java.lang.String

setCheckCustomNumberFormat(boolean value)

public void setCheckCustomNumberFormat(boolean value)

Sets whether checking custom number format when setting Style.Custom.

Parameters:

Parameter	Type	Description
value	boolean

setCreateCalcChain(boolean value)

public void setCreateCalcChain(boolean value)

Sets whether create calculated formulas chain. Default is false.

Parameters:

Parameter	Type	Description
value	boolean

setDate1904(boolean value)

public void setDate1904(boolean value)

Sets the value which represents if the workbook uses the 1904 date system.

Parameters:

Parameter	Type	Description
value	boolean

setEnableMacros(boolean value)

public void setEnableMacros(boolean value)

Sets whether enable macros; Now it only works when copying a worksheet to other worksheet in a workbook.

Parameters:

Parameter	Type	Description
value	boolean

setForceFullCalculate(boolean value)

public void setForceFullCalculate(boolean value)

Sets whether fully calculates every time when a calculation is triggered.

Parameters:

Parameter	Type	Description
value	boolean

setIteration(boolean value)

public void setIteration(boolean value)

Sets whether use iteration to resolve circular references.

Parameters:

Parameter	Type	Description
value	boolean

setMaxIteration(int value)

public void setMaxIteration(int value)

Sets the maximum number of iterations to resolve a circular reference,the default value is 100.

Parameters:

Parameter	Type	Description
value	int

setPrecisionAsDisplayed(boolean value)

public void setPrecisionAsDisplayed(boolean value)

True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed

Parameters:

Parameter	Type	Description
value	boolean

setPreservePaddingSpaces(boolean value)

public void setPreservePaddingSpaces(boolean value)

Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.

Remarks

Parameters:

Parameter	Type	Description
value	boolean

setReCalculateOnOpen(boolean value)

public void setReCalculateOnOpen(boolean value)

Sets whether re-calculate all formulas on opening file.

Parameters:

Parameter	Type	Description
value	boolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int