GlobalizationSettings
Inheritance: java.lang.Object
public class GlobalizationSettings
Represents the globalization settings.
Constructors
| Constructor | Description |
|---|---|
| GlobalizationSettings() |
Methods
| Method | Description |
|---|---|
| compare(String v1, String v2, boolean ignoreCase) | Compares two string values according to certain collation rules. |
| equals(Object arg0) | |
| getAllName() | Gets the name of “(All)” label in the PivotTable. |
| getBooleanValueString(boolean bv) | Gets the display string value for cell’s boolean value |
| getChartSettings() | Gets the globalization settings for Chart. |
| getClass() | |
| getCollationKey(String v, boolean ignoreCase) | Transforms the string into a comparable object according to certain collation rules. |
| getColumnLabelsOfPivotTable() | Gets the name of “Column Labels” label in the PivotTable. |
| getColumnSeparatorOfFormulaArray() | Gets the separator for the items in array’s row data in formula. |
| getCommentTitleName(int type) | Gets the locale dependent comment title name according to comment title type. |
| getDataFieldHeaderNameOfPivotTable() | Gets the the name of the value area field header in the PivotTable. |
| getDefaultSheetName() | Gets the default sheet name for adding worksheet automatically. |
| getEmptyDataName() | Gets the name of “(blank)” label in the PivotTable. |
| getErrorValueString(String err) | Gets the display string value for cell’s error value |
| getGrandTotalName(int functionType) | Gets the grand total name of the function. |
| getListSeparator() | Gets the separator for list, parameters of function, …etc. |
| getLocalBuiltInName(String standardName) | Gets the locale dependent text for built-in Name according to given standard text. |
| getLocalFunctionName(String standardName) | Gets the locale dependent function name according to given standard function name. |
| getMultipleItemsName() | Gets the name of “(Multiple Items)” label in the PivotTable. |
| getPivotGrandTotalName() | Gets the name of “Grand Total” label in the PivotTable. |
| getPivotSettings() | Gets the globalization settings for pivot table. |
| getPivotTotalName() | Gets the name of “Total” label in the PivotTable. |
| getProtectionNameOfPivotTable() | Gets the protection name in the PivotTable. |
| getRowLabelsNameOfPivotTable() | Gets the name of “Row Labels” label in the PivotTable. |
| getRowSeparatorOfFormulaArray() | Gets the separator for rows in array data in formula. |
| getStandardBuiltInName(String localName) | Gets the standard text of built-in Name according to given locale dependent text. |
| getStandardFunctionName(String localName) | Gets the standard function name according to given locale dependent function name. |
| getStandardHeaderFooterFontStyleName(String localfontStyleName) | Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name. |
| getSubTotalName(int subTotalType) | Gets the name of PivotFieldSubtotalType type in the PivotTable. |
| getTableRowTypeOfAll() | Gets the type name of table rows that consists of all rows in referenced table. |
| getTableRowTypeOfCurrent() | Gets the type name of table rows that consists of the current row in referenced table. |
| getTableRowTypeOfData() | Gets the type name of table rows that consists of data region of referenced table. |
| getTableRowTypeOfHeaders() | Gets the type name of table rows that consists of the table header. |
| getTableRowTypeOfTotals() | Gets the type name of table rows that consists of the total row of referenced table. |
| getTotalName(int functionType) | Gets the total name of the function. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setChartSettings(ChartGlobalizationSettings value) | Sets the globalization settings for Chart. |
| setPivotSettings(PivotGlobalizationSettings value) | Sets the globalization settings for pivot table. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
GlobalizationSettings()
public GlobalizationSettings()
compare(String v1, String v2, boolean ignoreCase)
public int compare(String v1, String v2, boolean ignoreCase)
Compares two string values according to certain collation rules.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| v1 | java.lang.String | the first string |
| v2 | java.lang.String | the second string |
| ignoreCase | boolean | whether ignore case when comparing values |
Returns: int - Integer that indicates the lexical relationship between the two comparands
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAllName()
public String getAllName()
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: java.lang.String - The name of “(All)” label
getBooleanValueString(boolean bv)
public String getBooleanValueString(boolean bv)
Gets the display string value for cell’s boolean value
Parameters:
| Parameter | Type | Description |
|---|---|---|
| bv | boolean | boolean value |
Returns: java.lang.String - By default returns “TRUE” for true value and “FALSE” for false value.
getChartSettings()
public ChartGlobalizationSettings getChartSettings()
Gets the globalization settings for Chart.
Returns: ChartGlobalizationSettings
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getCollationKey(String v, boolean ignoreCase)
public Comparable getCollationKey(String v, boolean ignoreCase)
Transforms the string into a comparable object according to certain collation rules.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| v | java.lang.String | String value needs to be compared with others. |
| ignoreCase | boolean | whether ignore case when comparing values |
Returns: java.lang.Comparable - Object can be used to compare or sort string values
getColumnLabelsOfPivotTable()
public String getColumnLabelsOfPivotTable()
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: java.lang.String - The name of column labels
getColumnSeparatorOfFormulaArray()
public char getColumnSeparatorOfFormulaArray()
Gets the separator for the items in array’s row data in formula.
Returns: char
getCommentTitleName(int type)
public String getCommentTitleName(int type)
Gets the locale dependent comment title name according to comment title type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | int | CommentTitleType. |
Returns: java.lang.String -
getDataFieldHeaderNameOfPivotTable()
public String getDataFieldHeaderNameOfPivotTable()
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: java.lang.String - The name of data field header name
getDefaultSheetName()
public 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: java.lang.String - the default sheet name for adding worksheet automatically
getEmptyDataName()
public String getEmptyDataName()
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: java.lang.String - The name of empty data
getErrorValueString(String err)
public String getErrorValueString(String err)
Gets the display string value for cell’s error value
Parameters:
| Parameter | Type | Description |
|---|---|---|
| err | java.lang.String | error values such as #VALUE!,#NAME? |
Returns: java.lang.String - By default returns the error value itself
getGrandTotalName(int functionType)
public String getGrandTotalName(int functionType)
Gets the grand total name of the function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| functionType | int | ConsolidationFunction. The function type. |
Returns: java.lang.String - The grand total name of the function.
getListSeparator()
public char getListSeparator()
Gets the separator for list, parameters of function, …etc.
Returns: char
getLocalBuiltInName(String standardName)
public String getLocalBuiltInName(String standardName)
Gets the locale dependent text for built-in Name according to given standard text.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| standardName | java.lang.String | Standard(en-US locale) text of built-in Name. |
Returns: java.lang.String - Locale dependent text. The locale was specified by the Workbook for which this settings is used.
getLocalFunctionName(String standardName)
public String getLocalFunctionName(String standardName)
Gets the locale dependent function name according to given standard function name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| standardName | java.lang.String | Standard(en-US locale) function name. |
Returns: java.lang.String - Locale dependent function name. The locale was specified by the Workbook for which this settings is used.
getMultipleItemsName()
public String getMultipleItemsName()
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: java.lang.String - The name of “(Multiple Items)” label
getPivotGrandTotalName()
public String getPivotGrandTotalName()
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: java.lang.String - The name of “Grand Total” label
getPivotSettings()
public PivotGlobalizationSettings getPivotSettings()
Gets the globalization settings for pivot table.
Returns: PivotGlobalizationSettings
getPivotTotalName()
public String getPivotTotalName()
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: java.lang.String - The name of “Total” label
getProtectionNameOfPivotTable()
public String getProtectionNameOfPivotTable()
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: java.lang.String - The protection name of PivotTable
getRowLabelsNameOfPivotTable()
public String getRowLabelsNameOfPivotTable()
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: java.lang.String - The name of row labels
getRowSeparatorOfFormulaArray()
public char getRowSeparatorOfFormulaArray()
Gets the separator for rows in array data in formula.
Returns: char
getStandardBuiltInName(String localName)
public String getStandardBuiltInName(String localName)
Gets the standard text of built-in Name according to given locale dependent text.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| localName | java.lang.String | Locale dependent text of built-in Name. The locale was specified by the Workbook for which this settings is used. |
Returns: java.lang.String - Standard(en-US locale) text.
getStandardFunctionName(String localName)
public String getStandardFunctionName(String localName)
Gets the standard function name according to given locale dependent function name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| localName | java.lang.String | Locale dependent function name. The locale was specified by the Workbook for which this settings is used. |
Returns: java.lang.String - Standard(en-US locale) function name.
getStandardHeaderFooterFontStyleName(String localfontStyleName)
public String getStandardHeaderFooterFontStyleName(String localfontStyleName)
Gets standard English font style name(Regular, Bold, Italic) for Header/Footer according to given locale font style name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| localfontStyleName | java.lang.String | Locale font style name for Header/Footer. |
Returns: java.lang.String - Standard English font style name(Regular, Bold, Italic)
getSubTotalName(int subTotalType)
public String getSubTotalName(int subTotalType)
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:
| Parameter | Type | Description |
|---|---|---|
| subTotalType | int | PivotFieldSubtotalType. The PivotFieldSubtotalType type |
Returns: java.lang.String - The name of PivotFieldSubtotalType type
getTableRowTypeOfAll()
public 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: java.lang.String - the type name of table rows
getTableRowTypeOfCurrent()
public 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: java.lang.String - the type name of table rows
getTableRowTypeOfData()
public 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: java.lang.String - the type name of table rows
getTableRowTypeOfHeaders()
public 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: java.lang.String - the type name of table rows
getTableRowTypeOfTotals()
public 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: java.lang.String - the type name of table rows
getTotalName(int functionType)
public String getTotalName(int functionType)
Gets the total name of the function.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| functionType | int | ConsolidationFunction. The function type. |
Returns: java.lang.String - The total name of the function.
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setChartSettings(ChartGlobalizationSettings value)
public void setChartSettings(ChartGlobalizationSettings value)
Sets the globalization settings for Chart.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ChartGlobalizationSettings |
setPivotSettings(PivotGlobalizationSettings value)
public void setPivotSettings(PivotGlobalizationSettings value)
Sets the globalization settings for pivot table.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PivotGlobalizationSettings |
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 |