com.aspose.cells

Class SettableGlobalizationSettings

java.lang.Object

com.aspose.cells.GlobalizationSettings

com.aspose.cells.SettableGlobalizationSettings

public class SettableGlobalizationSettings
extends GlobalizationSettings

Implementation of GlobalizationSettings that supports user to set/change pre-defined texts.

Constructor Summary

Constructors

Constructor and Description
SettableGlobalizationSettings()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBooleanValueString(boolean bv) Gets the display string value for cell's boolean value
char	getColumnSeparatorOfFormulaArray() Gets the separator for the items in array's row data in formula.
java.lang.String	getCommentTitleName(int type) Gets the locale dependent comment title name according to comment title type.
java.lang.String	getErrorValueString(java.lang.String err) Gets the display string value for cell's error value
java.lang.String	getGrandTotalName(int functionType) Gets the grand total name of the function.
char	getListSeparator() Gets the separator for list, parameters of function, ...etc.
java.lang.String	getLocalBuiltInName(java.lang.String standardName) Gets the locale dependent text for built-in Name according to given standard text.
java.lang.String	getLocalFunctionName(java.lang.String standardName) Gets the locale dependent function name according to given standard function name.
char	getRowSeparatorOfFormulaArray() Gets the separator for rows in array data in formula.
java.lang.String	getStandardBuiltInName(java.lang.String localName) Gets the standard text of built-in Name according to given locale dependent text.
java.lang.String	getStandardFunctionName(java.lang.String localName) Gets the standard function name according to given locale dependent function name.
java.lang.String	getStandardHeaderFooterFontStyleName(java.lang.String localfontStyleName) Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
java.lang.String	getTableRowTypeOfAll() Gets the type name of table rows that consists of all rows in referenced table.
java.lang.String	getTableRowTypeOfCurrent() Gets the type name of table rows that consists of the current row in referenced table.
java.lang.String	getTableRowTypeOfData() Gets the type name of table rows that consists of data region of referenced table.
java.lang.String	getTableRowTypeOfHeaders() Gets the type name of table rows that consists of the table header.
java.lang.String	getTableRowTypeOfTotals() Gets the type name of table rows that consists of the total row of referenced table.
java.lang.String	getTotalName(int functionType) Gets the total name of specific function.
void	setBooleanValueString(boolean bv, java.lang.String name) Sets the display string value for cell's boolean value
void	setColumnSeparatorOfFormulaArray(char c) Sets the separator for the items in array's row data in formula.
void	setCommentTitleName(int type, java.lang.String name) Gets the locale dependent comment title name according to comment title type.
void	setGrandTotalName(int functionType, java.lang.String name) Sets the grand total name of specific function.
void	setListSeparator(char c) Sets the separator for list, parameters of function, ...etc.
void	setLocalBuiltInName(java.lang.String standardName, java.lang.String localName, boolean bidirectional) Sets the locale dependent text for the built-in name with given standard name text.
void	setLocalFunctionName(java.lang.String standardName, java.lang.String localName, boolean bidirectional) Sets the locale dependent function name corresponding to given standard function name.
void	setRowSeparatorOfFormulaArray(char c) Sets the separator for rows in array data in formula.
void	setStandardBuiltInName(java.lang.String localName, java.lang.String standardName, boolean bidirectional) Sets the locale dependent function name according to given standard function name.
void	setStandardFunctionName(java.lang.String localName, java.lang.String standardName, boolean bidirectional) Sets the locale dependent function name according to given standard function name.
void	setStandardHeaderFooterFontStyleName(java.lang.String localfontStyleName, java.lang.String standardName) Sets the locale dependent function name according to given standard function name.
void	setTableRowTypeOfAll(java.lang.String name) Sets the type name of table rows that consists of all rows in referenced table.
void	setTableRowTypeOfCurrent(java.lang.String name) Sets the type name of table rows that consists of the current row in referenced table.
void	setTableRowTypeOfData(java.lang.String name) Sets the type name of table rows that consists of data region of referenced table.
void	setTableRowTypeOfHeaders(java.lang.String name) Sets the type name of table rows that consists of the table header.
void	setTableRowTypeOfTotals(java.lang.String name) Sets the type name of table rows that consists of the total row of referenced table.
void	setTotalName(int functionType, java.lang.String name) Sets the total name of specific function.

Methods inherited from class com.aspose.cells.GlobalizationSettings

compare, getAllName, getChartSettings, getCollationKey, getColumnLabelsOfPivotTable, getDataFieldHeaderNameOfPivotTable, getDefaultSheetName, getEmptyDataName, getMultipleItemsName, getPivotGrandTotalName, getPivotSettings, getPivotTotalName, getProtectionNameOfPivotTable, getRowLabelsNameOfPivotTable, getSubTotalName, setChartSettings, setPivotSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettableGlobalizationSettings

public SettableGlobalizationSettings()

Method Detail

getTotalName

public java.lang.String getTotalName(int functionType)

Gets the total name of specific function.

Overrides:

getTotalName in class GlobalizationSettings

Parameters:

functionType - ConsolidationFunction. The function type.

Returns:

The total name of the function.

setTotalName

public void setTotalName(int functionType,
                java.lang.String name)

Sets the total name of specific function.

Parameters:

functionType - ConsolidationFunction. The function type.

name - The total name of the function.

getGrandTotalName

public java.lang.String getGrandTotalName(int functionType)

Gets the grand total name of the function.

Overrides:

getGrandTotalName in class GlobalizationSettings

Parameters:

functionType - ConsolidationFunction. The function type.

Returns:

The grand total name of the function.

setGrandTotalName

public void setGrandTotalName(int functionType,
                     java.lang.String name)

Sets the grand total name of specific function.

Parameters:

functionType - ConsolidationFunction. The function type.

name - The grand total name of the function.

getTableRowTypeOfHeaders

public java.lang.String getTableRowTypeOfHeaders()

Gets the type name of table rows that consists of the table header. Default is "Headers", so in formula "#Headers" represents the table header.

Overrides:

getTableRowTypeOfHeaders in class GlobalizationSettings

Returns:

the type name of table rows

setTableRowTypeOfHeaders

public void setTableRowTypeOfHeaders(java.lang.String name)

Sets the type name of table rows that consists of the table header.

Parameters:

name - the type name of table rows

getTableRowTypeOfData

public java.lang.String getTableRowTypeOfData()

Gets the type name of table rows that consists of data region of referenced table. Default is "Data", so in formula "#Data" represents the data region of the table.

Overrides:

getTableRowTypeOfData in class GlobalizationSettings

Returns:

the type name of table rows

setTableRowTypeOfData

public void setTableRowTypeOfData(java.lang.String name)

Sets the type name of table rows that consists of data region of referenced table.

Parameters:

name - the type name of table rows

getTableRowTypeOfAll

public java.lang.String getTableRowTypeOfAll()

Gets the type name of table rows that consists of all rows in referenced table.

Overrides:

getTableRowTypeOfAll in class GlobalizationSettings

Returns:

the type name of table rows

setTableRowTypeOfAll

public void setTableRowTypeOfAll(java.lang.String name)

Sets the type name of table rows that consists of all rows in referenced table.

Parameters:

name - the type name of table rows

getTableRowTypeOfTotals

public java.lang.String getTableRowTypeOfTotals()

Gets the type name of table rows that consists of the total row of referenced table.

Overrides:

getTableRowTypeOfTotals in class GlobalizationSettings

Returns:

the type name of table rows

setTableRowTypeOfTotals

public void setTableRowTypeOfTotals(java.lang.String name)

Sets the type name of table rows that consists of the total row of referenced table.

Parameters:

name - the type name of table rows

getTableRowTypeOfCurrent

public java.lang.String getTableRowTypeOfCurrent()

Gets the type name of table rows that consists of the current row in referenced table.

Overrides:

getTableRowTypeOfCurrent in class GlobalizationSettings

Returns:

the type name of table rows

setTableRowTypeOfCurrent

public void setTableRowTypeOfCurrent(java.lang.String name)

Sets the type name of table rows that consists of the current row in referenced table.

Parameters:

name - the type name of table rows

getErrorValueString

public java.lang.String getErrorValueString(java.lang.String err)

Gets the display string value for cell's error value

Overrides:

getErrorValueString in class GlobalizationSettings

Parameters:

err - error values such as #VALUE!,#NAME?

Returns:

By default returns the error value itself

getBooleanValueString

public java.lang.String getBooleanValueString(boolean bv)

Gets the display string value for cell's boolean value

Overrides:

getBooleanValueString in class GlobalizationSettings

Parameters:

bv - boolean value

Returns:

By default returns "TRUE" for true value and "FALSE" for false value.

setBooleanValueString

public void setBooleanValueString(boolean bv,
                         java.lang.String name)

Sets the display string value for cell's boolean value

Parameters:

bv - boolean value

name - string value of the boolean value

getLocalFunctionName

public java.lang.String getLocalFunctionName(java.lang.String standardName)

Gets the locale dependent function name according to given standard function name.

Overrides:

getLocalFunctionName in class GlobalizationSettings

Parameters:

standardName - Standard(en-US locale) function name.

Returns:

Locale dependent function name. The locale was specified by the Workbook for which this settings is used.

setLocalFunctionName

public void setLocalFunctionName(java.lang.String standardName,
                        java.lang.String localName,
                        boolean bidirectional)

Sets the locale dependent function name corresponding to given standard function name.

Parameters:

standardName - Standard(en-US locale) function name.

localName - Locale dependent function name

bidirectional - Whether map the local function name to standard function name automatically. If true, the local name will be mapped to standard name automatically so user does not need to call setStandardFunctionName(String,String,boolean) again for the same standard and local names pair

getStandardFunctionName

public java.lang.String getStandardFunctionName(java.lang.String localName)

Gets the standard function name according to given locale dependent function name.

Overrides:

getStandardFunctionName in class GlobalizationSettings

Parameters:

localName - Locale dependent function name. The locale was specified by the Workbook for which this settings is used.

Returns:

Standard(en-US locale) function name.

setStandardFunctionName

public void setStandardFunctionName(java.lang.String localName,
                           java.lang.String standardName,
                           boolean bidirectional)

Sets the locale dependent function name according to given standard function name.

Parameters:

localName - Locale dependent function name

standardName - Standard(en-US locale) function name.

bidirectional - Whether map the standard function name to local function name automatically. If true, the standar name will be mapped to local name automatically so user does not need to call setLocalFunctionName(String,String,boolean) again for the same standard and local names pair

getLocalBuiltInName

public java.lang.String getLocalBuiltInName(java.lang.String standardName)

Gets the locale dependent text for built-in Name according to given standard text.

Overrides:

getLocalBuiltInName in class GlobalizationSettings

Parameters:

standardName - Standard(en-US locale) text of built-in Name.

Returns:

Locale dependent text. The locale was specified by the Workbook for which this settings is used.

setLocalBuiltInName

public void setLocalBuiltInName(java.lang.String standardName,
                       java.lang.String localName,
                       boolean bidirectional)

Sets the locale dependent text for the built-in name with given standard name text.

Parameters:

standardName - Standard(en-US locale) name text of built-in name.

localName - Locale dependent name text

bidirectional - Whether map the local name text to standard name text automatically. If true, the local name text will be mapped to standard name text automatically so user does not need to call setStandardBuiltInName(String,String,boolean) again for the same standard and local names pair

getStandardBuiltInName

public java.lang.String getStandardBuiltInName(java.lang.String localName)

Gets the standard text of built-in Name according to given locale dependent text.

Overrides:

getStandardBuiltInName in class GlobalizationSettings

Parameters:

localName - Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used.

Returns:

Standard(en-US locale) text.

setStandardBuiltInName

public void setStandardBuiltInName(java.lang.String localName,
                          java.lang.String standardName,
                          boolean bidirectional)

Sets the locale dependent function name according to given standard function name.

Parameters:

localName - Locale dependent function name

standardName - Standard(en-US locale) function name.

bidirectional - Whether map the standard name text to local name text automatically. If true, the standar name text will be mapped to local name text automatically so user does not need to call setLocalBuiltInName(String,String,boolean) again for the same standard and local names pair

getListSeparator

public char getListSeparator()

Gets the separator for list, parameters of function, ...etc.

Overrides:

getListSeparator in class GlobalizationSettings

setListSeparator

public void setListSeparator(char c)

Sets the separator for list, parameters of function, ...etc.

Parameters:

c - the specified separator

getRowSeparatorOfFormulaArray

public char getRowSeparatorOfFormulaArray()

Gets the separator for rows in array data in formula.

Overrides:

getRowSeparatorOfFormulaArray in class GlobalizationSettings

setRowSeparatorOfFormulaArray

public void setRowSeparatorOfFormulaArray(char c)

Sets the separator for rows in array data in formula.

Parameters:

c - the specified separator

getColumnSeparatorOfFormulaArray

public char getColumnSeparatorOfFormulaArray()

Gets the separator for the items in array's row data in formula.

Overrides:

getColumnSeparatorOfFormulaArray in class GlobalizationSettings

setColumnSeparatorOfFormulaArray

public void setColumnSeparatorOfFormulaArray(char c)

Sets the separator for the items in array's row data in formula.

Parameters:

c - the specified separator

getStandardHeaderFooterFontStyleName

public java.lang.String getStandardHeaderFooterFontStyleName(java.lang.String localfontStyleName)

Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.

Overrides:

getStandardHeaderFooterFontStyleName in class GlobalizationSettings

Parameters:

localfontStyleName - Locale font style name for Header/Footer.

Returns:

Standard English font style name(Regular, Bold, Italic)

setStandardHeaderFooterFontStyleName

public void setStandardHeaderFooterFontStyleName(java.lang.String localfontStyleName,
                                        java.lang.String standardName)

Sets the locale dependent function name according to given standard function name.

Parameters:

localfontStyleName - Locale font style name for Header/Footer.

standardName - Standard(en-US locale) function name.

getCommentTitleName

public java.lang.String getCommentTitleName(int type)

Gets the locale dependent comment title name according to comment title type.

Overrides:

getCommentTitleName in class GlobalizationSettings

Parameters:

type - CommentTitleType. type of comment title

Returns:

locale dependent comment title name

setCommentTitleName

public void setCommentTitleName(int type,
                       java.lang.String name)

Gets the locale dependent comment title name according to comment title type.

Parameters:

type - CommentTitleType. type of comment title

name - locale dependent comment title name