Package com.independentsoft.office.odf.fields

Class SheetName

java.lang.Object

com.independentsoft.office.odf.fields.Field

com.independentsoft.office.odf.fields.SheetName

All Implemented Interfaces:

IContentElement, IParagraphContent

public class SheetName
extends Field

Represents the name of a sheet that is currently being edited in a Spreadsheet document.

Field Summary

Fields inherited from class com.independentsoft.office.odf.fields.Field

parent

Constructor Summary

Constructors

Constructor	Description
SheetName()	Initializes a new instance of the SheetName class.
SheetName(InternalXMLStreamReader reader)	Instantiates a new sheet name.
SheetName(String name)	Initializes a new instance of the SheetName class.

Method Summary

Modifier and Type	Method	Description
SheetName	clone()	Creates a new object that is a deep copy of the current instance.
List<IContentElement>	getContentElements()	Returns all content elements.
IContentElement	getParent()	Returns the parent content element.
String	getValue()	Gets the sheet name.
void	setParent(IContentElement parent)	Sets the parent content element.
void	setValue(String value)	Sets the sheet name.
String	toString()	Converts the value of the current SheetName object to its equivalent string representation.

Methods inherited from class java.lang.Object

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

Constructor Details

SheetName

public SheetName()

Initializes a new instance of the SheetName class.

SheetName

public SheetName(String name)

Initializes a new instance of the SheetName class.

Parameters:

name - the name

SheetName

public SheetName(InternalXMLStreamReader reader)
          throws XMLStreamException

Instantiates a new sheet name.

Parameters:

reader - the reader

Throws:

XMLStreamException - the xML stream exception

Method Details

getContentElements

public List<IContentElement> getContentElements()

Returns all content elements.

Specified by:

getContentElements in interface IContentElement

Specified by:

getContentElements in class Field

Returns:

A collection of content elements.

getParent

public IContentElement getParent()

Returns the parent content element.

Specified by:

getParent in interface IContentElement

Overrides:

getParent in class Field

Returns:

the parent

setParent

public void setParent(IContentElement parent)

Sets the parent content element.

Specified by:

setParent in interface IContentElement

Overrides:

setParent in class Field

Parameters:

parent - the new parent

clone

public SheetName clone()

Creates a new object that is a deep copy of the current instance.

Specified by:

clone in interface IContentElement

Specified by:

clone in interface IParagraphContent

Specified by:

clone in class Field

Returns:

A new object that is a copy of this instance.

toString

public String toString()

Converts the value of the current SheetName object to its equivalent string representation.

Overrides:

toString in class Object

Returns:

the string

getValue

public String getValue()

Gets the sheet name.

Returns:

the value

setValue

public void setValue(String value)

Sets the sheet name.

Parameters:

value - the new value