org.zkoss.poi.xssf.usermodel

Class XSSFTableName

java.lang.Object

org.zkoss.poi.xssf.usermodel.XSSFTableName

public final class XSSFTableName
extends Object

Represents a table named range in a SpreadsheetML workbook.

Since:

3.9.7

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XSSFTableName(XSSFTable table, XSSFWorkbook workbook) Creates an XSSFName object - called internally by XSSFWorkbook.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Compares this name to the specified object.
XSSFTable	getTable()
String	getTableNameName() Returns the name that will appear in the user interface for the table name.
int	hashCode()
void	setTableNameName(String name) Sets the name that will appear in the user interface for the defined name.

Methods inherited from class java.lang.Object

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

Constructor Detail

XSSFTableName

protected XSSFTableName(XSSFTable table,
                        XSSFWorkbook workbook)

Creates an XSSFName object - called internally by XSSFWorkbook.

Parameters:

name - - the xml bean that holds data represenring this defined name.

workbook - - the workbook object associated with the name

See Also:

XSSFWorkbook.createName()

Method Detail

getTable

public XSSFTable getTable()

getTableNameName

public String getTableNameName()

Returns the name that will appear in the user interface for the table name.

Returns:

text name of this defined name

setTableNameName

public void setTableNameName(String name)

Sets the name that will appear in the user interface for the defined name. Names must begin with a letter or underscore, not contain spaces and be unique across the workbook.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Compares this name to the specified object. The result is true if the argument is XSSFName and the underlying CTDefinedName bean equals to the CTDefinedName representing this name

Overrides:

equals in class Object

Parameters:

o - the object to compare this XSSFName against.

Returns:

true if the XSSFName are equal; false otherwise.