com.aspose.cells

Class GlobalizationSettings

java.lang.Object

com.aspose.cells.GlobalizationSettings

Direct Known Subclasses:

SettableGlobalizationSettings

public class GlobalizationSettings
extends java.lang.Object

Represents the globalization settings.

Constructor Summary

Constructors

Constructor and Description
GlobalizationSettings()

Method Summary

Methods

Modifier and Type	Method and Description
int	compare(java.lang.String v1, java.lang.String v2, boolean ignoreCase) Compares two string values according to certain collation rules.
java.lang.String	getAllName() Deprecated. Use PivotGlobalizationSettings.GetTextOfAll() method instead.
java.lang.String	getBooleanValueString(boolean bv) Gets the display string value for cell's boolean value
ChartGlobalizationSettings	getChartSettings() Gets the globalization settings for Chart.
java.lang.Comparable	getCollationKey(java.lang.String v, boolean ignoreCase) Transforms the string into a comparable object according to certain collation rules.
java.lang.String	getColumnLabelsOfPivotTable() Deprecated. Use PivotGlobalizationSettings.GetTextOfColumnLabels() method instead.
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	getDataFieldHeaderNameOfPivotTable() Deprecated. Use PivotGlobalizationSettings.GetTextOfDataFieldHeader() method instead.
java.lang.String	getDefaultSheetName() Gets the default sheet name for adding worksheet automatically.
java.lang.String	getEmptyDataName() Deprecated. Use PivotGlobalizationSettings.GetTextOfEmptyData() method instead.
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.
java.lang.String	getMultipleItemsName() Deprecated. Use PivotGlobalizationSettings.GetTextOfMultipleItems() method instead.
java.lang.String	getPivotGrandTotalName() Deprecated. Use PivotGlobalizationSettings.GetTextOfGrandTotal() method instead.
PivotGlobalizationSettings	getPivotSettings() Gets the globalization settings for pivot table.
java.lang.String	getPivotTotalName() Deprecated. Use PivotGlobalizationSettings.GetTextOfTotal() method instead.
java.lang.String	getProtectionNameOfPivotTable() Deprecated. Use PivotGlobalizationSettings.GetTextOfProtectedName(string) method instead.
java.lang.String	getRowLabelsNameOfPivotTable() Deprecated. Use PivotGlobalizationSettings.GetTextOfRowLabels() method instead.
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	getSubTotalName(int subTotalType) Deprecated. Use PivotGlobalizationSettings.GetTextOfSubTotal() method instead.
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 the function.
void	setChartSettings(ChartGlobalizationSettings value) Sets the globalization settings for Chart.
void	setPivotSettings(PivotGlobalizationSettings value) Sets the globalization settings for pivot table.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalizationSettings

public GlobalizationSettings()

Method Detail

getChartSettings

public ChartGlobalizationSettings getChartSettings()

Gets the globalization settings for Chart.

setChartSettings

public void setChartSettings(ChartGlobalizationSettings value)

Sets the globalization settings for Chart.

getPivotSettings

public PivotGlobalizationSettings getPivotSettings()

Gets the globalization settings for pivot table.

setPivotSettings

public void setPivotSettings(PivotGlobalizationSettings value)

Sets the globalization settings for pivot table.

getPivotTotalName

public java.lang.String getPivotTotalName()

Deprecated. Use PivotGlobalizationSettings.GetTextOfTotal() method instead.

Gets the name of "Total" label in the PivotTable. You need to override this method when the PivotTable contains two or more PivotFields in the data area.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of "Total" label

getPivotGrandTotalName

public java.lang.String getPivotGrandTotalName()

Deprecated. Use PivotGlobalizationSettings.GetTextOfGrandTotal() method instead.

Gets the name of "Grand Total" label in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of "Grand Total" label

getMultipleItemsName

public java.lang.String getMultipleItemsName()

Deprecated. Use PivotGlobalizationSettings.GetTextOfMultipleItems() method instead.

Gets the name of "(Multiple Items)" label in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of "(Multiple Items)" label

getAllName

public java.lang.String getAllName()

Deprecated. Use PivotGlobalizationSettings.GetTextOfAll() method instead.

Gets the name of "(All)" label in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use GlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of "(All)" label

getProtectionNameOfPivotTable

public java.lang.String getProtectionNameOfPivotTable()

Deprecated. Use PivotGlobalizationSettings.GetTextOfProtectedName(string) method instead.

Gets the protection name in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetTextOfProtectedName(string) method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The protection name of PivotTable

getColumnLabelsOfPivotTable

public java.lang.String getColumnLabelsOfPivotTable()

Deprecated. Use PivotGlobalizationSettings.GetTextOfColumnLabels() method instead.

Gets the name of "Column Labels" label in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of column labels

getRowLabelsNameOfPivotTable

public java.lang.String getRowLabelsNameOfPivotTable()

Deprecated. Use PivotGlobalizationSettings.GetTextOfRowLabels() method instead.

Gets the name of "Row Labels" label in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of row labels

getEmptyDataName

public java.lang.String getEmptyDataName()

Deprecated. Use PivotGlobalizationSettings.GetTextOfEmptyData() method instead.

Gets the name of "(blank)" label in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of empty data

getDataFieldHeaderNameOfPivotTable

public java.lang.String getDataFieldHeaderNameOfPivotTable()

Deprecated. Use PivotGlobalizationSettings.GetTextOfDataFieldHeader() method instead.

Gets the the name of the value area field header in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Returns:

The name of data field header name

getSubTotalName

public java.lang.String getSubTotalName(int subTotalType)

Deprecated. Use PivotGlobalizationSettings.GetTextOfSubTotal() method instead.

Gets the name of PivotFieldSubtotalType type in the PivotTable.

Remarks

NOTE: This member is now obsolete. Instead, please use PivotGlobalizationSettings.GetColumnLabelsOfPivotTable() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

subTotalType - PivotFieldSubtotalType. The PivotFieldSubtotalType type

Returns:

The name of PivotFieldSubtotalType type

getTotalName

public java.lang.String getTotalName(int functionType)

Gets the total name of the function.

Parameters:

functionType - ConsolidationFunction. The function type.

Returns:

The total name of the function.

getGrandTotalName

public java.lang.String getGrandTotalName(int functionType)

Gets the grand total name of the function.

Parameters:

functionType - ConsolidationFunction. The function type.

Returns:

The grand total name of the function.

getDefaultSheetName

public java.lang.String getDefaultSheetName()

Gets the default sheet name for adding worksheet automatically. Default is "Sheet".

Remarks

The automatically added(such as by WorksheetCollection.add()) sheet's name will be the specified name plus sequence number. For example, for Germany user maybe wants the sheet name to be "Tabellenblatt2" instead of "Sheet2". Then user may implement this method to return "Tabellenblatt".

Returns:

the default sheet name for adding worksheet automatically

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.

Returns:

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.

Returns:

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. Default is "All", so in formula "#All" represents all rows in referenced table.

Returns:

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. Default is "Totals", so in formula "#Totals" represents the total row of referenced table.

Returns:

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. Default is "This Row", so in formula "#This Row" represents the current row in referenced table.

Returns:

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

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

Parameters:

bv - boolean value

Returns:

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

getLocalFunctionName

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

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

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.

getStandardFunctionName

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

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

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.

getLocalBuiltInName

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

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

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.

getStandardBuiltInName

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

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

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.

getListSeparator

public char getListSeparator()

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

getRowSeparatorOfFormulaArray

public char getRowSeparatorOfFormulaArray()

Gets the separator for rows in array data in formula.

getColumnSeparatorOfFormulaArray

public char getColumnSeparatorOfFormulaArray()

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

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.

Parameters:

localfontStyleName - Locale font style name for Header/Footer.

Returns:

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

getCommentTitleName

public java.lang.String getCommentTitleName(int type)

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

Parameters:

type - CommentTitleType.

Returns:

compare

public int compare(java.lang.String v1,
          java.lang.String v2,
          boolean ignoreCase)

Compares two string values according to certain collation rules.

Parameters:

v1 - the first string

v2 - the second string

ignoreCase - whether ignore case when comparing values

Returns:

Integer that indicates the lexical relationship between the two comparands

getCollationKey

public java.lang.Comparable getCollationKey(java.lang.String v,
                                   boolean ignoreCase)

Transforms the string into a comparable object according to certain collation rules.

Parameters:

v - String value needs to be compared with others.

ignoreCase - whether ignore case when comparing values

Returns:

Object can be used to compare or sort string values